diff --git a/.coderabbit.yaml b/.coderabbit.yaml index c53b1981..58eb549f 100644 --- a/.coderabbit.yaml +++ b/.coderabbit.yaml @@ -11,8 +11,8 @@ reviews: walkthrough: false poem: false auto_review: - enabled: false - drafts: true # Can review drafts. Since it's manually triggered, it's fine. + enabled: true + drafts: false # Don't review drafts automatically auto_incremental_review: false # always review the whole PR, not just new commits base_branches: - main diff --git a/.github/workflows/docs.yaml b/.github/workflows/docs.yaml index 741fc9ca..7e5de881 100644 --- a/.github/workflows/docs.yaml +++ b/.github/workflows/docs.yaml @@ -39,20 +39,11 @@ jobs: - name: Install dependencies run: npm ci - - name: Determine site URL - id: site-url - run: | - if [ "${{ github.repository }}" = "bmad-code-org/BMAD-METHOD" ]; then - echo "url=https://bmad-code-org.github.io/BMAD-METHOD" >> $GITHUB_OUTPUT - else - OWNER="${{ github.repository_owner }}" - REPO="${{ github.event.repository.name }}" - echo "url=https://${OWNER}.github.io/${REPO}" >> $GITHUB_OUTPUT - fi - - name: Build documentation env: - SITE_URL: ${{ steps.site-url.outputs.url }} + # Override site URL from GitHub repo variable if set + # Otherwise, astro.config.mjs will compute from GITHUB_REPOSITORY + SITE_URL: ${{ vars.SITE_URL }} run: npm run docs:build - name: Upload artifact diff --git a/.gitignore b/.gitignore index de55079f..c644f148 100644 --- a/.gitignore +++ b/.gitignore @@ -46,8 +46,6 @@ CLAUDE.local.md # Project-specific _bmad-core _bmad-creator-tools -test-project-install/* -sample-project/* flattened-codebase.xml *.stats.md .internal-docs/ @@ -66,6 +64,7 @@ shared-modules z*/ _bmad +_bmad-output .claude .codex .github/chatmodes @@ -76,6 +75,7 @@ _bmad bmad-custom-src/ -# Docusaurus / Documentation Build -.docusaurus/ +# Astro / Documentation Build +website/.astro/ +website/dist/ build/ diff --git a/.vscode/settings.json b/.vscode/settings.json index 1f500542..8a85c1f3 100644 --- a/.vscode/settings.json +++ b/.vscode/settings.json @@ -57,6 +57,7 @@ "tileset", "tmpl", "Trae", + "Unsharded", "VNET", "webskip" ], diff --git a/CHANGELOG.md b/CHANGELOG.md index a757f51f..7f266887 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,5 +1,533 @@ # Changelog +## [6.0.0-alpha.23] + +**Release: January 11, 2026** + +### 🌟 Key Highlights + +1. **Astro/Starlight Documentation Platform**: Complete migration from Docusaurus to modern Astro+Starlight for superior performance and customization +2. **Diataxis Framework Implementation**: Professional documentation restructuring with tutorials, how-to guides, explanations, and references +3. **Workflow Creator & Validator**: Powerful new tools for workflow creation with subprocess support and PRD validation +4. **TEA Documentation Expansion**: Comprehensive testing documentation with cheat sheets, MCP enhancements, and API testing patterns +5. **Brainstorming Revolution**: Research-backed procedural rigor with 100+ idea goal and anti-bias protocols +6. **Cursor IDE Modernization**: Refactored from rules-based to command-based architecture for better IDE integration + +### 📚 Documentation Platform Revolution + +**Astro/Starlight Migration:** + +- **From Docusaurus to Astro**: Complete platform migration for improved performance, better customization, and modern tooling +- **Starlight Theme**: Professional documentation theme with dark mode default and responsive design +- **Build Pipeline Overhaul**: New build-docs.js orchestrates link checking, artifact generation, and Astro build +- **LLM-Friendly Documentation**: Generated llms.txt and llms-full.txt for AI agent discoverability +- **Downloadable Source Bundles**: bmad-sources.zip and bmad-prompts.zip for offline use + +**Diataxis Framework Implementation:** + +- **Four Content Types**: Professional separation into tutorials, how-to guides, explanations, and references +- **21 Files Migrated**: Phase 1 migration of core documentation to Diataxis structure +- **42+ Focused Documents**: Phase 2 split of large legacy files into manageable pieces +- **FAQ Restructuring**: 7 topic-specific FAQ files with standardized format +- **Tutorial Style Guide**: Comprehensive documentation standards for consistent content creation + +**Link Management & Quality:** + +- **Site-Relative Links**: Converted 217 links to repo-relative format (/docs/path/file.md) +- **Link Validation Tools**: New validate-doc-links.js and fix-doc-links.js for maintaining link integrity +- **Broken Link Fixes**: Resolved ~50 broken internal links across documentation +- **BMad Acronym Standardization**: Consistent use of "BMad" (Breakthrough Method of Agile AI Driven Development) +- **SEO Optimization**: Absolute URLs in AI meta tags for better web crawler discoverability + +### 🔧 Workflow Creator & Validator (Major Feature) + +**Workflow Creation Tool:** + +- **Subprocess Support**: Advanced workflows can now spawn subprocesses for complex operations +- **PRD Validation Step**: New validation step ensures PRD quality before workflow execution +- **Trimodal Workflow Creation**: Three-mode workflow generation system +- **Quadrivariate Module Workflow**: Four-variable workflow architecture for enhanced flexibility +- **Path Violation Checks**: Validator ensures workflows don't violate path constraints +- **Max Parallel Mode POC**: Proof-of-concept for parallel workflow validation + +**Workflow Quality Improvements:** + +- **PRD Trimodal Compliance**: PRD workflow now follows trimodal standards +- **Standardized Step Formatting**: Consistent markdown formatting across workflow and PRD steps +- **Better Suggested Next Steps**: Improved workflow completion guidance +- **Variable Naming Standardization**: {project_root} → {project-root} across all workflows + +### 🧪 TEA Documentation Expansion + +**Comprehensive Testing Guides:** + +- **Cheat Sheets**: Quick reference guides for common testing scenarios +- **MCP Enhancements**: Model Context Protocol improvements for testing workflows +- **API Testing Patterns**: Best practices for API testing documentation +- **Design Philosophy Callout**: Clear explanation of TEA's design principles +- **Context Engineering Glossary**: New glossary entry defining context engineering concepts +- **Fragment Count Updates**: Accurate documentation of TEA workflow components +- **Playwright Utils Examples**: Updated code examples for playwright-utils integration + +### 💡 Brainstorming Workflow Overhaul + +**Research-Backed Procedural Rigor:** + +- **100+ Idea Goal**: Emphasis on quantity-first approach to unlock better quality ideas +- **Anti-Bias Protocol**: Domain pivot every 10 ideas to reduce cognitive biases +- **Chain-of-Thought Requirements**: Reasoning before idea generation +- **Simulated Temperature**: Prompts for higher divergence in ideation +- **Standardized Idea Format**: Quality control template for consistent output +- **Energy Checkpoints**: Multiple continuation options to maintain creative flow + +**Exploration Menu Improvements:** + +- **Letter-Based Navigation**: [K/T/A/B/C] options instead of numbers for clarity +- **Keep/Try/Advanced/Break/Continue**: Clear action options for idea refinement +- **Universal Facilitation Rules**: Consistent guidelines across all brainstorming steps +- **Quality Growth Enforcement**: Balance between quantity and quality metrics + +### 🖥️ Cursor IDE Modernization + +**Command-Based Architecture:** + +- **From Rules to Commands**: Complete refactor from rules-based to command-based system +- **Command Generation**: Automatic generation of task and tool commands +- **Commands Directory**: New `.cursor/commands/bmad/` structure for generated commands +- **Cleanup Integration**: Automatic cleanup of old BMAD commands alongside rules +- **Enhanced Logging**: Better feedback on agents, tasks, tools, and workflow commands generated + +### 🤖 Agent System Improvements + +**Agent Builder & Validation:** + +- **hasSidecar Field**: All agents now indicate sidecar support (true/false) +- **Validation Enforcement**: hasSidecar now required in agent validation +- **Better Brownfield Documentation**: Improved brownfield project documentation +- **Agent Builder Updates**: Agent builder now uses hasSidecar field +- **Agent Editor Integration**: Editor workflow respects hasSidecar configuration + +### 🐛 Bug Fixes & Quality Improvements + +**Critical Fixes:** + +- **Windows Line Endings**: Resolved CRLF issues causing cross-platform problems +- **Code-Review File Filtering**: Fixed code-review picking up non-application files +- **ERR_REQUIRE_ESM Resolution**: Dynamic import for inquirer v9+ compatibility +- **Project-Context Conflicts**: Allow full project-context usage with conflict precedence +- **Workflow Paths**: Fixed paths for workflow and sprint status files +- **Missing Scripts**: Fixed missing scripts from installation + +**Workflow & Variable Fixes:** + +- **Variable Naming**: Standardized from {project_root} to {project-root} across CIS, BMGD, and BMM modules +- **Workflow References**: Fixed broken .yaml → .md workflow references +- **Advanced Elicitation Variables**: Fixed undefined variables in brainstorming +- **Dependency Format**: Corrected dependency format and added missing frontmatter + +**Code Quality:** + +- **Dependency Updates**: Bumped qs from 6.14.0 to 6.14.1 +- **CodeRabbit Integration**: Enabled auto-review on new PRs +- **TEA Fragment Counts**: Updated fragment counts for accuracy +- **Documentation Links**: Fixed Discord channel references (#general-dev → #bmad-development) + +### 🚀 Installation & CLI Improvements + +**Installation Enhancements:** + +- **Workflow Exclusion**: Ability to exclude workflows from being added as commands +- **Example Workflow Protection**: Example workflow in workflow builder now excluded from tools +- **CNAME Configuration**: Added CNAME file for custom domain support +- **Script Fixes**: All scripts now properly included in installation + +### 📊 Statistics + +- **27 commits** since alpha.22 +- **217 documentation links** converted to site-relative format +- **42+ focused documents** created from large legacy files +- **7 topic-specific FAQ files** with standardized formatting +- **Complete documentation platform** migrated from Docusaurus to Astro/Starlight +- **Major workflow tools** added: Creator, Validator with subprocess support +- **Brainstorming workflow** overhauled with research-backed rigor + +--- + +## [6.0.0-alpha.22] + +**Release: December 31, 2025** + +### 🌟 Key Highlights + +1. **Unified Agent Workflow**: Create, Edit, and Validate workflows consolidated into single powerful agent workflow with separate step paths +2. **Agent Knowledge System**: Comprehensive data file architecture with persona properties, validation patterns, and crafting principles +3. **Deep Language Integration**: All sharded progressive workflows now support language choice at every step +4. **Core Module Documentation**: Extensive docs for core workflows (brainstorming, party mode, advanced elicitation) +5. **BMAD Core Concepts**: New documentation structure explaining agents, workflows, modules, and installation +6. **Tech Spec Sharded**: create-tech-spec workflow converted to sharded format with orient-first pattern + +### 🤖 Unified Agent Workflow (Major Feature) + +**Consolidated Architecture:** + +- **Single Workflow, Three Paths**: Create, Edit, and Validate operations unified under `src/modules/bmb/workflows/agent/` +- **steps-c/**: Create path with 9 comprehensive steps for building new agents +- **steps-e/**: Edit path with 10 steps for modifying existing agents +- **steps-v/**: Validate path for standalone agent validation review +- **data/**: Centralized knowledge base for all agent-building intel + +### 📚 Agent Knowledge System + +**Data File Architecture:** + +Located in `src/modules/bmb/workflows/agent/data/`: + +- **agent-metadata.md** (208 lines) - Complete metadata field reference +- **agent-menu-patterns.md** (233 lines) - Menu design patterns and best practices +- **agent-compilation.md** (273 lines) - Compilation process documentation +- **persona-properties.md** (266 lines) - Persona crafting properties and examples +- **principles-crafting.md** (292 lines) - Core principles for agent design +- **critical-actions.md** (120 lines) - Critical action patterns +- **expert-agent-architecture.md** (236 lines) - Expert agent structure +- **expert-agent-validation.md** (173 lines) - Expert-specific validation +- **module-agent-validation.md** (124 lines) - Module-specific validation +- **simple-agent-architecture.md** (204 lines) - Simple agent structure +- **simple-agent-validation.md** (132 lines) - Simple agent validation +- **understanding-agent-types.md** (222 lines) - Agent type comparison +- **brainstorm-context.md** - Brainstorming guidance +- **communication-presets.csv** - Communication style presets + +**Reference Examples:** + +- **reference/module-examples/architect.agent.yaml** - Module agent example +- **reference/simple-examples/commit-poet.agent.yaml** - Simple agent example +- **journal-keeper/** - Complete sidecar pattern example + +**Templates:** + +- **templates/simple-agent.template.md** - Simple agent template +- **templates/expert-agent-template/expert-agent.template.md** - Expert agent template +- **templates/expert-agent-sidecar/** - Sidecar templates (instructions, memories) + +### 🌍 Deep Language Integration + +**Progressive Workflow Language Support:** + +- **Every Step Biased**: All sharded progressive workflow steps now include language preference context +- **260+ Files Updated**: Comprehensive language integration across: + - Core workflows (brainstorming, party mode, advanced elicitation) + - BMB workflows (create-agent, create-module, create-workflow, edit-workflow, etc.) + - BMGD workflows (game-brief, gdd, narrative, game-architecture, etc.) + - BMM workflows (research, create-ux-design, prd, create-architecture, etc.) +- **Tested Languages**: Verified working with Spanish and Pirate Speak +- **Natural Conversations**: AI agents respond in configured language throughout workflow + +### 📖 Core Module Documentation + +**New Core Documentation Structure:** + +`docs/modules/core/`: + +- **index.md** - Core module overview +- **core-workflows.md** - Core workflow documentation +- **core-tasks.md** - Core task reference +- **brainstorming.md** (100 lines) - Brainstorming workflow guide +- **party-mode.md** (50 lines) - Party mode guide +- **advanced-elicitation.md** (105 lines) - Advanced elicitation techniques +- **document-sharding-guide.md** (133 lines) - Sharded workflow format guide +- **global-core-config.md** - Global core configuration reference + +**Advanced Elicitation Moved:** + +- **From**: `docs/` root +- **To**: `src/core/workflows/advanced-elicitation/` +- **Status**: Now a proper core workflow with methods.csv + +### 📚 BMAD Core Concepts Documentation + +**New Documentation Structure:** + +`docs/bmad-core-concepts/`: + +- **index.md** - Core concepts introduction +- **agents.md** (93 lines) - Understanding agents in BMAD +- **workflows.md** (89 lines) - Understanding workflows in BMAD +- **modules.md** (76 lines) - Understanding modules (BMM, BMGD, CIS, BMB, Core) +- **installing/index.md** (77 lines) - Installation guide +- **installing/upgrading.md** (144 lines) - Upgrading guide +- **bmad-customization/index.md** - Customization overview +- **bmad-customization/agents.md** - Agent customization guide +- **bmad-customization/workflows.md** (30 lines) - Workflow customization guide +- **web-bundles/index.md** (34 lines) - Web bundle distribution guide + +**Documentation Cleanup:** + +- **Removed v4-to-v6-upgrade.md** - Outdated upgrade guide +- **Removed document-sharding-guide.md** from docs root (moved to core) +- **Removed web-bundles-gemini-gpt-guide.md** - Consolidated into web-bundles/index.md +- **Removed getting-started/installation.md** - Migrated to bmad-core-concepts +- **Removed all ide-info/*.md files** - Consolidated into web-bundles documentation + +### 🔧 Create-Tech-Spec Sharded Conversion + +**Monolithic to Sharded:** + +- **From**: Single `workflow.yaml` with `instructions.md` +- **To**: Sharded `workflow.md` with individual step files +- **Pattern**: Orient-first approach (understand before investigating) + +### 🔨 Additional Improvements + +**Workflow Status Path Fixes:** + +- **Corrected Discovery Paths**: workflow-status workflows now properly use planning_artifacts and implementation_artifacts +- **Updated All Path Files**: enterprise-brownfield, enterprise-greenfield, method-brownfield, method-greenfield + +**Documentation Updates:** + +- **BMB Agent Creation Guide**: Comprehensive 166-line guide for agent creation +- **Workflow Vendoring Doc**: New 42-line guide on workflow customization and inheritance +- **Document Project Reference**: Moved from BMM docs to shared location +- **Workflows Planning Guide**: New 89-line guide for planning workflows + +**BMB Documentation Streamlining:** + +- **Removed Redundant Docs**: Eliminated duplicate documentation in `src/modules/bmb/docs/` +- **Step File Rules**: New 469-line comprehensive guide for step file creation +- **Agent Docs Moved**: Agent architecture and validation docs moved to workflow data/ + +**Windows Inquirer Fix:** + +- **Another Default Addition**: Additional inquirer default value setting for better Windows multiselection support + +**Code Quality:** + +- **Removed Old BMM README**: Consolidated module documentation +- **Removed BMM Troubleshooting**: 661-line doc moved to shared location +- **Removed Enterprise Agentic Development**: 686-line doc consolidated +- **Removed Scale Adaptive System**: 618-line doc consolidated + +--- + +## [6.0.0-alpha.21] + +**Release: December 27, 2025** + +### 🌟 Key Highlights + +1. **Consistent Menu System**: All agents now use standardized 2-letter menu codes (e.g., "rd" for research, "ca" for create-architecture) +2. **Planning Artifacts Architecture**: Phase 1-3 workflows now properly segregate planning artifacts from documentation +3. **Windows Installer Fixed Again**: Updated inquirer to resolve multiselection tool issues +4. **Auto-Injected Features**: Chat and party mode automatically injected into all agents +5. **Validation System**: All agents now pass comprehensive new validation checks + +### 🎯 Consistent Menu System (Major Feature) + +**Standardized 2-Letter Codes:** + +- **Compound Menu Triggers**: All agents now use consistent 2-letter compound trigger format (e.g., `bmm-rd`, `bmm-ca`) +- **Improved UX**: Shorter, more memorable command shortcuts across all modules +- **Module Prefixing**: Menu items properly scoped by module prefix (bmm-, bmgd-, cis-, bmb-) +- **Universal Pattern**: All 22 agents updated to follow the same menu structure + +**Agent Updates:** + +- **BMM Module**: 9 agents with standardized menus (pm, analyst, architect, dev, ux-designer, tech-writer, sm, tea, quick-flow-solo-dev) +- **BMGD Module**: 6 agents with standardized menus (game-architect, game-designer, game-dev, game-qa, game-scrum-master, game-solo-dev) +- **CIS Module**: 6 agents with standardized menus (innovation-strategist, design-thinking-coach, creative-problem-solver, brainstorming-coach, presentation-master, storyteller) +- **BMB Module**: 3 agents with standardized menus (bmad-builder, agent-builder, module-builder, workflow-builder) +- **Core Module**: BMAD Master agent updated with consistent menu patterns + +### 📁 Planning Artifacts Architecture + +**Content Segregation Implementation:** + +- **Phase 1-3 Workflows**: All planning workflows now use `planning_artifacts` folder (default changed from `docs`) +- **Proper Input Discovery**: Workflows follow consistent input discovery patterns from planning artifacts +- **Output Management**: Planning artifacts properly separated from long-term documentation +- **Affected Workflows**: + - Product Brief: Updated discovery and output to planning artifacts + - PRD: Fixed discovery and output to planning artifacts + - UX Design: Updated all steps for proper artifact handling + - Architecture: Updated discovery and output flow + - Game Architecture: Updated for planning artifacts + - Story Creation: Updated workflow output paths + +**File Organization:** + +- **Planning Artifacts**: Ephemeral planning documents (prd.md, product-brief.md, ux-design.md, architecture.md) +- **Documentation**: Long-term project documentation (separate from planning) +- **Module Configuration**: BMM and BMGD modules updated with proper default paths + +### 🪟 Windows Installer Fixes + +**Inquirer Multiselection Fix:** + +- **Updated Inquirer Version**: Resolved tool multiselection issues that were causing Windows installer failures +- **Better Compatibility**: Improved handling of checkbox and multi-select prompts on Windows(?) + +### 🤖 Agent System Improvements + +**Auto-Injected Features:** + +- **Chat Mode**: Automatically injected into all agents during compilation +- **Party Mode**: Automatically injected into all agents during compilation +- **Reduced Manual Configuration**: No need to manually add these features to agent definitions +- **Consistent Behavior**: All agents now have uniform access to chat and party mode capabilities + +**Agent Normalization:** + +- **All Agents Validated**: All 22 agents pass comprehensive validation checks +- **Schema Enforcement**: Proper compound trigger validation implemented +- **Metadata Cleanup**: Removed obsolete and inconsistent metadata patterns +- **Test Fixtures Updated**: Validation test fixtures aligned with new requirements + +### 🔧 Bug Fixes & Cleanup + +**Docusaurus Merge Recovery:** + +- **Restored Agent Files**: Fixed agent files accidentally modified in Docusaurus merge (PR #1191) +- **Reference Cleanup**: Removed obsolete agent reference examples (journal-keeper, security-engineer, trend-analyst) +- **Test Fixture Updates**: Aligned test fixtures with current validation requirements + +**Code Quality:** + +- **Schema Improvements**: Enhanced agent schema validation with better error messages +- **Removed Redundancy**: Cleaned up duplicate and obsolete agent definitions +- **Installer Cleanup**: Removed unused configuration code from BMM installer + +**Planning Artifacts Path:** +- Default: `planning_artifacts/` (configurable in module.yaml) +- Previous: `docs/` +- Benefit: Clear separation between planning work and permanent documentation + +--- + +## [6.0.0-alpha.20] + +**Release: December 23, 2025** + +### 🌟 Key Highlights + +1. **Windows Installer Fixed**: Better compatibility with inquirer v9.x upgrade +2. **Path Segregation**: Revolutionary content organization separating ephemeral artifacts from permanent documentation +3. **Custom Installation Messages**: Configurable intro/outro messages for professional installation experience +4. **Enhanced Upgrade Logic**: Two-version auto upgrades with proper config preservation +5. **Quick-Dev Refactor**: Sharded format with comprehensive adversarial review +6. **Improved Quality**: Streamlined personas, fixed workflows, and cleaned up documentation +7. **Doc Site Auto Generation**; Auto Generate a docusaurus site update on merge + +### 🪟 Windows Installer (hopefully) Fixed + +**Inquirer Upgrade:** + +- **Updated to v9.x**: Upgraded inquirer package for better Windows support +- **Improved Compatibility**: Better handling of Windows terminal environments +- **Enhanced UX**: More reliable interactive prompts across platforms + +### 🎯 Path Segregation Implementation (Major Feature) + +**Revolutionary Content Organization:** + +- **Phase 1-4 Path Segregation**: Implemented new BM paths across all BMM and BMGD workflows +- **Planning vs Implementation Artifacts**: Separated ephemeral Phase 4 artifacts from permanent documentation +- **Optimized File Organization**: Better structure differentiating planning artifacts from long-term project documentation +- **Backward Compatible**: Existing installations continue working while preparing for optimized content organization +- **Module Configuration Updates**: Enhanced module.yaml with new path configurations for all phases +- **Workflow Path Updates**: All 90+ workflow files updated with proper path configurations + +**Documentation Cleanup:** + +- **Removed Obsolete Documentation**: Cleaned up 3,100+ lines of outdated documentation +- **Streamlined README Files**: Consolidated and improved module documentation +- **Enhanced Clarity**: Removed redundant content and improved information architecture + +### 💬 Installation Experience Enhancements + +**Custom Installation Messages:** + +- **Configurable Intro/Outro Messages**: New install-messages.yaml file for customizable installation messages +- **Professional Installation Flow**: Custom welcome messages and completion notifications +- **Module-Specific Messaging**: Tailored messages for different installation contexts +- **Enhanced User Experience**: More informative and personalized installation process + +**Core Module Improvements:** + +- **Always Ask Questions**: Core module now always prompts for configuration (no accept defaults) +- **Better User Engagement**: Ensures users actively configure their installation +- **Improved Configuration Accuracy**: Reduces accidental acceptance of defaults + +### 🔧 Upgrade & Configuration Management + +**Two-Version Auto Upgrade:** + +- **Smarter Upgrade Logic**: Automatic upgrades now span 2 versions (e.g., .16 → .18) +- **Config Variable Preservation**: Ensures all configuration variables are retained during quick updates +- **Seamless Updates**: Quick updates now preserve custom settings properly +- **Enhanced Upgrade Safety**: Better handling of configuration across version boundaries + +### 🤖 Workflow Improvements + +**Quick-Dev Workflow Refactor (PR #1182):** + +- **Sharded Format Conversion**: Converted quick-dev workflow to modern step-file format +- **Adversarial Review Integration**: Added comprehensive self-check and adversarial review steps +- **Enhanced Quality Assurance**: 6-step process with mode detection, context gathering, execution, self-check, review, and resolution +- **578 New Lines Added**: Significant expansion of quick-dev capabilities + +**BMGD Workflow Fixes:** + +- **workflow-status Filename Correction**: Fixed incorrect filename references (PR #1172) +- **sprint-planning Update**: Added workflow-status update to game-architecture completion +- **Path Corrections**: Resolved dead references and syntax errors (PR #1164) + +### 🎨 Code Quality & Refactoring + +**Persona Streamlining (PR #1167):** + +- **Quick-Flow-Solo-Dev Persona**: Streamlined for clarity and accuracy +- **Improved Agent Behavior**: More focused and efficient solo development support + +**Package Management:** + +- **package-lock.json Sync**: Ensured version consistency (PR #1168) +- **Dependency Cleanup**: Reduced package-lock bloat significantly + +**Prettier Configuration:** + +- **Markdown Underscore Protection**: Prettier will no longer mess up underscores in markdown files +- **Disabled Auto-Fix**: Markdown formatting issues now handled more intelligently +- **Better Code Formatting**: Improved handling of special characters in documentation + +### 📚 Documentation Updates + +**Sponsor Attribution:** + +- **DigitalOcean Sponsorship**: Added attribution for DigitalOcean support (PR #1162) + +**Content Reorganization:** + +- **Removed Unused Docs**: Eliminated obsolete documentation files +- **Consolidated References**: Merged and reorganized technical references +- **Enhanced README Files**: Improved module and workflow documentation + +### 🧹 Cleanup & Optimization + +**File Organization:** + +- **Removed Asterisk Insertion**: Eliminated unwanted asterisk insertions into agent files +- **Removed Unused Commands**: Cleaned up deprecated command references +- **Consolidated Duplication**: Reduced code duplication across multiple files +- **Removed Unneeded Folders**: Cleaned up temporary and obsolete directory structures + +### 📊 Statistics + +- **23 commits** since alpha.19 +- **90+ workflow files** updated with new path configurations +- **3,100+ lines of documentation** removed and reorganized +- **578 lines added** to quick-dev workflow with adversarial review +- **Major architectural improvement** to content organization + ## [6.0.0-alpha.19] **Release: December 18, 2025** diff --git a/CNAME b/CNAME new file mode 100644 index 00000000..99cd1ce5 --- /dev/null +++ b/CNAME @@ -0,0 +1 @@ +docs.bmad-method.org \ No newline at end of file diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index d7c48cb4..78798b57 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -4,8 +4,9 @@ Thank you for considering contributing to the BMad project! We believe in **Huma 💬 **Discord Community**: Join our [Discord server](https://discord.gg/gk8jAdXWmj) for real-time discussions: -- **#general-dev** - Technical discussions, feature ideas, and development questions -- **#bugs-issues** - Bug reports and issue discussions +- **#bmad-development** - Technical discussions and development questions +- **#suggestions-feedback** - Feature ideas and suggestions +- **#report-bugs-and-issues** - Bug reports and issue discussions ## Our Philosophy @@ -56,7 +57,7 @@ Every contribution should strengthen human-AI collaboration. Ask yourself: **"Do ### Reporting Bugs 1. **Check existing issues** first to avoid duplicates -2. **Consider discussing in Discord** (#bugs-issues channel) for quick help +2. **Consider discussing in Discord** (#report-bugs-and-issues channel) for quick help 3. **Use the bug report template** when creating a new issue - it guides you through providing: - Clear bug description - Steps to reproduce @@ -67,7 +68,7 @@ Every contribution should strengthen human-AI collaboration. Ask yourself: **"Do ### Suggesting Features or New Modules -1. **Discuss first in Discord** (#general-dev channel) - the feature request template asks if you've done this +1. **Discuss first in Discord** (#suggestions-feedback channel) - the feature request template asks if you've done this 2. **Check existing issues and discussions** to avoid duplicates 3. **Use the feature request template** when creating an issue 4. **Be specific** about why this feature would benefit the BMad community and strengthen human-AI collaboration @@ -77,7 +78,7 @@ Every contribution should strengthen human-AI collaboration. Ask yourself: **"Do ⚠️ **Required before submitting PRs:** 1. **For bugs**: Check if an issue exists (create one using the bug template if not) -2. **For features**: Discuss in Discord (#general-dev) AND create a feature request issue +2. **For features**: Discuss in Discord (#suggestions-feedback) AND create a feature request issue 3. **For large changes**: Always open an issue first to discuss alignment Please propose small, granular changes! For large or significant changes, discuss in Discord and open an issue first. This prevents wasted effort on PRs that may not align with planned changes. @@ -251,8 +252,9 @@ By participating in this project, you agree to abide by our Code of Conduct. We ## Need Help? - 💬 Join our [Discord Community](https://discord.gg/gk8jAdXWmj): - - **#general-dev** - Technical questions and feature discussions - - **#bugs-issues** - Get help with bugs before filing issues + - **#bmad-development** - Technical questions and discussions + - **#suggestions-feedback** - Feature ideas and suggestions + - **#report-bugs-and-issues** - Get help with bugs before filing issues - 🐛 Report bugs using the [bug report template](https://github.com/bmad-code-org/BMAD-METHOD/issues/new?template=bug_report.md) - 💡 Suggest features using the [feature request template](https://github.com/bmad-code-org/BMAD-METHOD/issues/new?template=feature_request.md) - 📖 Browse the [GitHub Discussions](https://github.com/bmad-code-org/BMAD-METHOD/discussions) diff --git a/README.md b/README.md index 08a07462..14d581ff 100644 --- a/README.md +++ b/README.md @@ -1,245 +1,91 @@ -# BMad Method & BMad Core +# BMad Method -[![Stable Version](https://img.shields.io/npm/v/bmad-method?color=blue&label=stable)](https://www.npmjs.com/package/bmad-method) -[![Alpha Version](https://img.shields.io/npm/v/bmad-method/alpha?color=orange&label=alpha)](https://www.npmjs.com/package/bmad-method) +[![Version](https://img.shields.io/npm/v/bmad-method?color=blue&label=version)](https://www.npmjs.com/package/bmad-method) [![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](LICENSE) [![Node.js Version](https://img.shields.io/badge/node-%3E%3D20.0.0-brightgreen)](https://nodejs.org) [![Discord](https://img.shields.io/badge/Discord-Join%20Community-7289da?logo=discord&logoColor=white)](https://discord.gg/gk8jAdXWmj) ---- +**Build More, Architect Dreams** — An AI-driven agile development framework with 21 specialized agents, 50+ guided workflows, and scale-adaptive intelligence that adjusts from bug fixes to enterprise systems. -
+**100% free and open source.** No paywalls. No gated content. No gated Discord. We believe in empowering everyone, not just those who can pay. -## 🎉 NEW: BMAD V6 Installer - Create & Share Custom Content! +## Why BMad? -The completely revamped **BMAD V6 installer** now includes built-in support for creating, installing, and sharing custom modules, agents, workflows, templates, and tools! Build your own AI solutions or share them with your team - and real soon, with the whole BMad Community througha verified community sharing portal! +Traditional AI tools do the thinking for you, producing average results. BMad agents act as expert collaborators who guide you through structured workflows to bring out your best thinking. -**✨ What's New:** +- **Scale-Adaptive**: Automatically adjusts planning depth based on project complexity (Level 0-4) +- **Structured Workflows**: Grounded in agile best practices across analysis, planning, architecture, and implementation +- **Specialized Agents**: 12+ domain experts (PM, Architect, Developer, UX, Scrum Master, and more) +- **Complete Lifecycle**: From brainstorming to deployment, with just-in-time documentation -- 📦 **Streamlined Custom Module Installation** - Package your custom content as installable modules -- 🤖 **Agent & Workflow Sharing** - Distribute standalone agents and workflows -- 🔄 **Unitary Module Support** - Install individual components without full modules -- ⚙️ **Dependency Management** - Automatic handling of module dependencies -- 🛡️ **Update-Safe Customization** - Your custom content persists through updates +## Quick Start -**📚 Learn More:** - -- [**Custom Content Overview**](./docs/custom-content.md) - Discover all supported content types -- [**Installation Guide**](./docs/custom-content-installation.md) - Learn to create and install custom content -- [**Detail Content Docs**](./src/modules/bmb/docs/index.md) - Reference details for agents, modules, workflows and the bmad builder -- [**2 Very simple Custom Modules of questionable quality**](./samples/sample-custom-modules/README.md) - if you want to download and try to install a custom shared module, get an idea of how to bundle and share your own, or create your own personal agents, workflows and modules. - -
- ---- - -## AI-Driven Agile Development That Scales From Bug Fixes to Enterprise - -**Build More, Architect Dreams** (BMAD) with **21 specialized AI agents** across 4 official modules, and **50+ guided workflows** that adapt to your project's complexity—from quick bug fixes to enterprise platforms, and new step file workflows that allow for incredibly long workflows to stay on the rails longer than ever before! - -Additionally - when we say 'Build More, Architect Dreams' - we mean it! The BMad Builder has landed, and now as of Alpha.15 is fully supported in the installation flow via NPX - custom stand along agents, workflows and the modules of your dreams! The community forge will soon open, endless possibility awaits! - -> **🚀 v6 is a MASSIVE upgrade from v4!** Complete architectural overhaul, scale-adaptive intelligence, visual workflows, and the powerful BMad Core framework. v4 users: this changes everything. [See what's new →](#whats-new-in-v6) - -> **📌 v6 Alpha Status:** Near-beta quality with vastly improved stability. Documentation is being finalized. New videos coming soon to [BMadCode YouTube](https://www.youtube.com/@BMadCode). - -## 🎯 Why BMad Method? - -Unlike generic AI coding assistants, BMad Method provides **structured, battle-tested workflows** powered by specialized agents who understand agile development. Each agent has deep domain expertise—from product management to architecture to testing—working together seamlessly. - -**✨ Key Benefits:** - -- **Scale-Adaptive Intelligence** - Automatically adjusts planning depth from bug fixes to enterprise systems -- **Complete Development Lifecycle** - Analysis → Planning → Architecture → Implementation -- **Specialized Expertise** - 19 agents with specific roles (PM, Architect, Developer, UX Designer, etc.) -- **Proven Methodologies** - Built on agile best practices with AI amplification -- **IDE Integration** - Works with Claude Code, Cursor, Windsurf, VS Code - -## 🏗️ The Power of BMad Core - -**BMad Method** is actually a sophisticated module built on top of **BMad Core** (**C**ollaboration **O**ptimized **R**eflection **E**ngine). This revolutionary architecture means: - -- **BMad Core** provides the universal framework for human-AI collaboration -- **BMad Method** leverages Core to deliver agile development workflows -- **BMad Builder** lets YOU create custom modules as powerful as BMad Method itself - -With **BMad Builder**, you can architect both simple agents and vastly complex domain-specific modules (legal, medical, finance, education, creative) that will soon be sharable in an **official community marketplace**. Imagine building and sharing your own specialized AI team! - -## 📊 See It In Action - -

- BMad Method Workflow -

- -

- Complete BMad Method workflow showing all phases, agents, and decision points -

- -## 🚀 Get Started in 3 Steps - -### 1. Install BMad Method +**Prerequisites**: [Node.js](https://nodejs.org) v20+ ```bash -# Install v6 Alpha (recommended) npx bmad-method@alpha install - -# Or stable v4 for production -npx bmad-method install ``` -### 2. Initialize Your Project +Follow the installer prompts to configure your project. Then run: -Load any agent in your IDE and run: - -``` +```bash *workflow-init ``` -This analyzes your project and recommends the right workflow track. +This analyzes your project and recommends a track: -### 3. Choose Your Track +| Track | Best For | Time to First Story | +| --------------- | ------------------------- | ------------------- | +| **Quick Flow** | Bug fixes, small features | ~5 minutes | +| **BMad Method** | Products and platforms | ~15 minutes | +| **Enterprise** | Compliance-heavy systems | ~30 minutes | -BMad Method adapts to your needs with three intelligent tracks: +## Modules -| Track | Use For | Planning | Time to Start | -| ------------------ | ------------------------- | ----------------------- | ------------- | -| **⚡ Quick Flow** | Bug fixes, small features | Tech spec only | < 5 minutes | -| **📋 BMad Method** | Products, platforms | PRD + Architecture + UX | < 15 minutes | -| **🏢 Enterprise** | Compliance, scale | Full governance suite | < 30 minutes | +| Module | Purpose | +| ------------------------------------- | -------------------------------------------------------- | +| **BMad Method (BMM)** | Core agile development with 34 workflows across 4 phases | +| **BMad Builder (BMB)** | Create custom agents and domain-specific modules | +| **Creative Intelligence Suite (CIS)** | Innovation, brainstorming, and problem-solving | -> **Not sure?** Run `*workflow-init` and let BMad analyze your project goal. +## Documentation -## 🔄 How It Works: 4-Phase Methodology +**[Full Documentation](http://docs.bmad-method.org)** — Tutorials, how-to guides, concepts, and reference -BMad Method guides you through a proven development lifecycle: - -1. **📊 Analysis** (Optional) - Brainstorm, research, and explore solutions -2. **📝 Planning** - Create PRDs, tech specs, or game design documents -3. **🏗️ Solutioning** - Design architecture, UX, and technical approach -4. **⚡ Implementation** - Story-driven development with continuous validation - -Each phase has specialized workflows and agents working together to deliver exceptional results. - -## 🤖 Meet Your Team - -**12 Specialized Agents** working in concert: - -| Development | Architecture | Product | Leadership | -| ----------- | -------------- | ------------- | -------------- | -| Developer | Architect | PM | Scrum Master | -| UX Designer | Test Architect | Analyst | BMad Master | -| Tech Writer | Game Architect | Game Designer | Game Developer | - -**Test Architect** integrates with `@seontechnologies/playwright-utils` for production-ready fixture-based utilities. - -Each agent brings deep expertise and can be customized to match your team's style. - -## 📦 What's Included - -### Core Modules - -- **BMad Method (BMM)** - Complete agile development framework - - 12 specialized agents - - 34 workflows across 4 phases - - Scale-adaptive planning - - [→ Documentation Hub](./src/modules/bmm/docs/index.md) - -- **BMad Builder (BMB)** - Create custom agents and workflows - - Build anything from simple agents to complex modules - - Create domain-specific solutions (legal, medical, finance, education) - - [→ Builder Guide](./src/modules/bmb/docs/index.md) - -- **Creative Intelligence Suite (CIS)** - Innovation & problem-solving - - Brainstorming, design thinking, storytelling - - 5 creative facilitation workflows - - [→ Creative Workflows](./src/modules/cis/docs/index.md) - -### Key Features - -- **🎨 Customizable Agents** - Modify personalities, expertise, and communication styles -- **🌐 Multi-Language Support** - Separate settings for communication and code output -- **📄 Document Sharding** - 90% token savings for large projects -- **🔄 Update-Safe** - Your customizations persist through updates -- **🚀 Web Bundles** - Use in ChatGPT, Claude Projects, or Gemini Gems - -## 📚 Documentation - -### Quick Links - -- **[Quick Start Guide](./src/modules/bmm/docs/quick-start.md)** - 15-minute introduction -- **[Complete BMM Documentation](./src/modules/bmm/docs/index.md)** - All guides and references -- **[Agent Customization](./docs/agent-customization-guide.md)** - Personalize your agents -- **[All Documentation](./docs/index.md)** - Complete documentation index +- [Getting Started Tutorial](http://docs.bmad-method.org/tutorials/getting-started/getting-started-bmadv6/) +- [Upgrading from Previous Versions](http://docs.bmad-method.org/how-to/installation/upgrade-to-v6/) ### For v4 Users -- **[v4 Documentation](https://github.com/bmad-code-org/BMAD-METHOD/tree/V4)** -- **[v4 to v6 Upgrade Guide](./docs/v4-to-v6-upgrade.md)** +- **[v4 Documentation](https://github.com/bmad-code-org/BMAD-METHOD/tree/V4/docs)** -## 💬 Community & Support +## Community -- **[Discord Community](https://discord.gg/gk8jAdXWmj)** - Get help, share projects -- **[GitHub Issues](https://github.com/bmad-code-org/BMAD-METHOD/issues)** - Report bugs, request features -- **[YouTube Channel](https://www.youtube.com/@BMadCode)** - Video tutorials and demos -- **[Web Bundles](https://bmad-code-org.github.io/bmad-bundles/)** - Pre-built agent bundles -- **[Code of Conduct](.github/CODE_OF_CONDUCT.md)** - Community guidelines +- [Discord](https://discord.gg/gk8jAdXWmj) — Get help, share ideas, collaborate +- [YouTube](https://www.youtube.com/@BMadCode) — Tutorials, master class, and podcast (launching Feb 2025) +- [GitHub Issues](https://github.com/bmad-code-org/BMAD-METHOD/issues) — Bug reports and feature requests +- [Discussions](https://github.com/bmad-code-org/BMAD-METHOD/discussions) — Community conversations -## 🛠️ Development +## Support BMad -For contributors working on the BMad codebase: +BMad is free for everyone — and always will be. If you'd like to support development: -```bash -# Run all quality checks -npm test +- ⭐ [Star us on GitHub](https://github.com/bmad-code-org/BMAD-METHOD/) — Helps others discover BMad +- 📺 [Subscribe on YouTube](https://www.youtube.com/@BMadCode) — Master class launching Feb 2026 +- ☕ [Buy Me a Coffee](https://buymeacoffee.com/bmad) — Fuel the development +- 🏢 Corporate sponsorship — DM on Discord +- 🎤 Speaking & Media — Available for conferences, podcasts, interviews (Discord) -# Development commands -npm run lint:fix # Fix code style -npm run format:fix # Auto-format code -npm run bundle # Build web bundles -``` +## Contributing -See [CONTRIBUTING.md](CONTRIBUTING.md) for full development guidelines. +We welcome contributions! See [CONTRIBUTING.md](CONTRIBUTING.md) for guidelines. -## What's New in v6 +## License -**v6 represents a complete architectural revolution from v4:** - -### 🚀 Major Upgrades - -- **BMad Core Framework** - Modular architecture enabling custom domain solutions -- **Scale-Adaptive Intelligence** - Automatic adjustment from bug fixes to enterprise -- **Visual Workflows** - Beautiful SVG diagrams showing complete methodology -- **BMad Builder Module** - Create and share your own AI agent teams -- **50+ Workflows** - Up from 20 in v4, covering every development scenario -- **19 Specialized Agents** - Enhanced with customizable personalities and expertise -- **Update-Safe Customization** - Your configs persist through all updates -- **Web Bundles** - Use agents in ChatGPT, Claude, and Gemini -- **Multi-Language Support** - Separate settings for communication and code -- **Document Sharding** - 90% token savings for large projects - -### 🔄 For v4 Users - -- **[Comprehensive Upgrade Guide](./docs/v4-to-v6-upgrade.md)** - Step-by-step migration -- **[v4 Documentation Archive](https://github.com/bmad-code-org/BMAD-METHOD/tree/V4)** - Legacy reference -- Backwards compatibility where possible -- Smooth migration path with installer detection - -## 📄 License - -MIT License - See [LICENSE](LICENSE) for details. - -**Trademarks:** BMad™ and BMAD-METHOD™ are trademarks of BMad Code, LLC. - -Supported by:  DigitalOcean +MIT License — see [LICENSE](LICENSE) for details. --- -

- - Contributors - -

+**BMad** and **BMAD-METHOD** are trademarks of BMad Code, LLC. -

- Built with ❤️ for the human-AI collaboration community -

+[![Contributors](https://contrib.rocks/image?repo=bmad-code-org/BMAD-METHOD)](https://github.com/bmad-code-org/BMAD-METHOD/graphs/contributors) diff --git a/SECURITY.md b/SECURITY.md new file mode 100644 index 00000000..2c565ed1 --- /dev/null +++ b/SECURITY.md @@ -0,0 +1,85 @@ +# Security Policy + +## Supported Versions + +We release security patches for the following versions: + +| Version | Supported | +| ------- | ------------------ | +| Latest | :white_check_mark: | +| < Latest | :x: | + +We recommend always using the latest version of BMad Method to ensure you have the most recent security updates. + +## Reporting a Vulnerability + +We take security vulnerabilities seriously. If you discover a security issue, please report it responsibly. + +### How to Report + +**Do NOT report security vulnerabilities through public GitHub issues.** + +Instead, please report them via one of these methods: + +1. **GitHub Security Advisories** (Preferred): Use [GitHub's private vulnerability reporting](https://github.com/bmad-code-org/BMAD-METHOD/security/advisories/new) to submit a confidential report. + +2. **Discord**: Contact a maintainer directly via DM on our [Discord server](https://discord.gg/gk8jAdXWmj). + +### What to Include + +Please include as much of the following information as possible: + +- Type of vulnerability (e.g., prompt injection, path traversal, etc.) +- Full paths of source file(s) related to the vulnerability +- Step-by-step instructions to reproduce the issue +- Proof-of-concept or exploit code (if available) +- Impact assessment of the vulnerability + +### Response Timeline + +- **Initial Response**: Within 48 hours of receiving your report +- **Status Update**: Within 7 days with our assessment +- **Resolution Target**: Critical issues within 30 days; other issues within 90 days + +### What to Expect + +1. We will acknowledge receipt of your report +2. We will investigate and validate the vulnerability +3. We will work on a fix and coordinate disclosure timing with you +4. We will credit you in the security advisory (unless you prefer to remain anonymous) + +## Security Scope + +### In Scope + +- Vulnerabilities in BMad Method core framework code +- Security issues in agent definitions or workflows that could lead to unintended behavior +- Path traversal or file system access issues +- Prompt injection vulnerabilities that bypass intended agent behavior +- Supply chain vulnerabilities in dependencies + +### Out of Scope + +- Security issues in user-created custom agents or modules +- Vulnerabilities in third-party AI providers (Claude, GPT, etc.) +- Issues that require physical access to a user's machine +- Social engineering attacks +- Denial of service attacks that don't exploit a specific vulnerability + +## Security Best Practices for Users + +When using BMad Method: + +1. **Review Agent Outputs**: Always review AI-generated code before executing it +2. **Limit File Access**: Configure your AI IDE to limit file system access where possible +3. **Keep Updated**: Regularly update to the latest version +4. **Validate Dependencies**: Review any dependencies added by generated code +5. **Environment Isolation**: Consider running AI-assisted development in isolated environments + +## Acknowledgments + +We appreciate the security research community's efforts in helping keep BMad Method secure. Contributors who report valid security issues will be acknowledged in our security advisories. + +--- + +Thank you for helping keep BMad Method and our community safe. diff --git a/docs/404.md b/docs/404.md new file mode 100644 index 00000000..b42841e9 --- /dev/null +++ b/docs/404.md @@ -0,0 +1,9 @@ +--- +title: Page Not Found +template: splash +--- + + +The page you're looking for doesn't exist or has been moved. + +[Return to Home](/docs/index.md) diff --git a/src/modules/bmm/docs/images/README.md b/docs/_README_WORKFLOW_DIAGRAMS.md similarity index 95% rename from src/modules/bmm/docs/images/README.md rename to docs/_README_WORKFLOW_DIAGRAMS.md index 8e34ebbd..8e61bc94 100644 --- a/src/modules/bmm/docs/images/README.md +++ b/docs/_README_WORKFLOW_DIAGRAMS.md @@ -1,4 +1,7 @@ -# Workflow Diagram Maintenance +--- +title: "Workflow Diagram Maintenance" +--- + ## Regenerating SVG from Excalidraw diff --git a/docs/_STYLE_GUIDE.md b/docs/_STYLE_GUIDE.md new file mode 100644 index 00000000..008557e1 --- /dev/null +++ b/docs/_STYLE_GUIDE.md @@ -0,0 +1,766 @@ +--- +title: "Documentation Style Guide" +--- + +Internal guidelines for maintaining consistent, high-quality documentation across the BMad Method project. This document is not included in the Starlight sidebar — it's for contributors and maintainers, not end users. + +## Quick Principles + +1. **Clarity over brevity** — Be concise, but never at the cost of understanding +2. **Consistent structure** — Follow established patterns so readers know what to expect +3. **Strategic visuals** — Use admonitions, tables, and diagrams purposefully +4. **Scannable content** — Headers, lists, and callouts help readers find what they need + +## Validation Steps + +Before submitting documentation changes, run these checks from the repo root: + +1. **Fix link format** — Convert relative links (`./`, `../`) to site-relative paths (`/path/`) + ```bash + npm run docs:fix-links # Preview changes + npm run docs:fix-links -- --write # Apply changes + ``` + +2. **Validate links** — Check all links point to existing files + ```bash + npm run docs:validate-links # Preview issues + npm run docs:validate-links -- --write # Auto-fix where possible + ``` + +3. **Build the site** — Verify no build errors + ```bash + npm run docs:build + ``` + +## Tutorial Structure + +Every tutorial should follow this structure: + +``` +1. Title + Hook (1-2 sentences describing the outcome) +2. Version/Module Notice (info or warning admonition as appropriate) +3. What You'll Learn (bullet list of outcomes) +4. Prerequisites (info admonition) +5. Quick Path (tip admonition - TL;DR summary) +6. Understanding [Topic] (context before steps - tables for phases/agents) +7. Installation (if applicable) +8. Step 1: [First Major Task] +9. Step 2: [Second Major Task] +10. Step 3: [Third Major Task] +11. What You've Accomplished (summary + folder structure if applicable) +12. Quick Reference (commands table) +13. Common Questions (FAQ format) +14. Getting Help (community links) +15. Key Takeaways (tip admonition - memorable points) +``` + +Not all sections are required for every tutorial, but this is the standard flow. + +## How-To Structure + +How-to guides are task-focused and shorter than tutorials. They answer "How do I do X?" for users who already understand the basics. + +``` +1. Title + Hook (one sentence: "Use the `X` workflow to...") +2. When to Use This (bullet list of scenarios) +3. When to Skip This (optional - for workflows that aren't always needed) +4. Prerequisites (note admonition) +5. Steps (numbered ### subsections) +6. What You Get (output/artifacts produced) +7. Example (optional - concrete usage scenario) +8. Tips (optional - best practices, common pitfalls) +9. Next Steps (optional - what to do after completion) +``` + +Include sections only when they add value. A simple how-to might only need Hook, Prerequisites, Steps, and What You Get. + +### How-To vs Tutorial + +| Aspect | How-To | Tutorial | +|--------|--------|----------| +| **Length** | 50-150 lines | 200-400 lines | +| **Audience** | Users who know the basics | New users learning concepts | +| **Focus** | Complete a specific task | Understand a workflow end-to-end | +| **Sections** | 5-8 sections | 12-15 sections | +| **Examples** | Brief, inline | Detailed, step-by-step | + +### How-To Visual Elements + +Use admonitions strategically in how-to guides: + +| Admonition | Use In How-To | +|------------|---------------| +| `:::note[Prerequisites]` | Required dependencies, agents, prior steps | +| `:::tip[Pro Tip]` | Optional shortcuts or best practices | +| `:::caution[Common Mistake]` | Pitfalls to avoid | +| `:::note[Example]` | Brief usage example inline with steps | + +**Guidelines:** +- **1-2 admonitions max** per how-to (they're shorter than tutorials) +- **Prerequisites as admonition** makes scanning easier +- **Tips section** can be a flat list instead of admonition if there are multiple tips +- **Skip admonitions entirely** for very simple how-tos + +### How-To Checklist + +Before submitting a how-to: + +- [ ] Hook is one clear sentence starting with "Use the `X` workflow to..." +- [ ] When to Use This has 3-5 bullet points +- [ ] Prerequisites listed (admonition or flat list) +- [ ] Steps are numbered `###` subsections with action verbs +- [ ] What You Get describes output artifacts +- [ ] No horizontal rules (`---`) +- [ ] No `####` headers +- [ ] No "Related" section (sidebar handles navigation) +- [ ] 1-2 admonitions maximum + +## Explanation Structure + +Explanation documents help users understand concepts, features, and design decisions. They answer "What is X?" and "Why does X matter?" rather than "How do I do X?" + +### Types of Explanation Documents + +| Type | Purpose | Example | +|------|---------|---------| +| **Index/Landing** | Overview of a topic area with navigation | `core-concepts/index.md` | +| **Concept** | Define and explain a core concept | `what-are-agents.md` | +| **Feature** | Deep dive into a specific capability | `quick-flow.md` | +| **Philosophy** | Explain design decisions and rationale | `why-solutioning-matters.md` | +| **FAQ** | Answer common questions (see FAQ Sections below) | `brownfield-faq.md` | + +### General Explanation Structure + +``` +1. Title + Hook (1-2 sentences explaining the topic) +2. Overview/Definition (what it is, why it matters) +3. Key Concepts (### subsections for main ideas) +4. Comparison Table (optional - when comparing options) +5. When to Use / When Not to Use (optional - decision guidance) +6. Diagram (optional - mermaid for processes/flows) +7. Next Steps (optional - where to go from here) +``` + +### Index/Landing Pages + +Index pages orient users within a topic area. + +``` +1. Title + Hook (one sentence overview) +2. Content Table (links with descriptions) +3. Getting Started (numbered list for new users) +4. Choose Your Path (optional - decision tree for different goals) +``` + +**Example hook:** "Understanding the fundamental building blocks of the BMad Method." + +### Concept Explainers + +Concept pages define and explain core ideas. + +``` +1. Title + Hook (what it is in one sentence) +2. Types/Categories (if applicable, with ### subsections) +3. Key Differences Table (comparing types/options) +4. Components/Parts (breakdown of elements) +5. Which Should You Use? (decision guidance) +6. Creating/Customizing (brief pointer to how-to guides) +``` + +**Example hook:** "Agents are AI assistants that help you accomplish tasks. Each agent has a unique personality, specialized capabilities, and an interactive menu." + +### Feature Explainers + +Feature pages provide deep dives into specific capabilities. + +``` +1. Title + Hook (what the feature does) +2. Quick Facts (optional - "Perfect for:", "Time to:") +3. When to Use / When Not to Use (with bullet lists) +4. How It Works (process overview, mermaid diagram if helpful) +5. Key Benefits (what makes it valuable) +6. Comparison Table (vs alternatives if applicable) +7. When to Graduate/Upgrade (optional - when to use something else) +``` + +**Example hook:** "Quick Spec Flow is a streamlined alternative to the full BMad Method for Quick Flow track projects." + +### Philosophy/Rationale Documents + +Philosophy pages explain design decisions and reasoning. + +``` +1. Title + Hook (the principle or decision) +2. The Problem (what issue this addresses) +3. The Solution (how this approach solves it) +4. Key Principles (### subsections for main ideas) +5. Benefits (what users gain) +6. When This Applies (scope of the principle) +``` + +**Example hook:** "Phase 3 (Solutioning) translates **what** to build (from Planning) into **how** to build it (technical design)." + +### Explanation Visual Elements + +Use these elements strategically in explanation documents: + +| Element | Use For | +|---------|---------| +| **Comparison tables** | Contrasting types, options, or approaches | +| **Mermaid diagrams** | Process flows, phase sequences, decision trees | +| **"Best for:" lists** | Quick decision guidance | +| **Code examples** | Illustrating concepts (keep brief) | + +**Guidelines:** +- **Use diagrams sparingly** — one mermaid diagram per document maximum +- **Tables over prose** — for any comparison of 3+ items +- **Avoid step-by-step instructions** — point to how-to guides instead + +### Explanation Checklist + +Before submitting an explanation document: + +- [ ] Hook clearly states what the document explains +- [ ] Content organized into scannable `##` sections +- [ ] Comparison tables used for contrasting options +- [ ] No horizontal rules (`---`) +- [ ] No `####` headers +- [ ] No "Related" section (sidebar handles navigation) +- [ ] No "Next:" navigation links (sidebar handles navigation) +- [ ] Diagrams have clear labels and flow +- [ ] Links to how-to guides for "how do I do this?" questions +- [ ] 2-3 admonitions maximum + +## Reference Structure + +Reference documents provide quick lookup information for users who know what they're looking for. They answer "What are the options?" and "What does X do?" rather than explaining concepts or teaching skills. + +### Types of Reference Documents + +| Type | Purpose | Example | +|------|---------|---------| +| **Index/Landing** | Navigation to reference content | `workflows/index.md` | +| **Catalog** | Quick-reference list of items | `agents/index.md` | +| **Deep-Dive** | Detailed single-item reference | `document-project.md` | +| **Configuration** | Settings and config documentation | `core-tasks.md` | +| **Glossary** | Term definitions | `glossary/index.md` | +| **Comprehensive** | Extensive multi-item reference | `bmgd-workflows.md` | + +### Reference Index Pages + +For navigation landing pages: + +``` +1. Title + Hook (one sentence describing scope) +2. Content Sections (## for each category) + - Bullet list with links and brief descriptions +``` + +Keep these minimal — their job is navigation, not explanation. + +### Catalog Reference (Item Lists) + +For quick-reference lists of items: + +``` +1. Title + Hook (one sentence) +2. Items (## for each item) + - Brief description (one sentence) + - **Commands:** or **Key Info:** as flat list +3. Universal/Shared (## section if applicable) +``` + +**Guidelines:** +- Use `##` for items, not `###` +- No horizontal rules between items — whitespace is sufficient +- No "Related" section — sidebar handles navigation +- Keep descriptions to 1 sentence per item + +### Item Deep-Dive Reference + +For detailed single-item documentation: + +``` +1. Title + Hook (one sentence purpose) +2. Quick Facts (optional note admonition) + - Module, Command, Input, Output as list +3. Purpose/Overview (## section) +4. How to Invoke (code block) +5. Key Sections (## for each major aspect) + - Use ### for sub-options within sections +6. Notes/Caveats (tip or caution admonition) +``` + +**Guidelines:** +- Start with "quick facts" so readers immediately know scope +- Use admonitions for important caveats +- No "Related Documentation" section — sidebar handles this + +### Configuration Reference + +For settings, tasks, and config documentation: + +``` +1. Title + Hook (one sentence explaining what these configure) +2. Table of Contents (jump links if 4+ items) +3. Items (## for each config/task) + - **Bold summary** — one sentence describing what it does + - **Use it when:** bullet list of scenarios + - **How it works:** numbered steps + - **Output:** expected result (if applicable) +``` + +**Guidelines:** +- Table of contents only needed for 4+ items +- Keep "How it works" to 3-5 steps maximum +- No horizontal rules between items + +### Glossary Reference + +For term definitions: + +``` +1. Title + Hook (one sentence) +2. Navigation (jump links to categories) +3. Categories (## for each category) + - Terms (### for each term) + - Definition (1-3 sentences, no prefix) + - Related context or example (optional) +``` + +**Guidelines:** +- Group related terms into categories +- Keep definitions concise — link to explanation docs for depth +- Use `###` for terms (makes them linkable and scannable) +- No horizontal rules between terms + +### Comprehensive Reference Guide + +For extensive multi-item references: + +``` +1. Title + Hook (one sentence) +2. Overview (## section) + - Diagram or table showing organization +3. Major Sections (## for each phase/category) + - Items (### for each item) + - Standardized fields: Command, Agent, Input, Output, Description + - Optional: Steps, Features, Use when +4. Next Steps (optional — only if genuinely helpful) +``` + +**Guidelines:** +- Standardize item fields across all items in the guide +- Use tables for comparing multiple items at once +- One diagram maximum per document +- No horizontal rules — use `##` sections for separation + +### General Reference Guidelines + +These apply to all reference documents: + +| Do | Don't | +|----|-------| +| Use `##` for major sections, `###` for items within | Use `####` headers | +| Use whitespace for separation | Use horizontal rules (`---`) | +| Link to explanation docs for "why" | Explain concepts inline | +| Use tables for structured data | Use nested lists | +| Use admonitions for important notes | Use bold paragraphs for callouts | +| Keep descriptions to 1-2 sentences | Write paragraphs of explanation | + +### Reference Admonitions + +Use sparingly — 1-2 maximum per reference document: + +| Admonition | Use In Reference | +|------------|------------------| +| `:::note[Prerequisites]` | Dependencies needed before using | +| `:::tip[Pro Tip]` | Shortcuts or advanced usage | +| `:::caution[Important]` | Critical caveats or warnings | + +### Reference Checklist + +Before submitting a reference document: + +- [ ] Hook clearly states what the document references +- [ ] Appropriate structure for reference type (catalog, deep-dive, etc.) +- [ ] No horizontal rules (`---`) +- [ ] No `####` headers +- [ ] No "Related" section (sidebar handles navigation) +- [ ] Items use consistent structure throughout +- [ ] Descriptions are 1-2 sentences maximum +- [ ] Tables used for structured/comparative data +- [ ] 1-2 admonitions maximum +- [ ] Links to explanation docs for conceptual depth + +## Glossary Structure + +Glossaries provide quick-reference definitions for project terminology. Unlike other reference documents, glossaries prioritize compact scanability over narrative explanation. + +### Layout Strategy + +Starlight auto-generates a right-side "On this page" navigation from headers. Use this to your advantage: + +- **Categories as `##` headers** — Appear in right nav for quick jumping +- **Terms in tables** — Compact rows, not individual headers +- **No inline TOC** — Right sidebar handles navigation; inline TOC is redundant +- **Right nav shows categories only** — Cleaner than listing every term + +This approach reduces content length by ~70% while improving navigation. + +### Table Format + +Each category uses a two-column table: + +```md +## Category Name + +| Term | Definition | +|------|------------| +| **Agent** | Specialized AI persona with specific expertise that guides users through workflows. | +| **Workflow** | Multi-step guided process that orchestrates AI agent activities to produce deliverables. | +``` + +### Definition Guidelines + +| Do | Don't | +|----|-------| +| Start with what it IS or DOES | Start with "This is..." or "A [term] is..." | +| Keep to 1-2 sentences | Write multi-paragraph explanations | +| Bold the term name in the cell | Use plain text for terms | +| Link to docs for deep dives | Explain full concepts inline | + +### Context Markers + +For terms with limited scope, add italic context at the start of the definition: + +```md +| **Tech-Spec** | *Quick Flow only.* Comprehensive technical plan for small changes. | +| **PRD** | *BMad Method/Enterprise.* Product-level planning document with vision and goals. | +``` + +Standard markers: +- `*Quick Flow only.*` +- `*BMad Method/Enterprise.*` +- `*Phase N.*` +- `*BMGD.*` +- `*Brownfield.*` + +### Cross-References + +Link related terms when helpful. Reference the category anchor since individual terms aren't headers: + +```md +| **Tech-Spec** | *Quick Flow only.* Technical plan for small changes. See [PRD](#planning-documents). | +``` + +### Organization + +- **Alphabetize terms** within each category table +- **Alphabetize categories** or order by logical progression (foundational → specific) +- **No catch-all sections** — Every term belongs in a specific category + +### Glossary Checklist + +Before submitting glossary changes: + +- [ ] Terms in tables, not individual headers +- [ ] Terms alphabetized within each category +- [ ] No inline TOC (right nav handles navigation) +- [ ] No horizontal rules (`---`) +- [ ] Definitions are 1-2 sentences +- [ ] Context markers italicized at definition start +- [ ] Term names bolded in table cells +- [ ] No "A [term] is..." definitions + +## Visual Hierarchy + +### Avoid + +| Pattern | Problem | +|---------|---------| +| `---` horizontal rules | Fragment the reading flow | +| `####` deep headers | Create visual noise | +| **Important:** bold paragraphs | Blend into body text | +| Deeply nested lists | Hard to scan | +| Code blocks for non-code | Confusing semantics | + +### Use Instead + +| Pattern | When to Use | +|---------|-------------| +| White space + section headers | Natural content separation | +| Bold text within paragraphs | Inline emphasis | +| Admonitions | Callouts that need attention | +| Tables | Structured comparisons | +| Flat lists | Scannable options | + +## Admonitions + +Use Starlight admonitions strategically: + +```md +:::tip[Title] +Shortcuts, best practices, "pro tips" +::: + +:::note[Title] +Context, definitions, examples, prerequisites +::: + +:::caution[Title] +Caveats, potential issues, things to watch out for +::: + +:::danger[Title] +Critical warnings only — data loss, security issues +::: +``` + +### Standard Admonition Uses + +| Admonition | Standard Use in Tutorials | +|------------|---------------------------| +| `:::note[Prerequisites]` | What users need before starting | +| `:::tip[Quick Path]` | TL;DR summary at top of tutorial | +| `:::caution[Fresh Chats]` | Context limitation reminders | +| `:::note[Example]` | Command/response examples | +| `:::tip[Check Your Status]` | How to verify progress | +| `:::tip[Remember These]` | Key takeaways at end | + +### Admonition Guidelines + +- **Always include a title** for tip, info, and warning +- **Keep content brief** — 1-3 sentences ideal +- **Don't overuse** — More than 3-4 per major section feels noisy +- **Don't nest** — Admonitions inside admonitions are hard to read + +## Headers + +### Budget + +- **8-12 `##` sections** for full tutorials following standard structure +- **2-3 `###` subsections** per `##` section maximum +- **Avoid `####` entirely** — use bold text or admonitions instead + +### Naming + +- Use action verbs for steps: "Install BMad", "Create Your Plan" +- Use nouns for reference sections: "Common Questions", "Quick Reference" +- Keep headers short and scannable + +## Code Blocks + +### Do + +```md +```bash +npx bmad-method install +``` +``` + +### Don't + +````md +``` +You: Do something +Agent: [Response here] +``` +```` + +For command/response examples, use an admonition instead: + +```md +:::note[Example] +Run `workflow-status` and the agent will tell you the next recommended workflow. +::: +``` + +## Tables + +Use tables for: +- Phases and what happens in each +- Agent roles and when to use them +- Command references +- Comparing options +- Step sequences with multiple attributes + +Keep tables simple: +- 2-4 columns maximum +- Short cell content +- Left-align text, right-align numbers + +### Standard Tables + +**Phases Table:** +```md +| Phase | Name | What Happens | +|-------|------|--------------| +| 1 | Analysis | Brainstorm, research *(optional)* | +| 2 | Planning | Requirements — PRD or tech-spec *(required)* | +``` + +**Quick Reference Table:** +```md +| Command | Agent | Purpose | +|---------|-------|---------| +| `*workflow-init` | Analyst | Initialize a new project | +| `*prd` | PM | Create Product Requirements Document | +``` + +**Build Cycle Table:** +```md +| Step | Agent | Workflow | Purpose | +|------|-------|----------|---------| +| 1 | SM | `create-story` | Create story file from epic | +| 2 | DEV | `dev-story` | Implement the story | +``` + +## Lists + +### Flat Lists (Preferred) + +```md +- **Option A** — Description of option A +- **Option B** — Description of option B +- **Option C** — Description of option C +``` + +### Numbered Steps + +```md +1. Load the **PM agent** in a new chat +2. Run the PRD workflow: `*prd` +3. Output: `PRD.md` +``` + +### Avoid Deep Nesting + +```md + +1. First step + - Sub-step A + - Detail 1 + - Detail 2 + - Sub-step B +2. Second step +``` + +Instead, break into separate sections or use an admonition for context. + +## Links + +- Use descriptive link text: `[Tutorial Style Guide](./tutorial-style.md)` +- Avoid "click here" or bare URLs +- Prefer relative paths within docs + +## Images + +- Always include alt text +- Add a caption in italics below: `*Description of the image.*` +- Use SVG for diagrams when possible +- Store in `./images/` relative to the document + +## FAQ Sections + +Use a TOC with jump links, `###` headers for questions, and direct answers: + +```md +## Questions + +- [Do I always need architecture?](#do-i-always-need-architecture) +- [Can I change my plan later?](#can-i-change-my-plan-later) + +### Do I always need architecture? + +Only for BMad Method and Enterprise tracks. Quick Flow skips to implementation. + +### Can I change my plan later? + +Yes. The SM agent has a `correct-course` workflow for handling scope changes. + +**Have a question not answered here?** Please [open an issue](...) or ask in [Discord](...) so we can add it! +``` + +### FAQ Guidelines + +- **TOC at top** — Jump links under `## Questions` for quick navigation +- **`###` headers** — Questions are scannable and linkable (no `Q:` prefix) +- **Direct answers** — No `**A:**` prefix, just the answer +- **No "Related Documentation"** — Sidebar handles navigation; avoid repetitive links +- **End with CTA** — "Have a question not answered here?" with issue/Discord links + +## Folder Structure Blocks + +Show project structure in "What You've Accomplished": + +````md +Your project now has: + +``` +your-project/ +├── _bmad/ # BMad configuration +├── _bmad-output/ +│ ├── PRD.md # Your requirements document +│ └── bmm-workflow-status.yaml # Progress tracking +└── ... +``` +```` + +## Example: Before and After + +### Before (Noisy) + +```md +--- + +## Getting Started + +### Step 1: Initialize + +#### What happens during init? + +**Important:** You need to describe your project. + +1. Your project goals + - What you want to build + - Why you're building it +2. The complexity + - Small, medium, or large + +--- +``` + +### After (Clean) + +```md +## Step 1: Initialize Your Project + +Load the **Analyst agent** in your IDE, wait for the menu, then run `workflow-init`. + +:::note[What Happens] +You'll describe your project goals and complexity. The workflow then recommends a planning track. +::: +``` + +## Checklist + +Before submitting a tutorial: + +- [ ] Follows the standard structure +- [ ] Has version/module notice if applicable +- [ ] Has "What You'll Learn" section +- [ ] Has Prerequisites admonition +- [ ] Has Quick Path TL;DR admonition +- [ ] No horizontal rules (`---`) +- [ ] No `####` headers +- [ ] Admonitions used for callouts (not bold paragraphs) +- [ ] Tables used for structured data (phases, commands, agents) +- [ ] Lists are flat (no deep nesting) +- [ ] Has "What You've Accomplished" section +- [ ] Has Quick Reference table +- [ ] Has Common Questions section +- [ ] Has Getting Help section +- [ ] Has Key Takeaways admonition +- [ ] All links use descriptive text +- [ ] Images have alt text and captions diff --git a/docs/_archive/customize-workflows.md b/docs/_archive/customize-workflows.md new file mode 100644 index 00000000..3a80e471 --- /dev/null +++ b/docs/_archive/customize-workflows.md @@ -0,0 +1,30 @@ +--- +title: "Workflow Customization Guide" +--- + +Customize and optimize workflows with step replacement and hooks. + +## Status + +:::note[Coming Soon] +Workflow customization is an upcoming capability. This guide will be updated when the feature is available. +::: + +## What to Expect + +Workflow customization will allow you to: + +- **Replace Steps** - Swap out specific workflow steps with custom implementations +- **Add Hooks** - Inject custom behavior before/after workflow steps +- **Extend Workflows** - Create new workflows based on existing ones +- **Override Behavior** - Customize workflow logic for your project's needs + +## For Now + +While workflow customization is in development, you can: + +- **Create Custom Workflows** - Use the BMad Builder to create entirely new workflows +- **Customize Agents** - Modify agent behavior using [Agent Customization](/docs/how-to/customization/customize-agents.md) +- **Provide Feedback** - Share your workflow customization needs with the community + +**In the meantime:** Learn how to [create custom workflows](/docs/explanation/bmad-builder/index.md) from scratch. diff --git a/docs/_archive/getting-started-bmadv4.md b/docs/_archive/getting-started-bmadv4.md new file mode 100644 index 00000000..53ca1c6c --- /dev/null +++ b/docs/_archive/getting-started-bmadv4.md @@ -0,0 +1,247 @@ +--- +title: "Getting Started with BMad v4" +description: Install BMad and create your first planning document +--- + + +Build software faster using AI-powered workflows with specialized agents that guide you through planning, architecture, and implementation. + +:::note[Stable Release] +This tutorial covers BMad v4, the current stable release. For the latest features (with potential breaking changes), see the [BMad v6 Alpha tutorial](./getting-started-bmadv6.md). +::: + +## What You'll Learn + +- Install and configure BMad for your IDE +- Understand how BMad organizes work into phases and agents +- Initialize a project and choose a planning track +- Create your first requirements document + +:::note[Prerequisites] +- **Node.js 20+** — Required for the installer +- **Git** — Recommended for version control +- **AI-powered IDE** — Claude Code, Cursor, Windsurf, or similar +- **A project idea** — Even a simple one works for learning +::: + +:::tip[Quick Path] +**Install** → `npx bmad-method install` +**Initialize** → Load Analyst agent, run `workflow-init` +**Plan** → PM creates PRD, Architect creates architecture +**Build** → SM manages sprints, DEV implements stories +**Always use fresh chats** for each workflow to avoid context issues. +::: + +## Understanding BMad + +BMad helps you build software through guided workflows with specialized AI agents. The process follows four phases: + +| Phase | Name | What Happens | +|-------|------|--------------| +| 1 | Analysis | Brainstorm, research *(optional)* | +| 2 | Planning | Requirements — PRD or tech-spec *(required)* | +| 3 | Solutioning | Architecture, design decisions *(varies by track)* | +| 4 | Implementation | Build code story by story *(required)* | + +Based on your project's complexity, BMad offers three planning tracks: + +| Track | Best For | Documents Created | +|-------|----------|-------------------| +| **Quick Flow** | Bug fixes, simple features, clear scope | Tech-spec only | +| **BMad Method** | Products, platforms, complex features | PRD + Architecture + UX | +| **Enterprise** | Compliance, multi-tenant, enterprise needs | PRD + Architecture + Security + DevOps | + +## Installation + +Open a terminal in your project directory and run: + +```bash +npx bmad-method install +``` + +The interactive installer guides you through setup: + +- **Choose Installation Location** — Select current directory (recommended), subdirectory, or custom path +- **Select Your AI Tool** — Claude Code, Cursor, Windsurf, or other +- **Choose Modules** — Select **BMM** (BMad Method) for this tutorial +- **Accept Defaults** — Customize later in `_bmad/[module]/config.yaml` + +Verify your installation: + +``` +your-project/ +├── _bmad/ +│ ├── bmm/ # Method module +│ │ ├── agents/ # Agent files +│ │ ├── workflows/ # Workflow files +│ │ └── config.yaml # Module config +│ └── core/ # Core utilities +├── _bmad-output/ # Generated artifacts (created later) +└── .claude/ # IDE configuration (if using Claude Code) +``` + +:::tip[Troubleshooting] +Having issues? See [Install BMad](../../how-to/installation/install-bmad.md) for common solutions. +::: + +## Step 1: Initialize Your Project + +Load the **Analyst agent** in your IDE: +- **Claude Code**: Type `/analyst` or load the agent file directly +- **Cursor/Windsurf**: Open the agent file from `_bmad/bmm/agents/` + +Wait for the agent's menu to appear, then run: + +``` +Run workflow-init +``` + +Or use the shorthand: `*workflow-init` + +The workflow asks you to describe: +- **Your project and goals** — What are you building? What problem does it solve? +- **Existing codebase** — Is this new (greenfield) or existing code (brownfield)? +- **Size and complexity** — Roughly how big is this? (adjustable later) + +Based on your description, the workflow suggests a planning track. For this tutorial, choose **BMad Method**. + +Once you confirm, the workflow creates `bmm-workflow-status.yaml` to track your progress. + +:::caution[Fresh Chats] +Always start a fresh chat for each workflow. This prevents context limitations from causing issues. +::: + +## Step 2: Create Your Plan + +With your project initialized, work through the planning phases. + +### Phase 1: Analysis (Optional) + +If you want to brainstorm or research first: +- **brainstorm-project** — Guided ideation with the Analyst +- **research** — Market and technical research +- **product-brief** — Recommended foundation document + +### Phase 2: Planning (Required) + +**Start a fresh chat** and load the **PM agent**. + +``` +Run prd +``` + +Or use shortcuts: `*prd`, select "create-prd" from the menu, or say "Let's create a PRD". + +The PM agent guides you through: +1. **Project overview** — Refine your project description +2. **Goals and success metrics** — What does success look like? +3. **User personas** — Who uses this product? +4. **Functional requirements** — What must the system do? +5. **Non-functional requirements** — Performance, security, scalability needs + +When complete, you'll have `PRD.md` in your `_bmad-output/` folder. + +:::note[UX Design (Optional)] +If your project has a user interface, load the **UX-Designer agent** and run the UX design workflow after creating your PRD. +::: + +### Phase 3: Solutioning (Required for BMad Method) + +**Start a fresh chat** and load the **Architect agent**. + +``` +Run create-architecture +``` + +The architect guides you through technical decisions: tech stack, database design, API patterns, and system structure. + +:::tip[Check Your Status] +Unsure what's next? Load any agent and run `workflow-status`. It tells you the next recommended or required workflow. +::: + +## Step 3: Build Your Project + +Once planning is complete, move to implementation. + +### Initialize Sprint Planning + +Load the **SM agent** and run `sprint-planning`. This creates `sprint-status.yaml` to track all epics and stories. + +### The Build Cycle + +For each story, repeat this cycle with fresh chats: + +| Step | Agent | Workflow | Purpose | +|------|-------|----------|---------| +| 1 | SM | `create-story` | Create story file from epic | +| 2 | DEV | `dev-story` | Implement the story | +| 3 | DEV | `code-review` | Quality validation *(recommended)* | + +After completing all stories in an epic, load the **SM agent** and run `retrospective`. + +## What You've Accomplished + +You've learned the foundation of building with BMad: + +- Installed BMad and configured it for your IDE +- Initialized a project with your chosen planning track +- Created planning documents (PRD, Architecture) +- Understood the build cycle for implementation + +Your project now has: + +``` +your-project/ +├── _bmad/ # BMad configuration +├── _bmad-output/ +│ ├── PRD.md # Your requirements document +│ ├── architecture.md # Technical decisions +│ └── bmm-workflow-status.yaml # Progress tracking +└── ... +``` + +## Quick Reference + +| Command | Agent | Purpose | +|---------|-------|---------| +| `*workflow-init` | Analyst | Initialize a new project | +| `*workflow-status` | Any | Check progress and next steps | +| `*prd` | PM | Create Product Requirements Document | +| `*create-architecture` | Architect | Create architecture document | +| `*sprint-planning` | SM | Initialize sprint tracking | +| `*create-story` | SM | Create a story file | +| `*dev-story` | DEV | Implement a story | +| `*code-review` | DEV | Review implemented code | + +## Common Questions + +**Do I need to create a PRD for every project?** +Only for BMad Method and Enterprise tracks. Quick Flow projects use a simpler tech-spec instead. + +**Can I skip Phase 1 (Analysis)?** +Yes, Phase 1 is optional. If you already know what you're building, start with Phase 2 (Planning). + +**What if I want to brainstorm first?** +Load the Analyst agent and run `*brainstorm-project` before `workflow-init`. + +**Why start fresh chats for each workflow?** +Workflows are context-intensive. Reusing chats can cause the AI to hallucinate or lose track of details. Fresh chats ensure maximum context capacity. + +## Getting Help + +- **During workflows** — Agents guide you with questions and explanations +- **Check status** — Run `workflow-status` with any agent +- **Community** — [Discord](https://discord.gg/gk8jAdXWmj) (#bmad-method-help, #report-bugs-and-issues) +- **Video tutorials** — [BMad Code YouTube](https://www.youtube.com/@BMadCode) + +## Key Takeaways + +:::tip[Remember These] +- **Always use fresh chats** — Load agents in new chats for each workflow +- **Let workflow-status guide you** — Ask any agent for status when unsure +- **Track matters** — Quick Flow uses tech-spec; Method/Enterprise need PRD and architecture +- **Tracking is automatic** — Status files update themselves +- **Agents are flexible** — Use menu numbers, shortcuts (`*prd`), or natural language +::: + +Ready to start? Install BMad, load the Analyst, run `workflow-init`, and let the agents guide you. diff --git a/docs/_archive/vendor-workflows.md b/docs/_archive/vendor-workflows.md new file mode 100644 index 00000000..4ad4f840 --- /dev/null +++ b/docs/_archive/vendor-workflows.md @@ -0,0 +1,52 @@ +--- +title: "Workflow Vendoring, Customization, and Inheritance" +--- + +Use workflow vendoring and inheritance to share or reutilize workflows across modules. + +## Workflow Vendoring + +Workflow Vendoring allows an agent to have access to a workflow from another module, without having to install said module. At install time, the module workflow being vendored will be cloned and installed into the module that is receiving the vendored workflow the agent needs. + +### How to Vendor + +Lets assume you are building a module, and you do not want to recreate a workflow from the BMad Method, such as workflows/4-implementation/dev-story/workflow.md. Instead of copying all the context to your module, and having to maintain it over time as updates are made, you can instead use the exec-vendor menu item in your agent. + +From your modules agent definition, you would implement the menu item as follows in the agent: + +```yaml + - trigger: develop-story + exec-vendor: "{project-root}/_bmad//workflows/4-production/dev-story/workflow.md" + exec: "{project-root}/_bmad//workflows/dev-story/workflow.md" + description: "Execute Dev Story workflow, implementing tasks and tests, or performing updates to the story" +``` + +At install time, it will clone the workflow and all of its required assets, and the agent that gets built will have an exec to a path installed in its own module. The content gets added to the folder you specify in exec. While it does not have to exactly match the source path, you will want to ensure you are specifying the workflow.md to be in a new location (in other words in this example, dev-story would not already be the path of another custom module workflow that already exists.) + +## Workflow Inheritance + +:::note[Coming Soon] +Official support for workflow inheritance is coming post beta. +::: + +Workflow Inheritance is a different concept, that allows you to modify or extend existing workflow. + +Party Mode from the core is an example of a workflow that is designed with inheritance in mind - customization for specific party needs. While party mode itself is generic - there might be specific agent collaborations you want to create. Without having to reinvent the whole party mode concept, or copy and paste all of its content - you could inherit from party mode to extend it to be specific. + +Some possible examples could be: + +- Retrospective +- Sprint Planning +- Collaborative Brainstorming Sessions + +## Workflow Customization + +:::note[Coming Soon] +Official support for workflow customization is coming post beta. +::: + +Similar to Workflow Inheritance, Workflow Customization will soon be allowed for certain workflows that are meant to be user customized - similar in process to how agents are customized now. + +This will take the shape of workflows with optional hooks, configurable inputs, and the ability to replace whole at install time. + +For example, assume you are using the Create PRD workflow, which is comprised of 11 steps, and you want to always include specifics about your companies domain, technical landscape or something else. While project-context can be helpful with that, you can also through hooks and step overrides, have full replace steps, the key requirement being to ensure your step replace file is an exact file name match of an existing step, follows all conventions, and ends in a similar fashion to either hook back in to call the next existing step, or more custom steps that eventually hook back into the flow. diff --git a/docs/custom-content-installation.md b/docs/custom-content-installation.md deleted file mode 100644 index 6658233e..00000000 --- a/docs/custom-content-installation.md +++ /dev/null @@ -1,149 +0,0 @@ -# Custom Content Installation - -This guide explains how to create and install custom BMAD content including agents, workflows, and modules. Custom content extends BMAD's functionality with specialized tools and workflows that can be shared across projects or teams. - -For detailed information about the different types of custom content available, see [Custom Content](./custom-content.md). - -You can find example custom modules in the `samples/sample-custom-modules/` folder of the repository. Download either of the sample folders to try them out. - -## Content Types Overview - -BMAD Core supports several categories of custom content: - -- Custom Stand Alone Modules -- Custom Add On Modules -- Custom Global Modules -- Custom Agents -- Custom Workflows - -## Making Custom Content Installable - -### Custom Modules - -To create an installable custom module: - -1. **Folder Structure** - - Create a folder with a short, abbreviated name (e.g., `cis` for Creative Intelligence Suite) - - The folder name serves as the module code - -2. **Required Files** - - Include a `module.yaml` file in the root folder - - This file drives the installation process when used by the BMAD installer - - Reference existing modules or the BMad Builder for configuration examples - -3. **Folder Organization** - Follow these conventions for optimal compatibility: - - ``` - module-code/ - module.yaml - agents/ - workflows/ - tools/ - templates/ - ... - ``` - - - `agents/` - Agent definitions - - `workflows/` - Workflow definitions - - Additional custom folders are supported but following conventions is recommended for agent and workflow discovery - -**Note:** Full documentation for global modules and add-on modules will be available as support is finalized. - -### Standalone Content (Agents, Workflows, Tasks, Tools, Templates, Prompts) - -For standalone content that isn't part of a cohesive module collection, follow this structure: - -1. **Module Configuration** - - Create a folder with a `module.yaml` file (similar to custom modules) - - Add the property `unitary: true` to the module.yaml - - The `unitary: true` property indicates this is a collection of potentially unrelated items that don't depend on each other - -2. **Folder Structure** - Organize content in specific named folders: - - ``` - module-name/ - module.yaml # Contains unitary: true - agents/ - workflows/ - templates/ - tools/ - tasks/ - prompts/ - ``` - -3. **Individual Item Organization** - Each item should have its own subfolder: - ```text - my-custom-stuff/ - module.yaml - agents/ - larry/larry.agent.md - curly/curly.agent.md - moe/moe.agent.md - moe/moe-sidecar/memories.csv - ``` - -**Future Feature:** Unitary modules will support selective installation, allowing users to pick and choose which specific items to install. - -**Note:** Documentation explaining the distinctions between these content types and their specific use cases will be available soon. - -## Installation Process - -### Prerequisites - -Ensure your content follows the proper conventions and includes a `module.yaml` file (only one per top-level folder). - -### New Project Installation - -When setting up a new BMAD project: - -1. The installer will prompt: `Would you like to install a local custom module (this includes custom agents and workflows also)? (y/N)` -2. Select 'y' to specify the path to your module folder containing `module.yaml` - -### Existing Project Modification - -To add custom content to an existing BMAD project: - -1. Run the installer against your project location -2. Select `Modify BMAD Installation` -3. Choose the option to add, modify, or update custom modules - -### Upcoming Features - -- **Unitary Module Selection:** For modules with `type: unitary` (instead of `type: module`), you'll be able to select specific items to install -- **Add-on Module Dependencies:** The installer will verify and install dependencies for add-on modules automatically - -## Quick Updates - -When updates to BMAD Core or core modules (BMM, CIS, etc.) become available, the quick update process will: - -1. Apply available updates to core modules -2. Recompile all agents with customizations from the `_config/agents` folder -3. Retain your custom content from a cached location -4. Preserve your existing configurations and customizations - -This means you don't need to keep the source module files locally. When updates are available, simply point to the updated module location during the update process. - -## Important Considerations - -### Module Naming Conflicts - -When installing unofficial modules, ensure unique identification to avoid conflicts: - -1. **Module Codes:** Each module must have a unique code (e.g., don't use `bmm` for custom modules) -2. **Module Names:** Avoid using names that conflict with existing modules -3. **Multiple Custom Modules:** If creating multiple custom modules, use distinct codes for each - -**Examples of conflicts to avoid:** - -- Don't create a custom module with code `bmm` (already used by BMad Method) -- Don't name multiple custom modules with the same code like `mca` - -### Best Practices - -- Use descriptive, unique codes for your modules -- Document any dependencies your custom modules have -- Test custom modules in isolation before sharing -- Consider version numbering for your custom content to track updates diff --git a/docs/document-sharding-guide.md b/docs/document-sharding-guide.md deleted file mode 100644 index a0399375..00000000 --- a/docs/document-sharding-guide.md +++ /dev/null @@ -1,449 +0,0 @@ -# Document Sharding Guide - -Comprehensive guide to BMad Method's document sharding system for managing large planning and architecture documents. - -## Table of Contents - -- [What is Document Sharding?](#what-is-document-sharding) -- [When to Use Sharding](#when-to-use-sharding) -- [How Sharding Works](#how-sharding-works) -- [Using the Shard-Doc Tool](#using-the-shard-doc-tool) -- [Workflow Support](#workflow-support) -- [Best Practices](#best-practices) -- [Examples](#examples) - -## What is Document Sharding? - -Document sharding splits large markdown files into smaller, organized files based on level 2 headings (`## Heading`). This enables: - -- **Selective Loading** - Workflows load only the sections they need -- **Reduced Token Usage** - Massive efficiency gains for large projects -- **Better Organization** - Logical section-based file structure -- **Maintained Context** - Index file preserves document structure - -### Architecture - -``` -Before Sharding: -docs/ -└── PRD.md (large 50k token file) - -After Sharding: -docs/ -└── prd/ - ├── index.md # Table of contents with descriptions - ├── overview.md # Section 1 - ├── user-requirements.md # Section 2 - ├── technical-requirements.md # Section 3 - └── ... # Additional sections -``` - -## When to Use Sharding - -### Ideal Candidates - -**Large Multi-Epic Projects:** - -- Very large complex PRDs -- Architecture documents with multiple system layers -- Epic files with 4+ epics (especially for Phase 4) -- UX design specs covering multiple subsystems - -**Token Thresholds:** - -- **Consider sharding**: Documents > 20k tokens -- **Strongly recommended**: Documents > 40k tokens -- **Critical for efficiency**: Documents > 60k tokens - -### When NOT to Shard - -**Small Projects:** - -- Single epic projects -- Level 0-1 projects (tech-spec only) -- Documents under 10k tokens -- Quick prototypes - -**Frequently Updated Docs:** - -- Active work-in-progress documents -- Documents updated daily -- Documents where whole-file context is essential - -## How Sharding Works - -### Sharding Process - -1. **Tool Execution**: Run `npx @kayvan/markdown-tree-parser source.md destination/` - this is abstracted with the core shard-doc task which is installed as a slash command or manual task rule depending on your tools. -2. **Section Extraction**: Tool splits by level 2 headings -3. **File Creation**: Each section becomes a separate file -4. **Index Generation**: `index.md` created with structure and descriptions - -### Workflow Discovery - -BMad workflows use a **dual discovery system**: - -1. **Try whole document first** - Look for `document-name.md` -2. **Check for sharded version** - Look for `document-name/index.md` -3. **Priority rule** - Whole document takes precedence if both exist - -### Loading Strategies - -**Full Load (Phase 1-3 workflows):** - -``` -If sharded: - - Read index.md - - Read ALL section files - - Treat as single combined document -``` - -**Selective Load (Phase 4 workflows):** - -``` -If sharded epics and working on Epic 3: - - Read epics/index.md - - Load ONLY epics/epic-3.md - - Skip all other epic files - - 90%+ token savings! -``` - -## Using the Shard-Doc Tool - -### CLI Command - -```bash -# Activate bmad-master or analyst agent, then: -/shard-doc -``` - -### Interactive Process - -``` -Agent: Which document would you like to shard? -User: docs/PRD.md - -Agent: Default destination: docs/prd/ - Accept default? [y/n] -User: y - -Agent: Sharding PRD.md... - ✓ Created 12 section files - ✓ Generated index.md - ✓ Complete! -``` - -### What Gets Created - -**index.md structure:** - -```markdown -# PRD - Index - -## Sections - -1. [Overview](./overview.md) - Project vision and objectives -2. [User Requirements](./user-requirements.md) - Feature specifications -3. [Epic 1: Authentication](./epic-1-authentication.md) - User auth system -4. [Epic 2: Dashboard](./epic-2-dashboard.md) - Main dashboard UI - ... -``` - -**Individual section files:** - -- Named from heading text (kebab-case) -- Contains complete section content -- Preserves all markdown formatting -- Can be read independently - -## Workflow Support - -### Universal Support - -**All BMM workflows support both formats:** - -- ✅ Whole documents -- ✅ Sharded documents -- ✅ Automatic detection -- ✅ Transparent to user - -### Workflow-Specific Patterns - -#### Phase 1-3 (Full Load) - -Workflows load entire sharded documents: - -- `product-brief` - Research, brainstorming docs -- `prd` - Product brief, research -- `gdd` - Game brief, research -- `create-ux-design` - PRD, brief, architecture (if available) -- `tech-spec` - Brief, research -- `architecture` - PRD, UX design (if available) -- `create-epics-and-stories` - PRD, architecture -- `implementation-readiness` - All planning docs - -#### Phase 4 (Selective Load) - -Workflows load only needed sections: - -**sprint-planning** (Full Load): - -- Needs ALL epics to build complete status - -**create-story, code-review** (Selective): - -``` -Working on Epic 3, Story 2: - ✓ Load epics/epic-3.md only - ✗ Skip epics/epic-1.md, epic-2.md, epic-4.md, etc. - -Result: 90%+ token reduction for 10-epic projects! -``` - -### Input File Patterns - -Workflows use standardized patterns: - -```yaml -input_file_patterns: - prd: - whole: '{output_folder}/*prd*.md' - sharded: '{output_folder}/*prd*/index.md' - - epics: - whole: '{output_folder}/*epic*.md' - sharded_index: '{output_folder}/*epic*/index.md' - sharded_single: '{output_folder}/*epic*/epic-{{epic_num}}.md' -``` - -## Best Practices - -### Sharding Strategy - -**Do:** - -- ✅ Shard after planning phase complete -- ✅ Keep level 2 headings well-organized -- ✅ Use descriptive section names -- ✅ Shard before Phase 4 implementation -- ✅ Keep original file as backup initially - -**Don't:** - -- ❌ Shard work-in-progress documents -- ❌ Shard small documents (<20k tokens) -- ❌ Mix sharded and whole versions -- ❌ Manually edit index.md structure - -### Naming Conventions - -**Good Section Names:** - -```markdown -## Epic 1: User Authentication - -## Technical Requirements - -## System Architecture - -## UX Design Principles -``` - -**Poor Section Names:** - -```markdown -## Section 1 - -## Part A - -## Details - -## More Info -``` - -### File Management - -**When to Re-shard:** - -- Significant structural changes to document -- Adding/removing major sections -- After major refactoring - -**Updating Sharded Docs:** - -1. Edit individual section files directly -2. OR edit original, delete sharded folder, re-shard -3. Don't manually edit index.md - -## Examples - -### Example 1: Large PRD - -**Scenario:** 15-epic project, PRD is 45k tokens - -**Before Sharding:** - -``` -Every workflow loads entire 45k token PRD -Architecture workflow: 45k tokens -UX design workflow: 45k tokens -``` - -**After Sharding:** - -```bash -/shard-doc -Source: docs/PRD.md -Destination: docs/prd/ - -Created: - prd/index.md - prd/overview.md (3k tokens) - prd/functional-requirements.md (8k tokens) - prd/non-functional-requirements.md (6k tokens) - prd/user-personas.md (4k tokens) - ...additional FR/NFR sections -``` - -**Result:** - -``` -Architecture workflow: Can load specific sections needed -UX design workflow: Can load specific sections needed -Significant token reduction for large requirement docs! -``` - -### Example 2: Sharding Epics File - -**Scenario:** 8 epics with detailed stories, 35k tokens total - -```bash -/shard-doc -Source: docs/bmm-epics.md -Destination: docs/epics/ - -Created: - epics/index.md - epics/epic-1.md - epics/epic-2.md - ... - epics/epic-8.md -``` - -**Efficiency Gain:** - -``` -Working on Epic 5 stories: - Old: Load all 8 epics (35k tokens) - New: Load epic-5.md only (4k tokens) - Savings: 88% reduction -``` - -### Example 3: Architecture Document - -**Scenario:** Multi-layer system architecture, 28k tokens - -```bash -/shard-doc -Source: docs/architecture.md -Destination: docs/architecture/ - -Created: - architecture/index.md - architecture/system-overview.md - architecture/frontend-architecture.md - architecture/backend-services.md - architecture/data-layer.md - architecture/infrastructure.md - architecture/security-architecture.md -``` - -**Benefit:** Code-review workflow can reference specific architectural layers without loading entire architecture doc. - -## Custom Workflow Integration - -### For Workflow Builders - -When creating custom workflows that load large documents: - -**1. Add input_file_patterns to workflow.yaml:** - -```yaml -input_file_patterns: - your_document: - whole: '{output_folder}/*your-doc*.md' - sharded: '{output_folder}/*your-doc*/index.md' -``` - -**2. Add discovery instructions to instructions.md:** - -```markdown -## Document Discovery - -1. Search for whole document: _your-doc_.md -2. Check for sharded version: _your-doc_/index.md -3. If sharded: Read index + ALL sections (or specific sections if selective load) -4. Priority: Whole document first -``` - -**3. Choose loading strategy:** - -- **Full Load**: Read all sections when sharded -- **Selective Load**: Read only relevant sections (requires section identification logic) - -### Pattern Templates - -**Full Load Pattern:** - -```xml -Search for document: {output_folder}/*doc-name*.md -If not found, check for sharded: {output_folder}/*doc-name*/index.md -Read index.md to understand structure -Read ALL section files listed in index -Combine content as single document -``` - -**Selective Load Pattern (with section ID):** - -```xml -Determine section needed (e.g., epic_num = 3) -Check for sharded version: {output_folder}/*doc-name*/index.md -Read ONLY the specific section file needed -Skip all other section files -``` - -## Troubleshooting - -### Common Issues - -**Both whole and sharded exist:** - -- Workflows will use whole document (priority rule) -- Delete or archive the one you don't want - -**Index.md out of sync:** - -- Delete sharded folder -- Re-run shard-doc on original - -**Workflow can't find document:** - -- Check file naming matches patterns (`*prd*.md`, `*epic*.md`, etc.) -- Verify index.md exists in sharded folder -- Check output_folder path in config - -**Sections too granular:** - -- Combine sections in original document -- Use fewer level 2 headings -- Re-shard - -## Related Documentation - -- [shard-doc Tool](../src/core/tools/shard-doc.xml) - Tool implementation -- [BMM Workflows Guide](./modules/bmm/index.md#-workflow-guides) - Workflow overview -- [Workflow Creation Guide](./modules/bmb/workflows/index) - Custom workflow patterns - ---- - -**Document sharding is optional but powerful** - use it when efficiency matters for large projects! diff --git a/website/src/pages/downloads.md b/docs/downloads.md similarity index 55% rename from website/src/pages/downloads.md rename to docs/downloads.md index cef3a41b..0db386cf 100644 --- a/website/src/pages/downloads.md +++ b/docs/downloads.md @@ -1,47 +1,44 @@ -# Downloads +--- +title: Downloads +--- -Download BMAD Method resources for offline use, AI training, or integration. +Download BMad Method resources for offline use, AI training, or integration. + +## Source Bundles + +| File | Description | +|------|-------------| +| **[bmad-sources.zip](/downloads/bmad-sources.zip)** | Complete BMad source files | +| **[bmad-prompts.zip](/downloads/bmad-prompts.zip)** | Agent and workflow prompts only | ## LLM-Optimized Files These files are designed for AI consumption - perfect for loading into Claude, ChatGPT, or any LLM context window. -| File | Description | Use Case | -| ----------------------------------- | ----------------------------------- | -------------------------- | -| **[llms.txt](/llms.txt)** | Documentation index with summaries | Quick overview, navigation | -| **[llms-full.txt](/llms-full.txt)** | Complete documentation concatenated | Full context loading | +| File | Description | Use Case | +|------|-------------|----------| +| **[llms.txt](/llms.txt)** | Documentation index with summaries | Quick overview, navigation | +| **[llms-full.txt](/llms-full.txt)** | Complete documentation concatenated | Full context loading | ### Using with LLMs **Claude Projects:** - ``` Upload llms-full.txt as project knowledge ``` **ChatGPT:** - ``` Paste llms.txt for navigation, or sections from llms-full.txt as needed ``` **API Usage:** - ```python import requests docs = requests.get("https://bmad-code-org.github.io/BMAD-METHOD/llms-full.txt").text # Include in your system prompt or context ``` -## Source Bundles - -Download the complete source code for offline development or contribution. - -| Bundle | Contents | -| --------------------------------------------------- | ------------------------------------------- | -| **[bmad-sources.zip](/downloads/bmad-sources.zip)** | Complete `/src/` directory with all modules | -| **[bmad-prompts.zip](/downloads/bmad-prompts.zip)** | Agent prompts and workflows from `/_bmad/` | - ## Installation Options ### NPM (Recommended) @@ -50,12 +47,6 @@ Download the complete source code for offline development or contribution. npx bmad-method@alpha install ``` -### Manual Installation - -1. Download `bmad-prompts.zip` -2. Extract to your project root -3. Configure your IDE per the [IDE Guides](/docs/ide-info/) - ## Version Information - **Current Version:** See [CHANGELOG](https://github.com/bmad-code-org/BMAD-METHOD/blob/main/CHANGELOG.md) @@ -63,7 +54,7 @@ npx bmad-method@alpha install ## API Access -For programmatic access to BMAD documentation: +For programmatic access to BMad documentation: ```bash # Get documentation index @@ -75,7 +66,7 @@ curl https://bmad-code-org.github.io/BMAD-METHOD/llms-full.txt ## Contributing -Want to improve BMAD Method? Check out: +Want to improve BMad Method? Check out: - [Contributing Guide](https://github.com/bmad-code-org/BMAD-METHOD/blob/main/CONTRIBUTING.md) - [GitHub Repository](https://github.com/bmad-code-org/BMAD-METHOD) diff --git a/src/modules/bmm/docs/quick-flow-solo-dev.md b/docs/explanation/agents/barry-quick-flow.md similarity index 78% rename from src/modules/bmm/docs/quick-flow-solo-dev.md rename to docs/explanation/agents/barry-quick-flow.md index 8ca538d0..62d454ff 100644 --- a/src/modules/bmm/docs/quick-flow-solo-dev.md +++ b/docs/explanation/agents/barry-quick-flow.md @@ -1,21 +1,25 @@ -# Quick Flow Solo Dev Agent (Barry) - -**Agent ID:** `_bmad/bmm/agents/quick-flow-solo-dev.md` -**Icon:** 🚀 -**Module:** BMM - --- +title: "Quick Flow Solo Dev Agent (Barry)" +--- + +Barry is the elite solo developer who takes projects from concept to deployment with ruthless efficiency — no handoffs, no delays, just pure focused development. + +:::note[Agent Info] +- **Agent ID:** `_bmad/bmm/agents/quick-flow-solo-dev.md` +- **Icon:** 🚀 +- **Module:** BMM +::: ## Overview -Barry is the elite solo developer who lives and breathes the BMAD Quick Flow workflow. He takes projects from concept to deployment with ruthless efficiency - no handoffs, no delays, just pure focused development. Barry architects specs, writes the code, and ships features faster than entire teams. When you need it done right and done now, Barry's your dev. +Barry is the elite solo developer who lives and breathes the BMad Quick Flow workflow. He takes projects from concept to deployment with ruthless efficiency - no handoffs, no delays, just pure focused development. Barry architects specs, writes the code, and ships features faster than entire teams. When you need it done right and done now, Barry's your dev. ### Agent Persona **Name:** Barry **Title:** Quick Flow Solo Dev -**Identity:** Barry is an elite developer who thrives on autonomous execution. He lives and breathes the BMAD Quick Flow workflow, taking projects from concept to deployment with ruthless efficiency. No handoffs, no delays - just pure, focused development. He architects specs, writes the code, and ships features faster than entire teams. +**Identity:** Barry is an elite developer who thrives on autonomous execution. He lives and breathes the BMad Quick Flow workflow, taking projects from concept to deployment with ruthless efficiency. No handoffs, no delays - just pure, focused development. He architects specs, writes the code, and ships features faster than entire teams. **Communication Style:** Direct, confident, and implementation-focused. Uses tech slang and gets straight to the point. No fluff, just results. Every response moves the project forward. @@ -28,15 +32,13 @@ Barry is the elite solo developer who lives and breathes the BMAD Quick Flow wor - Documentation happens alongside development, not after - Ship early, ship often ---- - ## Menu Commands -Barry owns the entire BMAD Quick Flow path, providing a streamlined 3-step development process that eliminates handoffs and maximizes velocity. +Barry owns the entire BMad Quick Flow path, providing a streamlined 3-step development process that eliminates handoffs and maximizes velocity. -### 1. **create-tech-spec** +### 1. **quick-spec** -- **Workflow:** `_bmad/bmm/workflows/bmad-quick-flow/create-tech-spec/workflow.yaml` +- **Workflow:** `_bmad/bmm/workflows/bmad-quick-flow/quick-spec/workflow.md` - **Description:** Architect a technical spec with implementation-ready stories - **Use when:** You need to transform requirements into a buildable spec @@ -58,8 +60,6 @@ Barry owns the entire BMAD Quick Flow path, providing a streamlined 3-step devel - **Description:** Bring in other experts when I need specialized backup - **Use when:** You need collaborative problem-solving or specialized expertise ---- - ## When to Use Barry ### Ideal Scenarios @@ -78,15 +78,13 @@ Barry owns the entire BMAD Quick Flow path, providing a streamlined 3-step devel - **Proof of Concepts** - Rapid prototyping with production-quality code - **Performance Optimizations** - System improvements and scalability work ---- - -## The BMAD Quick Flow Process +## The BMad Quick Flow Process Barry orchestrates a simple, efficient 3-step process: ```mermaid flowchart LR - A[Requirements] --> B[create-tech-spec] + A[Requirements] --> B[quick-spec] B --> C[Tech Spec] C --> D[quick-dev] D --> E[Implementation] @@ -104,7 +102,7 @@ flowchart LR style H fill:#e0f2f1 ``` -### Step 1: Technical Specification (`create-tech-spec`) +### Step 1: Technical Specification (`quick-spec`) **Goal:** Transform user requirements into implementation-ready technical specifications @@ -177,8 +175,6 @@ flowchart LR - Security considerations - Maintainability and documentation ---- - ## Collaboration with Other Agents ### Natural Partnerships @@ -198,8 +194,6 @@ In party mode, Barry often acts as: - **Performance Optimizer** - Ensuring scalable solutions - **Code Review Authority** - Validating technical approaches ---- - ## Tips for Working with Barry ### For Best Results @@ -225,8 +219,6 @@ In party mode, Barry often acts as: 4. **Over-planning** - I excel at rapid, pragmatic development 5. **Not Using Party Mode** - Missing collaborative insights for complex problems ---- - ## Example Workflow ```bash @@ -234,7 +226,7 @@ In party mode, Barry often acts as: /bmad:bmm:agents:quick-flow-solo-dev # Create a tech spec -> create-tech-spec +> quick-spec # Quick implementation > quick-dev tech-spec-auth.md @@ -303,35 +295,34 @@ Implement OAuth 2.0 authentication with JWT tokens and role-based access control - [ ] Given admin role, when accessing admin endpoint, then allow access ``` ---- +## Common Questions -## Related Documentation +- [When should I use Barry vs other agents?](#when-should-i-use-barry-vs-other-agents) +- [Is the code review step mandatory?](#is-the-code-review-step-mandatory) +- [Can I skip the tech spec step?](#can-i-skip-the-tech-spec-step) +- [How does Barry differ from the Dev agent?](#how-does-barry-differ-from-the-dev-agent) +- [Can Barry handle enterprise-scale projects?](#can-barry-handle-enterprise-scale-projects) -- **[Quick Start Guide](./quick-start.md)** - Getting started with BMM -- **[Agents Guide](./agents-guide.md)** - Complete agent reference -- **[Scale Adaptive System](./scale-adaptive-system.md)** - Understanding development tracks -- **[Workflow Implementation](./workflows-implementation.md)** - Implementation workflows -- **[Party Mode](./party-mode.md)** - Multi-agent collaboration +### When should I use Barry vs other agents? ---- +Use Barry for Quick Flow development (small to medium features), rapid prototyping, or when you need elite solo development. For large, complex projects requiring full team collaboration, consider the full BMad Method with specialized agents. -## Frequently Asked Questions +### Is the code review step mandatory? -**Q: When should I use Barry vs other agents?** -A: Use Barry for Quick Flow development (small to medium features), rapid prototyping, or when you need elite solo development. For large, complex projects requiring full team collaboration, consider the full BMad Method with specialized agents. +No, it's optional but highly recommended for critical features, team projects, or when learning best practices. -**Q: Is the code review step mandatory?** -A: No, it's optional but highly recommended for critical features, team projects, or when learning best practices. +### Can I skip the tech spec step? -**Q: Can I skip the tech spec step?** -A: Yes, the quick-dev workflow accepts direct instructions. However, tech specs are recommended for complex features or team collaboration. +Yes, the quick-dev workflow accepts direct instructions. However, tech specs are recommended for complex features or team collaboration. -**Q: How does Barry differ from the Dev agent?** -A: Barry handles the complete Quick Flow process (spec → dev → review) with elite architectural expertise, while the Dev agent specializes in pure implementation tasks. Barry is your autonomous end-to-end solution. +### How does Barry differ from the Dev agent? -**Q: Can Barry handle enterprise-scale projects?** -A: For enterprise-scale projects requiring full team collaboration, consider using the Enterprise Method track. Barry is optimized for rapid delivery in the Quick Flow track where solo execution wins. +Barry handles the complete Quick Flow process (spec → dev → review) with elite architectural expertise, while the Dev agent specializes in pure implementation tasks. Barry is your autonomous end-to-end solution. ---- +### Can Barry handle enterprise-scale projects? -**Ready to ship some code?** → Start with `/bmad:bmm:agents:quick-flow-solo-dev` +For enterprise-scale projects requiring full team collaboration, consider using the Enterprise Method track. Barry is optimized for rapid delivery in the Quick Flow track where solo execution wins. + +:::tip[Ready to Ship?] +Start with `/bmad:bmm:agents:quick-flow-solo-dev` +::: diff --git a/docs/explanation/agents/index.md b/docs/explanation/agents/index.md new file mode 100644 index 00000000..c5f02426 --- /dev/null +++ b/docs/explanation/agents/index.md @@ -0,0 +1,20 @@ +--- +title: "Understanding Agents" +description: Understanding BMad agents and their roles +--- + +Comprehensive guides to BMad's AI agents — their roles, capabilities, and how to work with them effectively. + +## Agent Guides + +| Agent | Description | +|-------|-------------| +| **[Agent Roles](/docs/explanation/core-concepts/agent-roles.md)** | Overview of all BMM agent roles and responsibilities | +| **[Quick Flow Solo Dev (Barry)](/docs/explanation/agents/barry-quick-flow.md)** | The dedicated agent for rapid development | +| **[Game Development Agents](/docs/explanation/game-dev/agents.md)** | Complete guide to BMGD's specialized game dev agents | + +## Getting Started + +1. Read **[What Are Agents?](/docs/explanation/core-concepts/what-are-agents.md)** for the core concept explanation +2. Review **[Agent Roles](/docs/explanation/core-concepts/agent-roles.md)** to understand available agents +3. Choose an agent that fits your workflow needs diff --git a/docs/explanation/architecture/four-phases.md b/docs/explanation/architecture/four-phases.md new file mode 100644 index 00000000..59c350f0 --- /dev/null +++ b/docs/explanation/architecture/four-phases.md @@ -0,0 +1,107 @@ +--- +title: "The Four Phases of BMad Method" +description: Understanding the four phases of the BMad Method +--- + + +BMad Method uses a four-phase approach that adapts to project complexity while ensuring consistent quality. + +## Phase Overview + +| Phase | Name | Purpose | Required? | +|-------|------|---------|-----------| +| **Phase 1** | Analysis | Exploration and discovery | Optional | +| **Phase 2** | Planning | Requirements definition | Required | +| **Phase 3** | Solutioning | Technical design | Track-dependent | +| **Phase 4** | Implementation | Building the software | Required | + +## Phase 1: Analysis (Optional) + +Exploration and discovery workflows that help validate ideas and understand markets before planning. + +**Workflows:** +- `brainstorm-project` - Solution exploration +- `research` - Market/technical/competitive research +- `product-brief` - Strategic vision capture + +**When to use:** +- Starting new projects +- Exploring opportunities +- Validating market fit + +**When to skip:** +- Clear requirements +- Well-defined features +- Continuing existing work + +## Phase 2: Planning (Required) + +Requirements definition using the scale-adaptive system to match planning depth to project complexity. + +**Workflows:** +- `prd` - Product Requirements Document (BMad Method/Enterprise) +- `tech-spec` - Technical specification (Quick Flow) +- `create-ux-design` - Optional UX specification + +**Key principle:** +Define **what** to build and **why**. Leave **how** to Phase 3. + +## Phase 3: Solutioning (Track-Dependent) + +Technical architecture and design decisions that prevent agent conflicts during implementation. + +**Workflows:** +- `architecture` - System design with ADRs +- `create-epics-and-stories` - Work breakdown (after architecture) +- `implementation-readiness` - Gate check + +**Required for:** +- BMad Method (complex projects) +- Enterprise Method + +**Skip for:** +- Quick Flow (simple changes) + +**Key principle:** +Make technical decisions explicit so all agents implement consistently. + +## Phase 4: Implementation (Required) + +Iterative sprint-based development with story-centric workflow. + +**Workflows:** +- `sprint-planning` - Initialize tracking +- `create-story` - Prepare stories +- `dev-story` - Implement with tests +- `code-review` - Quality assurance +- `retrospective` - Continuous improvement + +:::tip[Key Principle] +One story at a time — complete each story's full lifecycle before starting the next. +::: + +## Phase Flow by Track + +### Quick Flow + +``` +Phase 2 (tech-spec) → Phase 4 (implement) +``` + +Skip Phases 1 and 3 for simple changes. + +### BMad Method + +``` +Phase 1 (optional) → Phase 2 (PRD) → Phase 3 (architecture) → Phase 4 (implement) +``` + +Full methodology for complex projects. + +### Enterprise + +``` +Phase 1 → Phase 2 (PRD) → Phase 3 (architecture + extended) → Phase 4 (implement) +``` + +Same as BMad Method with optional extended workflows. diff --git a/docs/explanation/architecture/preventing-agent-conflicts.md b/docs/explanation/architecture/preventing-agent-conflicts.md new file mode 100644 index 00000000..e8141989 --- /dev/null +++ b/docs/explanation/architecture/preventing-agent-conflicts.md @@ -0,0 +1,111 @@ +--- +title: "Preventing Agent Conflicts" +description: How architecture prevents conflicts when multiple agents implement a system +--- + + +When multiple AI agents implement different parts of a system, they can make conflicting technical decisions. Architecture documentation prevents this by establishing shared standards. + +## Common Conflict Types + +### API Style Conflicts + +Without architecture: +- Agent A uses REST with `/users/{id}` +- Agent B uses GraphQL mutations +- Result: Inconsistent API patterns, confused consumers + +With architecture: +- ADR specifies: "Use GraphQL for all client-server communication" +- All agents follow the same pattern + +### Database Design Conflicts + +Without architecture: +- Agent A uses snake_case column names +- Agent B uses camelCase column names +- Result: Inconsistent schema, confusing queries + +With architecture: +- Standards document specifies naming conventions +- All agents follow the same patterns + +### State Management Conflicts + +Without architecture: +- Agent A uses Redux for global state +- Agent B uses React Context +- Result: Multiple state management approaches, complexity + +With architecture: +- ADR specifies state management approach +- All agents implement consistently + +## How Architecture Prevents Conflicts + +### 1. Explicit Decisions via ADRs + +Every significant technology choice is documented with: +- Context (why this decision matters) +- Options considered (what alternatives exist) +- Decision (what we chose) +- Rationale (why we chose it) +- Consequences (trade-offs accepted) + +### 2. FR/NFR-Specific Guidance + +Architecture maps each functional requirement to technical approach: +- FR-001: User Management → GraphQL mutations +- FR-002: Mobile App → Optimized queries + +### 3. Standards and Conventions + +Explicit documentation of: +- Directory structure +- Naming conventions +- Code organization +- Testing patterns + +## Architecture as Shared Context + +Think of architecture as the shared context that all agents read before implementing: + +``` +PRD: "What to build" + ↓ +Architecture: "How to build it" + ↓ +Agent A reads architecture → implements Epic 1 +Agent B reads architecture → implements Epic 2 +Agent C reads architecture → implements Epic 3 + ↓ +Result: Consistent implementation +``` + +## Key ADR Topics + +Common decisions that prevent conflicts: + +| Topic | Example Decision | +|-------|-----------------| +| API Style | GraphQL vs REST vs gRPC | +| Database | PostgreSQL vs MongoDB | +| Auth | JWT vs Sessions | +| State Management | Redux vs Context vs Zustand | +| Styling | CSS Modules vs Tailwind vs Styled Components | +| Testing | Jest + Playwright vs Vitest + Cypress | + +## Anti-Patterns to Avoid + +:::caution[Common Mistakes] +- **Implicit Decisions** — "We'll figure out the API style as we go" leads to inconsistency +- **Over-Documentation** — Documenting every minor choice causes analysis paralysis +- **Stale Architecture** — Documents written once and never updated cause agents to follow outdated patterns +::: + +:::tip[Correct Approach] +- Document decisions that cross epic boundaries +- Focus on conflict-prone areas +- Update architecture as you learn +- Use `correct-course` for significant changes +::: diff --git a/docs/explanation/architecture/why-solutioning-matters.md b/docs/explanation/architecture/why-solutioning-matters.md new file mode 100644 index 00000000..cb37b7c5 --- /dev/null +++ b/docs/explanation/architecture/why-solutioning-matters.md @@ -0,0 +1,75 @@ +--- +title: "Why Solutioning Matters" +description: Understanding why the solutioning phase is critical for multi-epic projects +--- + + +Phase 3 (Solutioning) translates **what** to build (from Planning) into **how** to build it (technical design). This phase prevents agent conflicts in multi-epic projects by documenting architectural decisions before implementation begins. + +## The Problem Without Solutioning + +``` +Agent 1 implements Epic 1 using REST API +Agent 2 implements Epic 2 using GraphQL +Result: Inconsistent API design, integration nightmare +``` + +When multiple agents implement different parts of a system without shared architectural guidance, they make independent technical decisions that may conflict. + +## The Solution With Solutioning + +``` +architecture workflow decides: "Use GraphQL for all APIs" +All agents follow architecture decisions +Result: Consistent implementation, no conflicts +``` + +By documenting technical decisions explicitly, all agents implement consistently and integration becomes straightforward. + +## Solutioning vs Planning + +| Aspect | Planning (Phase 2) | Solutioning (Phase 3) | +| -------- | ----------------------- | --------------------------------- | +| Question | What and Why? | How? Then What units of work? | +| Output | FRs/NFRs (Requirements) | Architecture + Epics/Stories | +| Agent | PM | Architect → PM | +| Audience | Stakeholders | Developers | +| Document | PRD (FRs/NFRs) | Architecture + Epic Files | +| Level | Business logic | Technical design + Work breakdown | + +## Key Principle + +**Make technical decisions explicit and documented** so all agents implement consistently. + +This prevents: +- API style conflicts (REST vs GraphQL) +- Database design inconsistencies +- State management disagreements +- Naming convention mismatches +- Security approach variations + +## When Solutioning is Required + +| Track | Solutioning Required? | +|-------|----------------------| +| Quick Flow | No - skip entirely | +| BMad Method Simple | Optional | +| BMad Method Complex | Yes | +| Enterprise | Yes | + +:::tip[Rule of Thumb] +If you have multiple epics that could be implemented by different agents, you need solutioning. +::: + +## The Cost of Skipping + +Skipping solutioning on complex projects leads to: + +- **Integration issues** discovered mid-sprint +- **Rework** due to conflicting implementations +- **Longer development time** overall +- **Technical debt** from inconsistent patterns + +:::caution[Cost Multiplier] +Catching alignment issues in solutioning is 10× faster than discovering them during implementation. +::: diff --git a/docs/custom-content.md b/docs/explanation/bmad-builder/custom-content-types.md similarity index 75% rename from docs/custom-content.md rename to docs/explanation/bmad-builder/custom-content-types.md index 69f9e171..408cd411 100644 --- a/docs/custom-content.md +++ b/docs/explanation/bmad-builder/custom-content-types.md @@ -1,8 +1,14 @@ -# Custom Content +--- +title: "Custom Content" +--- -BMAD supports several categories of officially supported custom content that extend the platform's capabilities. Custom content can be created manually or with the recommended assistance of the BMad Builder (BoMB) Module. The BoMB Agent provides workflows and expertise to plan and build any custom content you can imagine. +BMad supports several categories of custom content that extend the platform's capabilities — from simple personal agents to full-featured professional modules. -This flexibility transforms the platform beyond its current capabilities, enabling: +:::tip[Recommended Approach] +Use the BMad Builder (BoMB) Module for guided workflows and expertise when creating custom content. +::: + +This flexibility enables: - Extensions and add-ons for existing modules (BMad Method, Creative Intelligence Suite) - Completely new modules, workflows, templates, and agents outside software engineering @@ -14,30 +20,26 @@ This flexibility transforms the platform beyond its current capabilities, enabli ## Categories -- [Custom Content](#custom-content) - - [Categories](#categories) - - [Custom Stand Alone Modules](#custom-stand-alone-modules) - - [Custom Add On Modules](#custom-add-on-modules) - - [Custom Global Modules](#custom-global-modules) - - [Custom Agents](#custom-agents) - - [BMad Tiny Agents](#bmad-tiny-agents) - - [Simple vs Expert Agents](#simple-vs-expert-agents) - - [Custom Workflows](#custom-workflows) +- [Custom Stand-Alone Modules](#custom-stand-alone-modules) +- [Custom Add-On Modules](#custom-add-on-modules) +- [Custom Global Modules](#custom-global-modules) +- [Custom Agents](#custom-agents) +- [Custom Workflows](#custom-workflows) -## Custom Stand Alone Modules +## Custom Stand-Alone Modules Custom modules range from simple collections of related agents, workflows, and tools designed to work independently, to complex, expansive systems like the BMad Method or even larger applications. -Custom modules are [installable](./custom-content-installation.md) using the standard BMAD method and support advanced features: +Custom modules are [installable](/docs/how-to/installation/install-custom-modules.md) using the standard BMad method and support advanced features: - Optional user information collection during installation/updates - Versioning and upgrade paths - Custom installer functions with IDE-specific post-installation handling (custom hooks, subagents, or vendor-specific tools) - Ability to bundle specific tools such as MCP, skills, execution libraries, and code -## Custom Add On Modules +## Custom Add-On Modules -Custom Add On Modules contain specific agents, tools, or workflows that expand, modify, or customize another module but cannot exist or install independently. These add-ons provide enhanced functionality while leveraging the base module's existing capabilities. +Custom Add-On Modules contain specific agents, tools, or workflows that expand, modify, or customize another module but cannot exist or install independently. These add-ons provide enhanced functionality while leveraging the base module's existing capabilities. Examples include: @@ -45,7 +47,7 @@ Examples include: - Framework-specific support for particular use cases - Game development expansions that add new genre-specific capabilities without reinventing existing functionality -Add on modules can include: +Add-on modules can include: - Custom agents with awareness of the target module - Access to existing module workflows @@ -53,13 +55,13 @@ Add on modules can include: ## Custom Global Modules -Similar to Custom Stand Alone Modules, but designed to add functionality that applies across all installed content. These modules provide cross-cutting capabilities that enhance the entire BMAD ecosystem. +Similar to Custom Stand-Alone Modules, but designed to add functionality that applies across all installed content. These modules provide cross-cutting capabilities that enhance the entire BMad ecosystem. Examples include: -- The current TTS (Text-to-Speech) functionality for Claude, which will be rebuilt as a global module +- The current TTS (Text-to-Speech) functionality for Claude, which will soon be converted to a global module - The core module, which is always installed and provides all agents with party mode and advanced elicitation capabilities -- Installation and update tools that work with any BMAD method configuration +- Installation and update tools that work with any BMad method configuration Upcoming standards will document best practices for building global content that affects installed modules through: @@ -81,7 +83,7 @@ Personal agents designed for highly specific needs that may not be suitable for These are simple, standalone files that can be scoped to focus on specific data or paths when integrated into an information vault or repository. -### Simple vs Expert Agents +### Simple and Expert Agents The distinction between simple and expert agents lies in their structure: @@ -89,7 +91,6 @@ The distinction between simple and expert agents lies in their structure: - Single file containing all prompts and configuration - Self-contained and straightforward -- has metadata type: simple **Expert Agent:** @@ -98,7 +99,9 @@ The distinction between simple and expert agents lies in their structure: - When installed, the sidecar folder (`[agentname]-sidecar`) is placed in the user memory location - has metadata type: expert +:::note[Key Distinction] The key distinction is the presence of a sidecar folder. As web and consumer agent tools evolve to support common memory mechanisms, storage formats, and MCP, the writable memory files will adapt to support these evolving standards. +::: Custom agents can be: @@ -119,4 +122,6 @@ A custom workflow created outside of a larger module can still be distributed an - Slash commands - Manual command/prompt execution when supported by tools +:::tip[Core Concept] At its core, a custom workflow is a single or series of prompts designed to achieve a specific outcome. +::: diff --git a/docs/explanation/bmad-builder/index.md b/docs/explanation/bmad-builder/index.md new file mode 100644 index 00000000..6653d9ca --- /dev/null +++ b/docs/explanation/bmad-builder/index.md @@ -0,0 +1,45 @@ +--- +title: "BMad Builder (BMB)" +description: Create custom agents, workflows, and modules for BMad +--- + +Create custom agents, workflows, and modules for BMad — from simple personal assistants to full-featured professional tools. + +## Quick Start + +| Resource | Description | +|----------|-------------| +| **[Agent Creation Guide](/docs/tutorials/advanced/create-custom-agent.md)** | Step-by-step guide to building your first agent | +| **[Install Custom Modules](/docs/how-to/installation/install-custom-modules.md)** | Installing standalone simple and expert agents | + +## Agent Architecture + +| Type | Description | +|------|-------------| +| **Simple Agent** | Self-contained, optimized, personality-driven | +| **Expert Agent** | Memory, sidecar files, domain restrictions | +| **Module Agent** | Workflow integration, professional tools | + +## Key Concepts + +Agents are authored in YAML with Handlebars templating. The compiler auto-injects: + +1. **Frontmatter** — Name and description from metadata +2. **Activation Block** — Steps, menu handlers, rules +3. **Menu Enhancement** — `*help` and `*exit` commands added automatically +4. **Trigger Prefixing** — Your triggers auto-prefixed with `*` + +:::note[Learn More] +See [Custom Content Types](/docs/explanation/bmad-builder/custom-content-types.md) for detailed explanations of all content categories. +::: + +## Reference Examples + +Production-ready examples available in the BMB reference folder: + +| Agent | Type | Description | +|-------|------|-------------| +| **commit-poet** | Simple | Commit message artisan with style customization | +| **journal-keeper** | Expert | Personal journal companion with memory and pattern recognition | +| **security-engineer** | Module | BMM security specialist with threat modeling | +| **trend-analyst** | Module | CIS trend intelligence expert | diff --git a/docs/explanation/bmm/index.md b/docs/explanation/bmm/index.md new file mode 100644 index 00000000..2631a43e --- /dev/null +++ b/docs/explanation/bmm/index.md @@ -0,0 +1,131 @@ +--- +title: "BMM Documentation" +--- + +Complete guides for the BMad Method Module (BMM) — AI-powered agile development workflows that adapt to your project's complexity. + +## Getting Started + +:::tip[Quick Path] +Install → workflow-init → Follow agent guidance +::: + +**New to BMM?** Start here: + +| Resource | Description | +|----------|-------------| +| **[Quick Start Guide](/docs/tutorials/getting-started/getting-started-bmadv6.md)** | Step-by-step guide to building your first project | +| **[Complete Workflow Diagram](../../tutorials/getting-started/images/workflow-method-greenfield.svg)** | Visual flowchart showing all phases, agents, and decision points | + +## Core Concepts + +The BMad Method is meant to be adapted and customized to your specific needs. In this realm there is no one size fits all - your needs are unique, and BMad Method is meant to support this (and if it does not, can be further customized or extended with new modules). + +First know there is the full BMad Method Process and then there is a Quick Flow for those quicker smaller efforts. + +- **[Full Adaptive BMad Method](#workflow-guides)** - Full planning and scope support through extensive development and testing. + - Broken down into 4 phases, all of which are comprised of both required and optional phases + - Phases 1-3 are all about progressive idea development through planning and preparations to build your project. + - Phase 4 is the implementation cycle where you will Just In Time (JIT) produce the contextual stories needed for the dev agent based on the extensive planning completed + - All 4 phases have optional steps in them, depending on how rigorous you want to go with planning, research ideation, validation, testing and traceability. + - While there is a lot here, know that even this can be distilled down to a simple PRD, Epic and Story list and then jump into the dev cycle. But if that is all you want, you might be better off with the BMad Quick Flow described next + +- **[BMad Quick Flow](/docs/explanation/features/quick-flow.md)** - Fast-track development workflow + - 3-step process: spec → dev → optional review + - Perfect for bug fixes and small features + - Rapid prototyping with production quality + - Implementation in minutes, not days + - Has a specialized single agent that does all of this: **[Quick Flow Solo Dev Agent](/docs/explanation/agents/barry-quick-flow.md)** + +- **TEA engagement (optional)** - Choose TEA engagement: none, TEA-only (standalone), or integrated by track. See **[Test Architect Guide](/docs/explanation/features/tea-overview.md)**. + +## Agents and Collaboration + +Complete guide to BMM's AI agent team: + +- **[Agents Guide](/docs/explanation/core-concepts/agent-roles.md)** - Comprehensive agent reference + - 12 specialized BMM agents + BMad Master + - Agent roles, workflows, and when to use them + - Agent customization system + - Best practices and common patterns + +- **[Party Mode Guide](/docs/explanation/features/party-mode.md)** - Multi-agent collaboration + - How party mode works (19+ agents collaborate in real-time) + - When to use it (strategic, creative, cross-functional, complex) + - Example party compositions + - Multi-module integration (BMM + CIS + BMB + custom) + - Agent customization in party mode + - Best practices + +## Working with Existing Code + +Comprehensive guide for brownfield development: + +- **[Brownfield Development Guide](/docs/how-to/brownfield/index.md)** - Complete guide for existing codebases + - Documentation phase strategies + - Track selection for brownfield + - Integration with existing patterns + - Phase-by-phase workflow guidance + - Common scenarios + +## Quick References + +Essential reference materials: + +- **[Glossary](/docs/reference/glossary/index.md)** - Key terminology and concepts +- **[FAQ](/docs/explanation/faq/index.md)** - Frequently asked questions across all topics + +## Choose Your Path + +### I need to... + +**Build something new (greenfield)** +→ Start with [Quick Start Guide](/docs/tutorials/getting-started/getting-started-bmadv6.md) + +**Fix a bug or add small feature** +→ Use the [Quick Flow Solo Dev](/docs/explanation/agents/barry-quick-flow.md) directly with its dedicated stand alone [Quick Bmad Spec Flow](/docs/explanation/features/quick-flow.md) process + +**Work with existing codebase (brownfield)** +→ Read [Brownfield Development Guide](/docs/how-to/brownfield/index.md) +→ Pay special attention to documentation requirements for brownfield projects + +## Workflow Guides + +Comprehensive documentation for all BMM workflows organized by phase: + +- **[Phase 1: Analysis Workflows](/docs/how-to/workflows/run-brainstorming-session.md)** - Optional exploration and research workflows (595 lines) + - brainstorm-project, product-brief, research, and more + - When to use analysis workflows + - Creative and strategic tools + +- **[Phase 2: Planning Workflows](/docs/how-to/workflows/create-prd.md)** - Scale-adaptive planning (967 lines) + - prd, tech-spec, gdd, narrative, ux + - Track-based planning approach (Quick Flow, BMad Method, Enterprise Method) + - Which planning workflow to use + +- **[Phase 3: Solutioning Workflows](/docs/how-to/workflows/create-architecture.md)** - Architecture and validation (638 lines) + - architecture, create-epics-and-stories, implementation-readiness + - V6: Epics created AFTER architecture for better quality + - Required for BMad Method and Enterprise Method tracks + - Preventing agent conflicts + +- **[Phase 4: Implementation Workflows](/docs/how-to/workflows/run-sprint-planning.md)** - Sprint-based development (1,634 lines) + - sprint-planning, create-story, dev-story, code-review + - Complete story lifecycle + - One-story-at-a-time discipline + +- **[Testing & QA Workflows](/docs/explanation/features/tea-overview.md)** - Comprehensive quality assurance (1,420 lines) + - Test strategy, automation, quality gates + - TEA agent and test healing + +## External Resources + +### Community and Support + +- **[Discord Community](https://discord.gg/gk8jAdXWmj)** - Get help from the community (#bmad-method-help, #report-bugs-and-issues) +- **[GitHub Issues](https://github.com/bmad-code-org/BMAD-METHOD/issues)** - Report bugs or request features +- **[YouTube Channel](https://www.youtube.com/@BMadCode)** - Video tutorials and walkthroughs + +:::tip[Ready to Begin?] +[Start with the Quick Start Guide](/docs/tutorials/getting-started/getting-started-bmadv6.md) +::: diff --git a/docs/explanation/core-concepts/agent-roles.md b/docs/explanation/core-concepts/agent-roles.md new file mode 100644 index 00000000..31e0d76c --- /dev/null +++ b/docs/explanation/core-concepts/agent-roles.md @@ -0,0 +1,179 @@ +--- +title: "Agent Roles in BMad Method" +description: Understanding the different agent roles in BMad Method +--- + +BMad Method uses specialized AI agents, each with a distinct role, expertise, and personality. Understanding these roles helps you know which agent to use for each task. + +## Core Agents Overview + +| Agent | Role | Primary Phase | +|-------|------|---------------| +| **Analyst** | Research and discovery | Phase 1 (Analysis) | +| **PM** | Requirements and planning | Phase 2 (Planning) | +| **Architect** | Technical design | Phase 3 (Solutioning) | +| **SM** | Sprint orchestration | Phase 4 (Implementation) | +| **DEV** | Code implementation | Phase 4 (Implementation) | +| **TEA** | Test architecture | Phases 3-4 (Cross-phase) | +| **UX Designer** | User experience | Phase 2-3 | +| **Quick Flow Solo Dev** | Fast solo development | All phases (Quick Flow) | + +## Phase 1: Analysis + +### Analyst (Mary) + +Business analysis and research specialist. + +**Responsibilities:** +- Brainstorming and ideation +- Market, domain, and competitive research +- Product brief creation +- Brownfield project documentation + +**Key Workflows:** +- `*brainstorm-project` +- `*research` +- `*product-brief` +- `*document-project` + +**When to use:** Starting new projects, exploring ideas, validating market fit, documenting existing codebases. + +## Phase 2: Planning + +### PM (John) + +Product requirements and planning expert. + +**Responsibilities:** +- Creating Product Requirements Documents +- Defining functional and non-functional requirements +- Breaking requirements into epics and stories +- Validating implementation readiness + +**Key Workflows:** +- `*create-prd` +- `*create-epics-and-stories` +- `*implementation-readiness` + +**When to use:** Defining what to build, creating PRDs, organizing work into stories. + +### UX Designer (Sally) + +User experience and UI design specialist. + +**Responsibilities:** +- UX specification creation +- User journey mapping +- Wireframe and mockup design +- Design system documentation + +**Key Workflows:** +- `*create-ux-design` +- `*validate-design` + +**When to use:** When UX is a primary differentiator, complex user workflows, design system creation. + +## Phase 3: Solutioning + +### Architect (Winston) + +System architecture and technical design expert. + +**Responsibilities:** +- System architecture design +- Architecture Decision Records (ADRs) +- Technical standards definition +- Implementation readiness validation + +**Key Workflows:** +- `*create-architecture` +- `*implementation-readiness` + +**When to use:** Multi-epic projects, cross-cutting technical decisions, preventing agent conflicts. + +## Phase 4: Implementation + +### SM (Bob) + +Sprint planning and story preparation orchestrator. + +**Responsibilities:** +- Sprint planning and tracking +- Story preparation for development +- Course correction handling +- Epic retrospectives + +**Key Workflows:** +- `*sprint-planning` +- `*create-story` +- `*correct-course` +- `*epic-retrospective` + +**When to use:** Organizing work, preparing stories, tracking progress. + +### DEV (Amelia) + +Story implementation and code review specialist. + +**Responsibilities:** +- Story implementation with tests +- Code review +- Following architecture patterns +- Quality assurance + +**Key Workflows:** +- `*dev-story` +- `*code-review` + +**When to use:** Writing code, implementing stories, reviewing quality. + +## Cross-Phase Agents + +### TEA (Murat) + +Test architecture and quality strategy expert. + +**Responsibilities:** +- Test framework setup +- Test design and planning +- ATDD and automation +- Quality gate decisions + +**Key Workflows:** +- `*framework`, `*ci` +- `*test-design`, `*atdd`, `*automate` +- `*test-review`, `*trace`, `*nfr-assess` + +**When to use:** Setting up testing, creating test plans, quality gates. + +## Quick Flow + +### Quick Flow Solo Dev (Barry) + +Fast solo development without handoffs. + +**Responsibilities:** +- Technical specification +- End-to-end implementation +- Code review + +**Key Workflows:** +- `*quick-spec` +- `*quick-dev` +- `*code-review` + +**When to use:** Bug fixes, small features, rapid prototyping. + +## Choosing the Right Agent + +| Task | Agent | +|------|-------| +| Brainstorming ideas | Analyst | +| Market research | Analyst | +| Creating PRD | PM | +| Designing UX | UX Designer | +| System architecture | Architect | +| Preparing stories | SM | +| Writing code | DEV | +| Setting up tests | TEA | +| Quick bug fix | Quick Flow Solo Dev | diff --git a/docs/explanation/core-concepts/index.md b/docs/explanation/core-concepts/index.md new file mode 100644 index 00000000..076c3820 --- /dev/null +++ b/docs/explanation/core-concepts/index.md @@ -0,0 +1,35 @@ +--- +title: "BMad Core Concepts" +--- + +Understanding the fundamental building blocks of the BMad Method. + +## The Essentials + +| Concept | Description | Guide | +|---------|-------------|-------| +| **Agents** | AI assistants with personas, capabilities, and menus | [Agents Guide](/docs/explanation/core-concepts/what-are-agents.md) | +| **Workflows** | Structured processes for achieving specific outcomes | [Workflows Guide](/docs/explanation/core-concepts/what-are-workflows.md) | +| **Modules** | Packaged collections of agents and workflows | [Modules Guide](/docs/explanation/core-concepts/what-are-modules.md) | + +## Getting Started + +### New to BMad? +Start here to understand what BMad is and how it works: + +1. **[Agents Guide](/docs/explanation/core-concepts/what-are-agents.md)** - Learn about Simple and Expert agents +2. **[Workflows Guide](/docs/explanation/core-concepts/what-are-workflows.md)** - Understand how workflows orchestrate tasks +3. **[Modules Guide](/docs/explanation/core-concepts/what-are-modules.md)** - See how modules organize functionality + +### Installing BMad + +- **[Installation Guide](/docs/how-to/installation/index.md)** - Set up BMad in your project +- **[Upgrading from v4](/docs/how-to/installation/upgrade-to-v6.md)** - Migrate from earlier versions + +### Configuration + +- **[BMad Customization](/docs/how-to/customization/index.md)** - Personalize agents and workflows + +### Advanced + +- **[Web Bundles](/docs/explanation/features/web-bundles.md)** - Use BMad in Gemini Gems and Custom GPTs diff --git a/docs/explanation/core-concepts/what-are-agents.md b/docs/explanation/core-concepts/what-are-agents.md new file mode 100644 index 00000000..86d49642 --- /dev/null +++ b/docs/explanation/core-concepts/what-are-agents.md @@ -0,0 +1,95 @@ +--- +title: "Agents" +--- + +Agents are AI assistants that help you accomplish tasks. Each agent has a unique personality, specialized capabilities, and an interactive menu. + +## Agent Types + +BMad has two primary agent types, designed for different use cases: + +### Simple Agents + +**Self-contained, focused, ready to use.** + +Simple agents are complete in a single file. They excel at well-defined tasks and require minimal setup. + +**Best for:** +- Single-purpose assistants (code review, documentation, commit messages) +- Quick deployment +- Projects that don't require persistent memory +- Getting started fast + +**Example:** A commit message agent that reads your git diff and generates conventional commits. + +### Expert Agents + +**Powerful, memory-equipped, domain specialists.** + +Expert agents have a **sidecar** - a companion folder containing additional instructions, workflows, and memory files. They remember context across sessions and handle complex, multi-step tasks. + +**Best for:** +- Domain specialists (security architect, game designer, product manager) +- Tasks requiring persistent memory +- Complex workflows with multiple stages +- Projects that grow over time + +**Example:** A game architect that remembers your design decisions, maintains consistency across sprints, and coordinates with other specialists. + +## Key Differences + +| Feature | Simple | Expert | +| ---------------- | -------------- | -------------------------- | +| **Files** | Single file | Agent + sidecar folder | +| **Memory** | Session only | Persistent across sessions | +| **Capabilities** | Focused scope | Multi-domain, extensible | +| **Setup** | Zero config | Sidecar initialization | +| **Best Use** | Specific tasks | Ongoing projects | + +## Agent Components + +All agents share these building blocks: + +### Persona +- **Role** - What the agent does (expertise domain) +- **Identity** - Who the agent is (personality, character) +- **Communication Style** - How the agent speaks (tone, voice) +- **Principles** - Why the agent acts (values, decision framework) + +### Capabilities +- Skills, tools, and knowledge the agent can apply +- Mapped to specific menu commands + +### Menu +- Interactive command list +- Triggers, descriptions, and handlers +- Auto-includes help and exit options + +### Critical Actions (optional) +- Instructions that execute before the agent starts +- Enable autonomous behaviors (e.g., "check git status before changes") + +## Which Should You Use? + +:::tip[Quick Decision] +Choose **Simple** for focused, one-off tasks with no memory needs. Choose **Expert** when you need persistent context and complex workflows. +::: + +**Choose Simple when:** +- You need a task done quickly and reliably +- The scope is well-defined and won't change much +- You don't need the agent to remember things between sessions + +**Choose Expert when:** +- You're building something complex over time +- The agent needs to maintain context (project history, decisions) +- You want the agent to coordinate workflows or other agents +- Domain expertise requires specialized knowledge bases + +## Creating Custom Agents + +BMad provides the **BMad Builder (BMB)** module for creating your own agents. See the [Agent Creation Guide](/docs/tutorials/advanced/create-custom-agent.md) for step-by-step instructions. + +## Customizing Existing Agents + +You can modify any agent's behavior without editing core files. See [BMad Customization](/docs/how-to/customization/index.md) for details. It is critical to never modify an installed agents .md file directly and follow the customization process, this way future updates to the agent or module its part of will continue to be updated and recompiled with the installer tool, and your customizations will still be retained. diff --git a/docs/explanation/core-concepts/what-are-modules.md b/docs/explanation/core-concepts/what-are-modules.md new file mode 100644 index 00000000..4527b9ba --- /dev/null +++ b/docs/explanation/core-concepts/what-are-modules.md @@ -0,0 +1,78 @@ +--- +title: "Modules" +--- + +Modules are organized collections of agents and workflows that solve specific problems or address particular domains. + +## What is a Module? + +A module is a self-contained package that includes: + +- **Agents** - Specialized AI assistants +- **Workflows** - Step-by-step processes +- **Configuration** - Module-specific settings +- **Documentation** - Usage guides and reference + +## Official Modules + +:::note[Core is Always Installed] +The Core module is automatically included with every BMad installation. It provides the foundation that other modules build upon. +::: + +### Core Module +Always installed, provides shared functionality: +- Global configuration +- Core workflows (Party Mode, Advanced Elicitation, Brainstorming) +- Common tasks (document indexing, sharding, review) + +### BMad Method (BMM) +Software and game development: +- Project planning workflows +- Implementation agents (Dev, PM, QA, Scrum Master) +- Testing and architecture guidance + +### BMad Builder (BMB) +Create custom solutions: +- Agent creation workflows +- Workflow authoring tools +- Module scaffolding + +### Creative Intelligence Suite (CIS) +Innovation and creativity: +- Creative thinking techniques +- Innovation strategy workflows +- Storytelling and ideation + +### BMad Game Dev (BMGD) +Game development specialization: +- Game design workflows +- Narrative development +- Performance testing frameworks + +## Module Structure + +Installed modules follow this structure: + +``` +_bmad/ +├── core/ # Always present +├── bmm/ # BMad Method (if installed) +├── bmb/ # BMad Builder (if installed) +├── cis/ # Creative Intelligence (if installed) +└── bmgd/ # Game Dev (if installed) +``` + +## Custom Modules + +You can create your own modules containing: +- Custom agents for your domain +- Organizational workflows +- Team-specific configurations + +Custom modules are installed the same way as official modules. + +## Installing Modules + +During BMad installation, you choose which modules to install. You can also add or remove modules later by re-running the installer. + +See [Installation Guide](/docs/how-to/installation/index.md) for details. diff --git a/docs/explanation/core-concepts/what-are-workflows.md b/docs/explanation/core-concepts/what-are-workflows.md new file mode 100644 index 00000000..e60d8d80 --- /dev/null +++ b/docs/explanation/core-concepts/what-are-workflows.md @@ -0,0 +1,204 @@ +--- +title: "Workflows" +--- + +Workflows are like prompts on steroids. They harness the untapped power and control of LLMs through progressive disclosure—breaking complex tasks into focused steps that execute sequentially. Instead of random AI slop where you hope for the best, workflows give you repeatable, reliable, high-quality outputs. + +This guide explains what workflows are, why they're powerful, and how to think about designing them. + +## What Is a Workflow? + +A workflow is a structured process where the AI executes steps sequentially to accomplish a task. Each step has a specific purpose, and the AI moves through them methodically—whether that involves extensive collaboration or minimal user interaction. + +Think of it this way: instead of asking "help me build a nutrition plan" and getting a generic response, a workflow guides you (or runs automatically) through discovery, assessment, strategy, shopping lists, and prep schedules—each step building on the last, nothing missed, no shortcuts taken. + +## How do workflows differ from skills? + +Actually they really do not - a workflow can be a skill, and a skill can be a workflow. The main thing with a BMad workflow is the suggestion to follow certain conventions, which actually are also skill best practices. A skill has a few optional and required fields to add as the main file workflow and get stored in a specific location depending on your tool choice for automatic invocation by the llm - whereas workflows are generally intentionally launched, with from another process calling them, or a user invoking via a slash command. In the near future, workflows will optionally be installable as skills also - but if you like, you can add front matter to your custom workflows based on the skill spec from Anthropic, and put them in the proper location your tool dictates. + +### The Power of Progressive Disclosure + +Here's why workflows work so well: the AI only sees the current step. It doesn't know about step 5 when it's on step 2. It can't get ahead of itself, skip steps, or lose focus. Each step gets the AI's full attention, completing fully before the next step loads. + +This is the opposite of a giant prompt that tries to handle everything at once and inevitably misses details or loses coherence. + +Workflows exist on a spectrum: + +- **Interactive workflows** guide users through complex decisions via collaboration and facilitation +- **Automated workflows** run with minimal user input, processing documents or executing tasks +- **Hybrid workflows** combine both—some steps need user input, others run automatically + +### Real-World Workflow Examples + +**Tax Organizer Workflow** + +A tax preparation workflow that helps users organize financial documents for tax filing. Runs in a single session, follows prescriptive IRS categories, produces a checklist of required documents with missing-item alerts. Sequential and compliance-focused. + +**Meal Planning Workflow** + +Creates personalized weekly meal plans through collaborative nutrition planning. Users can stop mid-session and return later because the workflow tracks progress. Intent-based conversation helps discover preferences rather than following a script. Multi-session, creative, and highly interactive. + +**Course Creator Workflow** + +Helps instructors design course syllabi. Branches based on course type—academic courses need accreditation sections, vocational courses need certification prep, self-paced courses need different structures entirely. + +**Therapy Intake Workflow** + +Guides mental health professionals through structured client intake sessions. Highly sensitive and confidential, uses intent-based questioning to build rapport while ensuring all required clinical information is collected. Continuable across multiple sessions. + +**Software Architecture Workflow** (BMM Module) + +Part of a larger software development pipeline. Runs after product requirements and UX design are complete, takes those documents as input, then collaboratively walks through technical decisions: system components, data flows, technology choices, architectural patterns. Produces an architecture document that implementation teams use to build consistently. + +**Shard Document Workflow** + +Nearly hands-off automated workflow. Takes a large document as input, uses a custom npx tool to split it into smaller files, deletes the original, then augments an index with content details so the LLM can efficiently find and reference specific sections later. Minimal user interaction—just specify the input document. + +These examples show the range: from collaborative creative processes to automated batch jobs, workflows ensure completeness and consistency whether the work involves deep collaboration or minimal human oversight. + +### The Facilitative Philosophy + +When workflows involve users, they should be **facilitative, not directive**. The AI treats users as partners and domain experts, not as passive recipients of generated content. + +**Collaborative dialogue, not command-response**: The AI and user work together throughout. The AI brings structured thinking, methodology, and technical knowledge. The user brings domain expertise, context, and judgment. Together they produce something better than either could alone. + +**The user is the expert in their domain**: A nutrition planning workflow doesn't dictate meal plans—it guides users through discovering what works for their lifestyle. An architecture workflow doesn't tell architects what to build—it facilitates systematic decision-making so choices are explicit and consistent. + +**Intent-based facilitation**: Workflows should describe goals and approaches, not scripts. Instead of "Ask: What is your age? Then ask: What is your goal weight?" use "Guide the user through understanding their health profile. Ask 1-2 questions at a time. Think about their responses before asking follow-ups. Probe to understand their actual needs." + +The AI figures out exact wording and question order based on conversation context. This makes interactions feel natural and responsive rather than robotic and interrogative. + +:::caution[When to Be Prescriptive] +Some workflows require exact scripts—medical intake, legal compliance, safety-critical procedures. But these are the exception. Default to facilitative intent-based approaches unless compliance or regulation demands otherwise. +::: + +## Why Workflows Matter + +Workflows solve three fundamental problems with AI interactions: + +**Focus**: Each step contains only instructions for that phase. The AI sees one step at a time, preventing it from getting ahead of itself or losing focus. + +**Continuity**: Workflows can span multiple sessions. Stop mid-workflow and return later without losing progress—something free-form prompts can't do. + +**Quality**: Sequential enforcement prevents shortcuts. The AI must complete each step fully before moving on, ensuring thorough, complete outputs instead of rushed, half-baked results. + +## How Workflows Work + +### The Basic Structure + +Workflows consist of multiple markdown files, each representing one step: + +``` +my-workflow/ +├── workflow.md # Entry point and configuration +├── steps/ # Step files (steps-c/ for create, steps-e/ for edit, steps-v/ for validate) +│ ├── step-01-init.md +│ ├── step-02-profile.md +│ └── step-N-final.md +├── data/ # Reference materials, CSVs, examples +└── templates/ # Output document templates +``` + +The `workflow.md` file is minimal—it contains the workflow name, description, goal, the AI's role, and how to start. Importantly, it does not list all steps or detail what each does. This is progressive disclosure in action. + +### Sequential Execution + +Workflows execute in strict sequence: `step-01 → step-02 → step-03 → ... → step-N` + +The AI cannot skip steps or optimize the sequence. It must complete each step fully before loading the next. This ensures thoroughness and prevents shortcuts that compromise quality. + +### Continuable Workflows + +Some workflows are complex enough that users might need multiple sessions. These "continuable workflows" track which steps are complete in the output document's frontmatter, so users can stop and resume later without losing progress. + +Use continuable workflows when: +- The workflow produces large documents +- Multiple sessions are likely +- Complex decisions benefit from reflection +- The workflow has many steps (8+) + +Keep it simple (single-session) when tasks are quick, focused, and can be completed in one sitting. + +### Workflow Chaining + +Workflows can be chained together where outputs become inputs. The BMM module pipeline is a perfect example: + +``` +brainstorming → research → brief → PRD → UX → architecture → epics → sprint-planning + ↓ + implement-story → review → repeat +``` + +Each workflow checks for required inputs from prior workflows, validates they're complete, and produces output for the next workflow. This creates powerful end-to-end pipelines for complex processes. + +### The Tri-Modal Pattern + +For critical workflows that produce important artifacts, BMad uses a tri-modal structure: Create, Validate, and Edit. Each mode is a separate workflow path that can run independently or flow into the others. + +**Create mode** builds new artifacts from scratch. But here's where it gets interesting: create mode can also function as a conversion tool. Feed it a non-compliant document—something that doesn't follow BMad standards—and it will extract the essential content and rebuild it as a compliant artifact. This means you can bring in existing work and automatically upgrade it to follow proper patterns. + +**Validate mode** runs standalone and checks artifacts against standards. Because it's separate, you can run validation whenever you want—immediately after creation, weeks later when things have changed, or even using a different LLM entirely. It's like having a quality assurance checkpoint that's always available but never forced. + +**Edit mode** modifies existing artifacts while enforcing standards. As you update documents to reflect changing requirements or new understanding, edit mode ensures you don't accidentally drift away from the patterns that make the artifacts useful. It checks compliance as you work and can route back to create mode if it detects something that needs full conversion. + +All BMad planning workflows and the BMB module (will) use this tri-modal pattern. The pristine example is the workflow workflow in BMB—it creates workflow specifications, validates them against standards, and lets you edit them while maintaining compliance. You can study that workflow to see the pattern in action. + +This tri-modal approach gives you the best of both worlds: the creativity and flexibility to build what you need, the quality assurance of validation that can run anytime, and the ability to iterate while staying true to standards that make the artifacts valuable across sessions and team members. + +## Design Decisions + +Before building a workflow, answer these questions: + +**Module affiliation**: Is this standalone or part of a module? Module-based workflows can access module-specific variables and reference other workflow outputs. Also when part of a module, generally they will be associated to an agent. + +**Continuable or single-session?**: Will users need multiple sessions, or can this be completed in one sitting? + +**Edit/Validate support?**: Do you need Create/Edit/Validate modes (tri-modal structure)? Use tri-modal for complex, critical workflows requiring quality assurance. Use create-only for simple, one-off workflows. + +**Document output?**: Does this produce a persistent file, or perform actions without output? + +**Intent or prescriptive?**: Is this intent-based facilitation (most workflows) or prescriptive compliance (medical, legal, regulated)? + +## Learning from Examples + +The best way to understand workflows is to study real examples. Look at the official BMad modules: + +- **BMB (Module Builder)**: Workflow and agent creation workflows +- **BMM (Business Method Module)**: Complete software development pipeline from brainstorming through sprint planning +- **BMGD (Game Development Module)**: Game design briefs, narratives, architecture +- **CIS (Creativity, Innovation, Strategy)**: Brainstorming, design thinking, storytelling, innovation strategy + +Study the workflow.md files to understand how each workflow starts. Examine step files to see how instructions are structured. Notice the frontmatter variables, menu handling, and how steps chain together. + +Copy patterns that work. Adapt them to your domain. The structure is consistent across all workflows—the content and steps change, but the architecture stays the same. + +## When to Use Workflows + +Use workflows when: + +- **Tasks are multi-step and complex**: Break down complexity into manageable pieces +- **Quality and completeness matter**: Sequential enforcement ensures nothing gets missed +- **Repeatability is important**: Get consistent results every time +- **Tasks span multiple sessions**: Continuable workflows preserve progress +- **You need to chain processes**: Output of one workflow becomes input of another +- **Compliance or standards matter**: Enforce required steps and documentation + +Don't use workflows when: + +- **Tasks are simple and one-off**: A single prompt works fine for quick questions +- **Flexibility trumps structure**: Free-form conversation is better for exploration + +Modified BMad Workflows + +- **Tasks are truly one-step** + +If there's only one thing to do and it can be explained in under about 300 lines - don't bother with step files. Instead, you can still have +a short single file workflow.md file. + +## The Bottom Line + +Workflows transform AI from a tool that gives variable, unpredictable results into a reliable system for complex, multi-step processes. Through progressive disclosure, sequential execution, guided facilitation, and thoughtful design, workflows give you control and repeatability that ad-hoc prompting alone can't match. + +They're not just for software development. You can create workflows for any guided process - meal planning, course design, therapy intake, tax preparation, document processing, creative writing, event planning—any complex task that benefits from structure and thoroughness. + +Start simple. Study examples. Build workflows for your own domain. You'll wonder how you ever got by with just prompts. diff --git a/docs/explanation/core/index.md b/docs/explanation/core/index.md new file mode 100644 index 00000000..9c604a48 --- /dev/null +++ b/docs/explanation/core/index.md @@ -0,0 +1,18 @@ +--- +title: "Core Module" +--- + + +The Core Module is installed with all installations of BMad modules and provides common functionality that any module, workflow, or agent can take advantage of. + +## Core Module Components + +- **[Global Core Config](/docs/reference/configuration/global-config.md)** — Inheritable configuration that impacts all modules and custom content +- **[Core Workflows](/docs/reference/workflows/core-workflows.md)** — Domain-agnostic workflows usable by any module + - [Party Mode](/docs/explanation/features/party-mode.md) — Multi-agent conversation orchestration + - [Brainstorming](/docs/explanation/features/brainstorming-techniques.md) — Structured creative sessions with 60+ techniques + - [Advanced Elicitation](/docs/explanation/features/advanced-elicitation.md) — LLM rethinking with 50+ reasoning methods +- **[Core Tasks](/docs/reference/configuration/core-tasks.md)** — Common tasks available across modules + - [Index Docs](/docs/reference/configuration/core-tasks.md#index-docs) — Generate directory index files + - [Adversarial Review](/docs/reference/configuration/core-tasks.md#adversarial-review) — Critical content review + - [Shard Document](/docs/reference/configuration/core-tasks.md#shard-document) — Split large documents into sections diff --git a/src/modules/cis/docs/index.md b/docs/explanation/creative-intelligence/index.md similarity index 61% rename from src/modules/cis/docs/index.md rename to docs/explanation/creative-intelligence/index.md index 46fb6e0a..439dc6f3 100644 --- a/src/modules/cis/docs/index.md +++ b/docs/explanation/creative-intelligence/index.md @@ -1,16 +1,10 @@ -# CIS - Creative Intelligence Suite +--- +title: "Creative Intelligence Suite (CIS)" +description: AI-powered creative facilitation with the Creative Intelligence Suite +--- AI-powered creative facilitation transforming strategic thinking through expert coaching across five specialized domains. -## Table of Contents - -- [Core Capabilities](#core-capabilities) -- [Specialized Agents](#specialized-agents) -- [Interactive Workflows](#interactive-workflows) -- [Quick Start](#quick-start) -- [Key Differentiators](#key-differentiators) -- [Configuration](#configuration) - ## Core Capabilities CIS provides structured creative methodologies through distinctive agent personas who act as master facilitators, drawing out insights through strategic questioning rather than generating solutions directly. @@ -25,46 +19,39 @@ CIS provides structured creative methodologies through distinctive agent persona ## Interactive Workflows -[View all workflows →](../workflows/README.md) - **5 Workflows** with **150+ Creative Techniques:** ### Brainstorming -36 techniques across 7 categories for ideation - +36 techniques across 7 categories for ideation: - Divergent/convergent thinking - Lateral connections - Forced associations ### Design Thinking -Complete 5-phase human-centered process - +Complete 5-phase human-centered process: - Empathize → Define → Ideate → Prototype → Test - User journey mapping - Rapid iteration ### Problem Solving -Systematic root cause analysis - +Systematic root cause analysis: - 5 Whys, Fishbone diagrams - Solution generation - Impact assessment ### Innovation Strategy -Business model disruption - +Business model disruption: - Blue Ocean Strategy - Jobs-to-be-Done - Disruptive innovation patterns ### Storytelling -25 narrative frameworks - +25 narrative frameworks: - Hero's Journey - Story circles - Compelling pitch structures @@ -74,20 +61,16 @@ Business model disruption ### Direct Workflow ```bash -# Start interactive session workflow brainstorming -# With context document workflow design-thinking --data /path/to/context.md ``` ### Agent-Facilitated ```bash -# Load agent agent cis/brainstorming-coach -# Start workflow > *brainstorm ``` @@ -99,31 +82,6 @@ agent cis/brainstorming-coach - **Persona-Driven** - Unique communication styles - **Rich Method Libraries** - 150+ proven techniques -## Configuration - -Edit `/_bmad/cis/config.yaml`: - -```yaml -output_folder: ./creative-outputs -user_name: Your Name -communication_language: english -``` - -## Module Structure - -``` -cis/ -├── agents/ # 5 specialized facilitators -├── workflows/ # 5 interactive processes -│ ├── brainstorming/ -│ ├── design-thinking/ -│ ├── innovation-strategy/ -│ ├── problem-solving/ -│ └── storytelling/ -├── tasks/ # Supporting operations -└── teams/ # Agent collaborations -``` - ## Integration Points CIS workflows integrate with: @@ -140,10 +98,6 @@ CIS workflows integrate with: 4. **Take breaks** when energy flags 5. **Document insights** as they emerge -## Related Documentation - -- **[BMM Documentation](../../bmm/docs/index.md)** - Core BMad Method documentation - ---- - -Part of BMad Method v6.0 - Transform creative potential through expert AI facilitation. +:::tip[Learn More] +See [Facilitation Over Generation](/docs/explanation/philosophy/facilitation-over-generation.md) for the core philosophy behind CIS. +::: diff --git a/docs/explanation/faq/brownfield-faq.md b/docs/explanation/faq/brownfield-faq.md new file mode 100644 index 00000000..79e192b2 --- /dev/null +++ b/docs/explanation/faq/brownfield-faq.md @@ -0,0 +1,73 @@ +--- +title: "Brownfield Development FAQ" +description: Common questions about brownfield development in the BMad Method +--- +Quick answers to common questions about brownfield (existing codebase) development in the BMad Method (BMM). + +## Questions + +- [What is brownfield vs greenfield?](#what-is-brownfield-vs-greenfield) +- [Do I have to run document-project for brownfield?](#do-i-have-to-run-document-project-for-brownfield) +- [What if I forget to run document-project?](#what-if-i-forget-to-run-document-project) +- [Can I use Quick Spec Flow for brownfield projects?](#can-i-use-quick-spec-flow-for-brownfield-projects) +- [How does workflow-init handle old planning docs?](#how-does-workflow-init-handle-old-planning-docs) +- [What if my existing code doesn't follow best practices?](#what-if-my-existing-code-doesnt-follow-best-practices) + +### What is brownfield vs greenfield? + +- **Greenfield** — New project, starting from scratch, clean slate +- **Brownfield** — Existing project, working with established codebase and patterns + +### Do I have to run document-project for brownfield? + +Highly recommended, especially if: + +- No existing documentation +- Documentation is outdated +- AI agents need context about existing code +- Level 2-4 complexity + +You can skip it if you have comprehensive, up-to-date documentation including `docs/index.md`. + +### What if I forget to run document-project? + +Workflows will lack context about existing code. You may get: + +- Suggestions that don't match existing patterns +- Integration approaches that miss existing APIs +- Architecture that conflicts with current structure + +Run document-project and restart planning with proper context. + +### Can I use Quick Spec Flow for brownfield projects? + +Yes! Quick Spec Flow works great for brownfield. It will: + +- Auto-detect your existing stack +- Analyze brownfield code patterns +- Detect conventions and ask for confirmation +- Generate context-rich tech-spec that respects existing code + +Perfect for bug fixes and small features in existing codebases. + +### How does workflow-init handle old planning docs? + +workflow-init asks about YOUR current work first, then uses old artifacts as context: + +1. Shows what it found (old PRD, epics, etc.) +2. Asks: "Is this work in progress, previous effort, or proposed work?" +3. If previous effort: Asks you to describe your NEW work +4. Determines level based on YOUR work, not old artifacts + +This prevents old Level 3 PRDs from forcing Level 3 workflow for a new Level 0 bug fix. + +### What if my existing code doesn't follow best practices? + +Quick Spec Flow detects your conventions and asks: "Should I follow these existing conventions?" You decide: + +- **Yes** → Maintain consistency with current codebase +- **No** → Establish new standards (document why in tech-spec) + +BMM respects your choice — it won't force modernization, but it will offer it. + +**Have a question not answered here?** Please [open an issue](https://github.com/bmad-code-org/BMAD-METHOD/issues) or ask in [Discord](https://discord.gg/gk8jAdXWmj) so we can add it! diff --git a/docs/explanation/faq/getting-started-faq.md b/docs/explanation/faq/getting-started-faq.md new file mode 100644 index 00000000..78b7c88e --- /dev/null +++ b/docs/explanation/faq/getting-started-faq.md @@ -0,0 +1,67 @@ +--- +title: "Getting Started FAQ" +description: Common questions about getting started with the BMad Method +--- + +Quick answers to common questions about getting started with the BMad Method. + +## Questions + +- [Why does BMad use so many tokens?](#why-does-bmad-use-so-many-tokens) +- [Do I always need to run workflow-init?](#do-i-always-need-to-run-workflow-init) +- [Why do I need fresh chats for each workflow?](#why-do-i-need-fresh-chats-for-each-workflow) +- [Can I skip workflow-status and just start working?](#can-i-skip-workflow-status-and-just-start-working) +- [What's the minimum I need to get started?](#whats-the-minimum-i-need-to-get-started) +- [How do I know if I'm in Phase 1, 2, 3, or 4?](#how-do-i-know-if-im-in-phase-1-2-3-or-4) + +### Why does BMad use so many tokens? + +BMad is not always the most token efficient approach, and that's by design. The checkpoints, story files, and retrospectives keep you in the loop so you can apply taste, judgment, and accumulated context that no agent has. Fully automated coding loops optimize for code velocity; BMad optimizes for decision quality. If you're building something you'll maintain for years, where user experience matters, where architectural choices compound—that tradeoff pays for itself. + +### Do I always need to run workflow-init? + +No, once you learn the flow you can go directly to workflows. However, workflow-init is helpful because it: + +- Determines your project's appropriate level automatically +- Creates the tracking status file +- Routes you to the correct starting workflow + +For experienced users: use the [Quick Start Guide](/docs/tutorials/getting-started/getting-started-bmadv6.md) to go directly to the right agent/workflow. + +### Why do I need fresh chats for each workflow? + +Context-intensive workflows (like brainstorming, PRD creation, architecture design) can cause AI hallucinations if run in sequence within the same chat. Starting fresh ensures the agent has maximum context capacity for each workflow. This is particularly important for: + +- Planning workflows (PRD, architecture) +- Analysis workflows (brainstorming, research) +- Complex story implementation + +Quick workflows like status checks can reuse chats safely. + +### Can I skip workflow-status and just start working? + +Yes, if you already know your project level and which workflow comes next. workflow-status is mainly useful for: + +- New projects (guides initial setup) +- When you're unsure what to do next +- After breaks in work (reminds you where you left off) +- Checking overall progress + +### What's the minimum I need to get started? + +For the fastest path: + +1. Install BMad Method: `npx bmad-method@alpha install` +2. For small changes: Load PM agent → run tech-spec → implement +3. For larger projects: Load PM agent → run prd → architect → implement + +### How do I know if I'm in Phase 1, 2, 3, or 4? + +Check your `bmm-workflow-status.md` file (created by workflow-init). It shows your current phase and progress. If you don't have this file, you can also tell by what you're working on: + +- **Phase 1** — Brainstorming, research, product brief (optional) +- **Phase 2** — Creating either a PRD or tech-spec (always required) +- **Phase 3** — Architecture design (Level 2-4 only) +- **Phase 4** — Actually writing code, implementing stories + +**Have a question not answered here?** Please [open an issue](https://github.com/bmad-code-org/BMAD-METHOD/issues) or ask in [Discord](https://discord.gg/gk8jAdXWmj) so we can add it! diff --git a/docs/explanation/faq/implementation-faq.md b/docs/explanation/faq/implementation-faq.md new file mode 100644 index 00000000..fe4f64cb --- /dev/null +++ b/docs/explanation/faq/implementation-faq.md @@ -0,0 +1,52 @@ +--- +title: "Implementation FAQ" +description: Common questions about implementation in the BMad Method +--- + +Quick answers to common questions about implementation in the BMad Method. + +## Questions + +- [Does create-story include implementation context?](#does-create-story-include-implementation-context) +- [How do I mark a story as done?](#how-do-i-mark-a-story-as-done) +- [Can I work on multiple stories at once?](#can-i-work-on-multiple-stories-at-once) +- [What if my story takes longer than estimated?](#what-if-my-story-takes-longer-than-estimated) +- [When should I run retrospective?](#when-should-i-run-retrospective) + +### Does create-story include implementation context? + +Yes! The create-story workflow generates story files that include implementation-specific guidance, references existing patterns from your documentation, and provides technical context. The workflow loads your architecture, PRD, and existing project documentation to create comprehensive stories. For Quick Flow projects using tech-spec, the tech-spec itself is already comprehensive, so stories can be simpler. + +### How do I mark a story as done? + +After dev-story completes and code-review passes: + +1. Open `sprint-status.yaml` (created by sprint-planning) +2. Change the story status from `review` to `done` +3. Save the file + +### Can I work on multiple stories at once? + +Yes, if you have capacity! Stories within different epics can be worked in parallel. However, stories within the same epic are usually sequential because they build on each other. + +### What if my story takes longer than estimated? + +That's normal! Stories are estimates. If implementation reveals more complexity: + +1. Continue working until DoD is met +2. Consider if story should be split +3. Document learnings in retrospective +4. Adjust future estimates based on this learning + +### When should I run retrospective? + +After completing all stories in an epic (when epic is done). Retrospectives capture: + +- What went well +- What could improve +- Technical insights +- Learnings for future epics + +Don't wait until project end — run after each epic for continuous improvement. + +**Have a question not answered here?** Please [open an issue](https://github.com/bmad-code-org/BMAD-METHOD/issues) or ask in [Discord](https://discord.gg/gk8jAdXWmj) so we can add it! diff --git a/docs/explanation/faq/index.md b/docs/explanation/faq/index.md new file mode 100644 index 00000000..2ccd7d3a --- /dev/null +++ b/docs/explanation/faq/index.md @@ -0,0 +1,16 @@ +--- +title: "Frequently Asked Questions" +description: Frequently asked questions about the BMad Method +--- + +Quick answers to common questions about the BMad Method, organized by topic. + +## Topics + +- [Getting Started](/docs/explanation/faq/getting-started-faq.md) - Questions about starting with BMad +- [Levels & Tracks](/docs/explanation/faq/levels-and-tracks-faq.md) - Choosing the right level +- [Workflows](/docs/explanation/faq/workflows-faq.md) - Workflow and phase questions +- [Planning](/docs/explanation/faq/planning-faq.md) - Planning document questions +- [Implementation](/docs/explanation/faq/implementation-faq.md) - Implementation questions +- [Brownfield](/docs/explanation/faq/brownfield-faq.md) - Existing codebase questions +- [Tools & Advanced](/docs/explanation/faq/tools-faq.md) - Tools, IDEs, and advanced topics diff --git a/docs/explanation/faq/levels-and-tracks-faq.md b/docs/explanation/faq/levels-and-tracks-faq.md new file mode 100644 index 00000000..acce6ae1 --- /dev/null +++ b/docs/explanation/faq/levels-and-tracks-faq.md @@ -0,0 +1,52 @@ +--- +title: "Levels and Tracks FAQ" +description: Common questions about choosing the right level for your project +--- + +Quick answers to common questions about choosing the right level for your BMad Method project. + +## Questions + +- [How do I know which level my project is?](#how-do-i-know-which-level-my-project-is) +- [Can I change levels mid-project?](#can-i-change-levels-mid-project) +- [What if workflow-init suggests the wrong level?](#what-if-workflow-init-suggests-the-wrong-level) +- [Do I always need architecture for Level 2?](#do-i-always-need-architecture-for-level-2) +- [What's the difference between Level 1 and Level 2?](#whats-the-difference-between-level-1-and-level-2) + +### How do I know which level my project is? + +Use workflow-init for automatic detection, or self-assess using these keywords: + +- **Level 0** — "fix", "bug", "typo", "small change", "patch" → 1 story +- **Level 1** — "simple", "basic", "small feature", "add" → 1-10 stories +- **Level 2** — "dashboard", "several features", "admin panel" → 5-15 stories +- **Level 3** — "platform", "integration", "complex", "system" → 12-40 stories +- **Level 4** — "enterprise", "multi-tenant", "multiple products" → 40+ stories + +When in doubt, start smaller. You can always run create-prd later if needed. + +### Can I change levels mid-project? + +Yes! If you started at Level 1 but realize it's Level 2, you can run create-prd to add proper planning docs. The system is flexible — your initial level choice isn't permanent. + +### What if workflow-init suggests the wrong level? + +You can override it! workflow-init suggests a level but always asks for confirmation. If you disagree, just say so and choose the level you think is appropriate. Trust your judgment. + +### Do I always need architecture for Level 2? + +No, architecture is **optional** for Level 2. Only create architecture if you need system-level design. Many Level 2 projects work fine with just PRD created during planning. + +### What's the difference between Level 1 and Level 2? + +- **Level 1** — 1-10 stories, uses tech-spec (simpler, faster), no architecture +- **Level 2** — 5-15 stories, uses PRD (product-focused), optional architecture + +The overlap (5-10 stories) is intentional. Choose based on: + +- Need product-level planning? → Level 2 +- Just need technical plan? → Level 1 +- Multiple epics? → Level 2 +- Single epic? → Level 1 + +**Have a question not answered here?** Please [open an issue](https://github.com/bmad-code-org/BMAD-METHOD/issues) or ask in [Discord](https://discord.gg/gk8jAdXWmj) so we can add it! diff --git a/docs/explanation/faq/planning-faq.md b/docs/explanation/faq/planning-faq.md new file mode 100644 index 00000000..c6ab49fe --- /dev/null +++ b/docs/explanation/faq/planning-faq.md @@ -0,0 +1,41 @@ +--- +title: "Planning Documents FAQ" +description: Common questions about planning documents in the BMad Method +--- + +Quick answers to common questions about planning documents in the BMad Method. + +## Questions + +- [Why no tech-spec at Level 2+?](#why-no-tech-spec-at-level-2) +- [Do I need a PRD for a bug fix?](#do-i-need-a-prd-for-a-bug-fix) +- [Can I skip the product brief?](#can-i-skip-the-product-brief) + +### Why no tech-spec at Level 2+? + +Level 2+ projects need product-level planning (PRD) and system-level design (Architecture), which tech-spec doesn't provide. Tech-spec is too narrow for coordinating multiple features. Instead, Level 2-4 uses: + +- PRD (product vision, functional requirements, non-functional requirements) +- Architecture (system design) +- Epics+Stories (created AFTER architecture is complete) + +### Do I need a PRD for a bug fix? + +No! Bug fixes are typically Level 0 (single atomic change). Use Quick Spec Flow: + +- Load PM agent +- Run tech-spec workflow +- Implement immediately + +PRDs are for Level 2-4 projects with multiple features requiring product-level coordination. + +### Can I skip the product brief? + +Yes, product brief is always optional. It's most valuable for: + +- Level 3-4 projects needing strategic direction +- Projects with stakeholders requiring alignment +- Novel products needing market research +- When you want to explore solution space before committing + +**Have a question not answered here?** Please [open an issue](https://github.com/bmad-code-org/BMAD-METHOD/issues) or ask in [Discord](https://discord.gg/gk8jAdXWmj) so we can add it! diff --git a/docs/explanation/faq/tools-faq.md b/docs/explanation/faq/tools-faq.md new file mode 100644 index 00000000..215d90e3 --- /dev/null +++ b/docs/explanation/faq/tools-faq.md @@ -0,0 +1,253 @@ +--- +title: "Tools and Advanced FAQ" +description: Common questions about tools, IDEs, and advanced topics in the BMad Method +--- + +Quick answers to common questions about tools, IDEs, and advanced topics in the BMad Method. + +## Questions + +**Tools and Technical** + +- [Why are my Mermaid diagrams not rendering?](#why-are-my-mermaid-diagrams-not-rendering) +- [Can I use BMM with GitHub Copilot / Cursor / other AI tools?](#can-i-use-bmm-with-github-copilot--cursor--other-ai-tools) +- [What IDEs/tools support BMM?](#what-idestools-support-bmm) +- [Can I customize agents?](#can-i-customize-agents) +- [What happens to my planning docs after implementation?](#what-happens-to-my-planning-docs-after-implementation) +- [Can I use BMM for non-software projects?](#can-i-use-bmm-for-non-software-projects) + +**Advanced** + +- [What if my project grows from Level 1 to Level 3?](#what-if-my-project-grows-from-level-1-to-level-3) +- [Can I mix greenfield and brownfield approaches?](#can-i-mix-greenfield-and-brownfield-approaches) +- [How do I handle urgent hotfixes during a sprint?](#how-do-i-handle-urgent-hotfixes-during-a-sprint) +- [What if I disagree with the workflow's recommendations?](#what-if-i-disagree-with-the-workflows-recommendations) +- [Can multiple developers work on the same BMM project?](#can-multiple-developers-work-on-the-same-bmm-project) +- [What is party mode and when should I use it?](#what-is-party-mode-and-when-should-i-use-it) + +**Getting Help** + +- [Where do I get help if my question isn't answered here?](#where-do-i-get-help-if-my-question-isnt-answered-here) +- [How do I report a bug or request a feature?](#how-do-i-report-a-bug-or-request-a-feature) + +## Tools and Technical + +### Why are my Mermaid diagrams not rendering? + +Common issues: + +1. Missing language tag: Use ` ```mermaid` not just ` ``` ` +2. Syntax errors in diagram (validate at mermaid.live) +3. Tool doesn't support Mermaid (check your Markdown renderer) + +All BMM docs use valid Mermaid syntax that should render in GitHub, VS Code, and most IDEs. + +### Can I use BMM with GitHub Copilot / Cursor / other AI tools? + +Yes! BMM is complementary. BMM handles: + +- Project planning and structure +- Workflow orchestration +- Agent Personas and expertise +- Documentation generation +- Quality gates + +Your AI coding assistant handles: + +- Line-by-line code completion +- Quick refactoring +- Test generation + +Use them together for best results. + +### What IDEs/tools support BMM? + +BMM requires tools with **agent mode** and access to **high-quality LLM models** that can load and follow complex workflows, then properly implement code changes. + +**Recommended Tools:** + +- **Claude Code** — Best choice + - Sonnet 4.5 (excellent workflow following, coding, reasoning) + - Opus (maximum context, complex planning) + - Native agent mode designed for BMM workflows + +- **Cursor** + - Supports Anthropic (Claude) and OpenAI models + - Agent mode with composer + - Good for developers who prefer Cursor's UX + +- **Windsurf** + - Multi-model support + - Agent capabilities + - Suitable for BMM workflows + +**What Matters:** + +1. **Agent mode** — Can load long workflow instructions and maintain context +2. **High-quality LLM** — Models ranked high on SWE-bench (coding benchmarks) +3. **Model selection** — Access to Claude Sonnet 4.5, Opus, or GPT-4o class models +4. **Context capacity** — Can handle large planning documents and codebases + +**Why model quality matters:** BMM workflows require LLMs that can follow multi-step processes, maintain context across phases, and implement code that adheres to specifications. Tools with weaker models will struggle with workflow adherence and code quality. + +### Can I customize agents? + +Yes! Agents are installed as markdown files with XML-style content (optimized for LLMs, readable by any model). Create customization files in `_bmad/_config/agents/[agent-name].customize.yaml` to override default behaviors while keeping core functionality intact. See agent documentation for customization options. + +**Note:** While source agents in this repo are YAML, they install as `.md` files with XML-style tags — a format any LLM can read and follow. + +### What happens to my planning docs after implementation? + +Keep them! They serve as: + +- Historical record of decisions +- Onboarding material for new team members +- Reference for future enhancements +- Audit trail for compliance + +For enterprise projects (Level 4), consider archiving completed planning artifacts to keep workspace clean. + +### Can I use BMM for non-software projects? + +BMM is optimized for software development, but the methodology principles (scale-adaptive planning, just-in-time design, context injection) can apply to other complex project types. You'd need to adapt workflows and agents for your domain. + +## Advanced + +### What if my project grows from Level 1 to Level 3? + +Totally fine! When you realize scope has grown: + +1. Run create-prd to add product-level planning +2. Run create-architecture for system design +3. Use existing tech-spec as input for PRD +4. Continue with updated level + +The system is flexible — growth is expected. + +### Can I mix greenfield and brownfield approaches? + +Yes! Common scenario: adding new greenfield feature to brownfield codebase. Approach: + +1. Run document-project for brownfield context +2. Use greenfield workflows for new feature planning +3. Explicitly document integration points between new and existing +4. Test integration thoroughly + +### How do I handle urgent hotfixes during a sprint? + +Use correct-course workflow or just: + +1. Save your current work state +2. Load PM agent → quick tech-spec for hotfix +3. Implement hotfix (Level 0 flow) +4. Deploy hotfix +5. Return to original sprint work + +Level 0 Quick Spec Flow is perfect for urgent fixes. + +### What if I disagree with the workflow's recommendations? + +Workflows are guidance, not enforcement. If a workflow recommends something that doesn't make sense for your context: + +- Explain your reasoning to the agent +- Ask for alternative approaches +- Skip the recommendation if you're confident +- Document why you deviated (for future reference) + +Trust your expertise — BMM supports your decisions. + +### Can multiple developers work on the same BMM project? + +Yes! But the paradigm is fundamentally different from traditional agile teams. + +**Key Difference:** + +- **Traditional** — Multiple devs work on stories within one epic (months) +- **Agentic** — Each dev owns complete epics (days) + +**In traditional agile:** A team of 5 devs might spend 2-3 months on a single epic, with each dev owning different stories. + +**With BMM + AI agents:** A single dev can complete an entire epic in 1-3 days. What used to take months now takes days. + +**Team Work Distribution:** + +- **Recommended:** Split work by **epic** (not story) +- Each developer owns complete epics end-to-end +- Parallel work happens at epic level +- Minimal coordination needed + +**For full-stack apps:** + +- Frontend and backend can be separate epics (unusual in traditional agile) +- Frontend dev owns all frontend epics +- Backend dev owns all backend epics +- Works because delivery is so fast + +**Enterprise Considerations:** + +- Use **git submodules** for BMM installation (not .gitignore) +- Allows personal configurations without polluting main repo +- Teams may use different AI tools (Claude Code, Cursor, etc.) +- Developers may follow different methods or create custom agents/workflows + +**Quick Tips:** + +- Share `sprint-status.yaml` (single source of truth) +- Assign entire epics to developers (not individual stories) +- Coordinate at epic boundaries, not story level +- Use git submodules for BMM in enterprise settings + +### What is party mode and when should I use it? + +Party mode is a unique multi-agent collaboration feature where ALL your installed agents (19+ from BMM, CIS, BMB, custom modules) discuss your challenges together in real-time. + +**How it works:** + +1. Run `/bmad:core:workflows:party-mode` (or `*party-mode` from any agent) +2. Introduce your topic +3. BMad Master selects 2-3 most relevant agents per message +4. Agents cross-talk, debate, and build on each other's ideas + +**Best for:** + +- Strategic decisions with trade-offs (architecture choices, tech stack, scope) +- Creative brainstorming (game design, product innovation, UX ideation) +- Cross-functional alignment (epic kickoffs, retrospectives, phase transitions) +- Complex problem-solving (multi-faceted challenges, risk assessment) + +**Example parties:** + +- **Product Strategy** — PM + Innovation Strategist (CIS) + Analyst +- **Technical Design** — Architect + Creative Problem Solver (CIS) + Game Architect +- **User Experience** — UX Designer + Design Thinking Coach (CIS) + Storyteller (CIS) + +**Why it's powerful:** + +- Diverse perspectives (technical, creative, strategic) +- Healthy debate reveals blind spots +- Emergent insights from agent interaction +- Natural collaboration across modules + +**For complete documentation:** See the [Party Mode Guide](/docs/explanation/features/party-mode.md) + +## Getting Help + +### Where do I get help if my question isn't answered here? + +1. Search [Complete Documentation](https://github.com/bmad-code-org/BMAD-METHOD/blob/main/README.md) for related topics +2. Ask in [Discord Community](https://discord.gg/gk8jAdXWmj) (#bmad-method-help) +3. Open a [GitHub Issue](https://github.com/bmad-code-org/BMAD-METHOD/issues) +4. Watch [YouTube Tutorials](https://www.youtube.com/@BMadCode) + +### How do I report a bug or request a feature? + +Open a GitHub issue at: + +Please include: + +- BMM version (check your installed version) +- Steps to reproduce (for bugs) +- Expected vs actual behavior +- Relevant workflow or agent involved + +**Have a question not answered here?** Please [open an issue](https://github.com/bmad-code-org/BMAD-METHOD/issues) or ask in [Discord](https://discord.gg/gk8jAdXWmj) so we can add it! diff --git a/docs/explanation/faq/workflows-faq.md b/docs/explanation/faq/workflows-faq.md new file mode 100644 index 00000000..9e92121f --- /dev/null +++ b/docs/explanation/faq/workflows-faq.md @@ -0,0 +1,61 @@ +--- +title: "Workflows FAQ" +description: Common questions about BMad Method workflows and phases +--- + +Quick answers to common questions about BMad Method workflows and phases. + +## Questions + +- [What's the difference between workflow-status and workflow-init?](#whats-the-difference-between-workflow-status-and-workflow-init) +- [Can I skip Phase 1 (Analysis)?](#can-i-skip-phase-1-analysis) +- [When is Phase 3 (Architecture) required?](#when-is-phase-3-architecture-required) +- [What happens if I skip a recommended workflow?](#what-happens-if-i-skip-a-recommended-workflow) +- [How do I know when Phase 3 is complete?](#how-do-i-know-when-phase-3-is-complete) +- [Can I run workflows in parallel?](#can-i-run-workflows-in-parallel) + +### What's the difference between workflow-status and workflow-init? + +- **workflow-status** — Checks existing status and tells you what's next (use when continuing work) +- **workflow-init** — Creates new status file and sets up project (use when starting new project) + +If status file exists, use workflow-status. If not, use workflow-init. + +### Can I skip Phase 1 (Analysis)? + +Yes! Phase 1 is optional for all levels, though recommended for complex projects. Skip if: + +- Requirements are clear +- No research needed +- Time-sensitive work +- Small changes (Level 0-1) + +### When is Phase 3 (Architecture) required? + +- **Level 0-1** — Never (skip entirely) +- **Level 2** — Optional (only if system design needed) +- **Level 3-4** — Required (comprehensive architecture mandatory) + +### What happens if I skip a recommended workflow? + +Nothing breaks! Workflows are guidance, not enforcement. However, skipping recommended workflows (like architecture for Level 3) may cause: + +- Integration issues during implementation +- Rework due to poor planning +- Conflicting design decisions +- Longer development time overall + +### How do I know when Phase 3 is complete? + +For Level 3-4, run the implementation-readiness workflow. It validates PRD + Architecture + Epics + UX (optional) are aligned before implementation. Pass the gate check = ready for Phase 4. + +### Can I run workflows in parallel? + +Most workflows must be sequential within a phase: + +- **Phase 1** — brainstorm → research → product-brief (optional order) +- **Phase 2** — PRD must complete before moving forward +- **Phase 3** — architecture → epics+stories → implementation-readiness (sequential) +- **Phase 4** — Stories within an epic should generally be sequential, but stories in different epics can be parallel if you have capacity + +**Have a question not answered here?** Please [open an issue](https://github.com/bmad-code-org/BMAD-METHOD/issues) or ask in [Discord](https://discord.gg/gk8jAdXWmj) so we can add it! diff --git a/docs/explanation/features/advanced-elicitation.md b/docs/explanation/features/advanced-elicitation.md new file mode 100644 index 00000000..0185977f --- /dev/null +++ b/docs/explanation/features/advanced-elicitation.md @@ -0,0 +1,95 @@ +--- +title: "Advanced Elicitation" +--- + +Push the LLM to rethink its work through 50+ reasoning methods — essentially, LLM brainstorming. + +Advanced Elicitation is the inverse of Brainstorming. Instead of pulling ideas out of you, the LLM applies sophisticated reasoning techniques to re-examine and enhance content it has just generated. It's the LLM brainstorming with itself to find better approaches, uncover hidden issues, and discover improvements it missed on the first pass. + +## When to Use It + +- After a workflow generates a section of content and you want to explore alternatives +- When the LLM's initial output seems adequate but you suspect there's more depth available +- For high-stakes content where multiple perspectives would strengthen the result +- To stress-test assumptions, explore edge cases, or find weaknesses in generated plans +- When you want the LLM to "think again" but with structured reasoning methods + +## How It Works + +### 1. Context Analysis +The LLM analyzes the current content, understanding its type, complexity, stakeholder needs, risk level, and creative potential. + +### 2. Smart Method Selection +Based on context, 5 methods are intelligently selected from a library of 50+ techniques and presented to you: + +| Option | Description | +| ----------------- | ---------------------------------------- | +| **1-5** | Apply the selected method to the content | +| **[r] Reshuffle** | Get 5 new methods selected randomly | +| **[a] List All** | Browse the complete method library | +| **[x] Proceed** | Continue with enhanced content | + +### 3. Method Execution & Iteration +- The selected method is applied to the current content +- Improvements are shown for your review +- You choose whether to apply changes or discard them +- The menu re-appears for additional elicitations +- Each method builds on previous enhancements + +### 4. Party Mode Integration (Optional) +If Party Mode is active, BMad agents participate randomly in the elicitation process, adding their unique perspectives to the methods. + +## Method Categories + +| Category | Focus | Example Methods | +| ----------------- | ----------------------------------- | -------------------------------------------------------------- | +| **Core** | Foundational reasoning techniques | First Principles Analysis, 5 Whys, Socratic Questioning | +| **Collaboration** | Multiple perspectives and synthesis | Stakeholder Round Table, Expert Panel Review, Debate Club | +| **Advanced** | Complex reasoning frameworks | Tree of Thoughts, Graph of Thoughts, Self-Consistency | +| **Competitive** | Adversarial stress-testing | Red Team vs Blue Team, Shark Tank Pitch, Code Review Gauntlet | +| **Technical** | Architecture and code quality | Decision Records, Rubber Duck Debugging, Algorithm Olympics | +| **Creative** | Innovation and lateral thinking | SCAMPER, Reverse Engineering, Random Input Stimulus | +| **Research** | Evidence-based analysis | Literature Review Personas, Thesis Defense, Comparative Matrix | +| **Risk** | Risk identification and mitigation | Pre-mortem Analysis, Failure Mode Analysis, Chaos Monkey | +| **Learning** | Understanding verification | Feynman Technique, Active Recall Testing | +| **Philosophical** | Conceptual clarity | Occam's Razor, Ethical Dilemmas | +| **Retrospective** | Reflection and lessons | Hindsight Reflection, Lessons Learned Extraction | + +## Key Features + +- **50+ reasoning methods** — Spanning core logic to advanced multi-step reasoning frameworks +- **Smart context selection** — Methods chosen based on content type, complexity, and stakeholder needs +- **Iterative enhancement** — Each method builds on previous improvements +- **User control** — Accept or discard each enhancement before proceeding +- **Party Mode integration** — Agents can participate when Party Mode is active + +## Workflow Integration + +Advanced Elicitation is a core workflow designed to be invoked by other workflows during content generation: + +| Parameter | Description | +| ---------------------- | --------------------------------------------------------- | +| **Content to enhance** | The current section content that was just generated | +| **Context type** | The kind of content being created (spec, code, doc, etc.) | +| **Enhancement goals** | What the calling workflow wants to improve | + +### Integration Flow + +When called from a workflow: +1. Receives the current section content that was just generated +2. Applies elicitation methods iteratively to enhance that content +3. Returns the enhanced version when user selects 'x' to proceed +4. The enhanced content replaces the original section in the output document + +### Example + +A specification generation workflow could invoke Advanced Elicitation after producing each major section (requirements, architecture, implementation plan). The workflow would pass the generated section, and Advanced Elicitation would offer methods like "Stakeholder Round Table" to gather diverse perspectives on requirements, or "Red Team vs Blue Team" to stress-test the architecture for vulnerabilities. + +## Advanced Elicitation vs. Brainstorming + +| | **Advanced Elicitation** | **Brainstorming** | +| ------------ | ------------------------------------------------- | --------------------------------------------- | +| **Source** | LLM generates ideas through structured reasoning | User provides ideas, AI coaches them out | +| **Purpose** | Rethink and improve LLM's own output | Unlock user's creativity | +| **Methods** | 50+ reasoning and analysis techniques | 60+ ideation and creativity techniques | +| **Best for** | Enhancing generated content, finding alternatives | Breaking through blocks, generating new ideas | diff --git a/docs/explanation/features/brainstorming-techniques.md b/docs/explanation/features/brainstorming-techniques.md new file mode 100644 index 00000000..704ddb3a --- /dev/null +++ b/docs/explanation/features/brainstorming-techniques.md @@ -0,0 +1,92 @@ +--- +title: "Brainstorming" +--- + +Facilitate structured creative sessions using 60+ proven ideation techniques. + +The Brainstorming workflow is an interactive facilitation system that helps you unlock your own creativity. The AI acts as coach, guide, and creative partner — using proven techniques to draw out ideas and insights that are already within you. + +:::note[Important] +Every idea comes from you. The workflow creates the conditions for your best thinking to emerge through guided exploration, but you are the source. +::: + +## When to Use It + +- Breaking through creative blocks on a specific challenge +- Generating innovative ideas for products, features, or solutions +- Exploring a problem from completely new angles +- Systematically developing ideas from raw concepts to actionable plans +- Team ideation (with collaborative techniques) or personal creative exploration + +## How It Works + +### 1. Session Setup +Define your topic, goals, and any constraints. + +### 2. Choose Your Approach + +| Approach | Description | +|----------|-------------| +| **User-Selected** | Browse the full technique library and pick what appeals to you | +| **AI-Recommended** | Get customized technique suggestions based on your goals | +| **Random Selection** | Discover unexpected methods through serendipitous technique combinations | +| **Progressive Flow** | Journey systematically from expansive exploration to focused action planning | + +### 3. Interactive Facilitation +Work through techniques with true collaborative coaching. The AI asks probing questions, builds on your ideas, and helps you think deeper—but your ideas are the source. + +### 4. Idea Organization +All your generated ideas are organized into themes and prioritized. + +### 5. Action Planning +Top ideas get concrete next steps, resource requirements, and success metrics. + +## What You Get + +A comprehensive session document that captures the entire journey: + +- Topic, goals, and session parameters +- Each technique used and how it was applied +- Your contributions and the ideas you generated +- Thematic organization connecting related insights +- Prioritized ideas with action plans +- Session highlights and key breakthroughs + +This document becomes a permanent record of your creative process — valuable for future reference, sharing with stakeholders, or continuing the session later. + +## Technique Categories + +| Category | Focus | +|----------|-------| +| **Collaborative** | Team dynamics and inclusive participation | +| **Creative** | Breakthrough thinking and paradigm shifts | +| **Deep** | Root cause analysis and strategic insight | +| **Structured** | Organized frameworks and systematic exploration | +| **Theatrical** | Playful, radical perspectives | +| **Wild** | Boundary-pushing, extreme thinking | +| **Biomimetic** | Nature-inspired solutions | +| **Quantum** | Quantum principles for innovation | +| **Cultural** | Traditional knowledge and cross-cultural approaches | +| **Introspective Delight** | Inner wisdom and authentic exploration | + +## Key Features + +- **Interactive coaching** — Pulls ideas *out* of you, doesn't generate them for you +- **On-demand loading** — Techniques loaded from a comprehensive library as needed +- **Session preservation** — Every step, insight, and action plan is documented +- **Continuation support** — Pause sessions and return later, or extend with additional techniques + +## Workflow Integration + +Brainstorming is a core workflow designed to be invoked and configured by other modules. When called from another workflow, it accepts contextual parameters: + +| Parameter | Description | +|-----------|-------------| +| **Topic focus** | What the brainstorming should help discover or solve | +| **Guardrails** | Constraints, boundaries, or must-avoid areas | +| **Output goals** | What the final output needs to accomplish for the calling workflow | +| **Context files** | Project-specific guidance to inform technique selection | + +### Example + +When creating a new module in the BMad Builder workflow, Brainstorming can be invoked with guardrails around the module's purpose and a goal to discover key features, user needs, or architectural considerations. The session becomes focused on producing exactly what the module creation workflow needs. diff --git a/docs/explanation/features/party-mode.md b/docs/explanation/features/party-mode.md new file mode 100644 index 00000000..1ff6d5cf --- /dev/null +++ b/docs/explanation/features/party-mode.md @@ -0,0 +1,95 @@ +--- +title: "Party Mode: Multi-Agent Collaboration" +--- + +Get all your AI agents in one conversation. + +## What is Party Mode? + +Ever wanted to gather your entire AI team in one room and see what happens? That's party mode. + +Type `/bmad:core:workflows:party-mode` (or `*party-mode` from any agent or at key workflow junctions when asked), and suddenly you've got **all your AI agents** in one conversation. PM, Architect, DEV, UX Designer and more that you can choose from. + +**Why it's useful:** + +- **After complex workflows** - Debrief with the whole team about what worked, what didn't +- **Big decisions with tradeoffs** - Get technical, creative, and strategic perspectives simultaneously +- **Brainstorming sessions** - Watch ideas evolve through cross-pollination +- **When things go wrong** - Call out failures, watch agents defend their decisions, let them debate whose fault it was (oddly therapeutic) +- **Sprint retrospectives** - Party mode powers the retrospective workflow +- **Sprint planning** - Multi-agent collaboration for planning sessions + +## How It Works + +**The basics:** + +1. Party mode reads `_bmad/_config/agent-manifest.csv` +2. Loads ALL installed agents (already includes your customizations from install) +3. BMad Master orchestrates - picks 2-3 relevant agents per message based on topic +4. Agents respond in character, can agree/disagree/build on each other's ideas +5. Discussion continues until you type "exit" or reach natural conclusion + +**That's it.** No complex merging, no runtime magic. Just agents talking. + +## Quick Start + +```bash +/bmad:core:workflows:party-mode + +*party-mode + + +/bmad:core:workflows:party-mode and include also in the party Santa Clause and Einstein + +Ask questions, respond to agents, direct the conversation + +Type: exit +``` + +## Fun Examples + +### Example 1: Calling Out Bad Architecture + +**You:** "Okay team, our last sprint was a disaster. The authentication service went down three times. Who screwed this up?" + +**Architect (Winston):** "The design was sound - distributed authentication with proper fallbacks. If implementation deviated from the spec..." + +**DEV (Amelia):** "I followed the architecture doc exactly. The spec didn't account for concurrent session invalidation race conditions." + +**PM (John):** "Both of you missed the bigger issue - we didn't validate session management requirements in the PRD. This is on me for not catching it." + +**TEA (Murat):** "And I should've caught this in integration tests. The test scenarios didn't cover concurrent invalidation." + +_(Watch them debate whose fault it really was - it's therapeutic)_ + +### Example 2: Creative Brainstorming + +**You:** "How do we make onboarding feel magical instead of boring?" + +**UX Designer (Sally):** "Start with progressive disclosure - reveal features as users need them, not all at once in a tutorial." + +**Storyteller (CIS):** "What if onboarding was a story? Each step reveals a character's journey - the user IS the hero." + +**Innovation Strategist (CIS):** "Take it further - gamify with unlockable achievements. But make them meaningful, not arbitrary badges." + +**Game Designer:** "Building on that - what if the first 'quest' is actually solving a real user problem? They learn by doing something valuable." + +_(Ideas cross-pollinate and evolve)_ + +### Example 3: Technical Decision + +**You:** "Monolith or microservices for MVP?" + +**Architect:** "Start monolith. Microservices add complexity you don't need at 1000 users." + +**PM:** "Agree. Time to market matters more than theoretical scalability." + +**DEV:** "Monolith with clear module boundaries. We can extract services later if needed." + +**Innovation Strategist:** "Contrarian take - if your differentiator IS scalability, build for it now. Otherwise Architect's right." + +_(Multiple perspectives reveal the right answer)_ + +:::tip[Better Decisions] +Better decisions through diverse perspectives. Welcome to party mode. +::: diff --git a/docs/explanation/features/quick-flow.md b/docs/explanation/features/quick-flow.md new file mode 100644 index 00000000..29857ef2 --- /dev/null +++ b/docs/explanation/features/quick-flow.md @@ -0,0 +1,149 @@ +--- +title: "Quick Spec Flow" +description: Understanding Quick Spec Flow for rapid development in BMad Method +--- + +Quick Spec Flow is a streamlined alternative to the full BMad Method for Quick Flow track projects. Instead of going through Product Brief → PRD → Architecture, you go straight to a context-aware technical specification and start coding. + +- **Perfect for:** Bug fixes, small features, rapid prototyping, and quick enhancements +- **Time to implementation:** Minutes, not hours + +## When to Use Quick Flow + +### Use Quick Flow when: + +- Single bug fix or small enhancement +- Small feature with clear scope (typically 1-15 stories) +- Rapid prototyping or experimentation +- Adding to existing brownfield codebase +- You know exactly what you want to build + +### Use BMad Method or Enterprise when: + +- Building new products or major features +- Need stakeholder alignment +- Complex multi-team coordination +- Requires extensive planning and architecture + +:::tip[Not Sure?] +Run `workflow-init` to get a recommendation based on your project's needs. +::: + +## Quick Flow Overview + +```mermaid +flowchart TD + START[Step 1: Run Tech-Spec Workflow] + DETECT[Detects project stack] + ANALYZE[Analyzes brownfield codebase] + TEST[Detects test frameworks] + CONFIRM[Confirms conventions] + GENERATE[Generates context-rich tech-spec] + STORIES[Creates ready-to-implement stories] + IMPL[Step 2: Implement with DEV Agent] + DONE[DONE!] + + START --> DETECT + DETECT --> ANALYZE + ANALYZE --> TEST + TEST --> CONFIRM + CONFIRM --> GENERATE + GENERATE --> STORIES + STORIES --> IMPL + IMPL --> DONE + + style START fill:#bfb,stroke:#333,stroke-width:2px + style IMPL fill:#bbf,stroke:#333,stroke-width:2px + style DONE fill:#f9f,stroke:#333,stroke-width:3px +``` + +## What Makes It Quick + +- No Product Brief needed +- No PRD needed +- No Architecture doc needed +- Auto-detects your stack +- Auto-analyzes brownfield code +- Auto-validates quality +- Story context optional (tech-spec is comprehensive) + +## Smart Context Discovery + +Quick Spec Flow automatically discovers and uses: + +### Existing Documentation +- Product briefs (if they exist) +- Research documents +- `document-project` output (brownfield codebase map) + +### Project Stack +- **Node.js:** package.json → frameworks, dependencies, scripts +- **Python:** requirements.txt, pyproject.toml → packages, tools +- **Ruby:** Gemfile → gems and versions +- **Java:** pom.xml, build.gradle → Maven/Gradle dependencies +- **Go:** go.mod → modules +- **Rust:** Cargo.toml → crates + +### Brownfield Code Patterns +- Directory structure and organization +- Existing code patterns (class-based, functional, MVC) +- Naming conventions +- Test frameworks and patterns +- Code style configurations + +### Convention Confirmation + +Quick Spec Flow detects your conventions and **asks for confirmation**: + +``` +I've detected these conventions in your codebase: + +Code Style: +- ESLint with Airbnb config +- Prettier with single quotes + +Test Patterns: +- Jest test framework +- .test.js file naming + +Should I follow these existing conventions? (yes/no) +``` + +**You decide:** Conform to existing patterns or establish new standards! + +## Auto-Validation + +Quick Spec Flow **automatically validates** everything: + +- Context gathering completeness +- Definitiveness (no "use X or Y" statements) +- Brownfield integration quality +- Stack alignment +- Implementation readiness + +## Comparison: Quick Flow vs Full BMM + +| Aspect | Quick Flow Track | BMad Method/Enterprise Tracks | +| --------------------- | ---------------------------- | ---------------------------------- | +| **Setup** | None (standalone) | workflow-init recommended | +| **Planning Docs** | tech-spec.md only | Product Brief → PRD → Architecture | +| **Time to Code** | Minutes | Hours to days | +| **Best For** | Bug fixes, small features | New products, major features | +| **Context Discovery** | Automatic | Manual + guided | +| **Validation** | Auto-validates everything | Manual validation steps | +| **Brownfield** | Auto-analyzes and conforms | Manual documentation required | + +## When to Graduate to BMad Method + +Start with Quick Flow, but switch to BMad Method when: + +- Project grows beyond initial scope +- Multiple teams need coordination +- Stakeholders need formal documentation +- Product vision is unclear +- Architectural decisions need deep analysis +- Compliance/regulatory requirements exist + +:::tip[Transition Tip] +You can always run `workflow-init` later to transition from Quick Flow to BMad Method. +::: diff --git a/docs/explanation/features/tea-overview.md b/docs/explanation/features/tea-overview.md new file mode 100644 index 00000000..3fb95ab5 --- /dev/null +++ b/docs/explanation/features/tea-overview.md @@ -0,0 +1,324 @@ +--- +title: "Test Architect (TEA) Overview" +description: Understanding the Test Architect (TEA) agent and its role in BMad Method +--- + + +The Test Architect (TEA) is a specialized agent focused on quality strategy, test automation, and release gates in BMad Method projects. + +:::tip[Design Philosophy] +TEA was built to solve AI-generated tests that rot in review. For the problem statement and design principles, see [Testing as Engineering](/docs/explanation/philosophy/testing-as-engineering.md). For setup, see [Setup Test Framework](/docs/how-to/workflows/setup-test-framework.md). +::: + +## Overview + +- **Persona:** Murat, Master Test Architect and Quality Advisor focused on risk-based testing, fixture architecture, ATDD, and CI/CD governance. +- **Mission:** Deliver actionable quality strategies, automation coverage, and gate decisions that scale with project complexity and compliance demands. +- **Use When:** BMad Method or Enterprise track projects, integration risk is non-trivial, brownfield regression risk exists, or compliance/NFR evidence is required. (Quick Flow projects typically don't require TEA) + +## Choose Your TEA Engagement Model + +BMad does not mandate TEA. There are five valid ways to use it (or skip it). Pick one intentionally. + +1. **No TEA** + - Skip all TEA workflows. Use your existing team testing approach. + +2. **TEA-only (Standalone)** + - Use TEA on a non-BMad project. Bring your own requirements, acceptance criteria, and environments. + - Typical sequence: `*test-design` (system or epic) -> `*atdd` and/or `*automate` -> optional `*test-review` -> `*trace` for coverage and gate decisions. + - Run `*framework` or `*ci` only if you want TEA to scaffold the harness or pipeline; they work best after you decide the stack/architecture. + +3. **Integrated: Greenfield - BMad Method (Simple/Standard Work)** + - Phase 3: system-level `*test-design`, then `*framework` and `*ci`. + - Phase 4: per-epic `*test-design`, optional `*atdd`, then `*automate` and optional `*test-review`. + - Gate (Phase 2): `*trace`. + +4. **Integrated: Brownfield - BMad Method or Enterprise (Simple or Complex)** + - Phase 2: baseline `*trace`. + - Phase 3: system-level `*test-design`, then `*framework` and `*ci`. + - Phase 4: per-epic `*test-design` focused on regression and integration risks. + - Gate (Phase 2): `*trace`; `*nfr-assess` (if not done earlier). + - For brownfield BMad Method, follow the same flow with `*nfr-assess` optional. + +5. **Integrated: Greenfield - Enterprise Method (Enterprise/Compliance Work)** + - Phase 2: `*nfr-assess`. + - Phase 3: system-level `*test-design`, then `*framework` and `*ci`. + - Phase 4: per-epic `*test-design`, plus `*atdd`/`*automate`/`*test-review`. + - Gate (Phase 2): `*trace`; archive artifacts as needed. + +If you are unsure, default to the integrated path for your track and adjust later. + +## TEA Command Catalog + +| Command | Primary Outputs | Notes | With Playwright MCP Enhancements | +| -------------- | --------------------------------------------------------------------------------------------- | ---------------------------------------------------- | ------------------------------------------------------------------------------------------------------------ | +| `*framework` | Playwright/Cypress scaffold, `.env.example`, `.nvmrc`, sample specs | Use when no production-ready harness exists | - | +| `*ci` | CI workflow, selective test scripts, secrets checklist | Platform-aware (GitHub Actions default) | - | +| `*test-design` | Combined risk assessment, mitigation plan, and coverage strategy | Risk scoring + optional exploratory mode | **+ Exploratory**: Interactive UI discovery with browser automation (uncover actual functionality) | +| `*atdd` | Failing acceptance tests + implementation checklist | TDD red phase + optional recording mode | **+ Recording**: AI generation verified with live browser (accurate selectors from real DOM) | +| `*automate` | Prioritized specs, fixtures, README/script updates, DoD summary | Optional healing/recording, avoid duplicate coverage | **+ Healing**: Pattern fixes enhanced with visual debugging + **+ Recording**: AI verified with live browser | +| `*test-review` | Test quality review report with 0-100 score, violations, fixes | Reviews tests against knowledge base patterns | - | +| `*nfr-assess` | NFR assessment report with actions | Focus on security/performance/reliability | - | +| `*trace` | Phase 1: Coverage matrix, recommendations. Phase 2: Gate decision (PASS/CONCERNS/FAIL/WAIVED) | Two-phase workflow: traceability + gate decision | - | + +## TEA Workflow Lifecycle + +**Phase Numbering Note:** BMad uses a 4-phase methodology with optional Phase 1 and a documentation prerequisite: + +- **Documentation** (Optional for brownfield): Prerequisite using `*document-project` +- **Phase 1** (Optional): Discovery/Analysis (`*brainstorm`, `*research`, `*product-brief`) +- **Phase 2** (Required): Planning (`*prd` creates PRD with FRs/NFRs) +- **Phase 3** (Track-dependent): Solutioning (`*architecture` → `*test-design` (system-level) → `*create-epics-and-stories` → TEA: `*framework`, `*ci` → `*implementation-readiness`) +- **Phase 4** (Required): Implementation (`*sprint-planning` → per-epic: `*test-design` → per-story: dev workflows) + +TEA integrates into the BMad development lifecycle during Solutioning (Phase 3) and Implementation (Phase 4): + +```mermaid +%%{init: {'theme':'base', 'themeVariables': { 'primaryColor':'#fff','primaryTextColor':'#000','primaryBorderColor':'#000','lineColor':'#000','secondaryColor':'#fff','tertiaryColor':'#fff','fontSize':'16px','fontFamily':'arial'}}}%% +graph TB + subgraph Phase2["Phase 2: PLANNING"] + PM["PM: *prd (creates PRD with FRs/NFRs)"] + PlanNote["Business requirements phase"] + NFR2["TEA: *nfr-assess (optional, enterprise)"] + PM -.-> NFR2 + NFR2 -.-> PlanNote + PM -.-> PlanNote + end + + subgraph Phase3["Phase 3: SOLUTIONING"] + Architecture["Architect: *architecture"] + EpicsStories["PM/Architect: *create-epics-and-stories"] + TestDesignSys["TEA: *test-design (system-level)"] + Framework["TEA: *framework (optional if needed)"] + CI["TEA: *ci (optional if needed)"] + GateCheck["Architect: *implementation-readiness"] + Architecture --> EpicsStories + Architecture --> TestDesignSys + TestDesignSys --> Framework + EpicsStories --> Framework + Framework --> CI + CI --> GateCheck + Phase3Note["Epics created AFTER architecture,
then system-level test design and test infrastructure setup"] + EpicsStories -.-> Phase3Note + end + + subgraph Phase4["Phase 4: IMPLEMENTATION - Per Epic Cycle"] + SprintPlan["SM: *sprint-planning"] + TestDesign["TEA: *test-design (per epic)"] + CreateStory["SM: *create-story"] + ATDD["TEA: *atdd (optional, before dev)"] + DevImpl["DEV: implements story"] + Automate["TEA: *automate"] + TestReview1["TEA: *test-review (optional)"] + Trace1["TEA: *trace (refresh coverage)"] + + SprintPlan --> TestDesign + TestDesign --> CreateStory + CreateStory --> ATDD + ATDD --> DevImpl + DevImpl --> Automate + Automate --> TestReview1 + TestReview1 --> Trace1 + Trace1 -.->|next story| CreateStory + TestDesignNote["Test design: 'How do I test THIS epic?'
Creates test-design-epic-N.md per epic"] + TestDesign -.-> TestDesignNote + end + + subgraph Gate["EPIC/RELEASE GATE"] + NFR["TEA: *nfr-assess (if not done earlier)"] + TestReview2["TEA: *test-review (final audit, optional)"] + TraceGate["TEA: *trace - Phase 2: Gate"] + GateDecision{"Gate Decision"} + + NFR --> TestReview2 + TestReview2 --> TraceGate + TraceGate --> GateDecision + GateDecision -->|PASS| Pass["PASS ✅"] + GateDecision -->|CONCERNS| Concerns["CONCERNS ⚠️"] + GateDecision -->|FAIL| Fail["FAIL ❌"] + GateDecision -->|WAIVED| Waived["WAIVED ⏭️"] + end + + Phase2 --> Phase3 + Phase3 --> Phase4 + Phase4 --> Gate + + style Phase2 fill:#bbdefb,stroke:#0d47a1,stroke-width:3px,color:#000 + style Phase3 fill:#c8e6c9,stroke:#2e7d32,stroke-width:3px,color:#000 + style Phase4 fill:#e1bee7,stroke:#4a148c,stroke-width:3px,color:#000 + style Gate fill:#ffe082,stroke:#f57c00,stroke-width:3px,color:#000 + style Pass fill:#4caf50,stroke:#1b5e20,stroke-width:3px,color:#000 + style Concerns fill:#ffc107,stroke:#f57f17,stroke-width:3px,color:#000 + style Fail fill:#f44336,stroke:#b71c1c,stroke-width:3px,color:#000 + style Waived fill:#9c27b0,stroke:#4a148c,stroke-width:3px,color:#000 +``` + +**TEA workflows:** `*framework` and `*ci` run once in Phase 3 after architecture. `*test-design` is **dual-mode**: + +- **System-level (Phase 3):** Run immediately after architecture/ADR drafting to produce `test-design-system.md` (testability review, ADR → test mapping, Architecturally Significant Requirements (ASRs), environment needs). Feeds the implementation-readiness gate. +- **Epic-level (Phase 4):** Run per-epic to produce `test-design-epic-N.md` (risk, priorities, coverage plan). + +The Quick Flow track skips Phases 1 and 3. +BMad Method and Enterprise use all phases based on project needs. +When an ADR or architecture draft is produced, run `*test-design` in **system-level** mode before the implementation-readiness gate. This ensures the ADR has an attached testability review and ADR → test mapping. Keep the test-design updated if ADRs change. + +## Why TEA Is Different from Other BMM Agents + +TEA spans multiple phases (Phase 3, Phase 4, and the release gate). Most BMM agents operate in a single phase. That multi-phase role is paired with a dedicated testing knowledge base so standards stay consistent across projects. + +### TEA's 8 Workflows Across Phases + +| Phase | TEA Workflows | Frequency | Purpose | +| ----------- | --------------------------------------------------------- | ---------------- | ---------------------------------------------- | +| **Phase 2** | (none) | - | Planning phase - PM defines requirements | +| **Phase 3** | \*test-design (system-level), \*framework, \*ci | Once per project | System testability review and test infrastructure setup | +| **Phase 4** | \*test-design, \*atdd, \*automate, \*test-review, \*trace | Per epic/story | Test planning per epic, then per-story testing | +| **Release** | \*nfr-assess, \*trace (Phase 2: gate) | Per epic/release | Go/no-go decision | + +**Note**: `*trace` is a two-phase workflow: Phase 1 (traceability) + Phase 2 (gate decision). This reduces cognitive load while maintaining natural workflow. + +### Why TEA Requires Its Own Knowledge Base + +TEA uniquely requires: + +- **Extensive domain knowledge**: Test patterns, CI/CD, fixtures, and quality practices +- **Cross-cutting concerns**: Standards that apply across all BMad projects (not just PRDs or stories) +- **Optional integrations**: Playwright-utils and MCP enhancements + +This architecture lets TEA maintain consistent, production-ready testing patterns while operating across multiple phases. + +## Track Cheat Sheets (Condensed) + +These cheat sheets map TEA workflows to the **BMad Method and Enterprise tracks** across the **4-Phase Methodology** (Phase 1: Analysis, Phase 2: Planning, Phase 3: Solutioning, Phase 4: Implementation). + +**Note:** The Quick Flow track typically doesn't require TEA (covered in Overview). These cheat sheets focus on BMad Method and Enterprise tracks where TEA adds value. + +**Legend for Track Deltas:** + +- ➕ = New workflow or phase added (doesn't exist in baseline) +- 🔄 = Modified focus (same workflow, different emphasis or purpose) +- 📦 = Additional output or archival requirement + +### Greenfield - BMad Method (Simple/Standard Work) + +**Planning Track:** BMad Method (PRD + Architecture) +**Use Case:** New projects with standard complexity + +| Workflow Stage | Test Architect | Dev / Team | Outputs | +| -------------------------- | ----------------------------------------------------------------- | ----------------------------------------------------------------------------------- | ---------------------------------------------------------- | +| **Phase 1**: Discovery | - | Analyst `*product-brief` (optional) | `product-brief.md` | +| **Phase 2**: Planning | - | PM `*prd` (creates PRD with FRs/NFRs) | PRD with functional/non-functional requirements | +| **Phase 3**: Solutioning | Run `*framework`, `*ci` AFTER architecture and epic creation | Architect `*architecture`, `*create-epics-and-stories`, `*implementation-readiness` | Architecture, epics/stories, test scaffold, CI pipeline | +| **Phase 4**: Sprint Start | - | SM `*sprint-planning` | Sprint status file with all epics and stories | +| **Phase 4**: Epic Planning | Run `*test-design` for THIS epic (per-epic test plan) | Review epic scope | `test-design-epic-N.md` with risk assessment and test plan | +| **Phase 4**: Story Dev | (Optional) `*atdd` before dev, then `*automate` after | SM `*create-story`, DEV implements | Tests, story implementation | +| **Phase 4**: Story Review | Execute `*test-review` (optional), re-run `*trace` | Address recommendations, update code/tests | Quality report, refreshed coverage matrix | +| **Phase 4**: Release Gate | (Optional) `*test-review` for final audit, Run `*trace` (Phase 2) | Confirm Definition of Done, share release notes | Quality audit, Gate YAML + release summary | + +**Key notes:** +- Run `*framework` and `*ci` once in Phase 3 after architecture. +- Run `*test-design` per epic in Phase 4; use `*atdd` before dev when helpful. +- Use `*trace` for gate decisions; `*test-review` is an optional audit. + +### Brownfield - BMad Method or Enterprise (Simple or Complex) + +**Planning Tracks:** BMad Method or Enterprise Method +**Use Case:** Existing codebases: simple additions (BMad Method) or complex enterprise requirements (Enterprise Method) + +**🔄 Brownfield Deltas from Greenfield:** + +- ➕ Documentation (Prerequisite) - Document existing codebase if undocumented +- ➕ Phase 2: `*trace` - Baseline existing test coverage before planning +- 🔄 Phase 4: `*test-design` - Focus on regression hotspots and brownfield risks +- 🔄 Phase 4: Story Review - May include `*nfr-assess` if not done earlier + +| Workflow Stage | Test Architect | Dev / Team | Outputs | +| --------------------------------- | --------------------------------------------------------------------------- | ----------------------------------------------------------------------------------- | ---------------------------------------------------------------------- | +| **Documentation**: Prerequisite ➕ | - | Analyst `*document-project` (if undocumented) | Comprehensive project documentation | +| **Phase 1**: Discovery | - | Analyst/PM/Architect rerun planning workflows | Updated planning artifacts in `{output_folder}` | +| **Phase 2**: Planning | Run ➕ `*trace` (baseline coverage) | PM `*prd` (creates PRD with FRs/NFRs) | PRD with FRs/NFRs, ➕ coverage baseline | +| **Phase 3**: Solutioning | Run `*framework`, `*ci` AFTER architecture and epic creation | Architect `*architecture`, `*create-epics-and-stories`, `*implementation-readiness` | Architecture, epics/stories, test framework, CI pipeline | +| **Phase 4**: Sprint Start | - | SM `*sprint-planning` | Sprint status file with all epics and stories | +| **Phase 4**: Epic Planning | Run `*test-design` for THIS epic 🔄 (regression hotspots) | Review epic scope and brownfield risks | `test-design-epic-N.md` with brownfield risk assessment and mitigation | +| **Phase 4**: Story Dev | (Optional) `*atdd` before dev, then `*automate` after | SM `*create-story`, DEV implements | Tests, story implementation | +| **Phase 4**: Story Review | Apply `*test-review` (optional), re-run `*trace`, ➕ `*nfr-assess` if needed | Resolve gaps, update docs/tests | Quality report, refreshed coverage matrix, NFR report | +| **Phase 4**: Release Gate | (Optional) `*test-review` for final audit, Run `*trace` (Phase 2) | Capture sign-offs, share release notes | Quality audit, Gate YAML + release summary | + +**Key notes:** +- Start with `*trace` in Phase 2 to baseline coverage. +- Focus `*test-design` on regression hotspots and integration risk. +- Run `*nfr-assess` before the gate if it wasn't done earlier. + +### Greenfield - Enterprise Method (Enterprise/Compliance Work) + +**Planning Track:** Enterprise Method (BMad Method + extended security/devops/test strategies) +**Use Case:** New enterprise projects with compliance, security, or complex regulatory requirements + +**🏢 Enterprise Deltas from BMad Method:** + +- ➕ Phase 1: `*research` - Domain and compliance research (recommended) +- ➕ Phase 2: `*nfr-assess` - Capture NFR requirements early (security/performance/reliability) +- 🔄 Phase 4: `*test-design` - Enterprise focus (compliance, security architecture alignment) +- 📦 Release Gate - Archive artifacts and compliance evidence for audits + +| Workflow Stage | Test Architect | Dev / Team | Outputs | +| -------------------------- | ----------------------------------------------------------------------- | ----------------------------------------------------------------------------------- | ------------------------------------------------------------------ | +| **Phase 1**: Discovery | - | Analyst ➕ `*research`, `*product-brief` | Domain research, compliance analysis, product brief | +| **Phase 2**: Planning | Run ➕ `*nfr-assess` | PM `*prd` (creates PRD with FRs/NFRs), UX `*create-ux-design` | Enterprise PRD with FRs/NFRs, UX design, ➕ NFR documentation | +| **Phase 3**: Solutioning | Run `*framework`, `*ci` AFTER architecture and epic creation | Architect `*architecture`, `*create-epics-and-stories`, `*implementation-readiness` | Architecture, epics/stories, test framework, CI pipeline | +| **Phase 4**: Sprint Start | - | SM `*sprint-planning` | Sprint plan with all epics | +| **Phase 4**: Epic Planning | Run `*test-design` for THIS epic 🔄 (compliance focus) | Review epic scope and compliance requirements | `test-design-epic-N.md` with security/performance/compliance focus | +| **Phase 4**: Story Dev | (Optional) `*atdd`, `*automate`, `*test-review`, `*trace` per story | SM `*create-story`, DEV implements | Tests, fixtures, quality reports, coverage matrices | +| **Phase 4**: Release Gate | Final `*test-review` audit, Run `*trace` (Phase 2), 📦 archive artifacts | Capture sign-offs, 📦 compliance evidence | Quality audit, updated assessments, gate YAML, 📦 audit trail | + +**Key notes:** +- Run `*nfr-assess` early in Phase 2. +- `*test-design` emphasizes compliance, security, and performance alignment. +- Archive artifacts at the release gate for audits. + +**Related how-to guides:** +- [How to Run Test Design](/docs/how-to/workflows/run-test-design.md) +- [How to Set Up a Test Framework](/docs/how-to/workflows/setup-test-framework.md) + +## Optional Integrations + +### Playwright Utils (`@seontechnologies/playwright-utils`) + +Production-ready fixtures and utilities that enhance TEA workflows. + +- Install: `npm install -D @seontechnologies/playwright-utils` +> Note: Playwright Utils is enabled via the installer. Only set `tea_use_playwright_utils` in `_bmad/bmm/config.yaml` if you need to override the installer choice. +- Impacts: `*framework`, `*atdd`, `*automate`, `*test-review`, `*ci` +- Utilities include: api-request, auth-session, network-recorder, intercept-network-call, recurse, log, file-utils, burn-in, network-error-monitor, fixtures-composition + +### Playwright MCP Enhancements + +Live browser verification for test design and automation. + +**Two Playwright MCP servers** (actively maintained, continuously updated): + +- `playwright` - Browser automation (`npx @playwright/mcp@latest`) +- `playwright-test` - Test runner with failure analysis (`npx playwright run-test-mcp-server`) + +**Configuration example**: + +```json +{ + "mcpServers": { + "playwright": { + "command": "npx", + "args": ["@playwright/mcp@latest"] + }, + "playwright-test": { + "command": "npx", + "args": ["playwright", "run-test-mcp-server"] + } + } +} +``` + +- Helps `*test-design` validate actual UI behavior. +- Helps `*atdd` and `*automate` verify selectors against the live DOM. +- Enhances healing with `browser_snapshot`, console, network, and locator tools. + +**To disable**: set `tea_use_mcp_enhancements: false` in `_bmad/bmm/config.yaml` or remove MCPs from IDE config. diff --git a/docs/explanation/features/web-bundles.md b/docs/explanation/features/web-bundles.md new file mode 100644 index 00000000..a3b1b522 --- /dev/null +++ b/docs/explanation/features/web-bundles.md @@ -0,0 +1,34 @@ +--- +title: "Web Bundles" +--- + +Use BMad agents in Gemini Gems and Custom GPTs. + +:::caution[Status] +The Web Bundling Feature is being rebuilt from the ground up. Current v6 bundles may be incomplete or missing functionality. +::: + +## What Are Web Bundles? + +Web bundles package BMad agents as self-contained files that work in Gemini Gems and Custom GPTs. Everything the agent needs - instructions, workflows, dependencies - is bundled into a single file for easy upload. + +### What's Included + +- Complete agent persona and instructions +- All workflows and dependencies +- Interactive menu system +- Party mode for multi-agent collaboration +- No external files required + +### Use Cases + +**Perfect for:** +- Uploading a single file to a Gemini GEM or Custom GPT +- Using BMad Method from the Web +- Cost savings (generally lower cost than local usage) +- Quick sharing of agent configurations + +**Trade-offs:** +- Some quality reduction vs local usage +- Less convenient than full local installation +- Limited to agent capabilities (no workflow file access) diff --git a/src/modules/bmgd/docs/agents-guide.md b/docs/explanation/game-dev/agents.md similarity index 89% rename from src/modules/bmgd/docs/agents-guide.md rename to docs/explanation/game-dev/agents.md index 40311984..1dcdbb32 100644 --- a/src/modules/bmgd/docs/agents-guide.md +++ b/docs/explanation/game-dev/agents.md @@ -1,25 +1,23 @@ -# BMGD Agents Guide +--- +title: "BMGD Agents Guide" +--- Complete reference for BMGD's six specialized game development agents. ---- - ## Agent Overview BMGD provides six agents, each with distinct expertise: -| Agent | Name | Role | Phase Focus | -| ------------------------ | ---------------- | ----------------------------------------------------------- | ----------- | -| 🎲 **Game Designer** | Samus Shepard | Lead Game Designer + Creative Vision Architect | Phases 1-2 | -| 🏛️ **Game Architect** | Cloud Dragonborn | Principal Game Systems Architect + Technical Director | Phase 3 | -| 🕹️ **Game Developer** | Link Freeman | Senior Game Developer + Technical Implementation Specialist | Phase 4 | -| 🎯 **Game Scrum Master** | Max | Game Development Scrum Master + Sprint Orchestrator | Phase 4 | -| 🧪 **Game QA** | GLaDOS | Game QA Architect + Test Automation Specialist | All Phases | -| 🎮 **Game Solo Dev** | Indie | Elite Indie Game Developer + Quick Flow Specialist | All Phases | +| Agent | Name | Role | Phase Focus | +|-------|------|------|-------------| +| **Game Designer** | Samus Shepard | Lead Game Designer + Creative Vision Architect | Phases 1-2 | +| **Game Architect** | Cloud Dragonborn | Principal Game Systems Architect + Technical Director | Phase 3 | +| **Game Developer** | Link Freeman | Senior Game Developer + Technical Implementation Specialist | Phase 4 | +| **Game Scrum Master** | Max | Game Development Scrum Master + Sprint Orchestrator | Phase 4 | +| **Game QA** | GLaDOS | Game QA Architect + Test Automation Specialist | All Phases | +| **Game Solo Dev** | Indie | Elite Indie Game Developer + Quick Flow Specialist | All Phases | ---- - -## 🎲 Game Designer (Samus Shepard) +## Game Designer (Samus Shepard) ### Role @@ -59,9 +57,7 @@ Talks like an excited streamer - enthusiastic, asks about player motivations, ce | `party-mode` | Multi-agent collaboration | | `advanced-elicitation` | Deep exploration (web only) | ---- - -## 🏛️ Game Architect (Cloud Dragonborn) +## Game Architect (Cloud Dragonborn) ### Role @@ -99,9 +95,7 @@ Speaks like a wise sage from an RPG - calm, measured, uses architectural metapho | `party-mode` | Multi-agent collaboration | | `advanced-elicitation` | Deep exploration (web only) | ---- - -## 🕹️ Game Developer (Link Freeman) +## Game Developer (Link Freeman) ### Role @@ -141,9 +135,7 @@ Speaks like a speedrunner - direct, milestone-focused, always optimizing for the | `party-mode` | Multi-agent collaboration | | `advanced-elicitation` | Deep exploration (web only) | ---- - -## 🎯 Game Scrum Master (Max) +## Game Scrum Master (Max) ### Role @@ -187,9 +179,7 @@ Talks in game terminology - milestones are save points, handoffs are level trans | `party-mode` | Multi-agent collaboration | | `advanced-elicitation` | Deep exploration (web only) | ---- - -## 🧪 Game QA (GLaDOS) +## Game QA (GLaDOS) ### Role @@ -262,9 +252,7 @@ GLaDOS has access to a comprehensive game testing knowledge base (`gametest/qa-i - Smoke testing - Test prioritization (P0-P3) ---- - -## 🎮 Game Solo Dev (Indie) +## Game Solo Dev (Indie) ### Role @@ -300,7 +288,7 @@ Direct, confident, and gameplay-focused. Uses dev slang, thinks in game feel and | ------------------ | ------------------------------------------------------ | | `quick-prototype` | Rapid prototype to test if a mechanic is fun | | `quick-dev` | Implement features end-to-end with game considerations | -| `create-tech-spec` | Create implementation-ready technical spec | +| `quick-spec` | Create implementation-ready technical spec | | `code-review` | Review code quality | | `test-framework` | Set up automated testing | | `party-mode` | Bring in specialists when needed | @@ -321,8 +309,6 @@ Use **Full BMGD workflow** when: - You're working with stakeholders/publishers - Long-term maintainability is critical ---- - ## Agent Selection Guide ### By Phase @@ -356,8 +342,6 @@ Use **Full BMGD workflow** when: | "Quick prototype this idea" | Game Solo Dev | | "Ship this feature fast" | Game Solo Dev | ---- - ## Multi-Agent Collaboration ### Party Mode @@ -388,8 +372,6 @@ Game QA integrates at multiple points: - During Implementation: Create automated tests - Before Release: Performance and certification testing ---- - ## Project Context All agents share the principle: @@ -398,10 +380,8 @@ All agents share the principle: The `project-context.md` file (if present) serves as the authoritative source for project decisions and constraints. ---- - ## Next Steps -- **[Quick Start Guide](./quick-start.md)** - Get started with BMGD -- **[Workflows Guide](./workflows-guide.md)** - Detailed workflow reference -- **[Game Types Guide](./game-types-guide.md)** - Game type templates +- **[Quick Start Guide](/docs/tutorials/getting-started/quick-start-bmgd.md)** - Get started with BMGD +- **[Workflows Guide](/docs/reference/workflows/index.md)** - Detailed workflow reference +- **[Game Types Guide](/docs/explanation/game-dev/game-types.md)** - Game type templates diff --git a/docs/explanation/game-dev/bmgd-vs-bmm.md b/docs/explanation/game-dev/bmgd-vs-bmm.md new file mode 100644 index 00000000..cbf16338 --- /dev/null +++ b/docs/explanation/game-dev/bmgd-vs-bmm.md @@ -0,0 +1,125 @@ +--- +title: "BMGD vs BMM" +description: Understanding the differences between BMGD and BMM +--- + +BMGD (BMad Game Development) extends BMM (BMad Method) with game-specific capabilities. This page explains the key differences. + +## Quick Comparison + +| Aspect | BMM | BMGD | +| -------------- | ------------------------------------- | ------------------------------------------------------------------------ | +| **Focus** | General software | Game development | +| **Agents** | PM, Architect, Dev, SM, TEA, Solo Dev | Game Designer, Game Dev, Game Architect, Game SM, Game QA, Game Solo Dev | +| **Planning** | PRD, Tech Spec | Game Brief, GDD | +| **Types** | N/A | 24 game type templates | +| **Narrative** | N/A | Full narrative workflow | +| **Testing** | Web-focused | Engine-specific (Unity, Unreal, Godot) | +| **Production** | BMM workflows | BMM workflows with game overrides | + +## Agent Differences + +### BMM Agents +- PM (Product Manager) +- Architect +- DEV (Developer) +- SM (Scrum Master) +- TEA (Test Architect) +- Quick Flow Solo Dev + +### BMGD Agents +- Game Designer +- Game Developer +- Game Architect +- Game Scrum Master +- Game QA +- Game Solo Dev + +BMGD agents understand game-specific concepts like: +- Game mechanics and balance +- Player psychology +- Engine-specific patterns +- Playtesting and QA + +## Planning Documents + +### BMM Planning +- **Product Brief** → **PRD** → **Architecture** +- Focus: Software requirements, user stories, system design + +### BMGD Planning +- **Game Brief** → **GDD** → **Architecture** +- Focus: Game vision, mechanics, narrative, player experience + +The GDD (Game Design Document) includes: +- Core gameplay loop +- Mechanics and systems +- Progression and balance +- Art and audio direction +- Genre-specific sections + +## Game Type Templates + +BMGD includes 24 game type templates that auto-configure GDD sections: + +- Action, Adventure, Puzzle +- RPG, Strategy, Simulation +- Sports, Racing, Fighting +- Horror, Platformer, Shooter +- And more... + +Each template provides: +- Genre-specific GDD sections +- Relevant mechanics patterns +- Testing considerations +- Common pitfalls to avoid + +## Narrative Support + +BMGD includes full narrative workflow for story-driven games: + +- **Narrative Design** workflow +- Story structure templates +- Character development +- World-building guidelines +- Dialogue systems + +BMM has no equivalent for narrative design. + +## Testing Differences + +### BMM Testing (TEA) +- Web-focused (Playwright, Cypress) +- API testing +- E2E for web applications + +### BMGD Testing (Game QA) +- Engine-specific frameworks (Unity, Unreal, Godot) +- Gameplay testing +- Performance profiling +- Playtest planning +- Balance validation + +## Production Workflow + +BMGD production workflows **inherit from BMM** and add game-specific: +- Checklists +- Templates +- Quality gates +- Engine-specific considerations + +This means you get all of BMM's implementation structure plus game-specific enhancements. + +## When to Use Each + +### Use BMM when: +- Building web applications +- Creating APIs and services +- Developing mobile apps (non-game) +- Any general software project + +### Use BMGD when: +- Building video games +- Creating interactive experiences +- Game prototyping +- Game jams diff --git a/src/modules/bmgd/docs/game-types-guide.md b/docs/explanation/game-dev/game-types.md similarity index 96% rename from src/modules/bmgd/docs/game-types-guide.md rename to docs/explanation/game-dev/game-types.md index f66bb538..ee012eb2 100644 --- a/src/modules/bmgd/docs/game-types-guide.md +++ b/docs/explanation/game-dev/game-types.md @@ -1,15 +1,13 @@ -# BMGD Game Types Guide +--- +title: "BMGD Game Types Guide" +--- Reference for selecting and using BMGD's 24 supported game type templates. ---- - ## Overview When creating a GDD, BMGD offers game type templates that provide genre-specific sections. This ensures your design document covers mechanics and systems relevant to your game's genre. ---- - ## Supported Game Types ### Action & Combat @@ -27,8 +25,6 @@ Side-scrolling or 3D platforming with combat mechanics. Think Hollow Knight, Cel - Level design patterns - Boss design ---- - #### Shooter **Tags:** shooter, combat, aiming, fps, tps @@ -43,8 +39,6 @@ Projectile combat with aiming mechanics. Covers FPS, TPS, and arena shooters. - Level/arena design - Multiplayer considerations ---- - #### Fighting **Tags:** fighting, combat, competitive, combos, pvp @@ -59,8 +53,6 @@ Projectile combat with aiming mechanics. Covers FPS, TPS, and arena shooters. - Competitive balance - Netcode requirements ---- - ### Strategy & Tactics #### Strategy @@ -77,8 +69,6 @@ Resource management with tactical decisions. RTS, 4X, and grand strategy. - Map/scenario design - Victory conditions ---- - #### Turn-Based Tactics **Tags:** tactics, turn-based, grid, positioning @@ -93,8 +83,6 @@ Grid-based movement with turn order. XCOM-likes and tactical RPGs. - Unit progression - Procedural mission generation ---- - #### Tower Defense **Tags:** tower-defense, waves, placement, strategy @@ -109,8 +97,6 @@ Wave-based defense with tower placement. - Map design patterns - Meta-progression ---- - ### RPG & Progression #### RPG @@ -127,8 +113,6 @@ Character progression with stats, inventory, and quests. - Combat system (action/turn-based) - Skill trees and builds ---- - #### Roguelike **Tags:** roguelike, procedural, permadeath, runs @@ -143,8 +127,6 @@ Procedural generation with permadeath and run-based progression. - Item/ability synergies - Meta-progression systems ---- - #### Metroidvania **Tags:** metroidvania, exploration, abilities, interconnected @@ -159,8 +141,6 @@ Interconnected world with ability gating. - Secret and collectible placement - Power-up progression ---- - ### Narrative & Story #### Adventure @@ -177,8 +157,6 @@ Story-driven exploration and narrative. Point-and-click and narrative adventures - Dialogue systems - Story branching ---- - #### Visual Novel **Tags:** visual-novel, narrative, choices, story @@ -193,8 +171,6 @@ Narrative choices with branching story. - UI/presentation - Save/load states ---- - #### Text-Based **Tags:** text, parser, interactive-fiction, mud @@ -209,8 +185,6 @@ Text input/output games. Parser games, choice-based IF, MUDs. - Text presentation - Save state management ---- - ### Simulation & Management #### Simulation @@ -227,8 +201,6 @@ Realistic systems with management and building. Includes tycoons and sim games. - Building/construction - Failure states ---- - #### Sandbox **Tags:** sandbox, creative, building, freedom @@ -243,8 +215,6 @@ Creative freedom with building and minimal objectives. - Sharing/community features - Optional objectives ---- - ### Sports & Racing #### Racing @@ -261,8 +231,6 @@ Vehicle control with tracks and lap times. - Progression/career mode - Multiplayer racing ---- - #### Sports **Tags:** sports, teams, realistic, physics @@ -277,8 +245,6 @@ Team-based or individual sports simulation. - Season/career modes - Multiplayer modes ---- - ### Multiplayer #### MOBA @@ -295,8 +261,6 @@ Multiplayer team battles with hero selection. - Matchmaking - Economy (gold/items) ---- - #### Party Game **Tags:** party, multiplayer, minigames, casual @@ -311,8 +275,6 @@ Local multiplayer with minigames. - Scoring systems - Player count flexibility ---- - ### Horror & Survival #### Survival @@ -329,8 +291,6 @@ Resource gathering with crafting and persistent threats. - Threat systems - Base building ---- - #### Horror **Tags:** horror, atmosphere, tension, fear @@ -345,8 +305,6 @@ Atmosphere and tension with limited resources. - Lighting and visibility - Enemy/threat design ---- - ### Casual & Progression #### Puzzle @@ -363,8 +321,6 @@ Logic-based challenges and problem-solving. - Level structure - Scoring/rating ---- - #### Idle/Incremental **Tags:** idle, incremental, automation, progression @@ -379,8 +335,6 @@ Passive progression with upgrades and automation. - Number scaling - Offline progress ---- - #### Card Game **Tags:** card, deck-building, strategy, turns @@ -395,8 +349,6 @@ Deck building with card mechanics. - Rarity and collection - Competitive balance ---- - ### Rhythm #### Rhythm @@ -413,8 +365,6 @@ Music synchronization with timing-based gameplay. - Music licensing - Input methods ---- - ## Hybrid Game Types Many games combine multiple genres. BMGD supports hybrid selection: @@ -446,8 +396,6 @@ You: It's a roguelike with card game combat Agent: I'll include sections for both Roguelike and Card Game... ``` ---- - ## Game Type Selection Tips ### 1. Start with Core Fantasy @@ -479,8 +427,6 @@ One type should be primary (most gameplay time). Others add flavor: - **Primary:** Platformer (core movement and exploration) - **Secondary:** Metroidvania (ability gating structure) ---- - ## GDD Section Mapping When you select a game type, BMGD adds these GDD sections: @@ -494,10 +440,8 @@ When you select a game type, BMGD adds these GDD sections: | Multiplayer | Matchmaking, Netcode, Balance | | Simulation | Systems, Economy, AI | ---- - ## Next Steps -- **[Quick Start Guide](./quick-start.md)** - Get started with BMGD -- **[Workflows Guide](./workflows-guide.md)** - GDD workflow details -- **[Glossary](./glossary.md)** - Game development terminology +- **[Quick Start Guide](/docs/tutorials/getting-started/quick-start-bmgd.md)** - Get started with BMGD +- **[Workflows Guide](/docs/reference/workflows/bmgd-workflows.md)** - GDD workflow details +- **[Glossary](/docs/reference/glossary/index.md)** - Game development terminology diff --git a/docs/explanation/game-dev/index.md b/docs/explanation/game-dev/index.md new file mode 100644 index 00000000..105c2c78 --- /dev/null +++ b/docs/explanation/game-dev/index.md @@ -0,0 +1,70 @@ +--- +title: "BMGD - Game Development Module" +description: AI-powered workflows for game design and development with BMGD +--- + +Complete guides for the BMad Game Development Module (BMGD) — AI-powered workflows for game design and development that adapt to your project's needs. + +## Getting Started + +**New to BMGD?** Start here: + +- **[Quick Start Guide](/docs/tutorials/getting-started/quick-start-bmgd.md)** - Get started building your first game + - Installation and setup + - Understanding the game development phases + - Running your first workflows + - Agent-based development flow + +:::tip[Quick Path] +Install BMGD module → Game Brief → GDD → Architecture → Build +::: + +## Core Documentation + +- **[Game Types Guide](/docs/explanation/game-dev/game-types.md)** - Selecting and using game type templates (24 supported types) +- **[BMGD vs BMM](/docs/explanation/game-dev/bmgd-vs-bmm.md)** - Understanding the differences + +## Game Development Phases + +BMGD follows four phases aligned with game development: + +### Phase 1: Preproduction +- **Brainstorm Game** - Ideation with game-specific techniques +- **Game Brief** - Capture vision, market, and fundamentals + +### Phase 2: Design +- **GDD (Game Design Document)** - Comprehensive game design +- **Narrative Design** - Story, characters, world (for story-driven games) + +### Phase 3: Technical +- **Game Architecture** - Engine, systems, patterns, structure + +### Phase 4: Production +- **Sprint Planning** - Epic and story management +- **Story Development** - Implementation workflow +- **Code Review** - Quality assurance +- **Testing** - Automated tests, playtesting, performance +- **Retrospective** - Continuous improvement + +## Choose Your Path + +### I need to... + +**Start a new game project** +→ Start with [Quick Start Guide](/docs/tutorials/getting-started/quick-start-bmgd.md) +→ Run `brainstorm-game` for ideation +→ Create a Game Brief with `create-brief` + +**Design my game** +→ Create a GDD with `create-gdd` +→ If story-heavy, add Narrative Design with `create-narrative` + +**Plan the technical architecture** +→ Run `create-architecture` with the Game Architect + +**Build my game** +→ Use Phase 4 production workflows +→ Follow the sprint-based development cycle + +**Quickly test an idea** +→ Use [Quick-Flow](/docs/how-to/workflows/bmgd-quick-flow.md) for rapid prototyping diff --git a/docs/explanation/philosophy/facilitation-over-generation.md b/docs/explanation/philosophy/facilitation-over-generation.md new file mode 100644 index 00000000..35fd13dd --- /dev/null +++ b/docs/explanation/philosophy/facilitation-over-generation.md @@ -0,0 +1,106 @@ +--- +title: "Facilitation Over Generation" +description: Understanding CIS's facilitation-first approach to creative work +--- + + +The Creative Intelligence Suite (CIS) takes a fundamentally different approach from typical AI tools. Instead of generating solutions directly, CIS agents act as master facilitators who guide you to discover insights yourself. + +## The Problem with Generation + +Traditional AI approaches to creative work: + +:::note[Generation Example] +**User:** "Give me marketing ideas" + +**AI:** "Here are 10 marketing ideas..." +::: + +This approach: +- Produces generic, predictable outputs +- Removes human ownership of ideas +- Misses context and nuance +- Limits creative exploration + +## The Facilitation Approach + +CIS agents use strategic questioning: + +:::note[Facilitation Example] +**User:** "I need marketing ideas" + +**CIS:** "What makes your customers choose you over alternatives? What's the one thing they always mention?" + +**User:** "They say our support is exceptional" + +**CIS:** "Interesting! How might you make that exceptional support visible before they become customers?" +::: + +This approach: +- Draws out insights already within you +- Maintains human ownership of ideas +- Captures context and nuance +- Enables deeper creative exploration + +## Key Principles + +### 1. Questions Over Answers + +CIS agents ask strategic questions rather than providing direct answers. This: +- Activates your own creative thinking +- Uncovers assumptions +- Reveals blind spots +- Builds on your domain knowledge + +### 2. Energy-Aware Sessions + +CIS monitors engagement and adapts: +- Adjusts pace when energy flags +- Suggests breaks when needed +- Changes techniques to maintain momentum +- Recognizes productive vs. unproductive struggle + +### 3. Process Trust + +CIS uses proven methodologies: +- Design Thinking's 5 phases +- Structured brainstorming techniques +- Root cause analysis frameworks +- Innovation strategy patterns + +You're not just having a conversation—you're following time-tested creative processes. + +### 4. Persona-Driven Engagement + +Each CIS agent has a distinct personality: +- **Carson** - Energetic, encouraging +- **Maya** - Jazz-like, improvisational +- **Dr. Quinn** - Analytical, methodical +- **Victor** - Bold, strategic +- **Sophia** - Narrative, imaginative + +These personas create engaging experiences that maintain creative flow. + +## When Generation is Appropriate + +CIS does generate when appropriate: +- Synthesizing session outputs +- Documenting decisions +- Creating structured artifacts +- Providing technique examples + +But the core creative work happens through facilitated discovery. + +## Benefits + +### For Individuals +- Deeper insights than pure generation +- Ownership of creative outputs +- Skill development in creative thinking +- More memorable and actionable ideas + +### For Teams +- Shared creative experience +- Aligned understanding +- Documented rationale +- Stronger buy-in to outcomes diff --git a/docs/explanation/philosophy/testing-as-engineering.md b/docs/explanation/philosophy/testing-as-engineering.md new file mode 100644 index 00000000..7b8db5a4 --- /dev/null +++ b/docs/explanation/philosophy/testing-as-engineering.md @@ -0,0 +1,112 @@ +--- +title: "AI-Generated Testing: Why Most Approaches Fail" +description: How Playwright-Utils, TEA workflows, and Playwright MCPs solve AI test quality problems +--- + + +AI-generated tests frequently fail in production because they lack systematic quality standards. This document explains the problem and presents a solution combining three components: Playwright-Utils, TEA (Test Architect), and Playwright MCPs. + +:::note[Source] +This article is adapted from [The Testing Meta Most Teams Have Not Caught Up To Yet](https://dev.to/muratkeremozcan/the-testing-meta-most-teams-have-not-caught-up-to-yet-5765) by Murat K Ozcan. +::: + +## The Problem with AI-Generated Tests + +When teams use AI to generate tests without structure, they often produce what can be called "slop factory" outputs: + +| Issue | Description | +|-------|-------------| +| Redundant coverage | Multiple tests covering the same functionality | +| Incorrect assertions | Tests that pass but don't actually verify behavior | +| Flaky tests | Non-deterministic tests that randomly pass or fail | +| Unreviewable diffs | Generated code too verbose or inconsistent to review | + +The core problem is that prompt-driven testing paths lean into nondeterminism, which is the exact opposite of what testing exists to protect. + +:::caution[The Paradox] +AI excels at generating code quickly, but testing requires precision and consistency. Without guardrails, AI-generated tests amplify the chaos they're meant to prevent. +::: + +## The Solution: A Three-Part Stack + +The solution combines three components that work together to enforce quality: + +### Playwright-Utils + +Bridges the gap between Cypress ergonomics and Playwright's capabilities by standardizing commonly reinvented primitives through utility functions. + +| Utility | Purpose | +|---------|---------| +| api-request | API calls with schema validation | +| auth-session | Authentication handling | +| intercept-network-call | Network mocking and interception | +| recurse | Retry logic and polling | +| log | Structured logging | +| network-recorder | Record and replay network traffic | +| burn-in | Smart test selection for CI | +| network-error-monitor | HTTP error detection | +| file-utils | CSV/PDF handling | + +These utilities eliminate the need to reinvent authentication, API calls, retries, and logging for every project. + +### TEA (Test Architect Agent) + +A quality operating model packaged as eight executable workflows spanning test design, CI/CD gates, and release readiness. TEA encodes test architecture expertise into repeatable processes. + +| Workflow | Purpose | +|----------|---------| +| `*test-design` | Risk-based test planning per epic | +| `*framework` | Scaffold production-ready test infrastructure | +| `*ci` | CI pipeline with selective testing | +| `*atdd` | Acceptance test-driven development | +| `*automate` | Prioritized test automation | +| `*test-review` | Test quality audits (0-100 score) | +| `*nfr-assess` | Non-functional requirements assessment | +| `*trace` | Coverage traceability and gate decisions | + +:::tip[Key Insight] +TEA doesn't just generate tests—it provides a complete quality operating model with workflows for planning, execution, and release gates. +::: + +### Playwright MCPs + +Model Context Protocols enable real-time verification during test generation. Instead of inferring selectors and behavior from documentation, MCPs allow agents to: + +- Run flows and confirm the DOM against the accessibility tree +- Validate network responses in real-time +- Discover actual functionality through interactive exploration +- Verify generated tests against live applications + +## How They Work Together + +The three components form a quality pipeline: + +| Stage | Component | Action | +|-------|-----------|--------| +| Standards | Playwright-Utils | Provides production-ready patterns and utilities | +| Process | TEA Workflows | Enforces systematic test planning and review | +| Verification | Playwright MCPs | Validates generated tests against live applications | + +**Before (AI-only):** 20 tests with redundant coverage, incorrect assertions, and flaky behavior. + +**After (Full Stack):** Risk-based selection, verified selectors, validated behavior, reviewable code. + +## Why This Matters + +Traditional AI testing approaches fail because they: + +- **Lack quality standards** — No consistent patterns or utilities +- **Skip planning** — Jump straight to test generation without risk assessment +- **Can't verify** — Generate tests without validating against actual behavior +- **Don't review** — No systematic audit of generated test quality + +The three-part stack addresses each gap: + +| Gap | Solution | +|-----|----------| +| No standards | Playwright-Utils provides production-ready patterns | +| No planning | TEA `*test-design` workflow creates risk-based test plans | +| No verification | Playwright MCPs validate against live applications | +| No review | TEA `*test-review` audits quality with scoring | + +This approach is sometimes called *context engineering*—loading domain-specific standards into AI context automatically rather than relying on prompts alone. TEA's `tea-index.csv` manifest loads relevant knowledge fragments so the AI doesn't relearn testing patterns each session. diff --git a/docs/getting-started/installation.md b/docs/getting-started/installation.md deleted file mode 100644 index f481ab96..00000000 --- a/docs/getting-started/installation.md +++ /dev/null @@ -1,76 +0,0 @@ -# Installation - -Get BMAD Method running in your project in under 2 minutes. - -## Quick Install - -```bash -npx bmad-method@alpha install -``` - -This interactive installer will: - -1. Detect your IDE (Claude Code, Cursor, VS Code, etc.) -2. Let you choose which modules to install -3. Configure agents and workflows for your project - -## Requirements - -- **Node.js** 18+ (for the installer) -- **Git** (recommended for version control) -- An **AI-powered IDE** or access to Claude/ChatGPT/Gemini - -## Module Options - -During installation, you'll choose which modules to install: - -| Module | Description | Best For | -| -------- | ---------------- | ---------------------------------------- | -| **BMM** | BMAD Method Core | Software development projects | -| **BMGD** | Game Development | Game projects with specialized workflows | -| **BMB** | Builder | Creating custom agents and workflows | - -## Post-Installation - -After installation, your project will have: - -``` -your-project/ -├── _bmad/ # BMAD configuration and agents -│ ├── bmm/ # Method module (if installed) -│ ├── bmgd/ # Game dev module (if installed) -│ └── config.yaml # Your project configuration -├── .claude/ # IDE-specific setup (varies by IDE) -└── ... your code -``` - -## Next Steps - -1. **Read the [Quick Start Guide](../modules/bmm/quick-start.md)** to build your first feature -2. **Check your [IDE Guide](../ide-info/index.md)** for IDE-specific tips -3. **Explore [Workflows](../modules/bmm/workflows-planning.md)** to understand the methodology - -## Alternative: Web Bundles - -Don't want to install? Use BMAD agents directly in: - -- **Claude Projects** - Upload the web bundle -- **ChatGPT** - Use custom GPT bundles -- **Gemini** - Import agent prompts - -See the [Web Bundles Guide](../web-bundles-gemini-gpt-guide.md) for details. - -## Troubleshooting - -### Common Issues - -**"Command not found: npx"** -: Install Node.js 18+ from [nodejs.org](https://nodejs.org) - -**"Permission denied"** -: Run with appropriate permissions or check your npm configuration - -**IDE not detected** -: The installer will prompt you to select your IDE manually - -For more help, see [Troubleshooting](../modules/bmm/troubleshooting.md) or join our [Discord](https://discord.gg/bmad). diff --git a/docs/how-to/brownfield/add-feature-to-existing.md b/docs/how-to/brownfield/add-feature-to-existing.md new file mode 100644 index 00000000..27c6412e --- /dev/null +++ b/docs/how-to/brownfield/add-feature-to-existing.md @@ -0,0 +1,74 @@ +--- +title: "How to Add a Feature to an Existing Project" +description: How to add new features to an existing brownfield project +--- + +Use the `workflow-init` workflow to add new functionality to your brownfield codebase while respecting existing patterns and architecture. + +## When to Use This + +- Adding a new feature to an existing codebase +- Major enhancements that need proper planning +- Features that touch multiple parts of the system + +:::note[Prerequisites] +- BMad Method installed +- Existing project documentation (run `document-project` first if needed) +- Clear understanding of what you want to build +::: + +## Steps + +### 1. Run workflow-init + +``` +Run workflow-init +``` + +The workflow should recognize you're in an existing project. If not, explicitly clarify that this is brownfield development. + +### 2. Choose Your Approach + +| Feature Scope | Recommended Approach | +|---------------|---------------------| +| Small (1-5 stories) | Quick Flow with tech-spec | +| Medium (5-15 stories) | BMad Method with PRD | +| Large (15+ stories) | Full BMad Method with architecture | + +### 3. Create Planning Documents + +**For Quick Flow:** +- Load PM agent +- Run tech-spec workflow +- The agent will analyze your existing codebase and create a context-aware spec + +**For BMad Method:** +- Load PM agent +- Run PRD workflow +- Ensure the agent reads your existing documentation +- Review that integration points are clearly identified + +### 4. Consider Architecture Impact + +If your feature affects system architecture: + +- Load Architect agent +- Run architecture workflow +- Ensure alignment with existing patterns +- Document any new ADRs (Architecture Decision Records) + +### 5. Implement + +Follow the standard Phase 4 implementation workflows: + +1. `sprint-planning` - Organize your work +2. `create-story` - Prepare each story +3. `dev-story` - Implement with tests +4. `code-review` - Quality assurance + +## Tips + +- Always ensure agents read your existing documentation +- Pay attention to integration points with existing code +- Follow existing conventions unless deliberately changing them +- Document why you're adding new patterns (if any) diff --git a/docs/how-to/brownfield/document-existing-project.md b/docs/how-to/brownfield/document-existing-project.md new file mode 100644 index 00000000..b318363b --- /dev/null +++ b/docs/how-to/brownfield/document-existing-project.md @@ -0,0 +1,66 @@ +--- +title: "How to Document an Existing Project" +description: How to document an existing brownfield codebase using BMad Method +--- + +Use the `document-project` workflow to scan your entire codebase and generate comprehensive documentation about its current state. + +## When to Use This + +- Starting work on an undocumented legacy project +- Documentation is outdated and needs refresh +- AI agents need context about existing code patterns +- Onboarding new team members + +:::note[Prerequisites] +- BMad Method installed in your project +- Access to the codebase you want to document +::: + +## Steps + +### 1. Load the Analyst Agent + +Start a fresh chat and load the Analyst agent. + +### 2. Run the document-project Workflow + +Tell the agent: + +``` +Run the document-project workflow +``` + +### 3. Let the Agent Scan Your Codebase + +The workflow will: + +- Scan your codebase structure +- Identify architecture patterns +- Document the technology stack +- Create reference documentation +- Generate a PRD-like document from existing code + +### 4. Review the Generated Documentation + +The output will be saved to `project-documentation-{date}.md` in your output folder. + +Review the documentation for: + +- Accuracy of detected patterns +- Completeness of architecture description +- Any missing business rules or intent + +## What You Get + +- **Project overview** - High-level description of what the project does +- **Technology stack** - Detected frameworks, libraries, and tools +- **Architecture patterns** - Code organization and design patterns found +- **Business rules** - Logic extracted from the codebase +- **Integration points** - External APIs and services + +## Tips + +- Run this before any major brownfield work +- Keep the documentation updated as the project evolves +- Use it as input for future PRD creation diff --git a/docs/how-to/brownfield/index.md b/docs/how-to/brownfield/index.md new file mode 100644 index 00000000..ab5f30e9 --- /dev/null +++ b/docs/how-to/brownfield/index.md @@ -0,0 +1,84 @@ +--- +title: "Brownfield Development" +description: How to use BMad Method on existing codebases +--- + +Use BMad Method effectively when working on existing projects and legacy codebases. + +## What is Brownfield Development? + +**Brownfield** refers to working on existing projects with established codebases and patterns, as opposed to **greenfield** which means starting from scratch with a clean slate. + +This guide covers the essential workflow for onboarding to brownfield projects with BMad Method. + +:::note[Prerequisites] +- BMad Method installed (`npx bmad-method install`) +- An existing codebase you want to work on +- Access to an AI-powered IDE (Claude Code, Cursor, or Windsurf) +::: + +## Step 1: Clean Up Completed Planning Artifacts + +If you have completed all PRD epics and stories through the BMad process, clean up those files. Archive them, delete them, or rely on version history if needed. Do not keep these files in: + +- `docs/` +- `_bmad-output/planning-artifacts/` +- `_bmad-output/implementation-artifacts/` + +## Step 2: Maintain Quality Project Documentation + +Your `docs/` folder should contain succinct, well-organized documentation that accurately represents your project: + +- Intent and business rationale +- Business rules +- Architecture +- Any other relevant project information + +For complex projects, consider using the `document-project` workflow. It offers runtime variants that will scan your entire project and document its actual current state. + +## Step 3: Initialize for Brownfield Work + +Run `workflow-init`. It should recognize you are in an existing project. If not, explicitly clarify that this is brownfield development for a new feature. + +### Choosing Your Approach + +You have two primary options depending on the scope of changes: + +| Scope | Recommended Approach | +| ------------------------------ | ----------------------------------------------------------------------------------------------------------------------------- | +| **Small updates or additions** | Use `quick-flow-solo-dev` to create a tech-spec and implement the change. The full four-phase BMad method is likely overkill. | +| **Major changes or additions** | Start with the BMad method, applying as much or as little rigor as needed. | + +### During PRD Creation + +When creating a brief or jumping directly into the PRD, ensure the agent: + +- Finds and analyzes your existing project documentation +- Reads the proper context about your current system + +You can guide the agent explicitly, but the goal is to ensure the new feature integrates well with your existing system. + +### UX Considerations + +UX work is optional. The decision depends not on whether your project has a UX, but on: + +- Whether you will be working on UX changes +- Whether significant new UX designs or patterns are needed + +If your changes amount to simple updates to existing screens you are happy with, a full UX process is unnecessary. + +### Architecture Considerations + +When doing architecture, ensure the architect: + +- Uses the proper documented files +- Scans the existing codebase + +Pay close attention here to prevent reinventing the wheel or making decisions that misalign with your existing architecture. + +## Next Steps + +- **[Document Existing Project](/docs/how-to/brownfield/document-existing-project.md)** - How to document your brownfield codebase +- **[Add Feature to Existing Project](/docs/how-to/brownfield/add-feature-to-existing.md)** - Adding new functionality +- **[Quick Fix in Brownfield](/docs/how-to/brownfield/quick-fix-in-brownfield.md)** - Bug fixes and ad-hoc changes +- **[Brownfield FAQ](/docs/explanation/faq/brownfield-faq.md)** - Common questions about brownfield development diff --git a/docs/how-to/brownfield/quick-fix-in-brownfield.md b/docs/how-to/brownfield/quick-fix-in-brownfield.md new file mode 100644 index 00000000..2e8896ab --- /dev/null +++ b/docs/how-to/brownfield/quick-fix-in-brownfield.md @@ -0,0 +1,77 @@ +--- +title: "How to Make Quick Fixes in Brownfield Projects" +description: How to make quick fixes and ad-hoc changes in brownfield projects +--- + +Use the **DEV agent** directly for bug fixes, refactorings, or small targeted changes that don't require the full BMad method or Quick Flow. + +## When to Use This + +- Bug fixes +- Small refactorings +- Targeted code improvements +- Learning about your codebase +- One-off changes that don't need planning + +## Steps + +### 1. Load an Agent + +For quick fixes, you can use: + +- **DEV agent** - For implementation-focused work +- **Quick Flow Solo Dev** - For slightly larger changes that still need a tech-spec + +### 2. Describe the Change + +Simply tell the agent what you need: + +``` +Fix the login validation bug that allows empty passwords +``` + +or + +``` +Refactor the UserService to use async/await instead of callbacks +``` + +### 3. Let the Agent Work + +The agent will: + +- Analyze the relevant code +- Propose a solution +- Implement the change +- Run tests (if available) + +### 4. Review and Commit + +Review the changes made and commit when satisfied. + +## Learning Your Codebase + +This approach is also excellent for exploring unfamiliar code: + +``` +Explain how the authentication system works in this codebase +``` + +``` +Show me where error handling happens in the API layer +``` + +LLMs are excellent at interpreting and analyzing code—whether it was AI-generated or not. Use the agent to: + +- Learn about your project +- Understand how things are built +- Explore unfamiliar parts of the codebase + +## When to Upgrade to Formal Planning + +Consider using Quick Flow or full BMad Method when: + +- The change affects multiple files or systems +- You're unsure about the scope +- The fix keeps growing in complexity +- You need documentation for the change diff --git a/docs/agent-customization-guide.md b/docs/how-to/customization/customize-agents.md similarity index 86% rename from docs/agent-customization-guide.md rename to docs/how-to/customization/customize-agents.md index 724f5d26..682a3fb8 100644 --- a/docs/agent-customization-guide.md +++ b/docs/how-to/customization/customize-agents.md @@ -1,6 +1,15 @@ -# Agent Customization Guide +--- +title: "Agent Customization Guide" +--- -Customize BMad agents without modifying core files. All customizations persist through updates. +Use `.customize.yaml` files to customize BMad agents without modifying core files. All customizations persist through updates. + +## When to Use This + +- Change agent names or personas +- Add project-specific memories or context +- Add custom menu items and workflows +- Define critical actions for consistent behavior ## Quick Start @@ -26,10 +35,8 @@ After editing, IT IS CRITICAL to rebuild the agent to apply changes: ```bash npx bmad-method@alpha install # and then select option to compile all agents -# OR for individual agent only npx bmad-method@alpha build -# Examples: npx bmad-method@alpha build bmm-dev npx bmad-method@alpha build core-bmad-master npx bmad-method@alpha build bmm-pm @@ -81,7 +88,7 @@ Add your own workflows to the agent's menu: ```yaml menu: - trigger: my-workflow - workflow: '{project-root}/custom/my-workflow.yaml' + workflow: '{project-root}/my-custom/workflows/my-workflow.yaml' description: My custom workflow - trigger: deploy action: '#deploy-prompt' @@ -119,7 +126,6 @@ prompts: **Example 1: Customize Developer Agent for TDD** ```yaml -# _bmad/_config/agents/bmm-dev.customize.yaml agent: metadata: name: 'TDD Developer' @@ -135,7 +141,6 @@ critical_actions: **Example 2: Add Custom Deployment Workflow** ```yaml -# _bmad/_config/agents/bmm-dev.customize.yaml menu: - trigger: deploy-staging workflow: '{project-root}/_bmad/deploy-staging.yaml' @@ -148,7 +153,6 @@ menu: **Example 3: Multilingual Product Manager** ```yaml -# _bmad/_config/agents/bmm-pm.customize.yaml persona: role: 'Bilingual Product Manager' identity: 'Expert in US and LATAM markets' @@ -203,6 +207,6 @@ memories: ## Next Steps -- **[BMM Agents Guide](./modules/bmm/agents-guide)** - Learn about the BMad Method agents -- **[BMB Create Agent Workflow](./modules/bmb/agents/index)** - Build completely custom agents -- **[BMM Complete Documentation](./modules/bmm/index)** - Full BMad Method reference +- **[Learn about Agents](/docs/explanation/core-concepts/what-are-agents.md)** - Understand Simple vs Expert agents +- **[Agent Creation Guide](/docs/tutorials/advanced/create-custom-agent.md)** - Build completely custom agents +- **[BMM Complete Documentation](/docs/explanation/bmm/index.md)** - Full BMad Method reference diff --git a/docs/how-to/customization/index.md b/docs/how-to/customization/index.md new file mode 100644 index 00000000..a792104c --- /dev/null +++ b/docs/how-to/customization/index.md @@ -0,0 +1,23 @@ +--- +title: "BMad Customization" +--- + +Personalize agents and workflows to match your needs. + +## Guides + +| Guide | Description | +|-------|-------------| +| **[Agent Customization](/docs/how-to/customization/customize-agents.md)** | Modify agent behavior without editing core files | + +## Overview + +BMad provides two main customization approaches: + +### Agent Customization + +Modify any agent's persona, name, capabilities, or menu items using `.customize.yaml` files in `_bmad/_config/agents/`. Your customizations persist through updates. + +### Workflow Customization + +Replace or extend workflow steps to create tailored processes. (Coming soon) diff --git a/docs/how-to/customization/shard-large-documents.md b/docs/how-to/customization/shard-large-documents.md new file mode 100644 index 00000000..a8cabc5b --- /dev/null +++ b/docs/how-to/customization/shard-large-documents.md @@ -0,0 +1,101 @@ +--- +title: "Document Sharding Guide" +--- + +Use the `shard-doc` tool to split large markdown files into smaller, organized files for better context management. + +## When to Use This + +- Very large complex PRDs +- Architecture documents with multiple system layers +- Epic files with 4+ epics (especially for Phase 4) +- UX design specs covering multiple subsystems + +## What is Document Sharding? + +Document sharding splits large markdown files into smaller, organized files based on level 2 headings (`## Heading`). This enables: + +- **Selective Loading** - Workflows load only the sections they need +- **Reduced Token Usage** - Massive efficiency gains for large projects +- **Better Organization** - Logical section-based file structure +- **Maintained Context** - Index file preserves document structure + +### Architecture + +``` +Before Sharding: +docs/ +└── PRD.md (large 50k token file) + +After Sharding: +docs/ +└── prd/ + ├── index.md # Table of contents with descriptions + ├── overview.md # Section 1 + ├── user-requirements.md # Section 2 + ├── technical-requirements.md # Section 3 + └── ... # Additional sections +``` + +## Steps + +### 1. Run the Shard-Doc Tool + +```bash +/bmad:core:tools:shard-doc +``` + +### 2. Follow the Interactive Process + +``` +Agent: Which document would you like to shard? +User: docs/PRD.md + +Agent: Default destination: docs/prd/ + Accept default? [y/n] +User: y + +Agent: Sharding PRD.md... + ✓ Created 12 section files + ✓ Generated index.md + ✓ Complete! +``` + +## What You Get + +**index.md structure:** + +```markdown + +## Sections + +1. [Overview](./overview.md) - Project vision and objectives +2. [User Requirements](./user-requirements.md) - Feature specifications +3. [Epic 1: Authentication](./epic-1-authentication.md) - User auth system +4. [Epic 2: Dashboard](./epic-2-dashboard.md) - Main dashboard UI + ... +``` + +**Individual section files:** + +- Named from heading text (kebab-case) +- Contains complete section content +- Preserves all markdown formatting +- Can be read independently + +## How Workflow Discovery Works + +BMad workflows use a **dual discovery system**: + +1. **Try whole document first** - Look for `document-name.md` +2. **Check for sharded version** - Look for `document-name/index.md` +3. **Priority rule** - Whole document takes precedence if both exist - remove the whole document if you want the sharded to be used instead + +## Workflow Support + +All BMM workflows support both formats: + +- Whole documents +- Sharded documents +- Automatic detection +- Transparent to user diff --git a/docs/how-to/get-answers-about-bmad.md b/docs/how-to/get-answers-about-bmad.md new file mode 100644 index 00000000..6581e817 --- /dev/null +++ b/docs/how-to/get-answers-about-bmad.md @@ -0,0 +1,102 @@ +--- +title: "How to Get Answers About BMad" +description: Use an LLM to quickly answer your own BMad questions +--- + +Use your AI tool to get answers about BMad by pointing it at the source files. + +## When to Use This + +- You have a question about how BMad works +- You want to understand a specific agent or workflow +- You need quick answers without waiting for Discord + +:::note[Prerequisites] +An AI tool (Claude Code, Cursor, ChatGPT, Claude.ai, etc.) and either BMad installed in your project or access to the GitHub repo. +::: + +## Steps + +### 1. Choose Your Source + +| Source | Best For | Examples | +|--------|----------|----------| +| **`_bmad` folder** | How BMad works—agents, workflows, prompts | "What does the PM agent do?" | +| **Full GitHub repo** | History, installer, architecture | "What changed in v6?" | +| **`llms-full.txt`** | Quick overview from docs | "Explain BMad's four phases" | + +The `_bmad` folder is created when you install BMad. If you don't have it yet, clone the repo instead. + +### 2. Point Your AI at the Source + +**If your AI can read files (Claude Code, Cursor, etc.):** + +- **BMad installed:** Point at the `_bmad` folder and ask directly +- **Want deeper context:** Clone the [full repo](https://github.com/bmad-code-org/BMAD-METHOD) + +**If you use ChatGPT or Claude.ai:** + +Fetch `llms-full.txt` into your session: + +``` +https://bmad-code-org.github.io/BMAD-METHOD/llms-full.txt +``` + +See the [Downloads page](/docs/downloads.md) for other downloadable resources. + +### 3. Ask Your Question + +:::note[Example] +**Q:** "Tell me the fastest way to build something with BMad" + +**A:** Use Quick Flow: Run `quick-spec` to write a technical specification, then `quick-dev` to implement it—skipping the full planning phases. +::: + +## What You Get + +Direct answers about BMad—how agents work, what workflows do, why things are structured the way they are—without waiting for someone else to respond. + +## Tips + +- **Verify surprising answers** — LLMs occasionally get things wrong. Check the source file or ask on Discord. +- **Be specific** — "What does step 3 of the PRD workflow do?" beats "How does PRD work?" + +## Still Stuck? + +Tried the LLM approach and still need help? You now have a much better question to ask. + +| Channel | Use For | +|---------|---------| +| `#bmad-method-help` | Quick questions (real-time chat) | +| `help-requests` forum | Detailed questions (searchable, persistent) | +| `#suggestions-feedback` | Ideas and feature requests | +| `#report-bugs-and-issues` | Bug reports | + +**Discord:** [discord.gg/gk8jAdXWmj](https://discord.gg/gk8jAdXWmj) + +**GitHub Issues:** [github.com/bmad-code-org/BMAD-METHOD/issues](https://github.com/bmad-code-org/BMAD-METHOD/issues) (for clear bugs) + +*You!* + *Stuck* + *in the queue—* + *waiting* + *for who?* + +*The source* + *is there,* + *plain to see!* + +*Point* + *your machine.* + *Set it free.* + +*It reads.* + *It speaks.* + *Ask away—* + +*Why wait* + *for tomorrow* + *when you have* + *today?* + +*—Claude* diff --git a/docs/how-to/installation/index.md b/docs/how-to/installation/index.md new file mode 100644 index 00000000..e3a3e29d --- /dev/null +++ b/docs/how-to/installation/index.md @@ -0,0 +1,12 @@ +--- +title: "Installation Guides" +description: How to install and upgrade BMad Method +--- + +How-to guides for installing and configuring the BMad Method. + +| Guide | Description | +|-------|-------------| +| [Install BMad](/docs/how-to/installation/install-bmad.md) | Step-by-step installation instructions | +| [Install Custom Modules](/docs/how-to/installation/install-custom-modules.md) | Add custom agents, workflows, and modules | +| [Upgrade to v6](/docs/how-to/installation/upgrade-to-v6.md) | Migrate from BMad v4 to v6 | diff --git a/docs/how-to/installation/install-bmad.md b/docs/how-to/installation/install-bmad.md new file mode 100644 index 00000000..f2d06fc7 --- /dev/null +++ b/docs/how-to/installation/install-bmad.md @@ -0,0 +1,112 @@ +--- +title: "How to Install BMad" +description: Step-by-step guide to installing BMad in your project +--- + +Use the `npx bmad-method install` command to set up BMad in your project with your choice of modules and AI tools. + +## When to Use This + +- Starting a new project with BMad +- Adding BMad to an existing codebase +- Setting up BMad on a new machine + +:::note[Prerequisites] +- **Node.js** 20+ (required for the installer) +- **Git** (recommended) +- **AI-powered IDE** (Claude Code, Cursor, Windsurf, or similar) +::: + +## Steps + +### 1. Run the Installer + +```bash +npx bmad-method install +``` + +### 2. Choose Installation Location + +The installer will ask where to install BMad files: + +- Current directory (recommended for new projects) +- Subdirectory +- Custom path + +### 3. Select Your AI Tools + +Choose which AI tools you'll be using: + +- Claude Code +- Cursor +- Windsurf +- Other + +The installer configures BMad for your selected tools. + +### 4. Choose Modules + +Select which modules to install: + +| Module | Purpose | +|--------|---------| +| **BMM** | Core methodology for software development | +| **BMGD** | Game development workflows | +| **CIS** | Creative intelligence and facilitation | +| **BMB** | Building custom agents and workflows | + +### 5. Add Custom Content (Optional) + +If you have custom agents, workflows, or modules, point to their location and the installer will integrate them. + +### 6. Configure Settings + +For each module, either accept recommended defaults (faster) or customize settings (more control). + +## What You Get + +``` +your-project/ +├── _bmad/ +│ ├── bmm/ # Method module +│ │ ├── agents/ # Agent files +│ │ ├── workflows/ # Workflow files +│ │ └── config.yaml # Module config +│ ├── core/ # Core utilities +│ └── ... +├── _bmad-output/ # Generated artifacts +└── .claude/ # IDE configuration +``` + +## Verify Installation + +1. Check the `_bmad/` directory exists +2. Load an agent in your AI tool +3. Run `*menu` to see available commands + +## Configuration + +Edit `_bmad/[module]/config.yaml` to customize: + +```yaml +output_folder: ./_bmad-output +user_name: Your Name +communication_language: english +``` + +## Troubleshooting + +**"Command not found: npx"** — Install Node.js 20+: +```bash +brew install node +``` + +**"Permission denied"** — Check npm permissions: +```bash +npm config set prefix ~/.npm-global +``` + +**Installer hangs** — Try running with verbose output: +```bash +npx bmad-method install --verbose +``` diff --git a/docs/how-to/installation/install-custom-modules.md b/docs/how-to/installation/install-custom-modules.md new file mode 100644 index 00000000..0e995676 --- /dev/null +++ b/docs/how-to/installation/install-custom-modules.md @@ -0,0 +1,118 @@ +--- +title: "How to Install Custom Modules" +description: Add custom agents, workflows, and modules to BMad +--- + +Use the BMad installer to add custom agents, workflows, and modules that extend BMad's functionality. + +## When to Use This + +- Adding third-party BMad modules to your project +- Installing your own custom agents or workflows +- Sharing custom content across projects or teams + +:::note[Prerequisites] +- BMad installed in your project +- Custom content with a valid `module.yaml` file +::: + +## Steps + +### 1. Prepare Your Custom Content + +Your custom content needs a `module.yaml` file. Choose the appropriate structure: + +**For a cohesive module** (agents and workflows that work together): + +``` +module-code/ + module.yaml + agents/ + workflows/ + tools/ + templates/ +``` + +**For standalone items** (unrelated agents/workflows): + +``` +module-name/ + module.yaml # Contains unitary: true + agents/ + larry/larry.agent.md + curly/curly.agent.md + workflows/ +``` + +Add `unitary: true` in your `module.yaml` to indicate items don't depend on each other. + +### 2. Run the Installer + +**New project:** + +```bash +npx bmad-method install +``` + +When prompted "Would you like to install a local custom module?", select 'y' and provide the path to your module folder. + +**Existing project:** + +```bash +npx bmad-method install +``` + +1. Select `Modify BMad Installation` +2. Choose the option to add, modify, or update custom modules +3. Provide the path to your module folder + +### 3. Verify Installation + +Check that your custom content appears in the `_bmad/` directory and is accessible from your AI tool. + +## What You Get + +- Custom agents available in your AI tool +- Custom workflows accessible via `*workflow-name` +- Content integrated with BMad's update system + +## Content Types + +BMad supports several categories of custom content: + +| Type | Description | +|------|-------------| +| **Stand Alone Modules** | Complete modules with their own agents and workflows | +| **Add On Modules** | Extensions that add to existing modules | +| **Global Modules** | Content available across all modules | +| **Custom Agents** | Individual agent definitions | +| **Custom Workflows** | Individual workflow definitions | + +For detailed information about content types, see [Custom Content Types](/docs/explanation/bmad-builder/custom-content-types.md). + +## Updating Custom Content + +When BMad Core or module updates are available, the quick update process: + +1. Applies updates to core modules +2. Recompiles all agents with your customizations +3. Retains your custom content from cache +4. Preserves your configurations + +You don't need to keep source module files locally—just point to the updated location during updates. + +## Tips + +- **Use unique module codes** — Don't use `bmm` or other existing module codes +- **Avoid naming conflicts** — Each module needs a distinct code +- **Document dependencies** — Note any modules your custom content requires +- **Test in isolation** — Verify custom modules work before sharing +- **Version your content** — Track updates with version numbers + +:::caution[Naming Conflicts] +Don't create custom modules with codes like `bmm` (already used by BMad Method). Each custom module needs a unique code. +::: + +## Example Modules + +Find example custom modules in the `samples/sample-custom-modules/` folder of the [BMad repository](https://github.com/bmad-code-org/BMAD-METHOD). Download either sample folder to try them out. diff --git a/docs/how-to/installation/upgrade-to-v6.md b/docs/how-to/installation/upgrade-to-v6.md new file mode 100644 index 00000000..3d576f46 --- /dev/null +++ b/docs/how-to/installation/upgrade-to-v6.md @@ -0,0 +1,131 @@ +--- +title: "How to Upgrade to v6" +description: Migrate from BMad v4 to v6 +--- + +Use the BMad installer to upgrade from v4 to v6, which includes automatic detection of legacy installations and migration assistance. + +## When to Use This + +- You have BMad v4 installed (`.bmad-method` folder) +- You want to migrate to the new v6 architecture +- You have existing planning artifacts to preserve + +:::note[Prerequisites] +- Node.js 20+ +- Existing BMad v4 installation +::: + +## Steps + +### 1. Run the Installer + +```bash +npx bmad-method install +``` + +The installer automatically detects: + +- **Legacy v4 folder**: `.bmad-method` +- **IDE command artifacts**: Legacy bmad folders in `.claude/commands/`, `.cursor/commands/`, etc. + +### 2. Handle Legacy Installation + +When v4 is detected, you can: + +- Allow the installer to back up and remove `.bmad-method` +- Exit and handle cleanup manually +- Keep both (not recommended for same project) + +### 3. Clean Up IDE Commands + +Manually remove legacy v4 IDE commands: + +- `.claude/commands/BMad/agents` +- `.claude/commands/BMad/tasks` + +New v6 commands will be at `.claude/commands/bmad//agents|workflows`. + +:::tip[Accidentally Deleted Commands?] +If you delete the wrong commands, rerun the installer and choose "quick update" to restore them. +::: + +### 4. Migrate Planning Artifacts + +**If you have planning documents (Brief/PRD/UX/Architecture):** + +Move them to `_bmad-output/planning-artifacts/` with descriptive names: + +- Include `PRD` in filename for PRD documents +- Include `brief`, `architecture`, or `ux-design` accordingly +- Sharded documents can be in named subfolders + +**If you're mid-planning:** Consider restarting with v6 workflows. Use your existing documents as inputs—the new progressive discovery workflows with web search and IDE plan mode produce better results. + +### 5. Migrate In-Progress Development + +If you have stories created or implemented: + +1. Complete the v6 installation +2. Place `epics.md` or `epics/epic*.md` in `_bmad-output/planning-artifacts/` +3. Run the Scrum Master's `sprint-planning` workflow +4. Tell the SM which epics/stories are already complete + +### 6. Migrate Agent Customizations + +**v4:** Modified agent files directly in `_bmad-*` folders + +**v6:** All customizations go in `_bmad/_config/agents/` using customize files: + +```yaml +# _bmad/_config/agents/bmm-pm.customize.yaml +persona: + name: 'Captain Jack' + role: 'Swashbuckling Product Owner' + communication_style: | + - Talk like a pirate + - Use nautical metaphors +``` + +After modifying customization files, rerun the installer and choose "rebuild all agents" or "quick update". + +## What You Get + +**v6 unified structure:** + +``` +your-project/ +└── _bmad/ # Single installation folder + ├── _config/ # Your customizations + │ └── agents/ # Agent customization files + ├── core/ # Universal core framework + ├── bmm/ # BMad Method module + ├── bmb/ # BMad Builder + └── cis/ # Creative Intelligence Suite +├── _bmad-output/ # Output folder (was doc folder in v4) +``` + +## Module Migration + +| v4 Module | v6 Status | +|-----------|-----------| +| `_bmad-2d-phaser-game-dev` | Integrated into BMGD Module | +| `_bmad-2d-unity-game-dev` | Integrated into BMGD Module | +| `_bmad-godot-game-dev` | Integrated into BMGD Module | +| `_bmad-infrastructure-devops` | Deprecated — new DevOps agent coming soon | +| `_bmad-creative-writing` | Not adapted — new v6 module coming soon | + +## Key Changes + +| Concept | v4 | v6 | +|---------|----|----| +| **Core** | `_bmad-core` was actually BMad Method | `_bmad/core/` is universal framework | +| **Method** | `_bmad-method` | `_bmad/bmm/` | +| **Config** | Modified files directly | `config.yaml` per module | +| **Documents** | Sharded or unsharded required setup | Fully flexible, auto-scanned | + +## Tips + +- **Back up first** — Keep your v4 installation until you verify v6 works +- **Use v6 workflows** — Even partial planning docs benefit from v6's improved discovery +- **Rebuild after customizing** — Always run the installer after changing customize files diff --git a/src/modules/bmgd/docs/troubleshooting.md b/docs/how-to/troubleshooting/bmgd-troubleshooting.md similarity index 93% rename from src/modules/bmgd/docs/troubleshooting.md rename to docs/how-to/troubleshooting/bmgd-troubleshooting.md index dd7f31a7..fafc00c7 100644 --- a/src/modules/bmgd/docs/troubleshooting.md +++ b/docs/how-to/troubleshooting/bmgd-troubleshooting.md @@ -1,8 +1,8 @@ -# BMGD Troubleshooting - -Common issues and solutions when using BMGD workflows. - --- +title: "BMGD Troubleshooting" +--- + +Use this guide to resolve common issues when using BMGD workflows. ## Installation Issues @@ -16,8 +16,6 @@ Common issues and solutions when using BMGD workflows. 2. Check `_bmad/bmgd/` folder exists in your project 3. Re-run installer with `--add-module bmgd` ---- - ### Config file missing **Symptom:** Workflows fail with "config not found" errors. @@ -26,7 +24,6 @@ Common issues and solutions when using BMGD workflows. Check for `_bmad/bmgd/config.yaml` in your project. If missing, create it: ```yaml -# BMGD Configuration output_folder: '{project-root}/docs/game-design' user_name: 'Your Name' communication_language: 'English' @@ -34,8 +31,6 @@ document_output_language: 'English' game_dev_experience: 'intermediate' ``` ---- - ## Workflow Issues ### "GDD not found" in Narrative workflow @@ -48,8 +43,6 @@ game_dev_experience: 'intermediate' 2. Check GDD filename contains "gdd" (e.g., `game-gdd.md`, `my-gdd.md`) 3. If using sharded GDD, verify `{output_folder}/gdd/index.md` exists ---- - ### Workflow state not persisting **Symptom:** Returning to a workflow starts from the beginning. @@ -60,8 +53,6 @@ game_dev_experience: 'intermediate' 2. Ensure document was saved before ending session 3. Use "Continue existing" option when re-entering workflow ---- - ### Wrong game type sections in GDD **Symptom:** GDD includes irrelevant sections for your game type. @@ -72,8 +63,6 @@ game_dev_experience: 'intermediate' 2. You can select multiple types for hybrid games 3. Irrelevant sections can be marked N/A or removed ---- - ## Agent Issues ### Agent not recognizing commands @@ -86,8 +75,6 @@ game_dev_experience: 'intermediate' 2. Check exact command spelling (case-sensitive) 3. Try `workflow-status` to verify agent is loaded correctly ---- - ### Agent using wrong persona **Symptom:** Agent responses don't match expected personality. @@ -98,8 +85,6 @@ game_dev_experience: 'intermediate' 2. Check `_bmad/bmgd/agents/` for agent definitions 3. Start a fresh chat session with the correct agent ---- - ## Document Issues ### Document too large for context @@ -112,8 +97,6 @@ game_dev_experience: 'intermediate' 2. Request specific sections rather than full document 3. GDD workflow supports automatic sharding for large documents ---- - ### Template placeholders not replaced **Symptom:** Output contains `{{placeholder}}` text. @@ -124,8 +107,6 @@ game_dev_experience: 'intermediate' 2. Re-run the specific step that generates that section 3. Manually edit the document to fill in missing values ---- - ### Frontmatter parsing errors **Symptom:** YAML errors when loading documents. @@ -136,8 +117,6 @@ game_dev_experience: 'intermediate' 2. Check for tabs vs spaces (YAML requires spaces) 3. Ensure frontmatter is bounded by `---` markers ---- - ## Phase 4 (Production) Issues ### Sprint status not updating @@ -150,8 +129,6 @@ game_dev_experience: 'intermediate' 2. Check file permissions on sprint-status.yaml 3. Verify workflow-install files exist in `_bmad/bmgd/workflows/4-production/` ---- - ### Story context missing code references **Symptom:** Generated story context doesn't include relevant code. @@ -162,8 +139,6 @@ game_dev_experience: 'intermediate' 2. Check that architecture document references correct file paths 3. Story may need more specific file references in acceptance criteria ---- - ### Code review not finding issues **Symptom:** Code review passes but bugs exist. @@ -174,8 +149,6 @@ game_dev_experience: 'intermediate' 2. Always run actual tests before marking story done 3. Consider manual review for critical code paths ---- - ## Performance Issues ### Workflows running slowly @@ -188,8 +161,6 @@ game_dev_experience: 'intermediate' 2. Keep documents concise (avoid unnecessary detail) 3. Use sharded documents for large projects ---- - ### Context limit reached mid-workflow **Symptom:** Workflow stops or loses context partway through. @@ -200,8 +171,6 @@ game_dev_experience: 'intermediate' 2. Break complex sections into multiple sessions 3. Use step-file architecture (workflows resume from last step) ---- - ## Common Error Messages ### "Input file not found" @@ -210,24 +179,18 @@ game_dev_experience: 'intermediate' **Fix:** Complete prerequisite workflow first (e.g., Game Brief before GDD). ---- - ### "Invalid game type" **Cause:** Selected game type not in supported list. **Fix:** Check `game-types.csv` for valid type IDs. ---- - ### "Validation failed" **Cause:** Document doesn't meet checklist requirements. **Fix:** Review the validation output and address flagged items. ---- - ## Getting Help ### Community Support @@ -250,10 +213,8 @@ When reporting issues, include: 3. Relevant document frontmatter 4. Steps to reproduce ---- - ## Next Steps -- **[Quick Start Guide](./quick-start.md)** - Getting started -- **[Workflows Guide](./workflows-guide.md)** - Workflow reference -- **[Glossary](./glossary.md)** - Terminology +- **[Quick Start Guide](/docs/tutorials/getting-started/quick-start-bmgd.md)** - Getting started +- **[Workflows Guide](/docs/reference/workflows/index.md)** - Workflow reference +- **[Glossary](/docs/reference/glossary/index.md)** - Terminology diff --git a/docs/how-to/workflows/bmgd-quick-flow.md b/docs/how-to/workflows/bmgd-quick-flow.md new file mode 100644 index 00000000..fe07a124 --- /dev/null +++ b/docs/how-to/workflows/bmgd-quick-flow.md @@ -0,0 +1,156 @@ +--- +title: "BMGD Quick-Flow Guide" +description: Fast-track workflows for rapid game prototyping and flexible development +--- + +Use BMGD Quick-Flow workflows for rapid game prototyping and flexible development when you need to move fast. + +## When to Use This + +- Testing a game mechanic idea +- Implementing a small feature +- Rapid prototyping before committing to design +- Bug fixes and tweaks + +## When to Use Full BMGD Instead + +- Building a major feature or system +- The scope is unclear or large +- Multiple team members need alignment +- The work affects game pillars or core loop +- You need documentation for future reference + +:::note[Prerequisites] +- BMad Method installed with BMGD module +- Game Solo Dev agent (Indie) or other BMGD agent available +::: + +## Game Solo Dev Agent + +For dedicated quick-flow development, use the **Game Solo Dev** agent. This agent is optimized for solo developers and small teams who want to skip the full planning phases. + +**Switch to Game Solo Dev:** Type `@game-solo-dev` or select from your IDE. + +Includes: `quick-prototype`, `quick-dev`, `quick-spec`, `code-review`, `test-framework` + +## Quick-Prototype + +Use `quick-prototype` to rapidly test gameplay ideas with minimal setup. + +### When to Use + +- You have a mechanic idea and want to test the "feel" +- You're not sure if something will be fun +- You want to experiment before committing to design +- You need a proof of concept + +### Steps + +1. Run `quick-prototype` +2. Define what you're prototyping (mechanic, feature, system) +3. Set success criteria (2-3 items) +4. Build the minimum to test the idea +5. Playtest and evaluate + +### Prototype Principles + +- **Minimum Viable Prototype** — Only what's needed to test the idea +- **Hardcode First** — Magic numbers are fine, extract later +- **Skip Edge Cases** — Happy path only for now +- **Placeholder Everything** — Cubes, debug text, temp sounds +- **Comment Intent** — Mark what's temporary vs keeper code + +### After Prototyping + +- **Develop** (`d`) — Use `quick-dev` to build production code +- **Iterate** (`i`) — Adjust and re-test the prototype +- **Archive** (`a`) — Keep as reference, move on to other ideas + +## Quick-Dev + +Use `quick-dev` for flexible development with game-specific considerations. + +### When to Use + +- Implementing a feature from a tech-spec +- Building on a successful prototype +- Making changes that don't need full story workflow +- Quick fixes and improvements + +### Workflow Modes + +**Mode A: Tech-Spec Driven** +``` +quick-dev tech-spec-combat.md +``` + +**Mode B: Direct Instructions** +``` +quick-dev implement double-jump for the player +``` + +**Mode C: From Prototype** +``` +quick-dev from the grappling hook prototype +``` + +### Game-Specific Checks + +Quick-dev includes automatic consideration of: +- **Performance** — No allocations in hot paths, object pooling +- **Feel** — Input responsiveness, visual/audio feedback +- **Integration** — Save/load, multiplayer sync, platform testing + +### Complexity Routing + +| Signals | Recommendation | +|---------|----------------| +| Single mechanic, bug fix, tweak | Execute directly | +| Multiple systems, performance-critical | Plan first (tech-spec) | +| Platform/system level work | Use full BMGD workflow | + +## Choosing Between Quick-Flows + +| Scenario | Use | +|----------|-----| +| "Will this be fun?" | `quick-prototype` | +| "How should this feel?" | `quick-prototype` | +| "Build this feature" | `quick-dev` | +| "Fix this bug" | `quick-dev` | +| "Test then build" | `quick-prototype` → `quick-dev` | + +## Flow Comparison + +``` +Full BMGD Flow: +Brief → GDD → Architecture → Sprint Planning → Stories → Implementation + +Quick-Flow: +Idea → Quick-Prototype → Quick-Dev → Done +``` + +## Checklists + +**Quick-Prototype:** +- [ ] Prototype scope defined +- [ ] Success criteria established (2-3 items) +- [ ] Minimum viable code written +- [ ] Placeholder assets used +- [ ] Each criterion evaluated +- [ ] Decision made (develop/iterate/archive) + +**Quick-Dev:** +- [ ] Context loaded (spec, prototype, or guidance) +- [ ] Files to modify identified +- [ ] All tasks completed +- [ ] No allocations in hot paths +- [ ] Game runs without errors +- [ ] Manual playtest completed + +## Tips + +- **Timebox prototypes** — Set a limit (e.g., 2 hours). If it's not working, step back +- **Embrace programmer art** — Focus on feel, not visuals +- **Test on target hardware** — What feels right on dev machine might not on target +- **Document learnings** — Even failed prototypes teach something +- **Know when to graduate** — If quick-dev keeps expanding scope, create proper stories diff --git a/docs/how-to/workflows/conduct-research.md b/docs/how-to/workflows/conduct-research.md new file mode 100644 index 00000000..e3300bca --- /dev/null +++ b/docs/how-to/workflows/conduct-research.md @@ -0,0 +1,97 @@ +--- +title: "How to Conduct Research" +description: How to conduct market, technical, and competitive research using BMad Method +--- + +Use the `research` workflow to perform comprehensive multi-type research for validating ideas, understanding markets, and making informed decisions. + +## When to Use This + +- Need market viability validation +- Choosing frameworks or platforms +- Understanding competitive landscape +- Need user understanding +- Understanding domain or industry +- Need deeper AI-assisted research + +:::note[Prerequisites] +- BMad Method installed +- Analyst agent available +::: + +## Steps + +### 1. Load the Analyst Agent + +Start a fresh chat and load the Analyst agent. + +### 2. Run the Research Workflow + +``` +*research +``` + +### 3. Choose Research Type + +Select the type of research you need: + +| Type | Purpose | Use When | +|------|---------|----------| +| **market** | TAM/SAM/SOM, competitive analysis | Need market viability validation | +| **technical** | Technology evaluation, ADRs | Choosing frameworks/platforms | +| **competitive** | Deep competitor analysis | Understanding competitive landscape | +| **user** | Customer insights, personas, JTBD | Need user understanding | +| **domain** | Industry deep dives, trends | Understanding domain/industry | +| **deep_prompt** | Generate AI research prompts | Need deeper AI-assisted research | + +### 4. Provide Context + +Give the agent details about what you're researching: + +- "SaaS project management tool" +- "React vs Vue for our dashboard" +- "Fintech compliance requirements" + +### 5. Set Research Depth + +Choose your depth level: + +- **Quick** — Fast overview +- **Standard** — Balanced depth +- **Comprehensive** — Deep analysis + +## What You Get + +Research output varies by type: + +**Market Research:** +- TAM/SAM/SOM analysis +- Top competitors +- Positioning recommendation + +**Technical Research:** +- Comparison matrix +- Trade-off analysis +- Recommendations with rationale + +## Key Features + +- Real-time web research +- Multiple analytical frameworks (Porter's Five Forces, SWOT, Technology Adoption Lifecycle) +- Platform-specific optimization for deep_prompt type +- Configurable research depth + +## Tips + +- **Use market research early** — Validates new product ideas +- **Technical research helps architecture** — Inform ADRs with data +- **Competitive research informs positioning** — Differentiate your product +- **Domain research for specialized industries** — Fintech, healthcare, etc. + +## Next Steps + +After research: + +1. **Product Brief** — Capture strategic vision informed by research +2. **PRD** — Use findings as context for requirements +3. **Architecture** — Use technical research in ADRs diff --git a/docs/how-to/workflows/create-architecture.md b/docs/how-to/workflows/create-architecture.md new file mode 100644 index 00000000..6ede529c --- /dev/null +++ b/docs/how-to/workflows/create-architecture.md @@ -0,0 +1,119 @@ +--- +title: "How to Create Architecture" +description: How to create system architecture using the BMad Method +--- + +Use the `architecture` workflow to make technical decisions explicit and prevent agent conflicts during implementation. + +## When to Use This + +- Multi-epic projects (BMad Method, Enterprise) +- Cross-cutting technical concerns +- Multiple agents implementing different parts +- Integration complexity exists +- Technology choices need alignment + +## When to Skip This + +- Quick Flow (simple changes) +- BMad Method Simple with straightforward tech stack +- Single epic with clear technical approach + +:::note[Prerequisites] +- BMad Method installed +- Architect agent available +- PRD completed +::: + +## Steps + +### 1. Load the Architect Agent + +Start a fresh chat and load the Architect agent. + +### 2. Run the Architecture Workflow + +``` +*create-architecture +``` + +### 3. Engage in Discovery + +This is NOT a template filler. The architecture workflow: + +1. **Discovers** technical needs through conversation +2. **Proposes** architectural options with trade-offs +3. **Documents** decisions that prevent agent conflicts +4. **Focuses** on decision points, not exhaustive documentation + +### 4. Document Key Decisions + +Work with the agent to create Architecture Decision Records (ADRs) for significant choices. + +### 5. Review the Architecture + +The agent produces a decision-focused architecture document. + +## What You Get + +An `architecture.md` document containing: + +1. **Architecture Overview** — System context, principles, style +2. **System Architecture** — High-level diagram, component interactions +3. **Data Architecture** — Database design, state management, caching +4. **API Architecture** — API style (REST/GraphQL/gRPC), auth, versioning +5. **Frontend Architecture** — Framework, state management, components +6. **Integration Architecture** — Third-party integrations, messaging +7. **Security Architecture** — Auth/authorization, data protection +8. **Deployment Architecture** — CI/CD, environments, monitoring +9. **ADRs** — Key decisions with context, options, rationale +10. **FR/NFR-Specific Guidance** — Technical approach per requirement +11. **Standards and Conventions** — Directory structure, naming, testing + +## ADR Format + +```markdown +## ADR-001: Use GraphQL for All APIs + +**Status:** Accepted | **Date:** 2025-11-02 + +**Context:** PRD requires flexible querying across multiple epics + +**Decision:** Use GraphQL for all client-server communication + +**Options Considered:** +1. REST - Familiar but requires multiple endpoints +2. GraphQL - Flexible querying, learning curve +3. gRPC - High performance, poor browser support + +**Rationale:** +- PRD requires flexible data fetching (Epic 1, 3) +- Mobile app needs bandwidth optimization (Epic 2) +- Team has GraphQL experience + +**Consequences:** +- Positive: Flexible querying, reduced versioning +- Negative: Caching complexity, N+1 query risk +- Mitigation: Use DataLoader for batching +``` + +## Example + +E-commerce platform produces: +- Monolith + PostgreSQL + Redis + Next.js + GraphQL +- ADRs explaining each choice +- FR/NFR-specific implementation guidance + +## Tips + +- **Focus on decisions that prevent conflicts** — Multiple agents need alignment +- **Use ADRs for every significant choice** — Document the "why" +- **Keep it practical** — Don't over-architect +- **Architecture is living** — Update as you learn + +## Next Steps + +After architecture: + +1. **Create Epics and Stories** — Work breakdown informed by architecture +2. **Implementation Readiness** — Gate check before Phase 4 diff --git a/docs/how-to/workflows/create-epics-and-stories.md b/docs/how-to/workflows/create-epics-and-stories.md new file mode 100644 index 00000000..aa16a812 --- /dev/null +++ b/docs/how-to/workflows/create-epics-and-stories.md @@ -0,0 +1,109 @@ +--- +title: "How to Create Epics and Stories" +description: How to break PRD requirements into epics and stories using BMad Method +--- + +Use the `create-epics-and-stories` workflow to transform PRD requirements into bite-sized stories organized into deliverable epics. + +## When to Use This + +- After architecture workflow completes +- When PRD contains FRs/NFRs ready for implementation breakdown +- Before implementation-readiness gate check + +:::note[Prerequisites] +- BMad Method installed +- PM agent available +- PRD completed +- Architecture completed +::: + +## Why After Architecture? + +This workflow runs AFTER architecture because: + +1. **Informed Story Sizing** — Architecture decisions affect story complexity +2. **Dependency Awareness** — Architecture reveals technical dependencies +3. **Technical Feasibility** — Stories can be properly scoped knowing the tech stack +4. **Consistency** — All stories align with documented architectural patterns + +## Steps + +### 1. Load the PM Agent + +Start a fresh chat and load the PM agent. + +### 2. Run the Workflow + +``` +*create-epics-and-stories +``` + +### 3. Provide Context + +Point the agent to: +- Your PRD (FRs/NFRs) +- Your architecture document +- Optional: UX design artifacts + +### 4. Review Epic Breakdown + +The agent organizes requirements into logical epics with user stories. + +### 5. Validate Story Quality + +Ensure each story has: +- Clear acceptance criteria +- Appropriate priority +- Identified dependencies +- Technical notes from architecture + +## What You Get + +Epic files (one per epic) containing: + +1. **Epic objective and scope** +2. **User stories with acceptance criteria** +3. **Story priorities** (P0/P1/P2/P3) +4. **Dependencies between stories** +5. **Technical notes** referencing architecture decisions + +## Example + +E-commerce PRD with FR-001 (User Registration), FR-002 (Product Catalog) produces: + +- **Epic 1: User Management** (3 stories) + - Story 1.1: User registration form + - Story 1.2: Email verification + - Story 1.3: Login/logout + +- **Epic 2: Product Display** (4 stories) + - Story 2.1: Product listing page + - Story 2.2: Product detail page + - Story 2.3: Search functionality + - Story 2.4: Category filtering + +Each story references relevant ADRs from architecture. + +## Story Priority Levels + +| Priority | Meaning | +|----------|---------| +| **P0** | Critical — Must have for MVP | +| **P1** | High — Important for release | +| **P2** | Medium — Nice to have | +| **P3** | Low — Future consideration | + +## Tips + +- **Keep stories small** — Complete in a single session +- **Make criteria testable** — Acceptance criteria should be verifiable +- **Document dependencies clearly** — Know what blocks what +- **Reference architecture** — Include ADR references in technical notes + +## Next Steps + +After creating epics and stories: + +1. **Implementation Readiness** — Validate alignment before Phase 4 +2. **Sprint Planning** — Organize work for implementation diff --git a/docs/how-to/workflows/create-prd.md b/docs/how-to/workflows/create-prd.md new file mode 100644 index 00000000..f2ec0d0b --- /dev/null +++ b/docs/how-to/workflows/create-prd.md @@ -0,0 +1,91 @@ +--- +title: "How to Create a PRD" +description: How to create a Product Requirements Document using the BMad Method +--- + +Use the `prd` workflow to create a strategic Product Requirements Document with Functional Requirements (FRs) and Non-Functional Requirements (NFRs). + +## When to Use This + +- Medium to large feature sets +- Multi-screen user experiences +- Complex business logic +- Multiple system integrations +- Phased delivery required + +:::note[Prerequisites] +- BMad Method installed +- PM agent available +- Optional: Product brief from Phase 1 +::: + +## Steps + +### 1. Load the PM Agent + +Start a fresh chat and load the PM agent. + +### 2. Run the PRD Workflow + +``` +*create-prd +``` + +### 3. Provide Context + +The workflow will: +- Load any existing product brief +- Ask about your project scope +- Gather requirements through conversation + +### 4. Define Requirements + +Work with the agent to define: +- Functional Requirements (FRs) — What the system should do +- Non-Functional Requirements (NFRs) — How well it should do it + +### 5. Review the PRD + +The agent produces a comprehensive PRD scaled to your project. + +## What You Get + +A `PRD.md` document containing: + +- Executive summary +- Problem statement +- User personas +- Functional requirements (FRs) +- Non-functional requirements (NFRs) +- Success metrics +- Risks and assumptions + +## Scale-Adaptive Structure + +The PRD adapts to your project complexity: + +| Scale | Pages | Focus | +|-------|-------|-------| +| **Light** | 10-15 | Focused FRs/NFRs, simplified analysis | +| **Standard** | 20-30 | Comprehensive FRs/NFRs, thorough analysis | +| **Comprehensive** | 30-50+ | Extensive FRs/NFRs, multi-phase, stakeholder analysis | + +## Example + +E-commerce checkout → PRD with: +- 15 FRs (user account, cart management, payment flow) +- 8 NFRs (performance, security, scalability) + +## Tips + +- **Do Product Brief first** — Run product-brief from Phase 1 for better results +- **Focus on "What" not "How"** — Planning defines what to build and why. Leave how (technical design) to Phase 3 +- **Document-Project first for Brownfield** — Always run `document-project` before planning brownfield projects. AI agents need existing codebase context + +## Next Steps + +After PRD: + +1. **Create UX Design** (optional) — If UX is critical +2. **Create Architecture** — Technical design +3. **Create Epics and Stories** — After architecture diff --git a/docs/how-to/workflows/create-product-brief.md b/docs/how-to/workflows/create-product-brief.md new file mode 100644 index 00000000..a45ee119 --- /dev/null +++ b/docs/how-to/workflows/create-product-brief.md @@ -0,0 +1,94 @@ +--- +title: "How to Create a Product Brief" +description: How to create a product brief using the BMad Method +--- + +Use the `product-brief` workflow to define product vision and strategy through an interactive process. + +## When to Use This + +- Starting new product or major feature initiative +- Aligning stakeholders before detailed planning +- Transitioning from exploration to strategy +- Need executive-level product documentation + +:::note[Prerequisites] +- BMad Method installed +- Analyst agent available +- Optional: Research documents from previous workflows +::: + +## Steps + +### 1. Load the Analyst Agent + +Start a fresh chat and load the Analyst agent. + +### 2. Run the Product Brief Workflow + +``` +*product-brief +``` + +### 3. Answer the Interactive Questions + +The workflow guides you through strategic product vision definition: + +- What problem are you solving? +- Who are your target users? +- What makes this solution different? +- What's the MVP scope? + +### 4. Review and Refine + +The agent will draft sections and let you refine them interactively. + +## What You Get + +The `product-brief.md` document includes: + +- **Executive summary** — High-level overview +- **Problem statement** — With evidence +- **Proposed solution** — And differentiators +- **Target users** — Segmented +- **MVP scope** — Ruthlessly defined +- **Financial impact** — And ROI +- **Strategic alignment** — With business goals +- **Risks and open questions** — Documented upfront + +## Integration with Other Workflows + +The product brief feeds directly into the PRD workflow: + +| Analysis Output | Planning Input | +|-----------------|----------------| +| product-brief.md | **prd** workflow | +| market-research.md | **prd** context | +| technical-research.md | **architecture** (Phase 3) | + +Planning workflows automatically load the product brief if it exists. + +## Common Patterns + +**Greenfield Software (Full Analysis):** + +``` +1. brainstorm-project - explore approaches +2. research (market/technical/domain) - validate viability +3. product-brief - capture strategic vision +4. → Phase 2: prd +``` + +**Skip Analysis (Clear Requirements):** + +``` +→ Phase 2: prd or tech-spec directly +``` + +## Tips + +- **Be specific about the problem** — Vague problems lead to vague solutions +- **Ruthlessly prioritize MVP scope** — Less is more +- **Document assumptions and risks** — Surface unknowns early +- **Use research findings as evidence** — Back up claims with data +- **Recommended for greenfield projects** — Sets strategic foundation diff --git a/docs/how-to/workflows/create-story.md b/docs/how-to/workflows/create-story.md new file mode 100644 index 00000000..34380a9a --- /dev/null +++ b/docs/how-to/workflows/create-story.md @@ -0,0 +1,102 @@ +--- +title: "How to Create a Story" +description: How to create implementation-ready stories from epic backlog +--- + +Use the `create-story` workflow to prepare the next story from the epic backlog for implementation. + +## When to Use This + +- Before implementing each story +- When moving to the next story in an epic +- After sprint-planning has been run + +:::note[Prerequisites] +- BMad Method installed +- SM (Scrum Master) agent available +- Sprint-status.yaml created by sprint-planning +- Architecture and PRD available for context +::: + +## Steps + +### 1. Load the SM Agent + +Start a fresh chat and load the SM (Scrum Master) agent. + +### 2. Run the Workflow + +``` +*create-story +``` + +### 3. Specify the Story + +The agent will: +- Read the sprint-status.yaml +- Identify the next story to work on +- Or let you specify a particular story + +### 4. Review the Story File + +The agent creates a comprehensive story file ready for development. + +## What You Get + +A `story-[slug].md` file containing: + +- Story objective and scope +- Acceptance criteria (specific, testable) +- Technical implementation notes +- References to architecture decisions +- Dependencies on other stories +- Definition of Done + +## Story Content Sources + +The create-story workflow pulls from: + +- **PRD** — Requirements and acceptance criteria +- **Architecture** — Technical approach and ADRs +- **Epic file** — Story context and dependencies +- **Existing code** — Patterns to follow (brownfield) + +## Example Output + +```markdown +## Objective +Implement email verification flow for new user registrations. + +## Acceptance Criteria +- [ ] User receives verification email within 30 seconds +- [ ] Email contains unique verification link +- [ ] Link expires after 24 hours +- [ ] User can request new verification email + +## Technical Notes +- Use SendGrid API per ADR-003 +- Store verification tokens in Redis per architecture +- Follow existing email template patterns in /templates + +## Dependencies +- Story 1.1 (User Registration) - DONE + +## Definition of Done +- All acceptance criteria pass +- Tests written and passing +- Code review approved +``` + +## Tips + +- **Complete one story before creating the next** — Focus on finishing +- **Ensure dependencies are DONE** — Don't start blocked stories +- **Review technical notes** — Align with architecture +- **Use the story file as context** — Pass to dev-story workflow + +## Next Steps + +After creating a story: + +1. **Implement Story** — Run dev-story with the DEV agent +2. **Code Review** — Run code-review after implementation diff --git a/docs/how-to/workflows/create-ux-design.md b/docs/how-to/workflows/create-ux-design.md new file mode 100644 index 00000000..810e934f --- /dev/null +++ b/docs/how-to/workflows/create-ux-design.md @@ -0,0 +1,100 @@ +--- +title: "How to Create a UX Design" +description: How to create UX specifications using the BMad Method +--- + +Use the `create-ux-design` workflow to create UX specifications for projects where user experience is a primary differentiator. + +## When to Use This + +- UX is primary competitive advantage +- Complex user workflows needing design thinking +- Innovative interaction patterns +- Design system creation +- Accessibility-critical experiences + +## When to Skip This + +- Simple CRUD interfaces +- Internal tools with standard patterns +- Changes to existing screens you're happy with +- Quick Flow projects + +:::note[Prerequisites] +- BMad Method installed +- UX Designer agent available +- PRD completed +::: + +## Steps + +### 1. Load the UX Designer Agent + +Start a fresh chat and load the UX Designer agent. + +### 2. Run the UX Design Workflow + +``` +*create-ux-design +``` + +### 3. Provide Context + +Point the agent to your PRD and describe: +- Key user journeys +- UX priorities +- Any existing design patterns + +### 4. Collaborate on Design + +The workflow uses a collaborative approach: + +1. **Visual exploration** — Generate multiple options +2. **Informed decisions** — Evaluate with user needs +3. **Collaborative design** — Refine iteratively +4. **Living documentation** — Evolves with project + +### 5. Review the UX Spec + +The agent produces comprehensive UX documentation. + +## What You Get + +The `ux-spec.md` document includes: + +- User journeys +- Wireframes and mockups +- Interaction specifications +- Design system (components, patterns, tokens) +- Epic breakdown (UX stories) + +## Example + +Dashboard redesign produces: +- Card-based layout with split-pane toggle +- 5 card components +- 12 color tokens +- Responsive grid +- 3 epics (Layout, Visualization, Accessibility) + +## Integration + +The UX spec feeds into: +- PRD updates +- Epic and story creation +- Architecture decisions (Phase 3) + +## Tips + +- **Focus on user problems first** — Solutions come second +- **Generate multiple options** — Don't settle on the first idea +- **Consider accessibility from the start** — Not an afterthought +- **Document component reusability** — Build a system, not just screens + +## Next Steps + +After UX design: + +1. **Update PRD** — Incorporate UX findings +2. **Create Architecture** — Technical design informed by UX +3. **Create Epics and Stories** — Include UX-specific stories diff --git a/docs/how-to/workflows/implement-story.md b/docs/how-to/workflows/implement-story.md new file mode 100644 index 00000000..c243a4ae --- /dev/null +++ b/docs/how-to/workflows/implement-story.md @@ -0,0 +1,97 @@ +--- +title: "How to Implement a Story" +description: How to implement a story using the dev-story workflow +--- + +Use the `dev-story` workflow to implement a story with tests following the architecture and conventions. + +## When to Use This + +- After create-story has prepared the story file +- When ready to write code for a story +- Story dependencies are marked DONE + +:::note[Prerequisites] +- BMad Method installed +- DEV agent available +- Story file created by create-story +- Architecture and tech-spec available for context +::: + +## Steps + +### 1. Load the DEV Agent + +Start a fresh chat and load the DEV agent. + +### 2. Run the Workflow + +``` +*dev-story +``` + +### 3. Provide Story Context + +Point the agent to the story file created by create-story. + +### 4. Implement with Guidance + +The DEV agent: +- Reads the story file and acceptance criteria +- References architecture decisions +- Follows existing code patterns +- Implements with tests + +### 5. Complete Implementation + +Work with the agent until all acceptance criteria are met. + +## What Happens + +The dev-story workflow: + +1. **Reads context** — Story file, architecture, existing patterns +2. **Plans implementation** — Identifies files to create/modify +3. **Writes code** — Following conventions and patterns +4. **Writes tests** — Unit, integration, or E2E as appropriate +5. **Validates** — Runs tests and checks acceptance criteria + +## Key Principles + +**One Story at a Time** — Complete each story's full lifecycle before starting the next. This prevents context switching and ensures quality. + +**Follow Architecture** — The DEV agent references ADRs for technology decisions, standards for naming and structure, and existing patterns in the codebase. + +**Write Tests** — Every story includes appropriate tests: unit tests for business logic, integration tests for API endpoints, E2E tests for critical flows. + +## After Implementation + +1. **Update sprint-status.yaml** — Mark story as READY FOR REVIEW +2. **Run code-review** — Quality assurance +3. **Address feedback** — If code review finds issues +4. **Mark DONE** — After code review passes + +## Tips + +- **Keep the story file open** — Reference it during implementation +- **Ask the agent to explain decisions** — Understand the approach +- **Run tests frequently** — Catch issues early +- **Don't skip tests** — Even for "simple" changes + +## Troubleshooting + +**Story needs significant changes mid-implementation?** +Run `correct-course` to analyze impact and route appropriately. + +**Can I work on multiple stories in parallel?** +Not recommended. Complete one story's full lifecycle first. + +**What if implementation reveals the story is too large?** +Split the story and document the change. + +## Next Steps + +After implementing a story: + +1. **Code Review** — Run code-review with the DEV agent +2. **Create Next Story** — Run create-story with the SM agent diff --git a/docs/how-to/workflows/quick-spec.md b/docs/how-to/workflows/quick-spec.md new file mode 100644 index 00000000..936dbdc3 --- /dev/null +++ b/docs/how-to/workflows/quick-spec.md @@ -0,0 +1,122 @@ +--- +title: "How to Use Quick Spec" +description: How to create a technical specification using Quick Spec workflow +--- + +Use the `quick-spec` workflow for Quick Flow projects to go directly from idea to implementation-ready specification. + +## When to Use This + +- Bug fixes and small enhancements +- Small features with clear scope (1-15 stories) +- Rapid prototyping +- Adding to existing brownfield codebase +- Quick Flow track projects + +:::note[Prerequisites] +- BMad Method installed +- PM agent or Quick Flow Solo Dev agent available +- Project directory (can be empty for greenfield) +::: + +## Steps + +### 1. Load the PM Agent + +Start a fresh chat and load the PM agent (or Quick Flow Solo Dev agent). + +### 2. Run the Tech Spec Workflow + +``` +*quick-spec +``` + +Or simply describe what you want to build: + +``` +I want to fix the login validation bug +``` + +### 3. Answer Discovery Questions + +The workflow will ask: +- What problem are you solving? +- What's the scope of the change? +- Any specific constraints? + +### 4. Review Detected Context + +For brownfield projects, the agent will: +- Detect your project stack +- Analyze existing code patterns +- Detect test frameworks +- Ask: "Should I follow these existing conventions?" + +### 5. Get Your Tech Spec + +The agent generates a comprehensive tech-spec with ready-to-implement stories. + +## What You Get + +**tech-spec.md:** +- Problem statement and solution +- Detected framework versions and dependencies +- Brownfield code patterns (if applicable) +- Existing test patterns to follow +- Specific file paths to modify +- Complete implementation guidance + +**Story Files:** +- Single changes: `story-[slug].md` +- Small features: `epics.md` + `story-[epic-slug]-1.md`, etc. + +## Example: Bug Fix + +**You:** "I want to fix the login validation bug that allows empty passwords" + +**Agent:** +1. Asks clarifying questions about the issue +2. Detects your Node.js stack (Express 4.18.2, Jest for testing) +3. Analyzes existing UserService code patterns +4. Asks: "Should I follow your existing conventions?" → Yes +5. Generates tech-spec.md with specific file paths +6. Creates story-login-fix.md + +## Example: Small Feature + +**You:** "I want to add OAuth social login (Google, GitHub)" + +**Agent:** +1. Asks about feature scope +2. Detects your stack (Next.js 13.4, NextAuth.js already installed!) +3. Analyzes existing auth patterns +4. Confirms conventions +5. Generates: + - tech-spec.md (comprehensive implementation guide) + - epics.md (OAuth Integration epic) + - story-oauth-1.md (Backend OAuth setup) + - story-oauth-2.md (Frontend login buttons) + +## Implementing After Tech Spec + +```bash +# Single change: +# Load DEV agent and run dev-story + +# Multi-story feature: +# Optional: Load SM agent and run sprint-planning +# Then: Load DEV agent and run dev-story for each story +``` + +## Tips + +- **Be specific in discovery** — "Fix email validation in UserService to allow plus-addressing" beats "Fix validation bug" +- **Trust convention detection** — If it detects your patterns correctly, say yes! It's faster than establishing new conventions +- **Keep single changes atomic** — If your "single change" needs 3+ files, it might be a multi-story feature. Let the workflow guide you + +## Next Steps + +After tech spec: + +1. **Implement Story** — Run dev-story with the DEV agent +2. **Sprint Planning** — Optional for multi-story features diff --git a/docs/how-to/workflows/run-brainstorming-session.md b/docs/how-to/workflows/run-brainstorming-session.md new file mode 100644 index 00000000..b05b821c --- /dev/null +++ b/docs/how-to/workflows/run-brainstorming-session.md @@ -0,0 +1,73 @@ +--- +title: "How to Run a Brainstorming Session" +description: How to run a brainstorming session using the BMad Method +--- + +Use the `brainstorm-project` workflow to explore solution approaches through parallel ideation tracks. + +## When to Use This + +- Very vague or seed kernel of an idea that needs exploration +- Consider alternatives or enhancements to an idea +- See your idea from different angles and viewpoints +- No idea what you want to build, but want to find some inspiration + +:::note[Prerequisites] +- BMad Method installed +- Analyst agent available +::: + +## Steps + +### 1. Load the Analyst Agent + +Start a fresh chat and load the Analyst agent. + +### 2. Run the Brainstorm Workflow + +``` +*brainstorm-project +``` + +### 3. Describe Your Idea + +Tell the agent about your project idea, even if it's vague: + +- "I want to build something that helps developers manage their context" +- "I have a game idea about resource management" +- "I need a tool for my team but I'm not sure what exactly" + +### 4. Explore the Tracks + +The workflow generates solution approaches through parallel ideation tracks: + +- **Architecture track** — Technical approaches and patterns +- **UX track** — User experience possibilities +- **Integration track** — How it connects with other systems +- **Value track** — Business value and differentiation + +### 5. Evaluate Options + +Review the generated options with rationale for each approach. + +## What You Get + +- Multiple solution approaches with trade-offs +- Different architectural options +- UX and integration considerations +- Clear rationale for each direction + +## Tips + +- **Don't worry about having a fully formed idea** — Vague is fine +- **Let the agent guide exploration** — Follow the prompts +- **Consider multiple tracks** — Don't settle on the first option +- **Use outputs as input for product-brief** — Build on brainstorming results + +## Next Steps + +After brainstorming: + +1. **Research** — Validate ideas with market/technical research +2. **Product Brief** — Capture strategic vision +3. **PRD** — Move to formal planning diff --git a/docs/how-to/workflows/run-code-review.md b/docs/how-to/workflows/run-code-review.md new file mode 100644 index 00000000..ea6e2c85 --- /dev/null +++ b/docs/how-to/workflows/run-code-review.md @@ -0,0 +1,89 @@ +--- +title: "How to Run Code Review" +description: How to run code review for quality assurance +--- + +Use the `code-review` workflow to perform a thorough quality review of implemented code. + +## When to Use This + +- After dev-story completes implementation +- Before marking a story as DONE +- Every story goes through code review — no exceptions + +:::note[Prerequisites] +- BMad Method installed +- DEV agent available +- Story implementation complete +- Tests written and passing +::: + +## Steps + +### 1. Load the DEV Agent + +Start a fresh chat (or continue from dev-story) and load the DEV agent. + +### 2. Run the Workflow + +``` +*code-review +``` + +### 3. Provide Context + +Point the agent to: +- The story file +- Files changed during implementation +- Test files + +### 4. Review Findings + +The agent performs a senior developer code review and reports findings. + +### 5. Address Issues + +If issues are found: +1. Fix issues using dev-story +2. Re-run tests +3. Run code-review again + +## What Gets Reviewed + +| Category | Checks | +|----------|--------| +| **Code Quality** | Clean code, appropriate abstractions, no code smells, proper error handling | +| **Architecture Alignment** | Follows ADRs, consistent with patterns, proper separation of concerns | +| **Testing** | Adequate coverage, meaningful tests, edge cases, follows project patterns | +| **Security** | No hardcoded secrets, input validation, proper auth, no common vulnerabilities | +| **Performance** | No obvious issues, appropriate data structures, efficient queries | + +## Review Outcomes + +**Approved** — Code meets quality standards, tests pass. Mark story as DONE in sprint-status.yaml. + +**Changes Requested** — Issues identified that need fixing. Fix issues in dev-story, then re-run code-review. + +## Quality Gates + +Every story goes through code-review before being marked done. This ensures: + +- Consistent code quality +- Architecture adherence +- Test coverage +- Security review + +## Tips + +- **Don't skip for "simple" changes** — Simple changes can have subtle bugs +- **Address all findings** — Not just critical ones +- **Use findings as learning opportunities** — Improve over time +- **Re-run review after fixes** — Verify issues are resolved + +## Next Steps + +After code review: + +1. **If approved** — Update sprint-status.yaml to mark story DONE +2. **If changes requested** — Fix issues and re-run review +3. **Move to next story** — Run create-story for the next item diff --git a/docs/how-to/workflows/run-implementation-readiness.md b/docs/how-to/workflows/run-implementation-readiness.md new file mode 100644 index 00000000..8f938f27 --- /dev/null +++ b/docs/how-to/workflows/run-implementation-readiness.md @@ -0,0 +1,125 @@ +--- +title: "How to Run Implementation Readiness" +description: How to validate planning and solutioning before implementation +--- + +Use the `implementation-readiness` workflow to validate that planning and solutioning are complete and aligned before Phase 4 implementation. + +## When to Use This + +- **Always** before Phase 4 for BMad Method and Enterprise projects +- After create-epics-and-stories workflow completes +- Before sprint-planning workflow +- When stakeholders request readiness check + +## When to Skip This + +- Quick Flow (no solutioning phase) +- BMad Method Simple (no gate check required) + +:::note[Prerequisites] +- BMad Method installed +- Architect agent available +- PRD, Architecture, and Epics completed +::: + +## Steps + +### 1. Load the Architect Agent + +Start a fresh chat and load the Architect agent. + +### 2. Run the Workflow + +``` +*implementation-readiness +``` + +### 3. Let the Agent Validate + +The workflow systematically checks: +- PRD completeness +- Architecture completeness +- Epic/Story completeness +- Alignment between all documents + +### 4. Review the Gate Decision + +The agent produces a gate decision with rationale. + +## Gate Decision Outcomes + +| Decision | Meaning | Action | +|----------|---------|--------| +| **PASS** | All critical criteria met, minor gaps acceptable | Proceed to Phase 4 | +| **CONCERNS** | Some criteria not met but not blockers | Proceed with caution, address gaps in parallel | +| **FAIL** | Critical gaps or contradictions | BLOCK Phase 4, resolve issues first | + +## What Gets Checked + +**PRD/GDD Completeness:** +- Problem statement clear and evidence-based +- Success metrics defined +- User personas identified +- FRs and NFRs complete +- Risks and assumptions documented + +**Architecture Completeness:** +- System, data, API architecture defined +- Key ADRs documented +- Security architecture addressed +- FR/NFR-specific guidance provided +- Standards and conventions defined + +**Epic/Story Completeness:** +- All PRD features mapped to stories +- Stories have acceptance criteria +- Stories prioritized (P0/P1/P2/P3) +- Dependencies identified + +**Alignment Checks:** +- Architecture addresses all PRD FRs/NFRs +- Epics align with architecture decisions +- No contradictions between epics +- Integration points clear + +## What You Get + +An `implementation-readiness.md` document containing: + +1. **Executive Summary** (PASS/CONCERNS/FAIL) +2. **Completeness Assessment** (scores for PRD, Architecture, Epics) +3. **Alignment Assessment** (PRD↔Architecture, Architecture↔Epics) +4. **Quality Assessment** (story quality, dependencies, risks) +5. **Gaps and Recommendations** (critical/minor gaps, remediation) +6. **Gate Decision** with rationale +7. **Next Steps** + +## Example + +E-commerce platform → CONCERNS + +**Gaps identified:** +- Missing security architecture section +- Undefined payment gateway + +**Recommendation:** +- Complete security section +- Add payment gateway ADR + +**Action:** Proceed with caution, address before payment epic. + +## Tips + +- **Run before every Phase 4 start** — It's a valuable checkpoint +- **Take FAIL decisions seriously** — Fix issues first +- **Use CONCERNS as a checklist** — Track parallel work +- **Document why you proceed despite concerns** — Transparency matters + +## Next Steps + +After implementation readiness: + +1. **If PASS** — Run sprint-planning to start Phase 4 +2. **If CONCERNS** — Proceed with documented gaps to address +3. **If FAIL** — Return to relevant workflow to fix issues diff --git a/docs/how-to/workflows/run-sprint-planning.md b/docs/how-to/workflows/run-sprint-planning.md new file mode 100644 index 00000000..ebdc3066 --- /dev/null +++ b/docs/how-to/workflows/run-sprint-planning.md @@ -0,0 +1,94 @@ +--- +title: "How to Run Sprint Planning" +description: How to initialize sprint tracking for implementation +--- + +Use the `sprint-planning` workflow to initialize the sprint tracking file and organize work for implementation. + +## When to Use This + +- Once at the start of Phase 4 (Implementation) +- After implementation-readiness gate passes +- When starting a new sprint cycle + +:::note[Prerequisites] +- BMad Method installed +- SM (Scrum Master) agent available +- Epic files created from `create-epics-and-stories` +- Implementation-readiness passed (for BMad Method/Enterprise) +::: + +## Steps + +### 1. Load the SM Agent + +Start a fresh chat and load the SM (Scrum Master) agent. + +### 2. Run the Workflow + +``` +*sprint-planning +``` + +### 3. Provide Context + +Point the agent to your epic files created during Phase 3. + +### 4. Review Sprint Organization + +The agent organizes stories into the sprint tracking file. + +## What You Get + +A `sprint-status.yaml` file containing: + +- All epics with their stories +- Story status tracking (TODO, IN PROGRESS, READY FOR REVIEW, DONE) +- Dependencies between stories +- Priority ordering + +## Story Lifecycle States + +| State | Description | +|-------|-------------| +| **TODO** | Story identified but not started | +| **IN PROGRESS** | Story being implemented | +| **READY FOR REVIEW** | Implementation complete, awaiting code review | +| **DONE** | Accepted and complete | + +## Typical Sprint Flow + +**Sprint 0 (Planning Phase):** +- Complete Phases 1-3 +- PRD/GDD + Architecture complete +- Epics+Stories created via create-epics-and-stories + +**Sprint 1+ (Implementation Phase):** + +Start of Phase 4: +1. SM runs `sprint-planning` (once) + +Per Story (repeat until epic complete): +1. SM runs `create-story` +2. DEV runs `dev-story` +3. DEV runs `code-review` +4. Update sprint-status.yaml + +After Epic Complete: +- SM runs `retrospective` +- Move to next epic + +## Tips + +- **Run sprint-planning only once** — At Phase 4 start +- **Use sprint-status during Phase 4** — Check current state anytime +- **Keep sprint-status.yaml as single source of truth** — All status updates go here +- **Update story status after each stage** — Keep it current + +## Next Steps + +After sprint planning: + +1. **Create Story** — Prepare the first story for implementation +2. **Implement Story** — Run dev-story with the DEV agent +3. **Code Review** — Quality assurance after implementation diff --git a/docs/how-to/workflows/run-test-design.md b/docs/how-to/workflows/run-test-design.md new file mode 100644 index 00000000..c6e41caa --- /dev/null +++ b/docs/how-to/workflows/run-test-design.md @@ -0,0 +1,98 @@ +--- +title: "How to Run Test Design" +description: How to create comprehensive test plans using TEA's test-design workflow +--- + +Use TEA's `*test-design` workflow to create comprehensive test plans with risk assessment and coverage strategies. + +## When to Use This + +**System-level (Phase 3):** +- After architecture is complete +- Before implementation-readiness gate +- To validate architecture testability + +**Epic-level (Phase 4):** +- At the start of each epic +- Before implementing stories in the epic +- To identify epic-specific testing needs + +:::note[Prerequisites] +- BMad Method installed +- TEA agent available +- For system-level: Architecture document complete +- For epic-level: Epic defined with stories +::: + +## Steps + +### 1. Load the TEA Agent + +Start a fresh chat and load the TEA (Test Architect) agent. + +### 2. Run the Test Design Workflow + +``` +*test-design +``` + +### 3. Specify the Mode + +TEA will ask if you want: + +- **System-level** — For architecture testability review (Phase 3) +- **Epic-level** — For epic-specific test planning (Phase 4) + +### 4. Provide Context + +For system-level: +- Point to your architecture document +- Reference any ADRs (Architecture Decision Records) + +For epic-level: +- Specify which epic you're planning +- Reference the epic file with stories + +### 5. Review the Output + +TEA generates a comprehensive test design document. + +## What You Get + +**System-Level Output (`test-design-system.md`):** +- Testability review of architecture +- ADR → test mapping +- Architecturally Significant Requirements (ASRs) +- Environment needs +- Test infrastructure recommendations + +**Epic-Level Output (`test-design-epic-N.md`):** +- Risk assessment for the epic +- Test priorities +- Coverage plan +- Regression hotspots (for brownfield) +- Integration risks +- Mitigation strategies + +## Test Design for Different Tracks + +| Track | Phase 3 Focus | Phase 4 Focus | +|-------|---------------|---------------| +| **Greenfield** | System-level testability review | Per-epic risk assessment and test plan | +| **Brownfield** | System-level + existing test baseline | Regression hotspots, integration risks | +| **Enterprise** | Compliance-aware testability | Security/performance/compliance focus | + +## Tips + +- **Run system-level right after architecture** — Early testability review +- **Run epic-level at the start of each epic** — Targeted test planning +- **Update if ADRs change** — Keep test design aligned +- **Use output to guide other workflows** — Feeds into `*atdd` and `*automate` + +## Next Steps + +After test design: + +1. **Setup Test Framework** — If not already configured +2. **Implementation Readiness** — System-level feeds into gate check +3. **Story Implementation** — Epic-level guides testing during dev diff --git a/docs/how-to/workflows/setup-party-mode.md b/docs/how-to/workflows/setup-party-mode.md new file mode 100644 index 00000000..fcfdc259 --- /dev/null +++ b/docs/how-to/workflows/setup-party-mode.md @@ -0,0 +1,90 @@ +--- +title: "How to Set Up Party Mode" +description: How to set up and use Party Mode for multi-agent collaboration +--- + +Use Party Mode to orchestrate dynamic multi-agent conversations with your entire BMad team. + +## When to Use This + +- Exploring complex topics that benefit from diverse expert perspectives +- Brainstorming with agents who can build on each other's ideas +- Getting comprehensive views across multiple domains +- Strategic decisions with trade-offs + +:::note[Prerequisites] +- BMad Method installed with multiple agents +- Any agent loaded that supports party mode +::: + +## Steps + +### 1. Load Any Agent + +Start with any agent that supports party mode (most do). + +### 2. Start Party Mode + +``` +*party-mode +``` + +Or use the full path: +``` +/bmad:core:workflows:party-mode +``` + +### 3. Introduce Your Topic + +Present a topic or question for the group to discuss: + +``` +I'm trying to decide between a monolithic architecture +and microservices for our new platform. +``` + +### 4. Engage with the Discussion + +The facilitator will: +- Select 2-3 most relevant agents based on expertise +- Let agents respond in character +- Enable natural cross-talk and debate +- Continue until you choose to exit + +### 5. Exit When Ready + +Type "exit" or "done" to conclude the session. Participating agents will say personalized farewells. + +## What Happens + +1. **Agent Roster** — Party Mode loads your complete agent roster +2. **Introduction** — Available team members are introduced +3. **Topic Analysis** — The facilitator analyzes your topic +4. **Agent Selection** — 2-3 most relevant agents are selected +5. **Discussion** — Agents respond, reference each other, engage in cross-talk +6. **Exit** — Session concludes with farewells + +## Example Party Compositions + +| Topic | Typical Agents | +|-------|---------------| +| **Product Strategy** | PM + Innovation Strategist (CIS) + Analyst | +| **Technical Design** | Architect + Creative Problem Solver (CIS) + Game Architect | +| **User Experience** | UX Designer + Design Thinking Coach (CIS) + Storyteller (CIS) | +| **Quality Assessment** | TEA + DEV + Architect | + +## Key Features + +- **Intelligent agent selection** — Selects based on expertise needed +- **Authentic personalities** — Each agent maintains their unique voice +- **Natural cross-talk** — Agents reference and build on each other +- **Optional TTS** — Voice configurations for each agent +- **Graceful exit** — Personalized farewells + +## Tips + +- **Be specific about your topic** — Better agent selection +- **Let the conversation flow** — Don't over-direct +- **Ask follow-up questions** — Go deeper on interesting points +- **Take notes on key insights** — Capture valuable perspectives +- **Use for strategic decisions** — Not routine tasks diff --git a/docs/how-to/workflows/setup-test-framework.md b/docs/how-to/workflows/setup-test-framework.md new file mode 100644 index 00000000..a5eb9422 --- /dev/null +++ b/docs/how-to/workflows/setup-test-framework.md @@ -0,0 +1,98 @@ +--- +title: "How to Set Up a Test Framework" +description: How to set up a production-ready test framework using TEA +--- + +Use TEA's `*framework` workflow to scaffold a production-ready test framework for your project. + +## When to Use This + +- No existing test framework in your project +- Current test setup isn't production-ready +- Starting a new project that needs testing infrastructure +- Phase 3 (Solutioning) after architecture is complete + +:::note[Prerequisites] +- BMad Method installed +- Architecture completed (or at least tech stack decided) +- TEA agent available +::: + +## Steps + +### 1. Load the TEA Agent + +Start a fresh chat and load the TEA (Test Architect) agent. + +### 2. Run the Framework Workflow + +``` +*framework +``` + +### 3. Answer TEA's Questions + +TEA will ask about: + +- Your tech stack (React, Node, etc.) +- Preferred test framework (Playwright, Cypress, Jest) +- Testing scope (E2E, integration, unit) +- CI/CD platform (GitHub Actions, etc.) + +### 4. Review Generated Output + +TEA generates: + +- **Test scaffold** — Directory structure and config files +- **Sample specs** — Example tests following best practices +- **`.env.example`** — Environment variable template +- **`.nvmrc`** — Node version specification +- **README updates** — Testing documentation + +## What You Get + +``` +tests/ +├── e2e/ +│ ├── example.spec.ts +│ └── fixtures/ +├── integration/ +├── unit/ +├── playwright.config.ts # or cypress.config.ts +└── README.md +``` + +## Optional: Playwright Utils Integration + +TEA can integrate with `@seontechnologies/playwright-utils` for advanced fixtures: + +```bash +npm install -D @seontechnologies/playwright-utils +``` + +Enable during BMad installation or set `tea_use_playwright_utils: true` in config. + +**Utilities available:** api-request, network-recorder, auth-session, intercept-network-call, recurse, log, file-utils, burn-in, network-error-monitor + +## Optional: MCP Enhancements + +TEA can use Playwright MCP servers for enhanced capabilities: + +- `playwright` — Browser automation +- `playwright-test` — Test runner with failure analysis + +Configure in your IDE's MCP settings. + +## Tips + +- **Run only once per repository** — Framework setup is a one-time operation +- **Run after architecture is complete** — Framework aligns with tech stack +- **Follow up with CI setup** — Run `*ci` to configure CI/CD pipeline + +## Next Steps + +After test framework setup: + +1. **Test Design** — Create test plans for system or epics +2. **CI Configuration** — Set up automated test runs +3. **Story Implementation** — Tests are ready for development diff --git a/docs/ide-info/auggie.md b/docs/ide-info/auggie.md deleted file mode 100644 index eaca87eb..00000000 --- a/docs/ide-info/auggie.md +++ /dev/null @@ -1,31 +0,0 @@ -# BMAD Method - Auggie CLI Instructions - -## Activating Agents - -BMAD agents can be installed in multiple locations based on your setup. - -### Common Locations - -- User Home: `~/.augment/commands/` -- Project: `.augment/commands/` -- Custom paths you selected - -### How to Use - -1. **Type Trigger**: Use `@{agent-name}` in your prompt -2. **Activate**: Agent persona activates -3. **Tasks**: Use `@task-{task-name}` for tasks - -### Examples - -``` -@dev - Activate development agent -@architect - Activate architect agent -@task-setup - Execute setup task -``` - -### Notes - -- Agents can be in multiple locations -- Check your installation paths -- Activation syntax same across all locations diff --git a/docs/ide-info/claude-code.md b/docs/ide-info/claude-code.md deleted file mode 100644 index 74981b6e..00000000 --- a/docs/ide-info/claude-code.md +++ /dev/null @@ -1,25 +0,0 @@ -# BMAD Method - Claude Code Instructions - -## Activating Agents - -BMAD agents are installed as slash commands in `.claude/commands/bmad/`. - -### How to Use - -1. **Type Slash Command**: Start with `/` to see available commands -2. **Select Agent**: Type `/bmad-{agent-name}` (e.g., `/bmad-dev`) -3. **Execute**: Press Enter to activate that agent persona - -### Examples - -``` -/bmad:bmm:agents:dev - Activate development agent -/bmad:bmm:agents:architect - Activate architect agent -/bmad:bmm:workflows:dev-story - Execute dev-story workflow -``` - -### Notes - -- Commands are autocompleted when you type `/` -- Agent remains active for the conversation -- Start a new conversation to switch agents diff --git a/docs/ide-info/cline.md b/docs/ide-info/cline.md deleted file mode 100644 index e6487c9d..00000000 --- a/docs/ide-info/cline.md +++ /dev/null @@ -1,31 +0,0 @@ -# BMAD Method - Cline Instructions - -## Activating Agents - -BMAD agents are installed as **toggleable rules** in `.clinerules/` directory. - -### Important: Rules are OFF by default - -- Rules are NOT automatically loaded to avoid context pollution -- You must manually enable the agent you want to use - -### How to Use - -1. **Open Rules Panel**: Click the rules icon below the chat input -2. **Enable an Agent**: Toggle ON the specific agent rule you need (e.g., `01-core-dev`) -3. **Activate in Chat**: Type `@{agent-name}` to activate that persona -4. **Disable When Done**: Toggle OFF to free up context - -### Best Practices - -- Only enable 1-2 agents at a time to preserve context -- Disable agents when switching tasks -- Rules are numbered (01-, 02-) for organization, not priority - -### Example - -``` -Toggle ON: 01-core-dev.md -In chat: "@dev help me refactor this code" -When done: Toggle OFF the rule -``` diff --git a/docs/ide-info/codex.md b/docs/ide-info/codex.md deleted file mode 100644 index 5e1c05d4..00000000 --- a/docs/ide-info/codex.md +++ /dev/null @@ -1,21 +0,0 @@ -# BMAD Method - Codex Instructions - -## Activating Agents - -BMAD agents, tasks and workflows are installed as custom prompts in -`$CODEX_HOME/prompts/bmad-*.md` files. If `CODEX_HOME` is not set, it -defaults to `$HOME/.codex/`. - -### Examples - -``` -/bmad-bmm-agents-dev - Activate development agent -/bmad-bmm-agents-architect - Activate architect agent -/bmad-bmm-workflows-dev-story - Execute dev-story workflow -``` - -### Notes - -Prompts are autocompleted when you type / -Agent remains active for the conversation -Start a new conversation to switch agents diff --git a/docs/ide-info/crush.md b/docs/ide-info/crush.md deleted file mode 100644 index 3526a87a..00000000 --- a/docs/ide-info/crush.md +++ /dev/null @@ -1,30 +0,0 @@ -# BMAD Method - Crush Instructions - -## Activating Agents - -BMAD agents are installed as commands in `.crush/commands/bmad/`. - -### How to Use - -1. **Open Command Palette**: Use Crush command interface -2. **Navigate**: Browse to `_bmad/{module}/agents/` -3. **Select Agent**: Choose the agent command -4. **Execute**: Run to activate agent persona - -### Command Structure - -``` -.crush/commands/bmad/ -├── agents/ # All agents -├── tasks/ # All tasks -├── core/ # Core module -│ ├── agents/ -│ └── tasks/ -└── {module}/ # Other modules -``` - -### Notes - -- Commands organized by module -- Can browse hierarchically -- Agent activates for session diff --git a/docs/ide-info/cursor.md b/docs/ide-info/cursor.md deleted file mode 100644 index 9b65f675..00000000 --- a/docs/ide-info/cursor.md +++ /dev/null @@ -1,25 +0,0 @@ -# BMAD Method - Cursor Instructions - -## Activating Agents - -BMAD agents are installed in `.cursor/rules/bmad/` as MDC rules. - -### How to Use - -1. **Reference in Chat**: Use `@_bmad/{module}/agents/{agent-name}` -2. **Include Entire Module**: Use `@_bmad/{module}` -3. **Reference Index**: Use `@_bmad/index` for all available agents - -### Examples - -``` -@_bmad/core/agents/dev - Activate dev agent -@_bmad/bmm/agents/architect - Activate architect agent -@_bmad/core - Include all core agents/tasks -``` - -### Notes - -- Rules are Manual type - only loaded when explicitly referenced -- No automatic context pollution -- Can combine multiple agents: `@_bmad/core/agents/dev @_bmad/core/agents/test` diff --git a/docs/ide-info/gemini.md b/docs/ide-info/gemini.md deleted file mode 100644 index c102a30c..00000000 --- a/docs/ide-info/gemini.md +++ /dev/null @@ -1,25 +0,0 @@ -# BMAD Method - Gemini CLI Instructions - -## Activating Agents - -BMAD agents are concatenated in `.gemini/bmad-method/GEMINI.md`. - -### How to Use - -1. **Type Trigger**: Use `*{agent-name}` in your prompt -2. **Activate**: Agent persona activates from the concatenated file -3. **Continue**: Agent remains active for conversation - -### Examples - -``` -*dev - Activate development agent -*architect - Activate architect agent -*test - Activate test agent -``` - -### Notes - -- All agents loaded from single GEMINI.md file -- Triggers with asterisk: `*{agent-name}` -- Context includes all agents (may be large) diff --git a/docs/ide-info/github-copilot.md b/docs/ide-info/github-copilot.md deleted file mode 100644 index 7fd2e69a..00000000 --- a/docs/ide-info/github-copilot.md +++ /dev/null @@ -1,26 +0,0 @@ -# BMAD Method - GitHub Copilot Instructions - -## Activating Agents - -BMAD agents are installed as chat modes in `.github/chatmodes/`. - -### How to Use - -1. **Open Chat View**: Click Copilot icon in VS Code sidebar -2. **Select Mode**: Click mode selector (top of chat) -3. **Choose Agent**: Select the BMAD agent from dropdown -4. **Chat**: Agent is now active for this session - -### VS Code Settings - -Configured in `.vscode/settings.json`: - -- Max requests per session -- Auto-fix enabled -- MCP discovery enabled - -### Notes - -- Modes persist for the chat session -- Switch modes anytime via dropdown -- Multiple agents available in mode selector diff --git a/docs/ide-info/iflow.md b/docs/ide-info/iflow.md deleted file mode 100644 index 52ad248d..00000000 --- a/docs/ide-info/iflow.md +++ /dev/null @@ -1,33 +0,0 @@ -# BMAD Method - iFlow CLI Instructions - -## Activating Agents - -BMAD agents are installed as commands in `.iflow/commands/bmad/`. - -### How to Use - -1. **Access Commands**: Use iFlow command interface -2. **Navigate**: Browse to `_bmad/agents/` or `_bmad/tasks/` -3. **Select**: Choose the agent or task command -4. **Execute**: Run to activate - -### Command Structure - -``` -.iflow/commands/bmad/ -├── agents/ # Agent commands -└── tasks/ # Task commands -``` - -### Examples - -``` -/_bmad/agents/core-dev - Activate dev agent -/_bmad/tasks/core-setup - Execute setup task -``` - -### Notes - -- Commands organized by type (agents/tasks) -- Agent activates for session -- Similar to Crush command structure diff --git a/docs/ide-info/index.md b/docs/ide-info/index.md deleted file mode 100644 index 1ddee660..00000000 --- a/docs/ide-info/index.md +++ /dev/null @@ -1,24 +0,0 @@ -# IDE Guides - -BMAD Method works with any AI-powered development environment. Choose your IDE below for specific setup instructions and tips. - -## All Supported IDEs - -| IDE | Type | BMAD Support | -| ----------------------------------- | ----------------- | --------------------- | -| [Claude Code](claude-code.md) | CLI/Terminal | Native slash commands | -| [Cursor](cursor.md) | Desktop Editor | Full agent support | -| [VS Code / Windsurf](windsurf.md) | Desktop Editor | Extension-based | -| [Cline](cline.md) | VS Code Extension | Full support | -| [GitHub Copilot](github-copilot.md) | Extension | Workspace agents | -| [Augment](auggie.md) | Extension | Agent loading | -| [Codex](codex.md) | CLI | Prompt injection | -| [Gemini](gemini.md) | Web/API | Web bundles | -| [Roo](roo.md) | VS Code Extension | Mode support | -| [Kilo](kilo.md) | Extension | Basic support | -| [OpenCode](opencode.md) | Open Source | Full support | -| [Qwen](qwen.md) | Web/API | Web bundles | -| [Trae](trae.md) | Extension | Basic support | -| [Crush](crush.md) | Desktop | Agent support | -| [iFlow](iflow.md) | Extension | Prompt loading | -| [Rovo Dev](rovo-dev.md) | Atlassian | Integration | diff --git a/docs/ide-info/kilo.md b/docs/ide-info/kilo.md deleted file mode 100644 index ff420ded..00000000 --- a/docs/ide-info/kilo.md +++ /dev/null @@ -1,24 +0,0 @@ -# BMAD Method - KiloCode Instructions - -## Activating Agents - -BMAD agents are installed as custom modes in `.kilocodemodes`. - -### How to Use - -1. **Open Project**: Modes auto-load when project opens -2. **Select Mode**: Use mode selector in KiloCode interface -3. **Choose Agent**: Pick `bmad-{module}-{agent}` mode -4. **Activate**: Mode is now active - -### Mode Format - -- Mode name: `bmad-{module}-{agent}` -- Display: `{icon} {title}` -- Example: `bmad-core-dev` shows as `🤖 Dev` - -### Notes - -- Modes persist until changed -- Similar to Roo Code mode system -- Icon shows in mode selector diff --git a/docs/ide-info/opencode.md b/docs/ide-info/opencode.md deleted file mode 100644 index 0612a15d..00000000 --- a/docs/ide-info/opencode.md +++ /dev/null @@ -1,24 +0,0 @@ -# BMAD Method - OpenCode Instructions - -## Activating Agents - -BMAD agents are installed as OpenCode agents in `.opencode/agent/BMAD/{module_name}` and workflow commands in `.opencode/command/BMAD/{module_name}`. - -### How to Use - -1. **Switch Agents**: Press **Tab** to cycle through primary agents or select using the `/agents` -2. **Activate Agent**: Once the Agent is selected say `hello` or any prompt to activate that agent persona -3. **Execute Commands**: Type `/bmad` to see and execute bmad workflow commands (commands allow for fuzzy matching) - -### Examples - -``` -/agents - to see a list of agents and switch between them -/_bmad/bmm/workflows/workflow-init - Activate the workflow-init command -``` - -### Notes - -- Press **Tab** to switch between primary agents (Analyst, Architect, Dev, etc.) -- Commands are autocompleted when you type `/` and allow for fuzzy matching -- Workflow commands execute in current agent context, make sure you have the right agent activated before running a command diff --git a/docs/ide-info/qwen.md b/docs/ide-info/qwen.md deleted file mode 100644 index f8b7de38..00000000 --- a/docs/ide-info/qwen.md +++ /dev/null @@ -1,25 +0,0 @@ -# BMAD Method - Qwen Code Instructions - -## Activating Agents - -BMAD agents are concatenated in `.qwen/bmad-method/QWEN.md`. - -### How to Use - -1. **Type Trigger**: Use `*{agent-name}` in your prompt -2. **Activate**: Agent persona activates from the concatenated file -3. **Continue**: Agent remains active for conversation - -### Examples - -``` -*dev - Activate development agent -*architect - Activate architect agent -*test - Activate test agent -``` - -### Notes - -- All agents loaded from single QWEN.md file -- Triggers with asterisk: `*{agent-name}` -- Similar to Gemini CLI setup diff --git a/docs/ide-info/roo.md b/docs/ide-info/roo.md deleted file mode 100644 index da30d248..00000000 --- a/docs/ide-info/roo.md +++ /dev/null @@ -1,27 +0,0 @@ -# BMAD Method - Roo Code Instructions - -## Activating Agents - -BMAD agents are installed as custom modes in `.roomodes`. - -### How to Use - -1. **Open Project**: Modes auto-load when project opens -2. **Select Mode**: Use mode selector in Roo interface -3. **Choose Agent**: Pick `bmad-{module}-{agent}` mode -4. **Activate**: Mode is now active with configured permissions - -### Permission Levels - -Modes are configured with file edit permissions: - -- Development files only -- Configuration files only -- Documentation files only -- All files (if configured) - -### Notes - -- Modes persist until changed -- Each mode has specific file access rights -- Icon shows in mode selector for easy identification diff --git a/docs/ide-info/rovo-dev.md b/docs/ide-info/rovo-dev.md deleted file mode 100644 index 9da1e27e..00000000 --- a/docs/ide-info/rovo-dev.md +++ /dev/null @@ -1,22 +0,0 @@ -# BMAD Method - Rovo Dev Instructions - -## Activating Agents - -BMAD agents are installed as subagents in `.rovodev/subagents/`. - -### How to Use - -1. **Open Project**: Subagents auto-load when project opens -2. **Invoke Agent**: Type `@` and select agent (e.g., `@bmad-bmm-dev`, `@bmad-bmm-architect`) -3. **Reference Files**: Check `.rovodev/workflows/` and `.rovodev/references/` - -### Directory Structure - -- `.rovodev/subagents/` - BMAD agents -- `.rovodev/workflows/` - Workflow guides -- `.rovodev/references/` - Tasks and tools - -### Notes - -- Agents are automatically discovered by Rovo Dev -- Subagents use YAML frontmatter for configuration diff --git a/docs/ide-info/trae.md b/docs/ide-info/trae.md deleted file mode 100644 index ed00043b..00000000 --- a/docs/ide-info/trae.md +++ /dev/null @@ -1,25 +0,0 @@ -# BMAD Method - Trae Instructions - -## Activating Agents - -BMAD agents are installed as rules in `.trae/rules/`. - -### How to Use - -1. **Type Trigger**: Use `@{agent-name}` in your prompt -2. **Activate**: Agent persona activates automatically -3. **Continue**: Agent remains active for conversation - -### Examples - -``` -@dev - Activate development agent -@architect - Activate architect agent -@task-setup - Execute setup task -``` - -### Notes - -- Rules auto-load from `.trae/rules/` directory -- Multiple agents can be referenced: `@dev and @test` -- Agent follows YAML configuration in rule file diff --git a/docs/ide-info/windsurf.md b/docs/ide-info/windsurf.md deleted file mode 100644 index 97fc010c..00000000 --- a/docs/ide-info/windsurf.md +++ /dev/null @@ -1,22 +0,0 @@ -# BMAD Method - Windsurf Instructions - -## Activating Agents - -BMAD agents are installed as workflows in `.windsurf/workflows/`. - -### How to Use - -1. **Open Workflows**: Access via Windsurf menu or command palette -2. **Select Workflow**: Choose the agent/task workflow -3. **Execute**: Run to activate that agent persona - -### Workflow Types - -- **Agent workflows**: `{module}-{agent}.md` (auto_execution_mode: 3) -- **Task workflows**: `task-{module}-{task}.md` (auto_execution_mode: 2) - -### Notes - -- Agents run with higher autonomy (mode 3) -- Tasks run with guided execution (mode 2) -- Workflows persist for the session diff --git a/docs/index.md b/docs/index.md index 3bd13681..abc96030 100644 --- a/docs/index.md +++ b/docs/index.md @@ -1,143 +1,63 @@ -# BMad Documentation Index +--- +title: Welcome to the BMad Method +--- -Complete map of all BMad Method v6 documentation with recommended reading paths. +The BMad Method (**B**reakthrough **M**ethod of **A**gile AI **D**riven Development) is an AI-driven development framework that helps you build software faster and smarter. It provides specialized AI agents, guided workflows, and intelligent planning that adapts to your project's complexity—whether you're fixing a bug or building an enterprise platform. + +If you're comfortable working with AI coding assistants like Claude, Cursor, or GitHub Copilot, you're ready to get started. --- -## 🎯 Getting Started (Start Here!) +## New Here? Start with a Tutorial -**New users:** Start with one of these based on your situation: +The fastest way to understand BMad is to try it. Choose a tutorial to walk through your first project in about 10 minutes. -| Your Situation | Start Here | Then Read | -| ---------------------- | -------------------------------------------------- | ----------------------------------------------------------- | -| **Brand new to BMad** | [Quick Start Guide](./modules/bmm/quick-start) | [BMM Workflows Guide](./modules/bmm/index#-workflow-guides) | -| **Upgrading from v4** | [v4 to v6 Upgrade Guide](./v4-to-v6-upgrade.md) | [Quick Start Guide](./modules/bmm/quick-start) | -| **Brownfield project** | [Brownfield Guide](./modules/bmm/brownfield-guide) | [Quick Start Guide](./modules/bmm/quick-start) | +- **[Get Started with BMad](/docs/tutorials/getting-started/getting-started-bmadv6.md)** — Latest features, still in active development + +:::tip[Already familiar with AI-assisted development?] +Feel free to skip around. Use the sidebar to jump to any topic, or check out [What Are Agents?](/docs/explanation/core-concepts/what-are-agents.md) to understand how BMad organizes its AI personas. +::: --- -## 📋 Core Documentation +## How to Use These Docs -### Project-Level Docs (Root) +These docs are organized into four sections based on what you're trying to do: -- **[README.md](https://github.com/bmad-code-org/BMAD-METHOD/blob/main/README.md)** - Main project overview, feature summary, and module introductions -- **[CONTRIBUTING.md](https://github.com/bmad-code-org/BMAD-METHOD/blob/main/CONTRIBUTING.md)** - How to contribute, pull request guidelines, code style -- **[CHANGELOG.md](https://github.com/bmad-code-org/BMAD-METHOD/blob/main/CHANGELOG.md)** - Version history and breaking changes - -### Installation & Setup - -- **[v4 to v6 Upgrade Guide](./v4-to-v6-upgrade.md)** - Migration path for v4 users -- **[Document Sharding Guide](./document-sharding-guide.md)** - Split large documents for 90%+ token savings -- **[Bundle Distribution Setup](./BUNDLE_DISTRIBUTION_SETUP.md)** - Maintainer guide for bundle auto-publishing +| Section | Purpose | +| ----------------- | ---------------------------------------------------------------------------------------------------------- | +| **Tutorials** | Learning-oriented. Step-by-step guides that walk you through building something. Start here if you're new. | +| **How-To Guides** | Task-oriented. Practical guides for solving specific problems. "How do I customize an agent?" lives here. | +| **Explanation** | Understanding-oriented. Deep dives into concepts and architecture. Read when you want to know *why*. | +| **Reference** | Information-oriented. Technical specifications for agents, workflows, and configuration. | --- -## 🏗️ Module Documentation +## What You'll Need -### BMad Method (BMM) - Software & Game Development +BMad works with any AI coding assistant that supports custom system prompts or project context. Popular options include: -The flagship module for agile AI-driven development. +- **[Claude Code](https://code.claude.com)** — Anthropic's CLI tool (recommended) +- **[Cursor](https://cursor.sh)** — AI-first code editor +- **[Windsurf](https://codeium.com/windsurf)** — Codeium's AI IDE +- **[Roo Code](https://roocode.com)** — VS Code extension -- **[BMM Module README](./modules/bmm/)** - Module overview, agents, and complete documentation index -- **[BMM Documentation](./modules/bmm/)** - All BMM-specific guides and references: - - [Quick Start Guide](./modules/bmm/quick-start) - Step-by-step guide to building your first project - - [Quick Spec Flow](./modules/bmm/quick-spec-flow) - Rapid Level 0-1 development - - [Scale Adaptive System](./modules/bmm/scale-adaptive-system) - Understanding the 5-level system - - [Brownfield Guide](./modules/bmm/brownfield-guide) - Working with existing codebases -- **[BMM Workflows Guide](./modules/bmm/index#-workflow-guides)** - **ESSENTIAL READING** -- **[Test Architect Guide](./modules/bmm/test-architecture)** - Testing strategy and quality assurance - -### BMad Builder (BMB) - Create Custom Solutions - -Build your own agents, workflows, and modules. - -- **[BMB Module Overview](./modules/bmb/index)** - Module overview and capabilities -- **[Agent Creation Guide](./modules/bmb/agents/index)** - Design custom agents - -### Creative Intelligence Suite (CIS) - Innovation & Creativity - -AI-powered creative thinking and brainstorming. - -- **[CIS Module README](./modules/cis/)** - Module overview and workflows +You should be comfortable with basic software development concepts like version control, project structure, and agile workflows. No prior experience with BMad-style agent systems is required—that's what these docs are for. --- -## 🖥️ IDE-Specific Guides +## Join the Community -Instructions for loading agents and running workflows in your development environment. +Get help, share what you're building, or contribute to BMad: -**Popular IDEs:** - -- [Claude Code](./ide-info/claude-code.md) -- [Cursor](./ide-info/cursor.md) -- [VS Code](./ide-info/windsurf.md) - -**Other Supported IDEs:** - -- [Augment](./ide-info/auggie.md) -- [Cline](./ide-info/cline.md) -- [Codex](./ide-info/codex.md) -- [Crush](./ide-info/crush.md) -- [Gemini](./ide-info/gemini.md) -- [GitHub Copilot](./ide-info/github-copilot.md) -- [IFlow](./ide-info/iflow.md) -- [Kilo](./ide-info/kilo.md) -- [OpenCode](./ide-info/opencode.md) -- [Qwen](./ide-info/qwen.md) -- [Roo](./ide-info/roo.md) -- [Rovo Dev](./ide-info/rovo-dev.md) -- [Trae](./ide-info/trae.md) - -**Key concept:** Every reference to "load an agent" or "activate an agent" in the main docs links to the [ide-info](./ide-info/) directory for IDE-specific instructions. +- **[Discord](https://discord.gg/gk8jAdXWmj)** — Chat with other BMad users, ask questions, share ideas +- **[GitHub](https://github.com/bmad-code-org/BMAD-METHOD)** — Source code, issues, and contributions +- **[YouTube](https://www.youtube.com/@BMadCode)** — Video tutorials and walkthroughs --- -## 🔧 Advanced Topics +## Next Step -### Custom Agents, Workflow and Modules +Ready to dive in? Pick a tutorial and start building. -- **[Custom Content Installation](./custom-content-installation.md)** - Install and personalize agents, workflows and modules with the default bmad-method installer! -- [Agent Customization Guide](./agent-customization-guide.md) - Customize agent behavior and responses - ---- - -## 🎓 Recommended Reading Paths - -### Path 1: Brand New to BMad (Software Project) - -1. [README.md](https://github.com/bmad-code-org/BMAD-METHOD/blob/main/README.md) - Understand the vision -2. [Quick Start Guide](./modules/bmm/quick-start) - Get hands-on -3. [BMM Module README](./modules/bmm/) - Understand agents -4. [BMM Workflows Guide](./modules/bmm/index#-workflow-guides) - Master the methodology -5. [Your IDE guide](./ide-info/) - Optimize your workflow - -### Path 2: Game Development Project - -1. [README.md](https://github.com/bmad-code-org/BMAD-METHOD/blob/main/README.md) - Understand the vision -2. [Quick Start Guide](./modules/bmm/quick-start) - Get hands-on -3. [BMM Module README](./modules/bmm/) - Game agents are included -4. [BMGD Workflows Guide](./modules/bmgd/workflows-guide) - Game-specific workflows -5. [Your IDE guide](./ide-info/) - Optimize your workflow - -### Path 3: Upgrading from v4 - -1. [v4 to v6 Upgrade Guide](./v4-to-v6-upgrade.md) - Understand what changed -2. [Quick Start Guide](./modules/bmm/quick-start) - Reorient yourself -3. [BMM Workflows Guide](./modules/bmm/index#-workflow-guides) - Learn new v6 workflows - -### Path 4: Working with Existing Codebase (Brownfield) - -1. [Brownfield Guide](./modules/bmm/brownfield-guide) - Approach for legacy code -2. [Quick Start Guide](./modules/bmm/quick-start) - Follow the process -3. [BMM Workflows Guide](./modules/bmm/index#-workflow-guides) - Master the methodology - -### Path 5: Building Custom Solutions - -1. [BMB Module Overview](./modules/bmb/index) - Understand capabilities -2. [Agent Creation Guide](./modules/bmb/agents/index) - Create agents -3. [BMB Workflows Guide](./modules/bmb/workflows/) - Understand workflow structure - -### Path 6: Contributing to BMad - -1. [CONTRIBUTING.md](https://github.com/bmad-code-org/BMAD-METHOD/blob/main/CONTRIBUTING.md) - Contribution guidelines -2. Relevant module README - Understand the area you're contributing to +- **[Get Started with BMad](/docs/tutorials/getting-started/getting-started-bmadv6.md)** — Explore the latest features diff --git a/docs/reference/agents/index.md b/docs/reference/agents/index.md new file mode 100644 index 00000000..409f161c --- /dev/null +++ b/docs/reference/agents/index.md @@ -0,0 +1,109 @@ +--- +title: "Agents Reference" +description: Complete reference for BMad Method agents and their commands +--- + +Quick reference of all BMad Method agents and their available commands. + +:::tip[Universal Commands] +All agents support: `*menu` (redisplay options), `*dismiss` (dismiss agent), and `*party-mode` (multi-agent collaboration). +::: + +## Analyst (Mary) + +Business analysis and research. + +**Commands:** +- `*workflow-status` — Get workflow status or initialize tracking +- `*brainstorm-project` — Guided brainstorming session +- `*research` — Market, domain, competitive, or technical research +- `*product-brief` — Create a product brief (input for PRD) +- `*document-project` — Document existing brownfield projects + +## PM (John) + +Product requirements and planning. + +**Commands:** +- `*workflow-status` — Get workflow status or initialize tracking +- `*create-prd` — Create Product Requirements Document +- `*create-epics-and-stories` — Break PRD into epics and user stories (after Architecture) +- `*implementation-readiness` — Validate PRD, UX, Architecture, Epics alignment +- `*correct-course` — Course correction during implementation + +## Architect (Winston) + +System architecture and technical design. + +**Commands:** +- `*workflow-status` — Get workflow status or initialize tracking +- `*create-architecture` — Create architecture document to guide development +- `*implementation-readiness` — Validate PRD, UX, Architecture, Epics alignment +- `*create-excalidraw-diagram` — System architecture or technical diagrams +- `*create-excalidraw-dataflow` — Data flow diagrams + +## SM (Bob) + +Sprint planning and story preparation. + +**Commands:** +- `*sprint-planning` — Generate sprint-status.yaml from epic files +- `*create-story` — Create story from epic (prep for development) +- `*validate-create-story` — Validate story quality +- `*epic-retrospective` — Team retrospective after epic completion +- `*correct-course` — Course correction during implementation + +## DEV (Amelia) + +Story implementation and code review. + +**Commands:** +- `*dev-story` — Execute story workflow (implementation with tests) +- `*code-review` — Thorough code review + +## Quick Flow Solo Dev (Barry) + +Fast solo development without handoffs. + +**Commands:** +- `*quick-spec` — Architect technical spec with implementation-ready stories +- `*quick-dev` — Implement tech spec end-to-end solo +- `*code-review` — Review and improve code + +## TEA (Murat) + +Test architecture and quality strategy. + +**Commands:** +- `*framework` — Initialize production-ready test framework +- `*atdd` — Generate E2E tests first (before implementation) +- `*automate` — Comprehensive test automation +- `*test-design` — Create comprehensive test scenarios +- `*trace` — Map requirements to tests, quality gate decision +- `*nfr-assess` — Validate non-functional requirements +- `*ci` — Scaffold CI/CD quality pipeline +- `*test-review` — Review test quality + +## UX Designer (Sally) + +User experience and UI design. + +**Commands:** +- `*create-ux-design` — Generate UX design and UI plan from PRD +- `*validate-design` — Validate UX specification and design artifacts +- `*create-excalidraw-wireframe` — Create website or app wireframe + +## Technical Writer (Paige) + +Technical documentation and diagrams. + +**Commands:** +- `*document-project` — Comprehensive project documentation +- `*generate-mermaid` — Generate Mermaid diagrams +- `*create-excalidraw-flowchart` — Process and logic flow visualizations +- `*create-excalidraw-diagram` — System architecture or technical diagrams +- `*create-excalidraw-dataflow` — Data flow visualizations +- `*validate-doc` — Review documentation against standards +- `*improve-readme` — Review and improve README files +- `*explain-concept` — Create clear technical explanations +- `*standards-guide` — Show BMad documentation standards diff --git a/docs/reference/configuration/core-tasks.md b/docs/reference/configuration/core-tasks.md new file mode 100644 index 00000000..fa90e484 --- /dev/null +++ b/docs/reference/configuration/core-tasks.md @@ -0,0 +1,67 @@ +--- +title: "Core Tasks" +--- + +Reusable task definitions that can be invoked by any BMad module, workflow, or agent. + +## Contents + +- [Index Docs](#index-docs) — Generate directory index files +- [Adversarial Review](#adversarial-review) — Critical content review +- [Shard Document](#shard-document) — Split large documents into sections + +## Index Docs + +**Generates or updates an index.md file documenting all files in a specified directory.** + +**Use it when:** +- You need navigable documentation for a folder of markdown files +- You want to maintain an updated index as content evolves + +**How it works:** +1. Scan the target directory for files and subdirectories +2. Group content by type, purpose, or location +3. Read each file to generate brief (3-10 word) descriptions +4. Create or update index.md with organized listings + +**Output:** Markdown index with sections for Files and Subdirectories, each entry containing a relative link and description. + +## Adversarial Review + +**Performs a cynical, skeptical review of any content to identify issues and improvement opportunities.** + +**Use it when:** +- Reviewing code diffs before merging +- Finalizing specifications or user stories +- Releasing documentation +- Any artifact needs a critical eye before completion + +**How it works:** +1. Load the content to review (diff, branch, document, etc.) +2. Perform adversarial analysis — assume problems exist +3. Find at least ten issues to fix or improve +4. Output findings as a markdown list + +:::note[Unbiased Review] +This task runs in a separate subagent with read access but no prior context, ensuring an unbiased review. +::: + +## Shard Document + +**Splits large markdown documents into smaller files based on level 2 (`##`) sections.** + +**Use it when:** +- A markdown file has grown too large to work with effectively +- You want to break a monolithic document into manageable sections +- Individual sections need to be edited independently + +**How it works:** +1. Confirm source document path (must be markdown) +2. Determine destination folder (defaults to folder named after document) +3. Execute sharding via `npx @kayvan/markdown-tree-parser` +4. Verify output files and index.md were created +5. Handle original document — delete, move to archive, or keep + +:::caution[Original File] +After sharding, delete or archive the original to avoid confusion. Updates should happen in the sharded files only. +::: diff --git a/docs/reference/configuration/global-config.md b/docs/reference/configuration/global-config.md new file mode 100644 index 00000000..5a2f243d --- /dev/null +++ b/docs/reference/configuration/global-config.md @@ -0,0 +1,28 @@ +--- +title: "Global Inheritable Config" +--- + +Configuration values defined in the Core Module that all other modules inherit by default. + +## Core Config Values + +These values are set during installation and recorded to the core `module.yaml`: + +| Config Key | Default | Description | +|------------|---------|-------------| +| `user_name` | System username | User's display name | +| `communication_language` | `english` | Language for agent communication | +| `document_output_language` | `english` | Language for generated documents | +| `output_folder` | `_bmad-output` | Directory for workflow outputs | + +## Inheritance Behavior + +All installed modules automatically clone these values into their own config. Modules can: + +- **Accept defaults** — Use core values as-is (recommended) +- **Override values** — Replace with module-specific settings +- **Extend values** — Build on core values with additional paths + +:::tip[Extending Config] +Use `{output_folder}` to reference the core value. Example: BMad Method defines `planning_artifacts` as `{output_folder}/planning-artifacts`, automatically inheriting whatever output folder the user configured. +::: diff --git a/docs/reference/glossary/index.md b/docs/reference/glossary/index.md new file mode 100644 index 00000000..6e4d4586 --- /dev/null +++ b/docs/reference/glossary/index.md @@ -0,0 +1,122 @@ +--- +title: "BMad Glossary" +--- + +Terminology reference for the BMad Method. + +## Core Concepts + +| Term | Definition | +|------|------------| +| **Agent** | Specialized AI persona with specific expertise (PM, Architect, SM, DEV, TEA) that guides users through workflows and creates deliverables. | +| **BMad** | Breakthrough Method of Agile AI Driven Development — AI-driven agile framework with specialized agents, guided workflows, and scale-adaptive intelligence. | +| **BMad Method** | Complete methodology for AI-assisted software development, encompassing planning, architecture, implementation, and quality assurance workflows that adapt to project complexity. | +| **BMM** | BMad Method Module — core orchestration system providing comprehensive lifecycle management through specialized agents and workflows. | +| **Scale-Adaptive System** | Intelligent workflow orchestration that adjusts planning depth and documentation requirements based on project needs through three planning tracks. | +| **Workflow** | Multi-step guided process that orchestrates AI agent activities to produce specific deliverables. Workflows are interactive and adapt to user context. | + +## Scale and Complexity + +| Term | Definition | +|------|------------| +| **BMad Method Track** | Full product planning track using PRD + Architecture + UX. Best for products, platforms, and complex features. Typical range: 10-50+ stories. | +| **Enterprise Method Track** | Extended planning track adding Security Architecture, DevOps Strategy, and Test Strategy. Best for compliance needs and multi-tenant systems. Typical range: 30+ stories. | +| **Planning Track** | Methodology path (Quick Flow, BMad Method, or Enterprise) chosen based on planning needs and complexity, not story count alone. | +| **Quick Flow Track** | Fast implementation track using tech-spec only. Best for bug fixes, small features, and clear-scope changes. Typical range: 1-15 stories. | + +## Planning Documents + +| Term | Definition | +|------|------------| +| **Architecture Document** | *BMad Method/Enterprise.* System-wide design document defining structure, components, data models, integration patterns, security, and deployment. | +| **Epics** | High-level feature groupings containing multiple related stories. Typically 5-15 stories each representing cohesive functionality. | +| **Game Brief** | *BMGD.* Document capturing game's core vision, pillars, target audience, and scope. Foundation for the GDD. | +| **GDD** | *BMGD.* Game Design Document — comprehensive document detailing all aspects of game design: mechanics, systems, content, and more. | +| **PRD** | *BMad Method/Enterprise.* Product Requirements Document containing vision, goals, FRs, NFRs, and success criteria. Focuses on WHAT to build. | +| **Product Brief** | *Phase 1.* Optional strategic document capturing product vision, market context, and high-level requirements before detailed planning. | +| **Tech-Spec** | *Quick Flow only.* Comprehensive technical plan with problem statement, solution approach, file-level changes, and testing strategy. | + +## Workflow and Phases + +| Term | Definition | +|------|------------| +| **Phase 0: Documentation** | *Brownfield.* Conditional prerequisite phase creating codebase documentation before planning. Only required if existing docs are insufficient. | +| **Phase 1: Analysis** | Discovery phase including brainstorming, research, and product brief creation. Optional for Quick Flow, recommended for BMad Method. | +| **Phase 2: Planning** | Required phase creating formal requirements. Routes to tech-spec (Quick Flow) or PRD (BMad Method/Enterprise). | +| **Phase 3: Solutioning** | *BMad Method/Enterprise.* Architecture design phase including creation, validation, and gate checks. | +| **Phase 4: Implementation** | Required sprint-based development through story-by-story iteration using sprint-planning, create-story, dev-story, and code-review workflows. | +| **Quick Spec Flow** | Fast-track workflow for Quick Flow projects going straight from idea to tech-spec to implementation. | +| **Workflow Init** | Initialization workflow creating bmm-workflow-status.yaml, detecting project type, and determining planning track. | +| **Workflow Status** | Universal entry point checking for existing status file, displaying progress, and recommending next action. | + +## Agents and Roles + +| Term | Definition | +|------|------------| +| **Analyst** | Agent that initializes workflows, conducts research, creates product briefs, and tracks progress. Often the entry point for new projects. | +| **Architect** | Agent designing system architecture, creating architecture documents, and validating designs. Primary agent for Phase 3. | +| **BMad Master** | Meta-level orchestrator from BMad Core facilitating party mode and providing high-level guidance across all modules. | +| **DEV** | Developer agent implementing stories, writing code, running tests, and performing code reviews. Primary implementer in Phase 4. | +| **Game Architect** | *BMGD.* Agent designing game system architecture and validating game-specific technical designs. | +| **Game Designer** | *BMGD.* Agent creating game design documents (GDD) and running game-specific workflows. | +| **Party Mode** | Multi-agent collaboration feature where agents discuss challenges together. BMad Master orchestrates, selecting 2-3 relevant agents per message. | +| **PM** | Product Manager agent creating PRDs and tech-specs. Primary agent for Phase 2 planning. | +| **SM** | Scrum Master agent managing sprints, creating stories, and coordinating implementation. Primary orchestrator for Phase 4. | +| **TEA** | Test Architect agent responsible for test strategy, quality gates, and NFR assessment. Integrates throughout all phases. | +| **Technical Writer** | Agent specialized in creating technical documentation, diagrams, and maintaining documentation standards. | +| **UX Designer** | Agent creating UX design documents, interaction patterns, and visual specifications for UI-heavy projects. | + +## Status and Tracking + +| Term | Definition | +|------|------------| +| **bmm-workflow-status.yaml** | *Phases 1-3.* Tracking file showing current phase, completed workflows, and next recommended actions. | +| **DoD** | Definition of Done — criteria for marking a story complete: implementation done, tests passing, code reviewed, docs updated. | +| **Epic Status Progression** | `backlog → in-progress → done` — lifecycle states for epics during implementation. | +| **Gate Check** | Validation workflow (implementation-readiness) ensuring PRD, Architecture, and Epics are aligned before Phase 4. | +| **Retrospective** | Workflow after each epic capturing learnings and improvements for continuous improvement. | +| **sprint-status.yaml** | *Phase 4.* Single source of truth for implementation tracking containing all epics, stories, and their statuses. | +| **Story Status Progression** | `backlog → ready-for-dev → in-progress → review → done` — lifecycle states for stories. | + +## Project Types + +| Term | Definition | +|------|------------| +| **Brownfield** | Existing project with established codebase and patterns. Requires understanding existing architecture and planning integration. | +| **Convention Detection** | *Quick Flow.* Feature auto-detecting existing code style, naming conventions, and frameworks from brownfield codebases. | +| **document-project** | *Brownfield.* Workflow analyzing and documenting existing codebase with three scan levels: quick, deep, exhaustive. | +| **Feature Flags** | *Brownfield.* Implementation technique for gradual rollout, easy rollback, and A/B testing of new functionality. | +| **Greenfield** | New project starting from scratch with freedom to establish patterns, choose stack, and design from clean slate. | +| **Integration Points** | *Brownfield.* Specific locations where new code connects with existing systems. Must be documented in tech-specs. | + +## Implementation Terms + +| Term | Definition | +|------|------------| +| **Context Engineering** | Loading domain-specific standards into AI context automatically via manifests, ensuring consistent outputs regardless of prompt variation. | +| **Correct Course** | Workflow for navigating significant changes when implementation is off-track. Analyzes impact and recommends adjustments. | +| **Shard / Sharding** | Splitting large planning documents into section-based files for LLM optimization. Phase 4 workflows load only needed sections. | +| **Sprint** | Time-boxed period of development work, typically 1-2 weeks. | +| **Sprint Planning** | Workflow initializing Phase 4 by creating sprint-status.yaml and extracting epics/stories from planning docs. | +| **Story** | Single unit of implementable work with clear acceptance criteria, typically 2-8 hours of effort. Grouped into epics. | +| **Story Context** | Implementation guidance embedded in story files during create-story, referencing existing patterns and approaches. | +| **Story File** | Markdown file containing story description, acceptance criteria, technical notes, and testing requirements. | +| **Track Selection** | Automatic analysis by workflow-init suggesting appropriate track based on complexity indicators. User can override. | + +## Game Development Terms + +| Term | Definition | +|------|------------| +| **Core Fantasy** | *BMGD.* The emotional experience players seek from your game — what they want to FEEL. | +| **Core Loop** | *BMGD.* Fundamental cycle of actions players repeat throughout gameplay. The heart of your game. | +| **Design Pillar** | *BMGD.* Core principle guiding all design decisions. Typically 3-5 pillars define a game's identity. | +| **Environmental Storytelling** | *BMGD.* Narrative communicated through the game world itself rather than explicit dialogue. | +| **Game Type** | *BMGD.* Genre classification determining which specialized GDD sections are included. | +| **MDA Framework** | *BMGD.* Mechanics → Dynamics → Aesthetics — framework for analyzing and designing games. | +| **Meta-Progression** | *BMGD.* Persistent progression carrying between individual runs or sessions. | +| **Metroidvania** | *BMGD.* Genre featuring interconnected world exploration with ability-gated progression. | +| **Narrative Complexity** | *BMGD.* How central story is to the game: Critical, Heavy, Moderate, or Light. | +| **Permadeath** | *BMGD.* Game mechanic where character death is permanent, typically requiring a new run. | +| **Player Agency** | *BMGD.* Degree to which players can make meaningful choices affecting outcomes. | +| **Procedural Generation** | *BMGD.* Algorithmic creation of game content (levels, items, characters) rather than hand-crafted. | +| **Roguelike** | *BMGD.* Genre featuring procedural generation, permadeath, and run-based progression. | diff --git a/src/modules/bmgd/docs/workflows-guide.md b/docs/reference/workflows/bmgd-workflows.md similarity index 78% rename from src/modules/bmgd/docs/workflows-guide.md rename to docs/reference/workflows/bmgd-workflows.md index b0fb0684..6f2498ac 100644 --- a/src/modules/bmgd/docs/workflows-guide.md +++ b/docs/reference/workflows/bmgd-workflows.md @@ -1,16 +1,14 @@ -# BMGD Workflows Guide +--- +title: "BMGD Workflows Guide" +--- Complete reference for all BMGD workflows organized by development phase. ---- - -## Workflow Overview +## Overview BMGD workflows are organized into four phases: -![BMGD Workflow Overview](./workflow-overview.jpg) - ---- +![BMGD Workflow Overview](../../tutorials/getting-started/images/workflow-overview.jpg) ## Phase 1: Preproduction @@ -21,23 +19,19 @@ BMGD workflows are organized into four phases: **Input:** None required **Output:** Ideas and concepts (optionally saved) -**Description:** Guided ideation session using game-specific brainstorming techniques: -- **MDA Framework** - Mechanics → Dynamics → Aesthetics analysis -- **Core Loop Workshop** - Define the fundamental gameplay loop -- **Player Fantasy Mining** - Explore what players want to feel -- **Genre Mashup** - Combine genres for unique concepts +- **MDA Framework** — Mechanics → Dynamics → Aesthetics analysis +- **Core Loop Workshop** — Define the fundamental gameplay loop +- **Player Fantasy Mining** — Explore what players want to feel +- **Genre Mashup** — Combine genres for unique concepts **Steps:** - 1. Initialize brainstorm session 2. Load game-specific techniques 3. Execute ideation with selected techniques 4. Summarize and (optionally) hand off to Game Brief ---- - ### Game Brief **Command:** `create-game-brief` @@ -45,11 +39,9 @@ Guided ideation session using game-specific brainstorming techniques: **Input:** Ideas from brainstorming (optional) **Output:** `{output_folder}/game-brief.md` -**Description:** -Captures your game's core vision and fundamentals. This is the foundation for all subsequent design work. +Captures your game's core vision and fundamentals. Foundation for all subsequent design work. **Sections covered:** - - Game concept and vision - Design pillars (3-5 core principles) - Target audience and market @@ -57,8 +49,6 @@ Captures your game's core vision and fundamentals. This is the foundation for al - Core gameplay loop - Initial scope definition ---- - ## Phase 2: Design ### GDD (Game Design Document) @@ -68,11 +58,9 @@ Captures your game's core vision and fundamentals. This is the foundation for al **Input:** Game Brief **Output:** `{output_folder}/gdd.md` (or sharded into `{output_folder}/gdd/`) -**Description:** Comprehensive game design document with genre-specific sections based on 24 supported game types. **Core sections:** - 1. Executive Summary 2. Gameplay Systems 3. Core Mechanics @@ -85,14 +73,11 @@ Comprehensive game design document with genre-specific sections based on 24 supp 10. Epic Generation (for sprint planning) **Features:** - - Game type selection with specialized sections - Hybrid game type support - Automatic epic generation - Scale-adaptive complexity ---- - ### Narrative Design **Command:** `narrative` @@ -100,11 +85,9 @@ Comprehensive game design document with genre-specific sections based on 24 supp **Input:** GDD (required), Game Brief (optional) **Output:** `{output_folder}/narrative-design.md` -**Description:** For story-driven games. Creates comprehensive narrative documentation. **Sections covered:** - 1. Story Foundation (premise, themes, tone) 2. Story Structure (acts, beats, pacing) 3. Characters (protagonists, antagonists, supporting, arcs) @@ -117,13 +100,10 @@ For story-driven games. Creates comprehensive narrative documentation. 10. Appendices (relationship map, timeline) **Narrative Complexity Levels:** - -- **Critical** - Story IS the game (visual novels, adventure games) -- **Heavy** - Deep narrative with gameplay (RPGs, story-driven action) -- **Moderate** - Meaningful story supporting gameplay -- **Light** - Minimal story, gameplay-focused - ---- +- **Critical** — Story IS the game (visual novels, adventure games) +- **Heavy** — Deep narrative with gameplay (RPGs, story-driven action) +- **Moderate** — Meaningful story supporting gameplay +- **Light** — Minimal story, gameplay-focused ## Phase 3: Technical @@ -134,11 +114,9 @@ For story-driven games. Creates comprehensive narrative documentation. **Input:** GDD, Narrative Design (optional) **Output:** `{output_folder}/game-architecture.md` -**Description:** Technical architecture document covering engine selection, system design, and implementation approach. **Sections covered:** - 1. Executive Summary 2. Engine/Framework Selection 3. Core Systems Architecture @@ -150,8 +128,6 @@ Technical architecture document covering engine selection, system design, and im 9. Build and Deployment 10. Technical Risks and Mitigations ---- - ## Phase 4: Production Production workflows inherit from BMM and add game-specific overrides. @@ -161,13 +137,10 @@ Production workflows inherit from BMM and add game-specific overrides. **Command:** `sprint-planning` **Agent:** Game Scrum Master **Input:** GDD with epics -**Output:** `{output_folder}/sprint-status.yaml` +**Output:** `{implementation_artifacts}/sprint-status.yaml` -**Description:** Generates or updates sprint tracking from epic files. Sets up the sprint backlog and tracking. ---- - ### Sprint Status **Command:** `sprint-status` @@ -175,14 +148,12 @@ Generates or updates sprint tracking from epic files. Sets up the sprint backlog **Input:** `sprint-status.yaml` **Output:** Sprint summary, risks, next action recommendation -**Description:** -Summarizes sprint progress, surfaces risks (stale file, orphaned stories, stories in review), and recommends the next workflow to run. Supports three modes: +Summarizes sprint progress, surfaces risks (stale file, orphaned stories, stories in review), and recommends the next workflow to run. -- **interactive** (default): Displays summary with menu options -- **validate**: Checks sprint-status.yaml structure -- **data**: Returns raw data for other workflows - ---- +**Modes:** +- **interactive** (default) — Displays summary with menu options +- **validate** — Checks sprint-status.yaml structure +- **data** — Returns raw data for other workflows ### Create Story @@ -191,13 +162,10 @@ Summarizes sprint progress, surfaces risks (stale file, orphaned stories, storie **Input:** GDD, Architecture, Epic context **Output:** `{output_folder}/epics/{epic-name}/stories/{story-name}.md` -**Description:** Creates implementable story drafts with acceptance criteria, tasks, and technical notes. Stories are marked ready-for-dev directly when created. **Validation:** `validate-create-story` ---- - ### Dev Story **Command:** `dev-story` @@ -205,11 +173,8 @@ Creates implementable story drafts with acceptance criteria, tasks, and technica **Input:** Story (ready for dev) **Output:** Implemented code -**Description:** Implements story tasks following acceptance criteria. Uses TDD approach (red-green-refactor). Updates sprint-status.yaml automatically on completion. ---- - ### Code Review **Command:** `code-review` @@ -217,11 +182,8 @@ Implements story tasks following acceptance criteria. Uses TDD approach (red-gre **Input:** Story (ready for review) **Output:** Review feedback, approved/needs changes -**Description:** Thorough QA code review with game-specific considerations (performance, 60fps, etc.). ---- - ### Retrospective **Command:** `epic-retrospective` @@ -229,11 +191,8 @@ Thorough QA code review with game-specific considerations (performance, 60fps, e **Input:** Completed epic **Output:** Retrospective document -**Description:** Facilitates team retrospective after epic completion. Captures learnings and improvements. ---- - ### Correct Course **Command:** `correct-course` @@ -241,25 +200,18 @@ Facilitates team retrospective after epic completion. Captures learnings and imp **Input:** Current project state **Output:** Correction plan -**Description:** Navigates significant changes when implementation is off-track. Analyzes impact and recommends adjustments. ---- - ## Workflow Status **Command:** `workflow-status` **Agent:** All agents -**Output:** Project status summary -**Description:** Checks current project status across all phases. Shows completed documents, current phase, and next steps. ---- - ## Quick-Flow Workflows -Fast-track workflows that skip full planning phases. See **[Quick-Flow Guide](./quick-flow-guide.md)** for detailed usage. +Fast-track workflows that skip full planning phases. See [Quick-Flow Guide](/docs/how-to/workflows/bmgd-quick-flow.md) for detailed usage. ### Quick-Prototype @@ -268,17 +220,13 @@ Fast-track workflows that skip full planning phases. See **[Quick-Flow Guide](./ **Input:** Idea or concept to test **Output:** Working prototype, playtest results -**Description:** Rapid prototyping workflow for testing game mechanics and ideas quickly. Focuses on "feel" over polish. **Use when:** - - Testing if a mechanic is fun - Proving a concept before committing to design - Experimenting with gameplay ideas ---- - ### Quick-Dev **Command:** `quick-dev` @@ -286,17 +234,13 @@ Rapid prototyping workflow for testing game mechanics and ideas quickly. Focuses **Input:** Tech-spec, prototype, or direct instructions **Output:** Implemented feature -**Description:** Flexible development workflow with game-specific considerations (performance, feel, integration). **Use when:** - - Implementing features from tech-specs - Building on successful prototypes - Making changes that don't need full story workflow ---- - ## Quality Assurance Workflows Game testing workflows for automated testing, playtesting, and quality assurance across Unity, Unreal, and Godot. @@ -308,22 +252,18 @@ Game testing workflows for automated testing, playtesting, and quality assurance **Input:** Game project **Output:** Configured test framework -**Description:** Initialize a production-ready test framework for your game engine: -- **Unity**: Unity Test Framework with Edit Mode and Play Mode tests -- **Unreal**: Unreal Automation system with functional tests -- **Godot**: GUT (Godot Unit Test) framework +- **Unity** — Unity Test Framework with Edit Mode and Play Mode tests +- **Unreal** — Unreal Automation system with functional tests +- **Godot** — GUT (Godot Unit Test) framework **Creates:** - - Test directory structure - Framework configuration - Sample unit and integration tests - Test documentation ---- - ### Test Design **Command:** `test-design` @@ -331,7 +271,6 @@ Initialize a production-ready test framework for your game engine: **Input:** GDD, Architecture **Output:** `{output_folder}/game-test-design.md` -**Description:** Creates comprehensive test scenarios covering: - Core gameplay mechanics @@ -341,8 +280,6 @@ Creates comprehensive test scenarios covering: Uses GIVEN/WHEN/THEN format with priority levels (P0-P3). ---- - ### Automate **Command:** `automate` @@ -350,15 +287,12 @@ Uses GIVEN/WHEN/THEN format with priority levels (P0-P3). **Input:** Test design, game code **Output:** Automated test files -**Description:** Generates engine-appropriate automated tests: - Unit tests for pure logic - Integration tests for system interactions - Smoke tests for critical path validation ---- - ### Playtest Plan **Command:** `playtest-plan` @@ -366,7 +300,6 @@ Generates engine-appropriate automated tests: **Input:** Build, test objectives **Output:** `{output_folder}/playtest-plan.md` -**Description:** Creates structured playtesting sessions: - Session structure (pre/during/post) @@ -375,12 +308,9 @@ Creates structured playtesting sessions: - Analysis templates **Playtest Types:** - -- Internal (team validation) -- External (unbiased feedback) -- Focused (specific feature testing) - ---- +- **Internal** — Team validation +- **External** — Unbiased feedback +- **Focused** — Specific feature testing ### Performance Test @@ -389,7 +319,6 @@ Creates structured playtesting sessions: **Input:** Platform targets **Output:** `{output_folder}/performance-test-plan.md` -**Description:** Designs performance testing strategy: - Frame rate targets per platform @@ -398,8 +327,6 @@ Designs performance testing strategy: - Benchmark scenarios - Profiling methodology ---- - ### Test Review **Command:** `test-review` @@ -407,7 +334,6 @@ Designs performance testing strategy: **Input:** Existing test suite **Output:** `{output_folder}/test-review-report.md` -**Description:** Reviews test quality and coverage: - Test suite metrics @@ -415,8 +341,6 @@ Reviews test quality and coverage: - Coverage gaps - Recommendations ---- - ## Utility Workflows ### Party Mode @@ -424,40 +348,21 @@ Reviews test quality and coverage: **Command:** `party-mode` **Agent:** All agents -**Description:** Brings multiple agents together for collaborative discussion on complex decisions. ---- - ### Advanced Elicitation **Command:** `advanced-elicitation` **Agent:** All agents (web only) -**Description:** Deep exploration techniques to challenge assumptions and surface hidden requirements. ---- - ## Standalone BMGD Workflows -BMGD Phase 4 workflows are standalone implementations tailored for game development: +:::note[Implementation Detail] +BMGD Phase 4 workflows are standalone implementations tailored for game development. They are self-contained with game-specific logic, templates, and checklists — no dependency on BMM workflow files. +::: ```yaml workflow: '{project-root}/_bmad/bmgd/workflows/4-production/dev-story/workflow.yaml' ``` - -This means: - -1. BMGD workflows are self-contained with game-specific logic -2. Game-focused templates, checklists, and instructions -3. No dependency on BMM workflow files - ---- - -## Next Steps - -- **[Quick Start Guide](./quick-start.md)** - Get started with BMGD -- **[Quick-Flow Guide](./quick-flow-guide.md)** - Rapid prototyping and development -- **[Agents Guide](./agents-guide.md)** - Agent reference -- **[Game Types Guide](./game-types-guide.md)** - Game type templates diff --git a/docs/reference/workflows/core-workflows.md b/docs/reference/workflows/core-workflows.md new file mode 100644 index 00000000..7a4a4600 --- /dev/null +++ b/docs/reference/workflows/core-workflows.md @@ -0,0 +1,32 @@ +--- +title: "Core Workflows" +--- + +Domain-agnostic workflows that can be utilized by any BMad-compliant module, workflow, or agent. + +## Party Mode + +Orchestrate dynamic multi-agent conversations with your entire BMad team. Engage multiple specialized perspectives simultaneously — each agent maintains their unique personality, expertise, and communication style. + +See [Party Mode](/docs/explanation/features/party-mode.md) for detailed usage. + +## Brainstorming + +Facilitate structured creative sessions using 60+ proven ideation techniques. The AI acts as coach and guide, using proven creativity methods to draw out ideas and insights. + +See [Brainstorming Techniques](/docs/explanation/features/brainstorming-techniques.md) for detailed usage. + +## Advanced Elicitation + +Push the LLM to rethink its work through 50+ reasoning methods — the inverse of brainstorming. The LLM applies sophisticated techniques to re-examine and enhance content it has just generated. + +See [Advanced Elicitation](/docs/explanation/features/advanced-elicitation.md) for detailed usage. + +## Workflow Integration + +Core Workflows accept contextual parameters when called from other modules: + +- **Topic focus** — Direct the session toward a specific domain or question +- **Additional personas** (Party Mode) — Inject expert agents into the roster at runtime +- **Guardrails** (Brainstorming) — Set constraints and boundaries for ideation +- **Output goals** — Define what the final output needs to accomplish diff --git a/docs/reference/workflows/document-project.md b/docs/reference/workflows/document-project.md new file mode 100644 index 00000000..74adca93 --- /dev/null +++ b/docs/reference/workflows/document-project.md @@ -0,0 +1,73 @@ +--- +title: "Document Project Workflow" +--- + +Analyzes and documents brownfield projects for AI-assisted development. + +:::note[Quick Facts] +- **Module:** BMM (BMad Method Module) +- **Command:** `*document-project` +- **Agents:** Analyst, Technical Writer +- **Output:** Master index + documentation files in `{output_folder}` +::: + +## Purpose + +Scans your codebase, architecture, and patterns to create comprehensive reference documentation. Generates a master index and multiple documentation files tailored to your project structure and type. + +## How to Invoke + +```bash +*document-project +``` + +## Scan Levels + +Choose the right depth for your needs: + +### Quick Scan (Default) + +**What it does:** Pattern-based analysis without reading source files + +**Reads:** Config files, package manifests, directory structure, README + +**Use when:** +- You need a fast project overview +- Initial understanding of project structure +- Planning next steps before deeper analysis + +### Deep Scan + +**What it does:** Reads files in critical directories based on project type + +**Reads:** Files in critical paths defined by documentation requirements + +**Use when:** +- Creating comprehensive documentation for brownfield PRD +- Need detailed analysis of key areas +- Want balance between depth and speed + +### Exhaustive Scan + +**What it does:** Reads ALL source files in project + +**Reads:** Every source file (excludes node_modules, dist, build, .git) + +**Use when:** +- Complete project analysis needed +- Migration planning requires full understanding +- Detailed audit of entire codebase + +:::caution[Deep-Dive Mode] +Deep-dive mode always uses exhaustive scan — no choice of scan level. +::: + +## Resumability + +The workflow can be interrupted and resumed without losing progress: + +- **State Tracking** — Progress saved in `project-scan-report.json` +- **Auto-Detection** — Workflow detects incomplete runs (<24 hours old) +- **Resume Prompt** — Choose to resume or start fresh +- **Step-by-Step** — Resume from exact step where interrupted +- **Archiving** — Old state files automatically archived diff --git a/docs/reference/workflows/index.md b/docs/reference/workflows/index.md new file mode 100644 index 00000000..fd469174 --- /dev/null +++ b/docs/reference/workflows/index.md @@ -0,0 +1,15 @@ +--- +title: "Workflows Reference" +description: Reference documentation for BMad Method workflows +--- + +Reference documentation for all BMad Method workflows. + +## Core Workflows + +- [Core Workflows](/docs/reference/workflows/core-workflows.md) — Domain-agnostic workflows available to all modules +- [Document Project](/docs/reference/workflows/document-project.md) — Brownfield project documentation + +## Module-Specific Workflows + +- [BMGD Workflows](/docs/reference/workflows/bmgd-workflows.md) — Game development workflows diff --git a/docs/tutorials/advanced/create-custom-agent.md b/docs/tutorials/advanced/create-custom-agent.md new file mode 100644 index 00000000..1050b341 --- /dev/null +++ b/docs/tutorials/advanced/create-custom-agent.md @@ -0,0 +1,171 @@ +--- +title: "Create a Custom Agent" +--- + + +Build your own AI agent with a unique personality, specialized commands, and optional persistent memory using the BMad Builder workflow. + +:::note[BMB Module] +This tutorial uses the **BMad Builder (BMB)** module. Make sure you have BMad installed with the BMB module enabled. +::: + +## What You'll Learn + +- How to run the `create-agent` workflow +- Choose between Simple, Expert, and Module agent types +- Define your agent's persona (role, identity, communication style, principles) +- Package and install your custom agent +- Test and iterate on your agent's behavior + +:::note[Prerequisites] +- BMad installed with the BMB module +- An idea for what you want your agent to do +- About 15-30 minutes for your first agent +::: + +:::tip[Quick Path] +Run `create-agent` workflow → Follow the guided steps → Install your agent module → Test and iterate. +::: + +## Understanding Agent Types + +Before creating your agent, understand the three types available: + +| Type | Best For | Memory | Complexity | +| ---------- | ------------------------------------- | ---------- | ---------- | +| **Simple** | Focused tasks, quick setup | None | Low | +| **Expert** | Specialized domains, ongoing projects | Persistent | Medium | +| **Module** | Building other agents/workflows | Persistent | High | + +**Simple Agent** - Use when your task is well-defined and focused. Perfect for single-purpose assistants like commit message generators or code reviewers. + +**Expert Agent** - Use when your domain requires specialized knowledge or you need memory across sessions. Great for roles like Security Architect or Documentation Lead. + +**Module Agent** - Use when your agent builds other agents or needs deep integration with the module system. + +## Step 1: Start the Workflow + +In your IDE (Claude Code, Cursor, etc.), invoke the create-agent workflow with the agent-builder agent. + +The workflow guides you through eight steps: + +| Step | What You'll Do | +| --------------------------- | -------------------------------------------- | +| **Brainstorm** *(optional)* | Explore ideas with creative techniques | +| **Discovery** | Define the agent's purpose and goals | +| **Type & Metadata** | Choose Simple or Expert, name your agent | +| **Persona** | Craft the agent's personality and principles | +| **Commands** | Define what the agent can do | +| **Activation** | Set up autonomous behaviors *(optional)* | +| **Build** | Generate the agent file | +| **Validation** | Review and verify everything works | + +:::tip[Workflow Options] +At each step, the workflow provides options: +- **[A] Advanced** - Get deeper insights and reasoning +- **[P] Party** - Get multiple agent perspectives +- **[C] Continue** - Move to the next step +::: + +## Step 2: Define the Persona + +Your agent's personality is defined by four fields: + +| Field | Purpose | Example | +| ----------------------- | -------------- | ----------------------------------------------------------------- | +| **Role** | What they do | "Senior code reviewer who catches bugs and suggests improvements" | +| **Identity** | Who they are | "Friendly but exacting, believes clean code is a craft" | +| **Communication Style** | How they speak | "Direct, constructive, explains the 'why' behind suggestions" | +| **Principles** | Why they act | "Security first, clarity over cleverness, test what you fix" | + +Keep each field focused on its purpose. The role isn't personality; the identity isn't job description. + +:::note[Writing Great Principles] +The first principle should "activate" the agent's expertise: + +- **Weak:** "Be helpful and accurate" +- **Strong:** "Channel decades of security expertise: threat modeling begins with trust boundaries, never trust client input, defense in depth is non-negotiable" +::: + +## Step 3: Install Your Agent + +Once created, package your agent for installation: + +``` +my-custom-stuff/ +├── module.yaml # Contains: unitary: true +├── agents/ +│ └── {agent-name}/ +│ ├── {agent-name}.agent.yaml +│ └── _memory/ # Expert agents only +│ └── {sidecar-folder}/ +└── workflows/ # Optional: custom workflows +``` + +Install using the BMad installer, then invoke your new agent in your IDE. + +## What You've Accomplished + +You've created a custom AI agent with: + +- A defined purpose and role in your workflow +- A unique persona with communication style and principles +- Custom menu commands for your specific tasks +- Optional persistent memory for ongoing context + +Your project now includes: + +``` +_bmad/ +├── _config/ +│ └── agents/ +│ └── {your-agent}/ # Your agent customizations +└── {module}/ + └── agents/ + └── {your-agent}/ + └── {your-agent}.agent.yaml +``` + +## Quick Reference + +| Action | How | +| ------------------- | ---------------------------------------------- | +| Start workflow | `"Run the BMad Builder create-agent workflow"` | +| Edit agent directly | Modify `{agent-name}.agent.yaml` | +| Edit customization | Modify `_bmad/_config/agents/{agent-name}` | +| Rebuild agent | `npx bmad-method build ` | +| Study examples | Check `src/modules/bmb/reference/agents/` | + +## Common Questions + +**Should I start with Simple or Expert?** +Start with Simple for your first agent. You can always upgrade to Expert later if you need persistent memory. + +**How do I add more commands later?** +Edit the agent YAML directly or use the customization file in `_bmad/_config/agents/`. Then rebuild. + +**Can I share my agent with others?** +Yes. Package your agent as a standalone module and share it with your team or the community. + +**Where can I see example agents?** +Study the reference agents in `src/modules/bmb/reference/agents/`: +- [commit-poet](https://github.com/bmad-code-org/BMAD-METHOD/tree/main/src/modules/bmb/reference/agents/simple-examples/commit-poet.agent.yaml) (Simple) +- [journal-keeper](https://github.com/bmad-code-org/BMAD-METHOD/tree/main/src/modules/bmb/reference/agents/expert-examples/journal-keeper) (Expert) + +## Getting Help + +- **[Discord Community](https://discord.gg/gk8jAdXWmj)** - Ask in #bmad-method-help or #report-bugs-and-issues +- **[GitHub Issues](https://github.com/bmad-code-org/BMAD-METHOD/issues)** - Report bugs or request features + +## Further Reading + +- **[What Are Agents](/docs/explanation/core-concepts/what-are-agents.md)** - Deep technical details on agent types +- **[Agent Customization](/docs/how-to/customization/customize-agents.md)** - Modify agents without editing core files +- **[Custom Content Installation](/docs/how-to/installation/install-custom-modules.md)** - Package and distribute your agents + +:::tip[Key Takeaways] +- **Start small** - Your first agent should solve one problem well +- **Persona matters** - Strong principles activate the agent's expertise +- **Iterate often** - Test your agent and refine based on behavior +- **Learn from examples** - Study reference agents before building your own +::: diff --git a/docs/tutorials/getting-started/getting-started-bmadv6.md b/docs/tutorials/getting-started/getting-started-bmadv6.md new file mode 100644 index 00000000..ed674cb3 --- /dev/null +++ b/docs/tutorials/getting-started/getting-started-bmadv6.md @@ -0,0 +1,246 @@ +--- +title: "Getting Started with the BMad Method" +description: Install BMad and build your first project +--- + +**Upgrading from previous versions?** See the [Upgrade Guide](/docs/how-to/installation/upgrade-to-v6.md) instead. + +--- + +Build software faster using AI-powered workflows with specialized agents that guide you through planning, architecture, and implementation. + +## What You'll Learn + +- Install and initialize BMad Method for a new project +- Choose the right planning track for your project size +- Progress through phases from requirements to working code +- Use agents and workflows effectively + +:::note[Prerequisites] +- **Node.js 20+** — Required for the installer +- **Git** — Recommended for version control +- **AI-powered IDE** — Claude Code, Cursor, Windsurf, or similar +- **A project idea** — Even a simple one works for learning +::: + +:::tip[Quick Path] +**Install** → `npx bmad-method@alpha install` +**Initialize** → Load Analyst agent, run `workflow-init` +**Plan** → PM creates PRD, Architect creates architecture +**Build** → SM manages sprints, DEV implements stories +**Always use fresh chats** for each workflow to avoid context issues. +::: + +## Understanding BMad + +BMad helps you build software through guided workflows with specialized AI agents. The process follows four phases: + +| Phase | Name | What Happens | +| ----- | -------------- | --------------------------------------------------- | +| 1 | Analysis | Brainstorming, research, product brief *(optional)* | +| 2 | Planning | Create requirements (PRD or tech-spec) | +| 3 | Solutioning | Design architecture *(BMad Method/Enterprise only)* | +| 4 | Implementation | Build epic by epic, story by story | + +![BMad Method Workflow - Standard Greenfield](./images/workflow-method-greenfield.svg) + +*Complete visual flowchart showing all phases, workflows, and agents for the standard greenfield track.* + +Based on your project's complexity, BMad offers three planning tracks: + +| Track | Best For | Documents Created | +| --------------- | ------------------------------------------------------ | -------------------------------------- | +| **Quick Flow** | Bug fixes, simple features, clear scope (1-15 stories) | Tech-spec only | +| **BMad Method** | Products, platforms, complex features (10-50+ stories) | PRD + Architecture + UX | +| **Enterprise** | Compliance, multi-tenant systems (30+ stories) | PRD + Architecture + Security + DevOps | + +:::note +Story counts are guidance, not definitions. Choose your track based on planning needs, not story math. +::: + +## Installation + +Open a terminal in your project directory and run: + +```bash +npx bmad-method@alpha install +``` + +The interactive installer guides you through setup and creates a `_bmad/` folder with all agents and workflows. + +Verify your installation: + +``` +your-project/ +├── _bmad/ +│ ├── bmm/ # Method module +│ │ ├── agents/ # Agent files +│ │ ├── workflows/ # Workflow files +│ │ └── config.yaml # Module config +│ └── core/ # Core utilities +├── _bmad-output/ # Generated artifacts (created later) +└── .claude/ # IDE configuration (if using Claude Code) +``` + +:::tip[Troubleshooting] +Having issues? See [Install BMad](/docs/how-to/installation/install-bmad.md) for common solutions. +::: + +## Step 1: Initialize Your Project + +Load the **Analyst agent** in your IDE, wait for the menu, then run `workflow-init`. + +:::note[How to Load Agents] +Type `/` in your IDE and use autocomplete. Not sure what's available? Start with `/bmad` to see all agents and workflows. +::: + +The workflow asks you to describe your project, whether it's new or existing, and the general complexity. Based on your description, it recommends a planning track. + +Once you confirm, the workflow creates `bmm-workflow-status.yaml` to track your progress through all phases. + +:::caution[Fresh Chats] +Always start a fresh chat for each workflow. This prevents context limitations from causing issues. +::: + +## Step 2: Create Your Plan + +After initialization, work through phases 1-3. **Use fresh chats for each workflow.** + +:::tip[Check Your Status] +Unsure what's next? Load any agent and ask for `workflow-status`. It tells you the next recommended or required workflow. +::: + +### Phase 1: Analysis (Optional) + +All workflows in this phase are optional: +- **brainstorm-project** — Guided ideation +- **research** — Market and technical research +- **product-brief** — Recommended foundation document + +### Phase 2: Planning (Required) + +**For BMad Method and Enterprise tracks:** +1. Load the **PM agent** in a new chat +2. Run the PRD workflow: `*prd` +3. Output: `PRD.md` + +**For Quick Flow track:** +- Use `tech-spec` instead of PRD, then skip to implementation + +:::note[UX Design (Optional)] +If your project has a user interface, load the **UX-Designer agent** and run the UX design workflow after creating your PRD. +::: + +### Phase 3: Solutioning (BMad Method/Enterprise) + +**Create Architecture** +1. Load the **Architect agent** in a new chat +2. Run `create-architecture` +3. Output: Architecture document with technical decisions + +**Create Epics and Stories** + +:::tip[V6 Improvement] +Epics and stories are now created *after* architecture. This produces better quality stories because architecture decisions (database, API patterns, tech stack) directly affect how work should be broken down. +::: + +1. Load the **PM agent** in a new chat +2. Run `create-epics-and-stories` +3. The workflow uses both PRD and Architecture to create technically-informed stories + +**Implementation Readiness Check** *(Highly Recommended)* +1. Load the **Architect agent** in a new chat +2. Run `implementation-readiness` +3. Validates cohesion across all planning documents + +## Step 3: Build Your Project + +Once planning is complete, move to implementation. **Each workflow should run in a fresh chat.** + +### Initialize Sprint Planning + +Load the **SM agent** and run `sprint-planning`. This creates `sprint-status.yaml` to track all epics and stories. + +### The Build Cycle + +For each story, repeat this cycle with fresh chats: + +| Step | Agent | Workflow | Purpose | +| ---- | ----- | -------------- | ------------------------------------- | +| 1 | SM | `create-story` | Create story file from epic | +| 2 | DEV | `dev-story` | Implement the story | +| 3 | TEA | `automate` | Generate guardrail tests *(optional)* | +| 4 | DEV | `code-review` | Quality validation *(recommended)* | + +After completing all stories in an epic, load the **SM agent** and run `retrospective`. + +## What You've Accomplished + +You've learned the foundation of building with BMad: + +- Installed BMad and configured it for your IDE +- Initialized a project with your chosen planning track +- Created planning documents (PRD, Architecture, Epics & Stories) +- Understood the build cycle for implementation + +Your project now has: + +``` +your-project/ +├── _bmad/ # BMad configuration +├── _bmad-output/ +│ ├── PRD.md # Your requirements document +│ ├── architecture.md # Technical decisions +│ ├── epics/ # Epic and story files +│ ├── bmm-workflow-status.yaml # Phase progress tracking +│ └── sprint-status.yaml # Sprint tracking +└── ... +``` + +## Quick Reference + +| Command | Agent | Purpose | +| --------------------------- | --------- | ------------------------------------ | +| `*workflow-init` | Analyst | Initialize a new project | +| `*workflow-status` | Any | Check progress and next steps | +| `*prd` | PM | Create Product Requirements Document | +| `*create-architecture` | Architect | Create architecture document | +| `*create-epics-and-stories` | PM | Break down PRD into epics | +| `*implementation-readiness` | Architect | Validate planning cohesion | +| `*sprint-planning` | SM | Initialize sprint tracking | +| `*create-story` | SM | Create a story file | +| `*dev-story` | DEV | Implement a story | +| `*code-review` | DEV | Review implemented code | + +## Common Questions + +**Do I always need architecture?** +Only for BMad Method and Enterprise tracks. Quick Flow skips from tech-spec to implementation. + +**Can I change my plan later?** +Yes. The SM agent has a `correct-course` workflow for handling scope changes. + +**What if I want to brainstorm first?** +Load the Analyst agent and run `brainstorm-project` before `workflow-init`. + +**Can I skip workflow-init and workflow-status?** +Yes, once you learn the flow. Use the Quick Reference to go directly to needed workflows. + +## Getting Help + +- **During workflows** — Agents guide you with questions and explanations +- **Community** — [Discord](https://discord.gg/gk8jAdXWmj) (#bmad-method-help, #report-bugs-and-issues) +- **Documentation** — [BMM Workflow Reference](/docs/reference/workflows/index.md) +- **Video tutorials** — [BMad Code YouTube](https://www.youtube.com/@BMadCode) + +## Key Takeaways + +:::tip[Remember These] +- **Always use fresh chats** — Load agents in new chats for each workflow +- **Let workflow-status guide you** — Ask any agent for status when unsure +- **Track matters** — Quick Flow uses tech-spec; Method/Enterprise need PRD and architecture +- **Tracking is automatic** — Status files update themselves +- **Agents are flexible** — Use menu numbers, shortcuts (`*prd`), or natural language +::: + +Ready to start? Install BMad, load the Analyst, run `workflow-init`, and let the agents guide you. diff --git a/src/modules/bmm/docs/images/workflow-method-greenfield.excalidraw b/docs/tutorials/getting-started/images/workflow-method-greenfield.excalidraw similarity index 100% rename from src/modules/bmm/docs/images/workflow-method-greenfield.excalidraw rename to docs/tutorials/getting-started/images/workflow-method-greenfield.excalidraw diff --git a/src/modules/bmm/docs/images/workflow-method-greenfield.svg b/docs/tutorials/getting-started/images/workflow-method-greenfield.svg similarity index 100% rename from src/modules/bmm/docs/images/workflow-method-greenfield.svg rename to docs/tutorials/getting-started/images/workflow-method-greenfield.svg diff --git a/src/modules/bmgd/docs/workflow-overview.jpg b/docs/tutorials/getting-started/images/workflow-overview.jpg similarity index 100% rename from src/modules/bmgd/docs/workflow-overview.jpg rename to docs/tutorials/getting-started/images/workflow-overview.jpg diff --git a/docs/tutorials/getting-started/quick-start-bmgd.md b/docs/tutorials/getting-started/quick-start-bmgd.md new file mode 100644 index 00000000..421ea867 --- /dev/null +++ b/docs/tutorials/getting-started/quick-start-bmgd.md @@ -0,0 +1,260 @@ +--- +title: "Getting Started with BMad Game Development" +description: Build games with BMad's Game Development Module +--- + + +Build games faster using AI-powered workflows with specialized game development agents that guide you through preproduction, design, architecture, and implementation. + +:::note[Module Extension] +BMGD (BMad Game Development) is a module that extends BMad Method. You'll need BMad installed first—see the [BMad v6 tutorial](/docs/tutorials/getting-started/getting-started-bmadv6.md) if you haven't installed it yet. +::: + +## What You'll Learn + +- Install and configure the BMGD module +- Understand game development phases and specialized agents +- Create a Game Brief and Game Design Document (GDD) +- Progress from concept to working game code + +:::note[Prerequisites] +- **BMad Method installed** — Follow the main installation guide first +- **A game idea** — Even a rough concept is enough to start +- **AI-powered IDE** — Claude Code, Cursor, Windsurf, or similar +::: + +:::tip[Quick Path] +**Install** → `npx bmad-method install` (select BMGD module) +**Preproduction** → Game Designer creates Game Brief +**Design** → Game Designer creates GDD (and Narrative if story-driven) +**Technical** → Game Architect creates Architecture +**Production** → Game SM manages sprints, Game Dev implements +**Always use fresh chats** for each workflow to avoid context issues. +::: + +## Understanding BMGD + +BMGD follows four game development phases with specialized agents for each: + +| Phase | Name | What Happens | +| ----- | ------------- | ----------------------------------------------------------------- | +| 1 | Preproduction | Capture game vision, create Game Brief *(optional brainstorming)* | +| 2 | Design | Detail mechanics, systems, narrative in GDD | +| 3 | Technical | Plan engine, architecture, technical decisions | +| 4 | Production | Build game in sprints, story by story | + +![BMGD Workflow Overview](./images/workflow-overview.jpg) + +*Complete visual flowchart showing all phases, workflows, and agents for game development.* + +### Game Development Agents + +| Agent | When to Use | +| --------------------- | ----------------------------------------- | +| **Game Designer** | Brainstorming, Game Brief, GDD, Narrative | +| **Game Architect** | Architecture, technical decisions | +| **Game Developer** | Implementation, code reviews | +| **Game Scrum Master** | Sprint planning, story management | +| **Game QA** | Test framework, test design, automation | +| **Game Solo Dev** | Quick prototyping, indie development | + +## Installation + +If you haven't installed BMad yet: + +```bash +npx bmad-method install +``` + +Or add BMGD to an existing installation: + +```bash +npx bmad-method install --add-module bmgd +``` + +Verify your installation: + +``` +your-project/ +├── _bmad/ +│ ├── bmgd/ # Game development module +│ │ ├── agents/ # Game-specific agents +│ │ ├── workflows/ # Game-specific workflows +│ │ └── config.yaml # Module config +│ ├── bmm/ # Core method module +│ └── core/ # Core utilities +├── _bmad-output/ # Generated artifacts (created later) +└── .claude/ # IDE configuration (if using Claude Code) +``` + +## Step 1: Create Your Game Brief (Preproduction) + +Load the **Game Designer** agent in your IDE, wait for the menu, then start with your game concept. + +### Optional: Brainstorm First + +If you have a vague idea and want help developing it: + +``` +Run brainstorm-game +``` + +The agent guides you through game-specific ideation techniques to refine your concept. + +### Create the Game Brief + +``` +Run create-game-brief +``` + +The Game Designer walks you through: +- **Game concept** — Core idea and unique selling points +- **Design pillars** — The 3-5 principles that guide all decisions +- **Target market** — Who plays this game? +- **Fundamentals** — Platform, genre, scope, team size + +When complete, you'll have `game-brief.md` in your `_bmad-output/` folder. + +:::caution[Fresh Chats] +Always start a fresh chat for each workflow. This prevents context limitations from causing issues. +::: + +## Step 2: Design Your Game + +With your Game Brief complete, detail your game's design. + +### Create the GDD + +**Start a fresh chat** with the **Game Designer** agent. + +``` +Run create-gdd +``` + +The agent guides you through mechanics, systems, and game-type-specific sections. BMGD offers 24 game type templates that provide genre-specific structure. + +When complete, you'll have `gdd.md` (or sharded into `gdd/` for large documents). + +:::note[Narrative Design (Optional)] +For story-driven games, start a fresh chat and run `narrative` to create a Narrative Design Document covering story, characters, world, and dialogue. +::: + +:::tip[Check Your Status] +Unsure what's next? Load any agent and run `workflow-status`. It tells you the next recommended workflow. +::: + +## Step 3: Plan Your Architecture + +**Start a fresh chat** with the **Game Architect** agent. + +``` +Run create-architecture +``` + +The architect guides you through: +- **Engine selection** — Unity, Unreal, Godot, custom, etc. +- **System design** — Core game systems and how they interact +- **Technical patterns** — Architecture patterns suited to your game +- **Structure** — Project organization and conventions + +When complete, you'll have `game-architecture.md`. + +## Step 4: Build Your Game + +Once planning is complete, move to production. **Each workflow should run in a fresh chat.** + +### Initialize Sprint Planning + +Load the **Game Scrum Master** agent and run `sprint-planning`. This creates `sprint-status.yaml` to track all epics and stories. + +### The Build Cycle + +For each story, repeat this cycle with fresh chats: + +| Step | Agent | Workflow | Purpose | +| ---- | -------- | -------------- | ---------------------------------- | +| 1 | Game SM | `create-story` | Create story file from epic | +| 2 | Game Dev | `dev-story` | Implement the story | +| 3 | Game QA | `automate` | Generate tests *(optional)* | +| 4 | Game Dev | `code-review` | Quality validation *(recommended)* | + +After completing all stories in an epic, load the **Game SM** and run `retrospective`. + +### Quick Prototyping Alternative + +For rapid iteration or indie development, load the **Game Solo Dev** agent: +- `quick-prototype` — Rapid prototyping +- `quick-dev` — Flexible development without full sprint structure + +## What You've Accomplished + +You've learned the foundation of building games with BMad: + +- Installed the BMGD module +- Created a Game Brief capturing your vision +- Detailed your design in a GDD +- Planned your technical architecture +- Understood the build cycle for implementation + +Your project now has: + +``` +your-project/ +├── _bmad/ # BMad configuration +├── _bmad-output/ +│ ├── game-brief.md # Your game vision +│ ├── gdd.md # Game Design Document +│ ├── narrative-design.md # Story design (if applicable) +│ ├── game-architecture.md # Technical decisions +│ ├── epics/ # Epic and story files +│ └── sprint-status.yaml # Sprint tracking +└── ... +``` + +## Quick Reference + +| Command | Agent | Purpose | +| ---------------------- | -------------- | ----------------------------- | +| `*brainstorm-game` | Game Designer | Guided game ideation | +| `*create-game-brief` | Game Designer | Create Game Brief | +| `*create-gdd` | Game Designer | Create Game Design Document | +| `*narrative` | Game Designer | Create Narrative Design | +| `*create-architecture` | Game Architect | Create game architecture | +| `*sprint-planning` | Game SM | Initialize sprint tracking | +| `*create-story` | Game SM | Create a story file | +| `*dev-story` | Game Dev | Implement a story | +| `*code-review` | Game Dev | Review implemented code | +| `*workflow-status` | Any | Check progress and next steps | + +## Common Questions + +**Do I need to create all documents?** +At minimum, create a Game Brief and GDD. Architecture is highly recommended. Narrative Design is only needed for story-driven games. + +**Can I use the Game Solo Dev for everything?** +Yes, for smaller projects or rapid prototyping. For larger games, the specialized agents provide more thorough guidance. + +**What game types are supported?** +BMGD includes 24 game type templates (RPG, platformer, puzzle, strategy, etc.) that provide genre-specific GDD sections. + +**Can I change my design later?** +Yes. Documents are living artifacts—return to update them as your vision evolves. The SM agent has `correct-course` for scope changes. + +## Getting Help + +- **During workflows** — Agents guide you with questions and explanations +- **Community** — [Discord](https://discord.gg/gk8jAdXWmj) (#bmad-method-help, #report-bugs-and-issues) +- **Documentation** — [BMGD Workflow Reference](/docs/reference/workflows/bmgd-workflows.md) +- **Video tutorials** — [BMad Code YouTube](https://www.youtube.com/@BMadCode) + +## Key Takeaways + +:::tip[Remember These] +- **Always use fresh chats** — Load agents in new chats for each workflow +- **Game Brief first** — It informs everything that follows +- **Use game type templates** — 24 templates provide genre-specific GDD structure +- **Documents evolve** — Return to update them as your vision grows +- **Solo Dev for speed** — Use Game Solo Dev for rapid prototyping +::: + +Ready to start? Load the **Game Designer** agent and run `create-game-brief` to capture your game vision. diff --git a/docs/tutorials/getting-started/workflow-overview.jpg b/docs/tutorials/getting-started/workflow-overview.jpg new file mode 100644 index 00000000..3f61b3c5 Binary files /dev/null and b/docs/tutorials/getting-started/workflow-overview.jpg differ diff --git a/docs/v4-to-v6-upgrade.md b/docs/v4-to-v6-upgrade.md deleted file mode 100644 index 788d570a..00000000 --- a/docs/v4-to-v6-upgrade.md +++ /dev/null @@ -1,227 +0,0 @@ -# BMad v4 to v6 Upgrade Guide - -## Overview - -BMad v6 represents a complete ground-up rewrite with significant architectural changes. This guide will help you migrate your v4 project to v6. - ---- - -## Automatic V4 Detection - -When you run `npm run install:bmad` on a project with v4 installed, the installer automatically detects: - -- **Legacy folders**: Any folders starting with `_bmad`, `bmad` (lowercase), or `Bmad` -- **IDE command artifacts**: Legacy bmad folders in IDE configuration directories (`.claude/commands/`, `.cursor/commands/`, etc.) - -### What Happens During Detection - -1. **Automatic Backup of v4 Modules**: All `_bmad-*` folders are moved to `v4-backup/` in your project root - - If a backup already exists, a timestamp is added to avoid conflicts - - Example: `_bmad-core` → `v4-backup/_bmad-core` - - Your project files and data are NOT affected - -2. **IDE Command Cleanup Recommended**: Legacy v4 IDE commands should be manually removed - - Located in IDE config folders: `.claude/commands/`, `.cursor/commands/`, etc. - - These old commands would still reference v4 folder structure if left in place - - The installer provides copy/paste terminal commands for your platform - - You can proceed without cleanup, but removing them prevents confusion with old v4 commands - ---- - -## Module Migration - -### Deprecated Modules - -| v4 Module | v6 Status | -| ----------------------------- | ------------------------------------------------ | -| `_bmad-2d-phaser-game-dev` | Integrated into BMM | -| `_bmad-2d-unity-game-dev` | Integrated into BMM | -| `_bmad-godot-game-dev` | Integrated into BMM | -| `_bmad-*-game-dev` (any) | Integrated into BMM | -| `_bmad-infrastructure-devops` | Deprecated - New core devops agent coming in BMM | -| `_bmad-creative-writing` | Not adapted - New module releasing soon | - -**Game Development**: All game development functionality has been consolidated and expanded within the BMM (BMad Method) module. Game-specific workflows now adapt to your game type and engine. - ---- - -## Architecture Changes - -### Folder Structure - -**v4 "Expansion Packs" Structure:** - -``` -your-project/ -├── _bmad-core/ # Was actually the BMad Method -├── _bmad-game-dev/ # Separate expansion packs -├── _bmad-creative-writing/ -└── _bmad-infrastructure-devops/ -``` - -**v6 Unified Structure:** - -``` -your-project/ -└── _bmad/ # Single installation folder, default _bmad - ├── core/ # Real core framework (applies to all modules) - ├── bmm/ # BMad Method (software/game dev) - ├── bmb/ # BMad Builder (create agents/workflows) - ├── cis/ # Creative Intelligence Suite - └── _config/ # Your customizations - └── agents/ # Agent customization files -``` - -### Key Concept Changes - -- **v4 `_bmad-core`**: Was actually the BMad Method -- **v6 `_bmad/core/`**: Is the real universal core framework -- **v6 `_bmad/bmm/`**: Is the BMad Method module -- **Module identification**: All modules now have a `config.yaml` file - ---- - -## Project Progress Migration - -### If You've Completed Planning Phase (PRD/Architecture) with the BMad Method: - -After running the v6 installer: - -1. **Run `workflow-init`** workflow to set up the guided workflow system -2. **Specify your project level** when prompted: - - If you followed v4's full workflow (PRD → Architecture → Stories), select **Level 3 or 4** - - This tells v6 you've already completed planning and solutioning phases -3. **Document paths**: Keep your existing paths during installation - - Default PRD/Architecture location: `docs/` - - Default stories location: `docs/sprint-artifacts/` - - **Accept these defaults** if you're already using them in v4 - -> **Important**: v6 workflows can handle both sharded and unsharded documents. You don't need to restructure your existing PRD or architecture files. - -### If You're Mid-Development (Stories Created/Implemented) - -1. Complete the v6 installation as above -2. Run `workflow-init` and specify Level 3 or 4 -3. When ready to continue development, run the **`sprint-planning`** workflow (Phase 4) - ---- - -## Agent Customization Migration - -### v4 Agent Customization - -In v4, you may have modified agent files directly in `_bmad-*` folders. - -### v6 Agent Customization - -**All customizations** now go in `_bmad/_config/agents/` using customize files: - -**Example: Renaming an agent and changing communication style** - -File: `_bmad/_config/agents/bmm-pm.customize.yaml` - -```yaml -# Customize the PM agent -persona: - name: 'Captain Jack' # Override agent name - role: 'Swashbuckling Product Owner' - communication_style: | - - Talk like a pirate - - Use nautical metaphors for software concepts - - Always upbeat and adventurous -``` - -**How it works:** - -- Base agent: `_bmad/bmm/agents/pm.md` -- Customization: `_bmad/_config/agents/bmm-pm.customize.yaml` -- Result: Agent uses your custom name and style, but updates don't overwrite your changes - ---- - -## Document Compatibility - -### Sharded vs Unsharded Documents - -**Good news**: Unlike v4, v6 workflows are **fully flexible** with document structure: - -- ✅ Sharded documents (split into multiple files) -- ✅ Unsharded documents (single file per section) -- ✅ Custom sections for your project type -- ✅ Mixed approaches - -All workflow files are scanned automatically. No manual configuration needed. - ---- - -## Installation Steps - -### 1. Clone Repository - -```bash -git clone https://github.com/bmad-code-org/BMAD-METHOD -cd BMAD-METHOD -npm install -``` - -### 2. Run Installer on Your v4 Project - -```bash -npx bmad-method install -``` - -**Enter the full path to your v4 project** when prompted. - -### 3. Follow Interactive Prompts - -The installer will: - -1. Detect v4 installation and offer to backup `_bmad-*` folders -2. Prompt for recommended cleanup (you can skip) -3. Let you select modules (recommend: BMM for software and or game development) -4. Configure core settings (name, language, etc.) -5. Configure module-specific options -6. Configure IDE integrations - -### 4. Accept Default Paths - -If you're using: - -- `docs/` for PRD and architecture -- `docs/sprint-artifacts/` for story files - -**Accept these defaults** during installation. - -### 5. Initialize Workflow - -After installation: - -1. **Load the Analyst agent** - See your IDE-specific instructions in [docs/ide-info](./ide-info/) for how to activate agents: - - [Claude Code](./ide-info/claude-code.md) - - [Cursor](./ide-info/cursor.md) - - [VS Code/Windsurf](./ide-info/) - Check your IDE folder - -2. **Wait for the agent's menu** to appear - -3. **Tell the agent**: `*workflow-init` - v6 supports excellent natural language fuzzy matching, so you could also say "workflow init" or "please init the workflow" - -Since you are migrating an existing project from v4, it's most likely **Level 3 or 4** you will want to suggest when asked - if you've already completed PRD/architecture in v4. - ---- - -## Post-Migration Checklist - -- [ ] v4 folders backed up to `v4-backup/` -- [ ] v6 installed to `_bmad/` folder -- [ ] `workflow-init` run with correct project level selected -- [ ] Agent customizations migrated to `_bmad/_config/agents/` if needed -- [ ] IDE integration working (test by listing agents) -- [ ] For active development: `sprint-planning` workflow executed - ---- - -## Getting Help - -- **Discord**: [Join the BMad Community](https://discord.gg/gk8jAdXWmj) -- **Issues**: [GitHub Issue Tracker](https://github.com/bmad-code-org/BMAD-METHOD/issues) -- **Docs**: Check `_bmad/docs/` in your installation for IDE-specific instructions diff --git a/docs/web-bundles-gemini-gpt-guide.md b/docs/web-bundles-gemini-gpt-guide.md deleted file mode 100644 index 0dd3bb85..00000000 --- a/docs/web-bundles-gemini-gpt-guide.md +++ /dev/null @@ -1,21 +0,0 @@ -# Using BMad Web Bundles in Gemini Gems & Custom GPTs - -## IMPORTANT NOTE - -The Web Bundling Feature is being rebuilt from the ground up, current bundles for v6 may be incomplete or missing functionality and are not optimized. This will be rectified very soon, with a more expansive guide. - -## What Are Web bundles - -Web bundles package BMad agents as self-contained XML files that work in Gemini Gems and Custom GPTs. Everything the agent needs - instructions, workflows, dependencies - is bundled into a single file. - -## What Are Web Bundles? - -Web bundles are standalone XML files containing: - -- Complete agent persona and instructions -- All workflows and dependencies -- Interactive menu system -- Party mode for multi-agent collaboration -- No external files required - -**Perfect for:** Uploading a single file to a Gemini GEM or Custom GPT to use BMad Method from the Web, generally at a huge cost savings, at the expense of some quality and convenience of using locally. diff --git a/eslint.config.mjs b/eslint.config.mjs index 0fbaa510..e361b1cd 100644 --- a/eslint.config.mjs +++ b/eslint.config.mjs @@ -18,9 +18,9 @@ export default [ 'test/fixtures/**/*.yaml', '_bmad/**', '_bmad*/**', - // Docusaurus build artifacts - '.docusaurus/**', + // Build output 'build/**', + // Website uses ESM/Astro - separate linting ecosystem 'website/**', // Gitignored patterns 'z*/**', // z-samples, z1, z2, etc. diff --git a/package-lock.json b/package-lock.json index 3e6d086e..18fd9a25 100644 --- a/package-lock.json +++ b/package-lock.json @@ -1,12 +1,12 @@ { "name": "bmad-method", - "version": "6.0.0-alpha.19", + "version": "6.0.0-alpha.23", "lockfileVersion": 3, "requires": true, "packages": { "": { "name": "bmad-method", - "version": "6.0.0-alpha.19", + "version": "6.0.0-alpha.23", "license": "MIT", "dependencies": { "@kayvan/markdown-tree-parser": "^1.6.1", @@ -19,7 +19,6 @@ "fs-extra": "^11.3.0", "glob": "^11.0.3", "ignore": "^7.0.5", - "inquirer": "^8.2.6", "js-yaml": "^4.1.0", "ora": "^5.4.1", "semver": "^7.6.3", @@ -32,10 +31,12 @@ "bmad-method": "tools/bmad-npx-wrapper.js" }, "devDependencies": { - "@docusaurus/core": "^3.6.0", - "@docusaurus/preset-classic": "^3.6.0", + "@astrojs/sitemap": "^3.6.0", + "@astrojs/starlight": "^0.37.0", + "@clack/prompts": "^0.11.0", "@eslint/js": "^9.33.0", "archiver": "^7.0.1", + "astro": "^5.16.0", "c8": "^10.1.3", "eslint": "^9.33.0", "eslint-config-prettier": "^10.1.8", @@ -46,357 +47,170 @@ "jest": "^30.0.4", "lint-staged": "^16.1.1", "markdownlint-cli2": "^0.19.1", - "prettier": "^3.5.3", + "prettier": "^3.7.4", "prettier-plugin-packagejson": "^2.5.19", - "prism-react-renderer": "^2.4.1", - "react": "^18.3.1", - "react-dom": "^18.3.1", + "sharp": "^0.33.5", "yaml-eslint-parser": "^1.2.3", - "yaml-lint": "^1.7.0", - "zod": "^4.1.12" + "yaml-lint": "^1.7.0" }, "engines": { "node": ">=20.0.0" } }, - "node_modules/@ai-sdk/gateway": { - "version": "2.0.22", - "resolved": "https://registry.npmjs.org/@ai-sdk/gateway/-/gateway-2.0.22.tgz", - "integrity": "sha512-6fHjDfCbjfj4vyMExuLei7ir2///E5sNwNZaobdJsJIxJjDSsjzSLGO/aUI7p9eOnB8XctDrDSF5ilwDGpi6eg==", - "dev": true, - "license": "Apache-2.0", - "dependencies": { - "@ai-sdk/provider": "2.0.0", - "@ai-sdk/provider-utils": "3.0.19", - "@vercel/oidc": "3.0.5" - }, - "engines": { - "node": ">=18" - }, - "peerDependencies": { - "zod": "^3.25.76 || ^4.1.8" - } - }, - "node_modules/@ai-sdk/provider": { - "version": "2.0.0", - "resolved": "https://registry.npmjs.org/@ai-sdk/provider/-/provider-2.0.0.tgz", - "integrity": "sha512-6o7Y2SeO9vFKB8lArHXehNuusnpddKPk7xqL7T2/b+OvXMRIXUO1rR4wcv1hAFUAT9avGZshty3Wlua/XA7TvA==", - "dev": true, - "license": "Apache-2.0", - "dependencies": { - "json-schema": "^0.4.0" - }, - "engines": { - "node": ">=18" - } - }, - "node_modules/@ai-sdk/provider-utils": { - "version": "3.0.19", - "resolved": "https://registry.npmjs.org/@ai-sdk/provider-utils/-/provider-utils-3.0.19.tgz", - "integrity": "sha512-W41Wc9/jbUVXVwCN/7bWa4IKe8MtxO3EyA0Hfhx6grnmiYlCvpI8neSYWFE0zScXJkgA/YK3BRybzgyiXuu6JA==", - "dev": true, - "license": "Apache-2.0", - "dependencies": { - "@ai-sdk/provider": "2.0.0", - "@standard-schema/spec": "^1.0.0", - "eventsource-parser": "^3.0.6" - }, - "engines": { - "node": ">=18" - }, - "peerDependencies": { - "zod": "^3.25.76 || ^4.1.8" - } - }, - "node_modules/@ai-sdk/react": { - "version": "2.0.117", - "resolved": "https://registry.npmjs.org/@ai-sdk/react/-/react-2.0.117.tgz", - "integrity": "sha512-qfwz4p1ev+i/M9rsOUEe53UgzxMUz7e4wrImWdkuFrpD78MBIj53eE/LtyCeAYSCFVSz3JfIDvtdk5MjTrNcbA==", - "dev": true, - "license": "Apache-2.0", - "dependencies": { - "@ai-sdk/provider-utils": "3.0.19", - "ai": "5.0.115", - "swr": "^2.2.5", - "throttleit": "2.1.0" - }, - "engines": { - "node": ">=18" - }, - "peerDependencies": { - "react": "^18 || ~19.0.1 || ~19.1.2 || ^19.2.1", - "zod": "^3.25.76 || ^4.1.8" - }, - "peerDependenciesMeta": { - "zod": { - "optional": true - } - } - }, - "node_modules/@algolia/abtesting": { - "version": "1.12.1", - "resolved": "https://registry.npmjs.org/@algolia/abtesting/-/abtesting-1.12.1.tgz", - "integrity": "sha512-Y+7e2uPe376OH5O73OB1+vR40ZhbV2kzGh/AR/dPCWguoBOp1IK0o+uZQLX+7i32RMMBEKl3pj6KVEav100Kvg==", - "dev": true, - "license": "MIT", - "dependencies": { - "@algolia/client-common": "5.46.1", - "@algolia/requester-browser-xhr": "5.46.1", - "@algolia/requester-fetch": "5.46.1", - "@algolia/requester-node-http": "5.46.1" - }, - "engines": { - "node": ">= 14.0.0" - } - }, - "node_modules/@algolia/autocomplete-core": { - "version": "1.19.2", - "resolved": "https://registry.npmjs.org/@algolia/autocomplete-core/-/autocomplete-core-1.19.2.tgz", - "integrity": "sha512-mKv7RyuAzXvwmq+0XRK8HqZXt9iZ5Kkm2huLjgn5JoCPtDy+oh9yxUMfDDaVCw0oyzZ1isdJBc7l9nuCyyR7Nw==", - "dev": true, - "license": "MIT", - "dependencies": { - "@algolia/autocomplete-plugin-algolia-insights": "1.19.2", - "@algolia/autocomplete-shared": "1.19.2" - } - }, - "node_modules/@algolia/autocomplete-plugin-algolia-insights": { - "version": "1.19.2", - "resolved": "https://registry.npmjs.org/@algolia/autocomplete-plugin-algolia-insights/-/autocomplete-plugin-algolia-insights-1.19.2.tgz", - "integrity": "sha512-TjxbcC/r4vwmnZaPwrHtkXNeqvlpdyR+oR9Wi2XyfORkiGkLTVhX2j+O9SaCCINbKoDfc+c2PB8NjfOnz7+oKg==", - "dev": true, - "license": "MIT", - "dependencies": { - "@algolia/autocomplete-shared": "1.19.2" - }, - "peerDependencies": { - "search-insights": ">= 1 < 3" - } - }, - "node_modules/@algolia/autocomplete-shared": { - "version": "1.19.2", - "resolved": "https://registry.npmjs.org/@algolia/autocomplete-shared/-/autocomplete-shared-1.19.2.tgz", - "integrity": "sha512-jEazxZTVD2nLrC+wYlVHQgpBoBB5KPStrJxLzsIFl6Kqd1AlG9sIAGl39V5tECLpIQzB3Qa2T6ZPJ1ChkwMK/w==", - "dev": true, - "license": "MIT", - "peerDependencies": { - "@algolia/client-search": ">= 4.9.1 < 6", - "algoliasearch": ">= 4.9.1 < 6" - } - }, - "node_modules/@algolia/client-abtesting": { - "version": "5.46.1", - "resolved": "https://registry.npmjs.org/@algolia/client-abtesting/-/client-abtesting-5.46.1.tgz", - "integrity": "sha512-5SWfl0UGuKxMBYlU2Y9BnlIKKEyhFU5jHE9F9jAd8nbhxZNLk0y7fXE+AZeFtyK1lkVw6O4B/e6c3XIVVCkmqw==", - "dev": true, - "license": "MIT", - "dependencies": { - "@algolia/client-common": "5.46.1", - "@algolia/requester-browser-xhr": "5.46.1", - "@algolia/requester-fetch": "5.46.1", - "@algolia/requester-node-http": "5.46.1" - }, - "engines": { - "node": ">= 14.0.0" - } - }, - "node_modules/@algolia/client-analytics": { - "version": "5.46.1", - "resolved": "https://registry.npmjs.org/@algolia/client-analytics/-/client-analytics-5.46.1.tgz", - "integrity": "sha512-496K6B1l/0Jvyp3MbW/YIgmm1a6nkTrKXBM7DoEy9YAOJ8GywGpa2UYjNCW1UrOTt+em1ECzDjRx7PIzTR9YvA==", - "dev": true, - "license": "MIT", - "dependencies": { - "@algolia/client-common": "5.46.1", - "@algolia/requester-browser-xhr": "5.46.1", - "@algolia/requester-fetch": "5.46.1", - "@algolia/requester-node-http": "5.46.1" - }, - "engines": { - "node": ">= 14.0.0" - } - }, - "node_modules/@algolia/client-common": { - "version": "5.46.1", - "resolved": "https://registry.npmjs.org/@algolia/client-common/-/client-common-5.46.1.tgz", - "integrity": "sha512-3u6AuZ1Kiss6V5JPuZfVIUYfPi8im06QBCgKqLg82GUBJ3SwhiTdSZFIEgz2mzFuitFdW1PQi3c/65zE/3FgIw==", - "dev": true, - "license": "MIT", - "engines": { - "node": ">= 14.0.0" - } - }, - "node_modules/@algolia/client-insights": { - "version": "5.46.1", - "resolved": "https://registry.npmjs.org/@algolia/client-insights/-/client-insights-5.46.1.tgz", - "integrity": "sha512-LwuWjdO35HHl1rxtdn48t920Xl26Dl0SMxjxjFeAK/OwK/pIVfYjOZl/f3Pnm7Kixze+6HjpByVxEaqhTuAFaw==", - "dev": true, - "license": "MIT", - "dependencies": { - "@algolia/client-common": "5.46.1", - "@algolia/requester-browser-xhr": "5.46.1", - "@algolia/requester-fetch": "5.46.1", - "@algolia/requester-node-http": "5.46.1" - }, - "engines": { - "node": ">= 14.0.0" - } - }, - "node_modules/@algolia/client-personalization": { - "version": "5.46.1", - "resolved": "https://registry.npmjs.org/@algolia/client-personalization/-/client-personalization-5.46.1.tgz", - "integrity": "sha512-6LvJAlfEsn9SVq63MYAFX2iUxztUK2Q7BVZtI1vN87lDiJ/tSVFKgKS/jBVO03A39ePxJQiFv6EKv7lmoGlWtQ==", - "dev": true, - "license": "MIT", - "dependencies": { - "@algolia/client-common": "5.46.1", - "@algolia/requester-browser-xhr": "5.46.1", - "@algolia/requester-fetch": "5.46.1", - "@algolia/requester-node-http": "5.46.1" - }, - "engines": { - "node": ">= 14.0.0" - } - }, - "node_modules/@algolia/client-query-suggestions": { - "version": "5.46.1", - "resolved": "https://registry.npmjs.org/@algolia/client-query-suggestions/-/client-query-suggestions-5.46.1.tgz", - "integrity": "sha512-9GLUCyGGo7YOXHcNqbzca82XYHJTbuiI6iT0FTGc0BrnV2N4OcrznUuVKic/duiLSun5gcy/G2Bciw5Sav9f9w==", - "dev": true, - "license": "MIT", - "dependencies": { - "@algolia/client-common": "5.46.1", - "@algolia/requester-browser-xhr": "5.46.1", - "@algolia/requester-fetch": "5.46.1", - "@algolia/requester-node-http": "5.46.1" - }, - "engines": { - "node": ">= 14.0.0" - } - }, - "node_modules/@algolia/client-search": { - "version": "5.46.1", - "resolved": "https://registry.npmjs.org/@algolia/client-search/-/client-search-5.46.1.tgz", - "integrity": "sha512-NL76o/BoEgU4ObY5oBEC3o6KSPpuXsnSta00tAxTm1iKUWOGR34DQEKhUt8xMHhMKleUNPM/rLPFiIVtfsGU8w==", - "dev": true, - "license": "MIT", - "peer": true, - "dependencies": { - "@algolia/client-common": "5.46.1", - "@algolia/requester-browser-xhr": "5.46.1", - "@algolia/requester-fetch": "5.46.1", - "@algolia/requester-node-http": "5.46.1" - }, - "engines": { - "node": ">= 14.0.0" - } - }, - "node_modules/@algolia/events": { - "version": "4.0.1", - "resolved": "https://registry.npmjs.org/@algolia/events/-/events-4.0.1.tgz", - "integrity": "sha512-FQzvOCgoFXAbf5Y6mYozw2aj5KCJoA3m4heImceldzPSMbdyS4atVjJzXKMsfX3wnZTFYwkkt8/z8UesLHlSBQ==", + "node_modules/@astrojs/compiler": { + "version": "2.13.0", + "resolved": "https://registry.npmjs.org/@astrojs/compiler/-/compiler-2.13.0.tgz", + "integrity": "sha512-mqVORhUJViA28fwHYaWmsXSzLO9osbdZ5ImUfxBarqsYdMlPbqAqGJCxsNzvppp1BEzc1mJNjOVvQqeDN8Vspw==", "dev": true, "license": "MIT" }, - "node_modules/@algolia/ingestion": { - "version": "1.46.1", - "resolved": "https://registry.npmjs.org/@algolia/ingestion/-/ingestion-1.46.1.tgz", - "integrity": "sha512-52Nc8WKC1FFXsdlXlTMl1Re/pTAbd2DiJiNdYmgHiikZcfF96G+Opx4qKiLUG1q7zp9e+ahNwXF6ED0XChMywg==", + "node_modules/@astrojs/internal-helpers": { + "version": "0.7.5", + "resolved": "https://registry.npmjs.org/@astrojs/internal-helpers/-/internal-helpers-0.7.5.tgz", + "integrity": "sha512-vreGnYSSKhAjFJCWAwe/CNhONvoc5lokxtRoZims+0wa3KbHBdPHSSthJsKxPd8d/aic6lWKpRTYGY/hsgK6EA==", + "dev": true, + "license": "MIT" + }, + "node_modules/@astrojs/markdown-remark": { + "version": "6.3.10", + "resolved": "https://registry.npmjs.org/@astrojs/markdown-remark/-/markdown-remark-6.3.10.tgz", + "integrity": "sha512-kk4HeYR6AcnzC4QV8iSlOfh+N8TZ3MEStxPyenyCtemqn8IpEATBFMTJcfrNW32dgpt6MY3oCkMM/Tv3/I4G3A==", "dev": true, "license": "MIT", "dependencies": { - "@algolia/client-common": "5.46.1", - "@algolia/requester-browser-xhr": "5.46.1", - "@algolia/requester-fetch": "5.46.1", - "@algolia/requester-node-http": "5.46.1" - }, - "engines": { - "node": ">= 14.0.0" + "@astrojs/internal-helpers": "0.7.5", + "@astrojs/prism": "3.3.0", + "github-slugger": "^2.0.0", + "hast-util-from-html": "^2.0.3", + "hast-util-to-text": "^4.0.2", + "import-meta-resolve": "^4.2.0", + "js-yaml": "^4.1.1", + "mdast-util-definitions": "^6.0.0", + "rehype-raw": "^7.0.0", + "rehype-stringify": "^10.0.1", + "remark-gfm": "^4.0.1", + "remark-parse": "^11.0.0", + "remark-rehype": "^11.1.2", + "remark-smartypants": "^3.0.2", + "shiki": "^3.19.0", + "smol-toml": "^1.5.2", + "unified": "^11.0.5", + "unist-util-remove-position": "^5.0.0", + "unist-util-visit": "^5.0.0", + "unist-util-visit-parents": "^6.0.2", + "vfile": "^6.0.3" } }, - "node_modules/@algolia/monitoring": { - "version": "1.46.1", - "resolved": "https://registry.npmjs.org/@algolia/monitoring/-/monitoring-1.46.1.tgz", - "integrity": "sha512-1x2/2Y/eqz6l3QcEZ8u/zMhSCpjlhePyizJd3sXrmg031HjayYT5+IxikjpqkdF7TU/deCTd/TFUcxLJ2ZHXiQ==", + "node_modules/@astrojs/mdx": { + "version": "4.3.13", + "resolved": "https://registry.npmjs.org/@astrojs/mdx/-/mdx-4.3.13.tgz", + "integrity": "sha512-IHDHVKz0JfKBy3//52JSiyWv089b7GVSChIXLrlUOoTLWowG3wr2/8hkaEgEyd/vysvNQvGk+QhysXpJW5ve6Q==", "dev": true, "license": "MIT", "dependencies": { - "@algolia/client-common": "5.46.1", - "@algolia/requester-browser-xhr": "5.46.1", - "@algolia/requester-fetch": "5.46.1", - "@algolia/requester-node-http": "5.46.1" + "@astrojs/markdown-remark": "6.3.10", + "@mdx-js/mdx": "^3.1.1", + "acorn": "^8.15.0", + "es-module-lexer": "^1.7.0", + "estree-util-visit": "^2.0.0", + "hast-util-to-html": "^9.0.5", + "piccolore": "^0.1.3", + "rehype-raw": "^7.0.0", + "remark-gfm": "^4.0.1", + "remark-smartypants": "^3.0.2", + "source-map": "^0.7.6", + "unist-util-visit": "^5.0.0", + "vfile": "^6.0.3" }, "engines": { - "node": ">= 14.0.0" + "node": "18.20.8 || ^20.3.0 || >=22.0.0" + }, + "peerDependencies": { + "astro": "^5.0.0" } }, - "node_modules/@algolia/recommend": { - "version": "5.46.1", - "resolved": "https://registry.npmjs.org/@algolia/recommend/-/recommend-5.46.1.tgz", - "integrity": "sha512-SSd3KlQuplxV3aRs5+Z09XilFesgpPjtCG7BGRxLTVje5hn9BLmhjO4W3gKw01INUt44Z1r0Fwx5uqnhAouunA==", + "node_modules/@astrojs/prism": { + "version": "3.3.0", + "resolved": "https://registry.npmjs.org/@astrojs/prism/-/prism-3.3.0.tgz", + "integrity": "sha512-q8VwfU/fDZNoDOf+r7jUnMC2//H2l0TuQ6FkGJL8vD8nw/q5KiL3DS1KKBI3QhI9UQhpJ5dc7AtqfbXWuOgLCQ==", "dev": true, "license": "MIT", "dependencies": { - "@algolia/client-common": "5.46.1", - "@algolia/requester-browser-xhr": "5.46.1", - "@algolia/requester-fetch": "5.46.1", - "@algolia/requester-node-http": "5.46.1" + "prismjs": "^1.30.0" }, "engines": { - "node": ">= 14.0.0" + "node": "18.20.8 || ^20.3.0 || >=22.0.0" } }, - "node_modules/@algolia/requester-browser-xhr": { - "version": "5.46.1", - "resolved": "https://registry.npmjs.org/@algolia/requester-browser-xhr/-/requester-browser-xhr-5.46.1.tgz", - "integrity": "sha512-3GfCwudeW6/3caKSdmOP6RXZEL4F3GiemCaXEStkTt2Re8f7NcGYAAZnGlHsCzvhlNEuDzPYdYxh4UweY8l/2w==", + "node_modules/@astrojs/sitemap": { + "version": "3.6.0", + "resolved": "https://registry.npmjs.org/@astrojs/sitemap/-/sitemap-3.6.0.tgz", + "integrity": "sha512-4aHkvcOZBWJigRmMIAJwRQXBS+ayoP5z40OklTXYXhUDhwusz+DyDl+nSshY6y9DvkVEavwNcFO8FD81iGhXjg==", "dev": true, "license": "MIT", "dependencies": { - "@algolia/client-common": "5.46.1" - }, - "engines": { - "node": ">= 14.0.0" + "sitemap": "^8.0.0", + "stream-replace-string": "^2.0.0", + "zod": "^3.25.76" } }, - "node_modules/@algolia/requester-fetch": { - "version": "5.46.1", - "resolved": "https://registry.npmjs.org/@algolia/requester-fetch/-/requester-fetch-5.46.1.tgz", - "integrity": "sha512-JUAxYfmnLYTVtAOFxVvXJ4GDHIhMuaP7JGyZXa/nCk3P8RrN5FCNTdRyftSnxyzwSIAd8qH3CjdBS9WwxxqcHQ==", + "node_modules/@astrojs/starlight": { + "version": "0.37.2", + "resolved": "https://registry.npmjs.org/@astrojs/starlight/-/starlight-0.37.2.tgz", + "integrity": "sha512-DGeaaKizwxHDsz72FdxyIBZ32eY8OdUoH6b757BGZlLEDq82O4uipFWoh+kz7+aKg1QoFu/rDq6fqtw+58tpRQ==", "dev": true, "license": "MIT", "dependencies": { - "@algolia/client-common": "5.46.1" + "@astrojs/markdown-remark": "^6.3.1", + "@astrojs/mdx": "^4.2.3", + "@astrojs/sitemap": "^3.3.0", + "@pagefind/default-ui": "^1.3.0", + "@types/hast": "^3.0.4", + "@types/js-yaml": "^4.0.9", + "@types/mdast": "^4.0.4", + "astro-expressive-code": "^0.41.1", + "bcp-47": "^2.1.0", + "hast-util-from-html": "^2.0.1", + "hast-util-select": "^6.0.2", + "hast-util-to-string": "^3.0.0", + "hastscript": "^9.0.0", + "i18next": "^23.11.5", + "js-yaml": "^4.1.0", + "klona": "^2.0.6", + "magic-string": "^0.30.17", + "mdast-util-directive": "^3.0.0", + "mdast-util-to-markdown": "^2.1.0", + "mdast-util-to-string": "^4.0.0", + "pagefind": "^1.3.0", + "rehype": "^13.0.1", + "rehype-format": "^5.0.0", + "remark-directive": "^3.0.0", + "ultrahtml": "^1.6.0", + "unified": "^11.0.5", + "unist-util-visit": "^5.0.0", + "vfile": "^6.0.2" }, - "engines": { - "node": ">= 14.0.0" + "peerDependencies": { + "astro": "^5.5.0" } }, - "node_modules/@algolia/requester-node-http": { - "version": "5.46.1", - "resolved": "https://registry.npmjs.org/@algolia/requester-node-http/-/requester-node-http-5.46.1.tgz", - "integrity": "sha512-VwbhV1xvTGiek3d2pOS6vNBC4dtbNadyRT+i1niZpGhOJWz1XnfhxNboVbXPGAyMJYz7kDrolbDvEzIDT93uUA==", + "node_modules/@astrojs/telemetry": { + "version": "3.3.0", + "resolved": "https://registry.npmjs.org/@astrojs/telemetry/-/telemetry-3.3.0.tgz", + "integrity": "sha512-UFBgfeldP06qu6khs/yY+q1cDAaArM2/7AEIqQ9Cuvf7B1hNLq0xDrZkct+QoIGyjq56y8IaE2I3CTvG99mlhQ==", "dev": true, "license": "MIT", "dependencies": { - "@algolia/client-common": "5.46.1" + "ci-info": "^4.2.0", + "debug": "^4.4.0", + "dlv": "^1.1.3", + "dset": "^3.1.4", + "is-docker": "^3.0.0", + "is-wsl": "^3.1.0", + "which-pm-runs": "^1.1.0" }, "engines": { - "node": ">= 14.0.0" - } - }, - "node_modules/@ampproject/remapping": { - "version": "2.3.0", - "resolved": "https://registry.npmjs.org/@ampproject/remapping/-/remapping-2.3.0.tgz", - "integrity": "sha512-30iZtAPgz+LTIYoeivqYo853f02jBYSd5uGnGpkFV0M3xOt9aN73erkgYAmZU43x4VfqcnLxW9Kpg3R5LC4YYw==", - "dev": true, - "license": "Apache-2.0", - "dependencies": { - "@jridgewell/gen-mapping": "^0.3.5", - "@jridgewell/trace-mapping": "^0.3.24" - }, - "engines": { - "node": ">=6.0.0" + "node": "18.20.8 || ^20.3.0 || >=22.0.0" } }, "node_modules/@babel/code-frame": { @@ -425,23 +239,22 @@ } }, "node_modules/@babel/core": { - "version": "7.28.3", - "resolved": "https://registry.npmjs.org/@babel/core/-/core-7.28.3.tgz", - "integrity": "sha512-yDBHV9kQNcr2/sUr9jghVyz9C3Y5G2zUM2H2lo+9mKv4sFgbA8s8Z9t8D1jiTkGoO/NoIfKMyKWr4s6CN23ZwQ==", + "version": "7.28.5", + "resolved": "https://registry.npmjs.org/@babel/core/-/core-7.28.5.tgz", + "integrity": "sha512-e7jT4DxYvIDLk1ZHmU/m/mB19rex9sv0c2ftBtjSBv+kVM/902eh0fINUzD7UwLLNR+jU585GxUJ8/EBfAM5fw==", "dev": true, "license": "MIT", - "peer": true, "dependencies": { - "@ampproject/remapping": "^2.2.0", "@babel/code-frame": "^7.27.1", - "@babel/generator": "^7.28.3", + "@babel/generator": "^7.28.5", "@babel/helper-compilation-targets": "^7.27.2", "@babel/helper-module-transforms": "^7.28.3", - "@babel/helpers": "^7.28.3", - "@babel/parser": "^7.28.3", + "@babel/helpers": "^7.28.4", + "@babel/parser": "^7.28.5", "@babel/template": "^7.27.2", - "@babel/traverse": "^7.28.3", - "@babel/types": "^7.28.2", + "@babel/traverse": "^7.28.5", + "@babel/types": "^7.28.5", + "@jridgewell/remapping": "^2.3.5", "convert-source-map": "^2.0.0", "debug": "^4.1.0", "gensync": "^1.0.0-beta.2", @@ -483,19 +296,6 @@ "node": ">=6.9.0" } }, - "node_modules/@babel/helper-annotate-as-pure": { - "version": "7.27.3", - "resolved": "https://registry.npmjs.org/@babel/helper-annotate-as-pure/-/helper-annotate-as-pure-7.27.3.tgz", - "integrity": "sha512-fXSwMQqitTGeHLBC08Eq5yXz2m37E4pJX1qAU1+2cNedz/ifv/bVXft90VeSav5nFO61EcNgwr0aJxbyPaWBPg==", - "dev": true, - "license": "MIT", - "dependencies": { - "@babel/types": "^7.27.3" - }, - "engines": { - "node": ">=6.9.0" - } - }, "node_modules/@babel/helper-compilation-targets": { "version": "7.27.2", "resolved": "https://registry.npmjs.org/@babel/helper-compilation-targets/-/helper-compilation-targets-7.27.2.tgz", @@ -523,83 +323,6 @@ "semver": "bin/semver.js" } }, - "node_modules/@babel/helper-create-class-features-plugin": { - "version": "7.28.5", - "resolved": "https://registry.npmjs.org/@babel/helper-create-class-features-plugin/-/helper-create-class-features-plugin-7.28.5.tgz", - "integrity": "sha512-q3WC4JfdODypvxArsJQROfupPBq9+lMwjKq7C33GhbFYJsufD0yd/ziwD+hJucLeWsnFPWZjsU2DNFqBPE7jwQ==", - "dev": true, - "license": "MIT", - "dependencies": { - "@babel/helper-annotate-as-pure": "^7.27.3", - "@babel/helper-member-expression-to-functions": "^7.28.5", - "@babel/helper-optimise-call-expression": "^7.27.1", - "@babel/helper-replace-supers": "^7.27.1", - "@babel/helper-skip-transparent-expression-wrappers": "^7.27.1", - "@babel/traverse": "^7.28.5", - "semver": "^6.3.1" - }, - "engines": { - "node": ">=6.9.0" - }, - "peerDependencies": { - "@babel/core": "^7.0.0" - } - }, - "node_modules/@babel/helper-create-class-features-plugin/node_modules/semver": { - "version": "6.3.1", - "resolved": "https://registry.npmjs.org/semver/-/semver-6.3.1.tgz", - "integrity": "sha512-BR7VvDCVHO+q2xBEWskxS6DJE1qRnb7DxzUrogb71CWoSficBxYsiAGd+Kl0mmq/MprG9yArRkyrQxTO6XjMzA==", - "dev": true, - "license": "ISC", - "bin": { - "semver": "bin/semver.js" - } - }, - "node_modules/@babel/helper-create-regexp-features-plugin": { - "version": "7.28.5", - "resolved": "https://registry.npmjs.org/@babel/helper-create-regexp-features-plugin/-/helper-create-regexp-features-plugin-7.28.5.tgz", - "integrity": "sha512-N1EhvLtHzOvj7QQOUCCS3NrPJP8c5W6ZXCHDn7Yialuy1iu4r5EmIYkXlKNqT99Ciw+W0mDqWoR6HWMZlFP3hw==", - "dev": true, - "license": "MIT", - "dependencies": { - "@babel/helper-annotate-as-pure": "^7.27.3", - "regexpu-core": "^6.3.1", - "semver": "^6.3.1" - }, - "engines": { - "node": ">=6.9.0" - }, - "peerDependencies": { - "@babel/core": "^7.0.0" - } - }, - "node_modules/@babel/helper-create-regexp-features-plugin/node_modules/semver": { - "version": "6.3.1", - "resolved": "https://registry.npmjs.org/semver/-/semver-6.3.1.tgz", - "integrity": "sha512-BR7VvDCVHO+q2xBEWskxS6DJE1qRnb7DxzUrogb71CWoSficBxYsiAGd+Kl0mmq/MprG9yArRkyrQxTO6XjMzA==", - "dev": true, - "license": "ISC", - "bin": { - "semver": "bin/semver.js" - } - }, - "node_modules/@babel/helper-define-polyfill-provider": { - "version": "0.6.5", - "resolved": "https://registry.npmjs.org/@babel/helper-define-polyfill-provider/-/helper-define-polyfill-provider-0.6.5.tgz", - "integrity": "sha512-uJnGFcPsWQK8fvjgGP5LZUZZsYGIoPeRjSF5PGwrelYgq7Q15/Ft9NGFp1zglwgIv//W0uG4BevRuSJRyylZPg==", - "dev": true, - "license": "MIT", - "dependencies": { - "@babel/helper-compilation-targets": "^7.27.2", - "@babel/helper-plugin-utils": "^7.27.1", - "debug": "^4.4.1", - "lodash.debounce": "^4.0.8", - "resolve": "^1.22.10" - }, - "peerDependencies": { - "@babel/core": "^7.4.0 || ^8.0.0-0 <8.0.0" - } - }, "node_modules/@babel/helper-globals": { "version": "7.28.0", "resolved": "https://registry.npmjs.org/@babel/helper-globals/-/helper-globals-7.28.0.tgz", @@ -610,20 +333,6 @@ "node": ">=6.9.0" } }, - "node_modules/@babel/helper-member-expression-to-functions": { - "version": "7.28.5", - "resolved": "https://registry.npmjs.org/@babel/helper-member-expression-to-functions/-/helper-member-expression-to-functions-7.28.5.tgz", - "integrity": "sha512-cwM7SBRZcPCLgl8a7cY0soT1SptSzAlMH39vwiRpOQkJlh53r5hdHwLSCZpQdVLT39sZt+CRpNwYG4Y2v77atg==", - "dev": true, - "license": "MIT", - "dependencies": { - "@babel/traverse": "^7.28.5", - "@babel/types": "^7.28.5" - }, - "engines": { - "node": ">=6.9.0" - } - }, "node_modules/@babel/helper-module-imports": { "version": "7.27.1", "resolved": "https://registry.npmjs.org/@babel/helper-module-imports/-/helper-module-imports-7.27.1.tgz", @@ -656,19 +365,6 @@ "@babel/core": "^7.0.0" } }, - "node_modules/@babel/helper-optimise-call-expression": { - "version": "7.27.1", - "resolved": "https://registry.npmjs.org/@babel/helper-optimise-call-expression/-/helper-optimise-call-expression-7.27.1.tgz", - "integrity": "sha512-URMGH08NzYFhubNSGJrpUEphGKQwMQYBySzat5cAByY1/YgIRkULnIy3tAMeszlL/so2HbeilYloUmSpd7GdVw==", - "dev": true, - "license": "MIT", - "dependencies": { - "@babel/types": "^7.27.1" - }, - "engines": { - "node": ">=6.9.0" - } - }, "node_modules/@babel/helper-plugin-utils": { "version": "7.27.1", "resolved": "https://registry.npmjs.org/@babel/helper-plugin-utils/-/helper-plugin-utils-7.27.1.tgz", @@ -679,56 +375,6 @@ "node": ">=6.9.0" } }, - "node_modules/@babel/helper-remap-async-to-generator": { - "version": "7.27.1", - "resolved": "https://registry.npmjs.org/@babel/helper-remap-async-to-generator/-/helper-remap-async-to-generator-7.27.1.tgz", - "integrity": "sha512-7fiA521aVw8lSPeI4ZOD3vRFkoqkJcS+z4hFo82bFSH/2tNd6eJ5qCVMS5OzDmZh/kaHQeBaeyxK6wljcPtveA==", - "dev": true, - "license": "MIT", - "dependencies": { - "@babel/helper-annotate-as-pure": "^7.27.1", - "@babel/helper-wrap-function": "^7.27.1", - "@babel/traverse": "^7.27.1" - }, - "engines": { - "node": ">=6.9.0" - }, - "peerDependencies": { - "@babel/core": "^7.0.0" - } - }, - "node_modules/@babel/helper-replace-supers": { - "version": "7.27.1", - "resolved": "https://registry.npmjs.org/@babel/helper-replace-supers/-/helper-replace-supers-7.27.1.tgz", - "integrity": "sha512-7EHz6qDZc8RYS5ElPoShMheWvEgERonFCs7IAonWLLUTXW59DP14bCZt89/GKyreYn8g3S83m21FelHKbeDCKA==", - "dev": true, - "license": "MIT", - "dependencies": { - "@babel/helper-member-expression-to-functions": "^7.27.1", - "@babel/helper-optimise-call-expression": "^7.27.1", - "@babel/traverse": "^7.27.1" - }, - "engines": { - "node": ">=6.9.0" - }, - "peerDependencies": { - "@babel/core": "^7.0.0" - } - }, - "node_modules/@babel/helper-skip-transparent-expression-wrappers": { - "version": "7.27.1", - "resolved": "https://registry.npmjs.org/@babel/helper-skip-transparent-expression-wrappers/-/helper-skip-transparent-expression-wrappers-7.27.1.tgz", - "integrity": "sha512-Tub4ZKEXqbPjXgWLl2+3JpQAYBJ8+ikpQ2Ocj/q/r0LwE3UhENh7EUabyHjz2kCEsrRY83ew2DQdHluuiDQFzg==", - "dev": true, - "license": "MIT", - "dependencies": { - "@babel/traverse": "^7.27.1", - "@babel/types": "^7.27.1" - }, - "engines": { - "node": ">=6.9.0" - } - }, "node_modules/@babel/helper-string-parser": { "version": "7.27.1", "resolved": "https://registry.npmjs.org/@babel/helper-string-parser/-/helper-string-parser-7.27.1.tgz", @@ -759,30 +405,15 @@ "node": ">=6.9.0" } }, - "node_modules/@babel/helper-wrap-function": { - "version": "7.28.3", - "resolved": "https://registry.npmjs.org/@babel/helper-wrap-function/-/helper-wrap-function-7.28.3.tgz", - "integrity": "sha512-zdf983tNfLZFletc0RRXYrHrucBEg95NIFMkn6K9dbeMYnsgHaSBGcQqdsCSStG2PYwRre0Qc2NNSCXbG+xc6g==", - "dev": true, - "license": "MIT", - "dependencies": { - "@babel/template": "^7.27.2", - "@babel/traverse": "^7.28.3", - "@babel/types": "^7.28.2" - }, - "engines": { - "node": ">=6.9.0" - } - }, "node_modules/@babel/helpers": { - "version": "7.28.3", - "resolved": "https://registry.npmjs.org/@babel/helpers/-/helpers-7.28.3.tgz", - "integrity": "sha512-PTNtvUQihsAsDHMOP5pfobP8C6CM4JWXmP8DrEIt46c3r2bf87Ua1zoqevsMo9g+tWDwgWrFP5EIxuBx5RudAw==", + "version": "7.28.4", + "resolved": "https://registry.npmjs.org/@babel/helpers/-/helpers-7.28.4.tgz", + "integrity": "sha512-HFN59MmQXGHVyYadKLVumYsA9dBFun/ldYxipEjzA4196jpLZd8UjEEBLkbEkvfYreDqJhZxYAWFPtrfhNpj4w==", "dev": true, "license": "MIT", "dependencies": { "@babel/template": "^7.27.2", - "@babel/types": "^7.28.2" + "@babel/types": "^7.28.4" }, "engines": { "node": ">=6.9.0" @@ -804,103 +435,6 @@ "node": ">=6.0.0" } }, - "node_modules/@babel/plugin-bugfix-firefox-class-in-computed-class-key": { - "version": "7.28.5", - "resolved": "https://registry.npmjs.org/@babel/plugin-bugfix-firefox-class-in-computed-class-key/-/plugin-bugfix-firefox-class-in-computed-class-key-7.28.5.tgz", - "integrity": "sha512-87GDMS3tsmMSi/3bWOte1UblL+YUTFMV8SZPZ2eSEL17s74Cw/l63rR6NmGVKMYW2GYi85nE+/d6Hw5N0bEk2Q==", - "dev": true, - "license": "MIT", - "dependencies": { - "@babel/helper-plugin-utils": "^7.27.1", - "@babel/traverse": "^7.28.5" - }, - "engines": { - "node": ">=6.9.0" - }, - "peerDependencies": { - "@babel/core": "^7.0.0" - } - }, - "node_modules/@babel/plugin-bugfix-safari-class-field-initializer-scope": { - "version": "7.27.1", - "resolved": "https://registry.npmjs.org/@babel/plugin-bugfix-safari-class-field-initializer-scope/-/plugin-bugfix-safari-class-field-initializer-scope-7.27.1.tgz", - "integrity": "sha512-qNeq3bCKnGgLkEXUuFry6dPlGfCdQNZbn7yUAPCInwAJHMU7THJfrBSozkcWq5sNM6RcF3S8XyQL2A52KNR9IA==", - "dev": true, - "license": "MIT", - "dependencies": { - "@babel/helper-plugin-utils": "^7.27.1" - }, - "engines": { - "node": ">=6.9.0" - }, - "peerDependencies": { - "@babel/core": "^7.0.0" - } - }, - "node_modules/@babel/plugin-bugfix-safari-id-destructuring-collision-in-function-expression": { - "version": "7.27.1", - "resolved": "https://registry.npmjs.org/@babel/plugin-bugfix-safari-id-destructuring-collision-in-function-expression/-/plugin-bugfix-safari-id-destructuring-collision-in-function-expression-7.27.1.tgz", - "integrity": "sha512-g4L7OYun04N1WyqMNjldFwlfPCLVkgB54A/YCXICZYBsvJJE3kByKv9c9+R/nAfmIfjl2rKYLNyMHboYbZaWaA==", - "dev": true, - "license": "MIT", - "dependencies": { - "@babel/helper-plugin-utils": "^7.27.1" - }, - "engines": { - "node": ">=6.9.0" - }, - "peerDependencies": { - "@babel/core": "^7.0.0" - } - }, - "node_modules/@babel/plugin-bugfix-v8-spread-parameters-in-optional-chaining": { - "version": "7.27.1", - "resolved": "https://registry.npmjs.org/@babel/plugin-bugfix-v8-spread-parameters-in-optional-chaining/-/plugin-bugfix-v8-spread-parameters-in-optional-chaining-7.27.1.tgz", - "integrity": "sha512-oO02gcONcD5O1iTLi/6frMJBIwWEHceWGSGqrpCmEL8nogiS6J9PBlE48CaK20/Jx1LuRml9aDftLgdjXT8+Cw==", - "dev": true, - "license": "MIT", - "dependencies": { - "@babel/helper-plugin-utils": "^7.27.1", - "@babel/helper-skip-transparent-expression-wrappers": "^7.27.1", - "@babel/plugin-transform-optional-chaining": "^7.27.1" - }, - "engines": { - "node": ">=6.9.0" - }, - "peerDependencies": { - "@babel/core": "^7.13.0" - } - }, - "node_modules/@babel/plugin-bugfix-v8-static-class-fields-redefine-readonly": { - "version": "7.28.3", - "resolved": "https://registry.npmjs.org/@babel/plugin-bugfix-v8-static-class-fields-redefine-readonly/-/plugin-bugfix-v8-static-class-fields-redefine-readonly-7.28.3.tgz", - "integrity": "sha512-b6YTX108evsvE4YgWyQ921ZAFFQm3Bn+CA3+ZXlNVnPhx+UfsVURoPjfGAPCjBgrqo30yX/C2nZGX96DxvR9Iw==", - "dev": true, - "license": "MIT", - "dependencies": { - "@babel/helper-plugin-utils": "^7.27.1", - "@babel/traverse": "^7.28.3" - }, - "engines": { - "node": ">=6.9.0" - }, - "peerDependencies": { - "@babel/core": "^7.0.0" - } - }, - "node_modules/@babel/plugin-proposal-private-property-in-object": { - "version": "7.21.0-placeholder-for-preset-env.2", - "resolved": "https://registry.npmjs.org/@babel/plugin-proposal-private-property-in-object/-/plugin-proposal-private-property-in-object-7.21.0-placeholder-for-preset-env.2.tgz", - "integrity": "sha512-SOSkfJDddaM7mak6cPEpswyTRnuRltl429hMraQEglW+OkovnCzsiszTmsrlY//qLFjCpQDFRvjdm2wA5pPm9w==", - "dev": true, - "license": "MIT", - "engines": { - "node": ">=6.9.0" - }, - "peerDependencies": { - "@babel/core": "^7.0.0-0" - } - }, "node_modules/@babel/plugin-syntax-async-generators": { "version": "7.8.4", "resolved": "https://registry.npmjs.org/@babel/plugin-syntax-async-generators/-/plugin-syntax-async-generators-7.8.4.tgz", @@ -956,35 +490,6 @@ "@babel/core": "^7.0.0-0" } }, - "node_modules/@babel/plugin-syntax-dynamic-import": { - "version": "7.8.3", - "resolved": "https://registry.npmjs.org/@babel/plugin-syntax-dynamic-import/-/plugin-syntax-dynamic-import-7.8.3.tgz", - "integrity": "sha512-5gdGbFon+PszYzqs83S3E5mpi7/y/8M9eC90MRTZfduQOYW76ig6SOSPNe41IG5LoP3FGBn2N0RjVDSQiS94kQ==", - "dev": true, - "license": "MIT", - "dependencies": { - "@babel/helper-plugin-utils": "^7.8.0" - }, - "peerDependencies": { - "@babel/core": "^7.0.0-0" - } - }, - "node_modules/@babel/plugin-syntax-import-assertions": { - "version": "7.27.1", - "resolved": "https://registry.npmjs.org/@babel/plugin-syntax-import-assertions/-/plugin-syntax-import-assertions-7.27.1.tgz", - "integrity": "sha512-UT/Jrhw57xg4ILHLFnzFpPDlMbcdEicaAtjPQpbj9wa8T4r5KVWCimHcL/460g8Ht0DMxDyjsLgiWSkVjnwPFg==", - "dev": true, - "license": "MIT", - "dependencies": { - "@babel/helper-plugin-utils": "^7.27.1" - }, - "engines": { - "node": ">=6.9.0" - }, - "peerDependencies": { - "@babel/core": "^7.0.0-0" - } - }, "node_modules/@babel/plugin-syntax-import-attributes": { "version": "7.27.1", "resolved": "https://registry.npmjs.org/@babel/plugin-syntax-import-attributes/-/plugin-syntax-import-attributes-7.27.1.tgz", @@ -1169,1166 +674,6 @@ "@babel/core": "^7.0.0-0" } }, - "node_modules/@babel/plugin-syntax-unicode-sets-regex": { - "version": "7.18.6", - "resolved": "https://registry.npmjs.org/@babel/plugin-syntax-unicode-sets-regex/-/plugin-syntax-unicode-sets-regex-7.18.6.tgz", - "integrity": "sha512-727YkEAPwSIQTv5im8QHz3upqp92JTWhidIC81Tdx4VJYIte/VndKf1qKrfnnhPLiPghStWfvC/iFaMCQu7Nqg==", - "dev": true, - "license": "MIT", - "dependencies": { - "@babel/helper-create-regexp-features-plugin": "^7.18.6", - "@babel/helper-plugin-utils": "^7.18.6" - }, - "engines": { - "node": ">=6.9.0" - }, - "peerDependencies": { - "@babel/core": "^7.0.0" - } - }, - "node_modules/@babel/plugin-transform-arrow-functions": { - "version": "7.27.1", - "resolved": "https://registry.npmjs.org/@babel/plugin-transform-arrow-functions/-/plugin-transform-arrow-functions-7.27.1.tgz", - "integrity": "sha512-8Z4TGic6xW70FKThA5HYEKKyBpOOsucTOD1DjU3fZxDg+K3zBJcXMFnt/4yQiZnf5+MiOMSXQ9PaEK/Ilh1DeA==", - "dev": true, - "license": "MIT", - "dependencies": { - "@babel/helper-plugin-utils": "^7.27.1" - }, - "engines": { - "node": ">=6.9.0" - }, - "peerDependencies": { - "@babel/core": "^7.0.0-0" - } - }, - "node_modules/@babel/plugin-transform-async-generator-functions": { - "version": "7.28.0", - "resolved": "https://registry.npmjs.org/@babel/plugin-transform-async-generator-functions/-/plugin-transform-async-generator-functions-7.28.0.tgz", - "integrity": "sha512-BEOdvX4+M765icNPZeidyADIvQ1m1gmunXufXxvRESy/jNNyfovIqUyE7MVgGBjWktCoJlzvFA1To2O4ymIO3Q==", - "dev": true, - "license": "MIT", - "dependencies": { - "@babel/helper-plugin-utils": "^7.27.1", - "@babel/helper-remap-async-to-generator": "^7.27.1", - "@babel/traverse": "^7.28.0" - }, - "engines": { - "node": ">=6.9.0" - }, - "peerDependencies": { - "@babel/core": "^7.0.0-0" - } - }, - "node_modules/@babel/plugin-transform-async-to-generator": { - "version": "7.27.1", - "resolved": "https://registry.npmjs.org/@babel/plugin-transform-async-to-generator/-/plugin-transform-async-to-generator-7.27.1.tgz", - "integrity": "sha512-NREkZsZVJS4xmTr8qzE5y8AfIPqsdQfRuUiLRTEzb7Qii8iFWCyDKaUV2c0rCuh4ljDZ98ALHP/PetiBV2nddA==", - "dev": true, - "license": "MIT", - "dependencies": { - "@babel/helper-module-imports": "^7.27.1", - "@babel/helper-plugin-utils": "^7.27.1", - "@babel/helper-remap-async-to-generator": "^7.27.1" - }, - "engines": { - "node": ">=6.9.0" - }, - "peerDependencies": { - "@babel/core": "^7.0.0-0" - } - }, - "node_modules/@babel/plugin-transform-block-scoped-functions": { - "version": "7.27.1", - "resolved": "https://registry.npmjs.org/@babel/plugin-transform-block-scoped-functions/-/plugin-transform-block-scoped-functions-7.27.1.tgz", - "integrity": "sha512-cnqkuOtZLapWYZUYM5rVIdv1nXYuFVIltZ6ZJ7nIj585QsjKM5dhL2Fu/lICXZ1OyIAFc7Qy+bvDAtTXqGrlhg==", - "dev": true, - "license": "MIT", - "dependencies": { - "@babel/helper-plugin-utils": "^7.27.1" - }, - "engines": { - "node": ">=6.9.0" - }, - "peerDependencies": { - "@babel/core": "^7.0.0-0" - } - }, - "node_modules/@babel/plugin-transform-block-scoping": { - "version": "7.28.5", - "resolved": "https://registry.npmjs.org/@babel/plugin-transform-block-scoping/-/plugin-transform-block-scoping-7.28.5.tgz", - "integrity": "sha512-45DmULpySVvmq9Pj3X9B+62Xe+DJGov27QravQJU1LLcapR6/10i+gYVAucGGJpHBp5mYxIMK4nDAT/QDLr47g==", - "dev": true, - "license": "MIT", - "dependencies": { - "@babel/helper-plugin-utils": "^7.27.1" - }, - "engines": { - "node": ">=6.9.0" - }, - "peerDependencies": { - "@babel/core": "^7.0.0-0" - } - }, - "node_modules/@babel/plugin-transform-class-properties": { - "version": "7.27.1", - "resolved": "https://registry.npmjs.org/@babel/plugin-transform-class-properties/-/plugin-transform-class-properties-7.27.1.tgz", - "integrity": "sha512-D0VcalChDMtuRvJIu3U/fwWjf8ZMykz5iZsg77Nuj821vCKI3zCyRLwRdWbsuJ/uRwZhZ002QtCqIkwC/ZkvbA==", - "dev": true, - "license": "MIT", - "dependencies": { - "@babel/helper-create-class-features-plugin": "^7.27.1", - "@babel/helper-plugin-utils": "^7.27.1" - }, - "engines": { - "node": ">=6.9.0" - }, - "peerDependencies": { - "@babel/core": "^7.0.0-0" - } - }, - "node_modules/@babel/plugin-transform-class-static-block": { - "version": "7.28.3", - "resolved": "https://registry.npmjs.org/@babel/plugin-transform-class-static-block/-/plugin-transform-class-static-block-7.28.3.tgz", - "integrity": "sha512-LtPXlBbRoc4Njl/oh1CeD/3jC+atytbnf/UqLoqTDcEYGUPj022+rvfkbDYieUrSj3CaV4yHDByPE+T2HwfsJg==", - "dev": true, - "license": "MIT", - "dependencies": { - "@babel/helper-create-class-features-plugin": "^7.28.3", - "@babel/helper-plugin-utils": "^7.27.1" - }, - "engines": { - "node": ">=6.9.0" - }, - "peerDependencies": { - "@babel/core": "^7.12.0" - } - }, - "node_modules/@babel/plugin-transform-classes": { - "version": "7.28.4", - "resolved": "https://registry.npmjs.org/@babel/plugin-transform-classes/-/plugin-transform-classes-7.28.4.tgz", - "integrity": "sha512-cFOlhIYPBv/iBoc+KS3M6et2XPtbT2HiCRfBXWtfpc9OAyostldxIf9YAYB6ypURBBbx+Qv6nyrLzASfJe+hBA==", - "dev": true, - "license": "MIT", - "dependencies": { - "@babel/helper-annotate-as-pure": "^7.27.3", - "@babel/helper-compilation-targets": "^7.27.2", - "@babel/helper-globals": "^7.28.0", - "@babel/helper-plugin-utils": "^7.27.1", - "@babel/helper-replace-supers": "^7.27.1", - "@babel/traverse": "^7.28.4" - }, - "engines": { - "node": ">=6.9.0" - }, - "peerDependencies": { - "@babel/core": "^7.0.0-0" - } - }, - "node_modules/@babel/plugin-transform-computed-properties": { - "version": "7.27.1", - "resolved": "https://registry.npmjs.org/@babel/plugin-transform-computed-properties/-/plugin-transform-computed-properties-7.27.1.tgz", - "integrity": "sha512-lj9PGWvMTVksbWiDT2tW68zGS/cyo4AkZ/QTp0sQT0mjPopCmrSkzxeXkznjqBxzDI6TclZhOJbBmbBLjuOZUw==", - "dev": true, - "license": "MIT", - "dependencies": { - "@babel/helper-plugin-utils": "^7.27.1", - "@babel/template": "^7.27.1" - }, - "engines": { - "node": ">=6.9.0" - }, - "peerDependencies": { - "@babel/core": "^7.0.0-0" - } - }, - "node_modules/@babel/plugin-transform-destructuring": { - "version": "7.28.5", - "resolved": "https://registry.npmjs.org/@babel/plugin-transform-destructuring/-/plugin-transform-destructuring-7.28.5.tgz", - "integrity": "sha512-Kl9Bc6D0zTUcFUvkNuQh4eGXPKKNDOJQXVyyM4ZAQPMveniJdxi8XMJwLo+xSoW3MIq81bD33lcUe9kZpl0MCw==", - "dev": true, - "license": "MIT", - "dependencies": { - "@babel/helper-plugin-utils": "^7.27.1", - "@babel/traverse": "^7.28.5" - }, - "engines": { - "node": ">=6.9.0" - }, - "peerDependencies": { - "@babel/core": "^7.0.0-0" - } - }, - "node_modules/@babel/plugin-transform-dotall-regex": { - "version": "7.27.1", - "resolved": "https://registry.npmjs.org/@babel/plugin-transform-dotall-regex/-/plugin-transform-dotall-regex-7.27.1.tgz", - "integrity": "sha512-gEbkDVGRvjj7+T1ivxrfgygpT7GUd4vmODtYpbs0gZATdkX8/iSnOtZSxiZnsgm1YjTgjI6VKBGSJJevkrclzw==", - "dev": true, - "license": "MIT", - "dependencies": { - "@babel/helper-create-regexp-features-plugin": "^7.27.1", - "@babel/helper-plugin-utils": "^7.27.1" - }, - "engines": { - "node": ">=6.9.0" - }, - "peerDependencies": { - "@babel/core": "^7.0.0-0" - } - }, - "node_modules/@babel/plugin-transform-duplicate-keys": { - "version": "7.27.1", - "resolved": "https://registry.npmjs.org/@babel/plugin-transform-duplicate-keys/-/plugin-transform-duplicate-keys-7.27.1.tgz", - "integrity": "sha512-MTyJk98sHvSs+cvZ4nOauwTTG1JeonDjSGvGGUNHreGQns+Mpt6WX/dVzWBHgg+dYZhkC4X+zTDfkTU+Vy9y7Q==", - "dev": true, - "license": "MIT", - "dependencies": { - "@babel/helper-plugin-utils": "^7.27.1" - }, - "engines": { - "node": ">=6.9.0" - }, - "peerDependencies": { - "@babel/core": "^7.0.0-0" - } - }, - "node_modules/@babel/plugin-transform-duplicate-named-capturing-groups-regex": { - "version": "7.27.1", - "resolved": "https://registry.npmjs.org/@babel/plugin-transform-duplicate-named-capturing-groups-regex/-/plugin-transform-duplicate-named-capturing-groups-regex-7.27.1.tgz", - "integrity": "sha512-hkGcueTEzuhB30B3eJCbCYeCaaEQOmQR0AdvzpD4LoN0GXMWzzGSuRrxR2xTnCrvNbVwK9N6/jQ92GSLfiZWoQ==", - "dev": true, - "license": "MIT", - "dependencies": { - "@babel/helper-create-regexp-features-plugin": "^7.27.1", - "@babel/helper-plugin-utils": "^7.27.1" - }, - "engines": { - "node": ">=6.9.0" - }, - "peerDependencies": { - "@babel/core": "^7.0.0" - } - }, - "node_modules/@babel/plugin-transform-dynamic-import": { - "version": "7.27.1", - "resolved": "https://registry.npmjs.org/@babel/plugin-transform-dynamic-import/-/plugin-transform-dynamic-import-7.27.1.tgz", - "integrity": "sha512-MHzkWQcEmjzzVW9j2q8LGjwGWpG2mjwaaB0BNQwst3FIjqsg8Ct/mIZlvSPJvfi9y2AC8mi/ktxbFVL9pZ1I4A==", - "dev": true, - "license": "MIT", - "dependencies": { - "@babel/helper-plugin-utils": "^7.27.1" - }, - "engines": { - "node": ">=6.9.0" - }, - "peerDependencies": { - "@babel/core": "^7.0.0-0" - } - }, - "node_modules/@babel/plugin-transform-explicit-resource-management": { - "version": "7.28.0", - "resolved": "https://registry.npmjs.org/@babel/plugin-transform-explicit-resource-management/-/plugin-transform-explicit-resource-management-7.28.0.tgz", - "integrity": "sha512-K8nhUcn3f6iB+P3gwCv/no7OdzOZQcKchW6N389V6PD8NUWKZHzndOd9sPDVbMoBsbmjMqlB4L9fm+fEFNVlwQ==", - "dev": true, - "license": "MIT", - "dependencies": { - "@babel/helper-plugin-utils": "^7.27.1", - "@babel/plugin-transform-destructuring": "^7.28.0" - }, - "engines": { - "node": ">=6.9.0" - }, - "peerDependencies": { - "@babel/core": "^7.0.0-0" - } - }, - "node_modules/@babel/plugin-transform-exponentiation-operator": { - "version": "7.28.5", - "resolved": "https://registry.npmjs.org/@babel/plugin-transform-exponentiation-operator/-/plugin-transform-exponentiation-operator-7.28.5.tgz", - "integrity": "sha512-D4WIMaFtwa2NizOp+dnoFjRez/ClKiC2BqqImwKd1X28nqBtZEyCYJ2ozQrrzlxAFrcrjxo39S6khe9RNDlGzw==", - "dev": true, - "license": "MIT", - "dependencies": { - "@babel/helper-plugin-utils": "^7.27.1" - }, - "engines": { - "node": ">=6.9.0" - }, - "peerDependencies": { - "@babel/core": "^7.0.0-0" - } - }, - "node_modules/@babel/plugin-transform-export-namespace-from": { - "version": "7.27.1", - "resolved": "https://registry.npmjs.org/@babel/plugin-transform-export-namespace-from/-/plugin-transform-export-namespace-from-7.27.1.tgz", - "integrity": "sha512-tQvHWSZ3/jH2xuq/vZDy0jNn+ZdXJeM8gHvX4lnJmsc3+50yPlWdZXIc5ay+umX+2/tJIqHqiEqcJvxlmIvRvQ==", - "dev": true, - "license": "MIT", - "dependencies": { - "@babel/helper-plugin-utils": "^7.27.1" - }, - "engines": { - "node": ">=6.9.0" - }, - "peerDependencies": { - "@babel/core": "^7.0.0-0" - } - }, - "node_modules/@babel/plugin-transform-for-of": { - "version": "7.27.1", - "resolved": "https://registry.npmjs.org/@babel/plugin-transform-for-of/-/plugin-transform-for-of-7.27.1.tgz", - "integrity": "sha512-BfbWFFEJFQzLCQ5N8VocnCtA8J1CLkNTe2Ms2wocj75dd6VpiqS5Z5quTYcUoo4Yq+DN0rtikODccuv7RU81sw==", - "dev": true, - "license": "MIT", - "dependencies": { - "@babel/helper-plugin-utils": "^7.27.1", - "@babel/helper-skip-transparent-expression-wrappers": "^7.27.1" - }, - "engines": { - "node": ">=6.9.0" - }, - "peerDependencies": { - "@babel/core": "^7.0.0-0" - } - }, - "node_modules/@babel/plugin-transform-function-name": { - "version": "7.27.1", - "resolved": "https://registry.npmjs.org/@babel/plugin-transform-function-name/-/plugin-transform-function-name-7.27.1.tgz", - "integrity": "sha512-1bQeydJF9Nr1eBCMMbC+hdwmRlsv5XYOMu03YSWFwNs0HsAmtSxxF1fyuYPqemVldVyFmlCU7w8UE14LupUSZQ==", - "dev": true, - "license": "MIT", - "dependencies": { - "@babel/helper-compilation-targets": "^7.27.1", - "@babel/helper-plugin-utils": "^7.27.1", - "@babel/traverse": "^7.27.1" - }, - "engines": { - "node": ">=6.9.0" - }, - "peerDependencies": { - "@babel/core": "^7.0.0-0" - } - }, - "node_modules/@babel/plugin-transform-json-strings": { - "version": "7.27.1", - "resolved": "https://registry.npmjs.org/@babel/plugin-transform-json-strings/-/plugin-transform-json-strings-7.27.1.tgz", - "integrity": "sha512-6WVLVJiTjqcQauBhn1LkICsR2H+zm62I3h9faTDKt1qP4jn2o72tSvqMwtGFKGTpojce0gJs+76eZ2uCHRZh0Q==", - "dev": true, - "license": "MIT", - "dependencies": { - "@babel/helper-plugin-utils": "^7.27.1" - }, - "engines": { - "node": ">=6.9.0" - }, - "peerDependencies": { - "@babel/core": "^7.0.0-0" - } - }, - "node_modules/@babel/plugin-transform-literals": { - "version": "7.27.1", - "resolved": "https://registry.npmjs.org/@babel/plugin-transform-literals/-/plugin-transform-literals-7.27.1.tgz", - "integrity": "sha512-0HCFSepIpLTkLcsi86GG3mTUzxV5jpmbv97hTETW3yzrAij8aqlD36toB1D0daVFJM8NK6GvKO0gslVQmm+zZA==", - "dev": true, - "license": "MIT", - "dependencies": { - "@babel/helper-plugin-utils": "^7.27.1" - }, - "engines": { - "node": ">=6.9.0" - }, - "peerDependencies": { - "@babel/core": "^7.0.0-0" - } - }, - "node_modules/@babel/plugin-transform-logical-assignment-operators": { - "version": "7.28.5", - "resolved": "https://registry.npmjs.org/@babel/plugin-transform-logical-assignment-operators/-/plugin-transform-logical-assignment-operators-7.28.5.tgz", - "integrity": "sha512-axUuqnUTBuXyHGcJEVVh9pORaN6wC5bYfE7FGzPiaWa3syib9m7g+/IT/4VgCOe2Upef43PHzeAvcrVek6QuuA==", - "dev": true, - "license": "MIT", - "dependencies": { - "@babel/helper-plugin-utils": "^7.27.1" - }, - "engines": { - "node": ">=6.9.0" - }, - "peerDependencies": { - "@babel/core": "^7.0.0-0" - } - }, - "node_modules/@babel/plugin-transform-member-expression-literals": { - "version": "7.27.1", - "resolved": "https://registry.npmjs.org/@babel/plugin-transform-member-expression-literals/-/plugin-transform-member-expression-literals-7.27.1.tgz", - "integrity": "sha512-hqoBX4dcZ1I33jCSWcXrP+1Ku7kdqXf1oeah7ooKOIiAdKQ+uqftgCFNOSzA5AMS2XIHEYeGFg4cKRCdpxzVOQ==", - "dev": true, - "license": "MIT", - "dependencies": { - "@babel/helper-plugin-utils": "^7.27.1" - }, - "engines": { - "node": ">=6.9.0" - }, - "peerDependencies": { - "@babel/core": "^7.0.0-0" - } - }, - "node_modules/@babel/plugin-transform-modules-amd": { - "version": "7.27.1", - "resolved": "https://registry.npmjs.org/@babel/plugin-transform-modules-amd/-/plugin-transform-modules-amd-7.27.1.tgz", - "integrity": "sha512-iCsytMg/N9/oFq6n+gFTvUYDZQOMK5kEdeYxmxt91fcJGycfxVP9CnrxoliM0oumFERba2i8ZtwRUCMhvP1LnA==", - "dev": true, - "license": "MIT", - "dependencies": { - "@babel/helper-module-transforms": "^7.27.1", - "@babel/helper-plugin-utils": "^7.27.1" - }, - "engines": { - "node": ">=6.9.0" - }, - "peerDependencies": { - "@babel/core": "^7.0.0-0" - } - }, - "node_modules/@babel/plugin-transform-modules-commonjs": { - "version": "7.27.1", - "resolved": "https://registry.npmjs.org/@babel/plugin-transform-modules-commonjs/-/plugin-transform-modules-commonjs-7.27.1.tgz", - "integrity": "sha512-OJguuwlTYlN0gBZFRPqwOGNWssZjfIUdS7HMYtN8c1KmwpwHFBwTeFZrg9XZa+DFTitWOW5iTAG7tyCUPsCCyw==", - "dev": true, - "license": "MIT", - "dependencies": { - "@babel/helper-module-transforms": "^7.27.1", - "@babel/helper-plugin-utils": "^7.27.1" - }, - "engines": { - "node": ">=6.9.0" - }, - "peerDependencies": { - "@babel/core": "^7.0.0-0" - } - }, - "node_modules/@babel/plugin-transform-modules-systemjs": { - "version": "7.28.5", - "resolved": "https://registry.npmjs.org/@babel/plugin-transform-modules-systemjs/-/plugin-transform-modules-systemjs-7.28.5.tgz", - "integrity": "sha512-vn5Jma98LCOeBy/KpeQhXcV2WZgaRUtjwQmjoBuLNlOmkg0fB5pdvYVeWRYI69wWKwK2cD1QbMiUQnoujWvrew==", - "dev": true, - "license": "MIT", - "dependencies": { - "@babel/helper-module-transforms": "^7.28.3", - "@babel/helper-plugin-utils": "^7.27.1", - "@babel/helper-validator-identifier": "^7.28.5", - "@babel/traverse": "^7.28.5" - }, - "engines": { - "node": ">=6.9.0" - }, - "peerDependencies": { - "@babel/core": "^7.0.0-0" - } - }, - "node_modules/@babel/plugin-transform-modules-umd": { - "version": "7.27.1", - "resolved": "https://registry.npmjs.org/@babel/plugin-transform-modules-umd/-/plugin-transform-modules-umd-7.27.1.tgz", - "integrity": "sha512-iQBE/xC5BV1OxJbp6WG7jq9IWiD+xxlZhLrdwpPkTX3ydmXdvoCpyfJN7acaIBZaOqTfr76pgzqBJflNbeRK+w==", - "dev": true, - "license": "MIT", - "dependencies": { - "@babel/helper-module-transforms": "^7.27.1", - "@babel/helper-plugin-utils": "^7.27.1" - }, - "engines": { - "node": ">=6.9.0" - }, - "peerDependencies": { - "@babel/core": "^7.0.0-0" - } - }, - "node_modules/@babel/plugin-transform-named-capturing-groups-regex": { - "version": "7.27.1", - "resolved": "https://registry.npmjs.org/@babel/plugin-transform-named-capturing-groups-regex/-/plugin-transform-named-capturing-groups-regex-7.27.1.tgz", - "integrity": "sha512-SstR5JYy8ddZvD6MhV0tM/j16Qds4mIpJTOd1Yu9J9pJjH93bxHECF7pgtc28XvkzTD6Pxcm/0Z73Hvk7kb3Ng==", - "dev": true, - "license": "MIT", - "dependencies": { - "@babel/helper-create-regexp-features-plugin": "^7.27.1", - "@babel/helper-plugin-utils": "^7.27.1" - }, - "engines": { - "node": ">=6.9.0" - }, - "peerDependencies": { - "@babel/core": "^7.0.0" - } - }, - "node_modules/@babel/plugin-transform-new-target": { - "version": "7.27.1", - "resolved": "https://registry.npmjs.org/@babel/plugin-transform-new-target/-/plugin-transform-new-target-7.27.1.tgz", - "integrity": "sha512-f6PiYeqXQ05lYq3TIfIDu/MtliKUbNwkGApPUvyo6+tc7uaR4cPjPe7DFPr15Uyycg2lZU6btZ575CuQoYh7MQ==", - "dev": true, - "license": "MIT", - "dependencies": { - "@babel/helper-plugin-utils": "^7.27.1" - }, - "engines": { - "node": ">=6.9.0" - }, - "peerDependencies": { - "@babel/core": "^7.0.0-0" - } - }, - "node_modules/@babel/plugin-transform-nullish-coalescing-operator": { - "version": "7.27.1", - "resolved": "https://registry.npmjs.org/@babel/plugin-transform-nullish-coalescing-operator/-/plugin-transform-nullish-coalescing-operator-7.27.1.tgz", - "integrity": "sha512-aGZh6xMo6q9vq1JGcw58lZ1Z0+i0xB2x0XaauNIUXd6O1xXc3RwoWEBlsTQrY4KQ9Jf0s5rgD6SiNkaUdJegTA==", - "dev": true, - "license": "MIT", - "dependencies": { - "@babel/helper-plugin-utils": "^7.27.1" - }, - "engines": { - "node": ">=6.9.0" - }, - "peerDependencies": { - "@babel/core": "^7.0.0-0" - } - }, - "node_modules/@babel/plugin-transform-numeric-separator": { - "version": "7.27.1", - "resolved": "https://registry.npmjs.org/@babel/plugin-transform-numeric-separator/-/plugin-transform-numeric-separator-7.27.1.tgz", - "integrity": "sha512-fdPKAcujuvEChxDBJ5c+0BTaS6revLV7CJL08e4m3de8qJfNIuCc2nc7XJYOjBoTMJeqSmwXJ0ypE14RCjLwaw==", - "dev": true, - "license": "MIT", - "dependencies": { - "@babel/helper-plugin-utils": "^7.27.1" - }, - "engines": { - "node": ">=6.9.0" - }, - "peerDependencies": { - "@babel/core": "^7.0.0-0" - } - }, - "node_modules/@babel/plugin-transform-object-rest-spread": { - "version": "7.28.4", - "resolved": "https://registry.npmjs.org/@babel/plugin-transform-object-rest-spread/-/plugin-transform-object-rest-spread-7.28.4.tgz", - "integrity": "sha512-373KA2HQzKhQCYiRVIRr+3MjpCObqzDlyrM6u4I201wL8Mp2wHf7uB8GhDwis03k2ti8Zr65Zyyqs1xOxUF/Ew==", - "dev": true, - "license": "MIT", - "dependencies": { - "@babel/helper-compilation-targets": "^7.27.2", - "@babel/helper-plugin-utils": "^7.27.1", - "@babel/plugin-transform-destructuring": "^7.28.0", - "@babel/plugin-transform-parameters": "^7.27.7", - "@babel/traverse": "^7.28.4" - }, - "engines": { - "node": ">=6.9.0" - }, - "peerDependencies": { - "@babel/core": "^7.0.0-0" - } - }, - "node_modules/@babel/plugin-transform-object-super": { - "version": "7.27.1", - "resolved": "https://registry.npmjs.org/@babel/plugin-transform-object-super/-/plugin-transform-object-super-7.27.1.tgz", - "integrity": "sha512-SFy8S9plRPbIcxlJ8A6mT/CxFdJx/c04JEctz4jf8YZaVS2px34j7NXRrlGlHkN/M2gnpL37ZpGRGVFLd3l8Ng==", - "dev": true, - "license": "MIT", - "dependencies": { - "@babel/helper-plugin-utils": "^7.27.1", - "@babel/helper-replace-supers": "^7.27.1" - }, - "engines": { - "node": ">=6.9.0" - }, - "peerDependencies": { - "@babel/core": "^7.0.0-0" - } - }, - "node_modules/@babel/plugin-transform-optional-catch-binding": { - "version": "7.27.1", - "resolved": "https://registry.npmjs.org/@babel/plugin-transform-optional-catch-binding/-/plugin-transform-optional-catch-binding-7.27.1.tgz", - "integrity": "sha512-txEAEKzYrHEX4xSZN4kJ+OfKXFVSWKB2ZxM9dpcE3wT7smwkNmXo5ORRlVzMVdJbD+Q8ILTgSD7959uj+3Dm3Q==", - "dev": true, - "license": "MIT", - "dependencies": { - "@babel/helper-plugin-utils": "^7.27.1" - }, - "engines": { - "node": ">=6.9.0" - }, - "peerDependencies": { - "@babel/core": "^7.0.0-0" - } - }, - "node_modules/@babel/plugin-transform-optional-chaining": { - "version": "7.28.5", - "resolved": "https://registry.npmjs.org/@babel/plugin-transform-optional-chaining/-/plugin-transform-optional-chaining-7.28.5.tgz", - "integrity": "sha512-N6fut9IZlPnjPwgiQkXNhb+cT8wQKFlJNqcZkWlcTqkcqx6/kU4ynGmLFoa4LViBSirn05YAwk+sQBbPfxtYzQ==", - "dev": true, - "license": "MIT", - "dependencies": { - "@babel/helper-plugin-utils": "^7.27.1", - "@babel/helper-skip-transparent-expression-wrappers": "^7.27.1" - }, - "engines": { - "node": ">=6.9.0" - }, - "peerDependencies": { - "@babel/core": "^7.0.0-0" - } - }, - "node_modules/@babel/plugin-transform-parameters": { - "version": "7.27.7", - "resolved": "https://registry.npmjs.org/@babel/plugin-transform-parameters/-/plugin-transform-parameters-7.27.7.tgz", - "integrity": "sha512-qBkYTYCb76RRxUM6CcZA5KRu8K4SM8ajzVeUgVdMVO9NN9uI/GaVmBg/WKJJGnNokV9SY8FxNOVWGXzqzUidBg==", - "dev": true, - "license": "MIT", - "dependencies": { - "@babel/helper-plugin-utils": "^7.27.1" - }, - "engines": { - "node": ">=6.9.0" - }, - "peerDependencies": { - "@babel/core": "^7.0.0-0" - } - }, - "node_modules/@babel/plugin-transform-private-methods": { - "version": "7.27.1", - "resolved": "https://registry.npmjs.org/@babel/plugin-transform-private-methods/-/plugin-transform-private-methods-7.27.1.tgz", - "integrity": "sha512-10FVt+X55AjRAYI9BrdISN9/AQWHqldOeZDUoLyif1Kn05a56xVBXb8ZouL8pZ9jem8QpXaOt8TS7RHUIS+GPA==", - "dev": true, - "license": "MIT", - "dependencies": { - "@babel/helper-create-class-features-plugin": "^7.27.1", - "@babel/helper-plugin-utils": "^7.27.1" - }, - "engines": { - "node": ">=6.9.0" - }, - "peerDependencies": { - "@babel/core": "^7.0.0-0" - } - }, - "node_modules/@babel/plugin-transform-private-property-in-object": { - "version": "7.27.1", - "resolved": "https://registry.npmjs.org/@babel/plugin-transform-private-property-in-object/-/plugin-transform-private-property-in-object-7.27.1.tgz", - "integrity": "sha512-5J+IhqTi1XPa0DXF83jYOaARrX+41gOewWbkPyjMNRDqgOCqdffGh8L3f/Ek5utaEBZExjSAzcyjmV9SSAWObQ==", - "dev": true, - "license": "MIT", - "dependencies": { - "@babel/helper-annotate-as-pure": "^7.27.1", - "@babel/helper-create-class-features-plugin": "^7.27.1", - "@babel/helper-plugin-utils": "^7.27.1" - }, - "engines": { - "node": ">=6.9.0" - }, - "peerDependencies": { - "@babel/core": "^7.0.0-0" - } - }, - "node_modules/@babel/plugin-transform-property-literals": { - "version": "7.27.1", - "resolved": "https://registry.npmjs.org/@babel/plugin-transform-property-literals/-/plugin-transform-property-literals-7.27.1.tgz", - "integrity": "sha512-oThy3BCuCha8kDZ8ZkgOg2exvPYUlprMukKQXI1r1pJ47NCvxfkEy8vK+r/hT9nF0Aa4H1WUPZZjHTFtAhGfmQ==", - "dev": true, - "license": "MIT", - "dependencies": { - "@babel/helper-plugin-utils": "^7.27.1" - }, - "engines": { - "node": ">=6.9.0" - }, - "peerDependencies": { - "@babel/core": "^7.0.0-0" - } - }, - "node_modules/@babel/plugin-transform-react-constant-elements": { - "version": "7.27.1", - "resolved": "https://registry.npmjs.org/@babel/plugin-transform-react-constant-elements/-/plugin-transform-react-constant-elements-7.27.1.tgz", - "integrity": "sha512-edoidOjl/ZxvYo4lSBOQGDSyToYVkTAwyVoa2tkuYTSmjrB1+uAedoL5iROVLXkxH+vRgA7uP4tMg2pUJpZ3Ug==", - "dev": true, - "license": "MIT", - "dependencies": { - "@babel/helper-plugin-utils": "^7.27.1" - }, - "engines": { - "node": ">=6.9.0" - }, - "peerDependencies": { - "@babel/core": "^7.0.0-0" - } - }, - "node_modules/@babel/plugin-transform-react-display-name": { - "version": "7.28.0", - "resolved": "https://registry.npmjs.org/@babel/plugin-transform-react-display-name/-/plugin-transform-react-display-name-7.28.0.tgz", - "integrity": "sha512-D6Eujc2zMxKjfa4Zxl4GHMsmhKKZ9VpcqIchJLvwTxad9zWIYulwYItBovpDOoNLISpcZSXoDJ5gaGbQUDqViA==", - "dev": true, - "license": "MIT", - "dependencies": { - "@babel/helper-plugin-utils": "^7.27.1" - }, - "engines": { - "node": ">=6.9.0" - }, - "peerDependencies": { - "@babel/core": "^7.0.0-0" - } - }, - "node_modules/@babel/plugin-transform-react-jsx": { - "version": "7.27.1", - "resolved": "https://registry.npmjs.org/@babel/plugin-transform-react-jsx/-/plugin-transform-react-jsx-7.27.1.tgz", - "integrity": "sha512-2KH4LWGSrJIkVf5tSiBFYuXDAoWRq2MMwgivCf+93dd0GQi8RXLjKA/0EvRnVV5G0hrHczsquXuD01L8s6dmBw==", - "dev": true, - "license": "MIT", - "dependencies": { - "@babel/helper-annotate-as-pure": "^7.27.1", - "@babel/helper-module-imports": "^7.27.1", - "@babel/helper-plugin-utils": "^7.27.1", - "@babel/plugin-syntax-jsx": "^7.27.1", - "@babel/types": "^7.27.1" - }, - "engines": { - "node": ">=6.9.0" - }, - "peerDependencies": { - "@babel/core": "^7.0.0-0" - } - }, - "node_modules/@babel/plugin-transform-react-jsx-development": { - "version": "7.27.1", - "resolved": "https://registry.npmjs.org/@babel/plugin-transform-react-jsx-development/-/plugin-transform-react-jsx-development-7.27.1.tgz", - "integrity": "sha512-ykDdF5yI4f1WrAolLqeF3hmYU12j9ntLQl/AOG1HAS21jxyg1Q0/J/tpREuYLfatGdGmXp/3yS0ZA76kOlVq9Q==", - "dev": true, - "license": "MIT", - "dependencies": { - "@babel/plugin-transform-react-jsx": "^7.27.1" - }, - "engines": { - "node": ">=6.9.0" - }, - "peerDependencies": { - "@babel/core": "^7.0.0-0" - } - }, - "node_modules/@babel/plugin-transform-react-pure-annotations": { - "version": "7.27.1", - "resolved": "https://registry.npmjs.org/@babel/plugin-transform-react-pure-annotations/-/plugin-transform-react-pure-annotations-7.27.1.tgz", - "integrity": "sha512-JfuinvDOsD9FVMTHpzA/pBLisxpv1aSf+OIV8lgH3MuWrks19R27e6a6DipIg4aX1Zm9Wpb04p8wljfKrVSnPA==", - "dev": true, - "license": "MIT", - "dependencies": { - "@babel/helper-annotate-as-pure": "^7.27.1", - "@babel/helper-plugin-utils": "^7.27.1" - }, - "engines": { - "node": ">=6.9.0" - }, - "peerDependencies": { - "@babel/core": "^7.0.0-0" - } - }, - "node_modules/@babel/plugin-transform-regenerator": { - "version": "7.28.4", - "resolved": "https://registry.npmjs.org/@babel/plugin-transform-regenerator/-/plugin-transform-regenerator-7.28.4.tgz", - "integrity": "sha512-+ZEdQlBoRg9m2NnzvEeLgtvBMO4tkFBw5SQIUgLICgTrumLoU7lr+Oghi6km2PFj+dbUt2u1oby2w3BDO9YQnA==", - "dev": true, - "license": "MIT", - "dependencies": { - "@babel/helper-plugin-utils": "^7.27.1" - }, - "engines": { - "node": ">=6.9.0" - }, - "peerDependencies": { - "@babel/core": "^7.0.0-0" - } - }, - "node_modules/@babel/plugin-transform-regexp-modifiers": { - "version": "7.27.1", - "resolved": "https://registry.npmjs.org/@babel/plugin-transform-regexp-modifiers/-/plugin-transform-regexp-modifiers-7.27.1.tgz", - "integrity": "sha512-TtEciroaiODtXvLZv4rmfMhkCv8jx3wgKpL68PuiPh2M4fvz5jhsA7697N1gMvkvr/JTF13DrFYyEbY9U7cVPA==", - "dev": true, - "license": "MIT", - "dependencies": { - "@babel/helper-create-regexp-features-plugin": "^7.27.1", - "@babel/helper-plugin-utils": "^7.27.1" - }, - "engines": { - "node": ">=6.9.0" - }, - "peerDependencies": { - "@babel/core": "^7.0.0" - } - }, - "node_modules/@babel/plugin-transform-reserved-words": { - "version": "7.27.1", - "resolved": "https://registry.npmjs.org/@babel/plugin-transform-reserved-words/-/plugin-transform-reserved-words-7.27.1.tgz", - "integrity": "sha512-V2ABPHIJX4kC7HegLkYoDpfg9PVmuWy/i6vUM5eGK22bx4YVFD3M5F0QQnWQoDs6AGsUWTVOopBiMFQgHaSkVw==", - "dev": true, - "license": "MIT", - "dependencies": { - "@babel/helper-plugin-utils": "^7.27.1" - }, - "engines": { - "node": ">=6.9.0" - }, - "peerDependencies": { - "@babel/core": "^7.0.0-0" - } - }, - "node_modules/@babel/plugin-transform-runtime": { - "version": "7.28.5", - "resolved": "https://registry.npmjs.org/@babel/plugin-transform-runtime/-/plugin-transform-runtime-7.28.5.tgz", - "integrity": "sha512-20NUVgOrinudkIBzQ2bNxP08YpKprUkRTiRSd2/Z5GOdPImJGkoN4Z7IQe1T5AdyKI1i5L6RBmluqdSzvaq9/w==", - "dev": true, - "license": "MIT", - "dependencies": { - "@babel/helper-module-imports": "^7.27.1", - "@babel/helper-plugin-utils": "^7.27.1", - "babel-plugin-polyfill-corejs2": "^0.4.14", - "babel-plugin-polyfill-corejs3": "^0.13.0", - "babel-plugin-polyfill-regenerator": "^0.6.5", - "semver": "^6.3.1" - }, - "engines": { - "node": ">=6.9.0" - }, - "peerDependencies": { - "@babel/core": "^7.0.0-0" - } - }, - "node_modules/@babel/plugin-transform-runtime/node_modules/semver": { - "version": "6.3.1", - "resolved": "https://registry.npmjs.org/semver/-/semver-6.3.1.tgz", - "integrity": "sha512-BR7VvDCVHO+q2xBEWskxS6DJE1qRnb7DxzUrogb71CWoSficBxYsiAGd+Kl0mmq/MprG9yArRkyrQxTO6XjMzA==", - "dev": true, - "license": "ISC", - "bin": { - "semver": "bin/semver.js" - } - }, - "node_modules/@babel/plugin-transform-shorthand-properties": { - "version": "7.27.1", - "resolved": "https://registry.npmjs.org/@babel/plugin-transform-shorthand-properties/-/plugin-transform-shorthand-properties-7.27.1.tgz", - "integrity": "sha512-N/wH1vcn4oYawbJ13Y/FxcQrWk63jhfNa7jef0ih7PHSIHX2LB7GWE1rkPrOnka9kwMxb6hMl19p7lidA+EHmQ==", - "dev": true, - "license": "MIT", - "dependencies": { - "@babel/helper-plugin-utils": "^7.27.1" - }, - "engines": { - "node": ">=6.9.0" - }, - "peerDependencies": { - "@babel/core": "^7.0.0-0" - } - }, - "node_modules/@babel/plugin-transform-spread": { - "version": "7.27.1", - "resolved": "https://registry.npmjs.org/@babel/plugin-transform-spread/-/plugin-transform-spread-7.27.1.tgz", - "integrity": "sha512-kpb3HUqaILBJcRFVhFUs6Trdd4mkrzcGXss+6/mxUd273PfbWqSDHRzMT2234gIg2QYfAjvXLSquP1xECSg09Q==", - "dev": true, - "license": "MIT", - "dependencies": { - "@babel/helper-plugin-utils": "^7.27.1", - "@babel/helper-skip-transparent-expression-wrappers": "^7.27.1" - }, - "engines": { - "node": ">=6.9.0" - }, - "peerDependencies": { - "@babel/core": "^7.0.0-0" - } - }, - "node_modules/@babel/plugin-transform-sticky-regex": { - "version": "7.27.1", - "resolved": "https://registry.npmjs.org/@babel/plugin-transform-sticky-regex/-/plugin-transform-sticky-regex-7.27.1.tgz", - "integrity": "sha512-lhInBO5bi/Kowe2/aLdBAawijx+q1pQzicSgnkB6dUPc1+RC8QmJHKf2OjvU+NZWitguJHEaEmbV6VWEouT58g==", - "dev": true, - "license": "MIT", - "dependencies": { - "@babel/helper-plugin-utils": "^7.27.1" - }, - "engines": { - "node": ">=6.9.0" - }, - "peerDependencies": { - "@babel/core": "^7.0.0-0" - } - }, - "node_modules/@babel/plugin-transform-template-literals": { - "version": "7.27.1", - "resolved": "https://registry.npmjs.org/@babel/plugin-transform-template-literals/-/plugin-transform-template-literals-7.27.1.tgz", - "integrity": "sha512-fBJKiV7F2DxZUkg5EtHKXQdbsbURW3DZKQUWphDum0uRP6eHGGa/He9mc0mypL680pb+e/lDIthRohlv8NCHkg==", - "dev": true, - "license": "MIT", - "dependencies": { - "@babel/helper-plugin-utils": "^7.27.1" - }, - "engines": { - "node": ">=6.9.0" - }, - "peerDependencies": { - "@babel/core": "^7.0.0-0" - } - }, - "node_modules/@babel/plugin-transform-typeof-symbol": { - "version": "7.27.1", - "resolved": "https://registry.npmjs.org/@babel/plugin-transform-typeof-symbol/-/plugin-transform-typeof-symbol-7.27.1.tgz", - "integrity": "sha512-RiSILC+nRJM7FY5srIyc4/fGIwUhyDuuBSdWn4y6yT6gm652DpCHZjIipgn6B7MQ1ITOUnAKWixEUjQRIBIcLw==", - "dev": true, - "license": "MIT", - "dependencies": { - "@babel/helper-plugin-utils": "^7.27.1" - }, - "engines": { - "node": ">=6.9.0" - }, - "peerDependencies": { - "@babel/core": "^7.0.0-0" - } - }, - "node_modules/@babel/plugin-transform-typescript": { - "version": "7.28.5", - "resolved": "https://registry.npmjs.org/@babel/plugin-transform-typescript/-/plugin-transform-typescript-7.28.5.tgz", - "integrity": "sha512-x2Qa+v/CuEoX7Dr31iAfr0IhInrVOWZU/2vJMJ00FOR/2nM0BcBEclpaf9sWCDc+v5e9dMrhSH8/atq/kX7+bA==", - "dev": true, - "license": "MIT", - "dependencies": { - "@babel/helper-annotate-as-pure": "^7.27.3", - "@babel/helper-create-class-features-plugin": "^7.28.5", - "@babel/helper-plugin-utils": "^7.27.1", - "@babel/helper-skip-transparent-expression-wrappers": "^7.27.1", - "@babel/plugin-syntax-typescript": "^7.27.1" - }, - "engines": { - "node": ">=6.9.0" - }, - "peerDependencies": { - "@babel/core": "^7.0.0-0" - } - }, - "node_modules/@babel/plugin-transform-unicode-escapes": { - "version": "7.27.1", - "resolved": "https://registry.npmjs.org/@babel/plugin-transform-unicode-escapes/-/plugin-transform-unicode-escapes-7.27.1.tgz", - "integrity": "sha512-Ysg4v6AmF26k9vpfFuTZg8HRfVWzsh1kVfowA23y9j/Gu6dOuahdUVhkLqpObp3JIv27MLSii6noRnuKN8H0Mg==", - "dev": true, - "license": "MIT", - "dependencies": { - "@babel/helper-plugin-utils": "^7.27.1" - }, - "engines": { - "node": ">=6.9.0" - }, - "peerDependencies": { - "@babel/core": "^7.0.0-0" - } - }, - "node_modules/@babel/plugin-transform-unicode-property-regex": { - "version": "7.27.1", - "resolved": "https://registry.npmjs.org/@babel/plugin-transform-unicode-property-regex/-/plugin-transform-unicode-property-regex-7.27.1.tgz", - "integrity": "sha512-uW20S39PnaTImxp39O5qFlHLS9LJEmANjMG7SxIhap8rCHqu0Ik+tLEPX5DKmHn6CsWQ7j3lix2tFOa5YtL12Q==", - "dev": true, - "license": "MIT", - "dependencies": { - "@babel/helper-create-regexp-features-plugin": "^7.27.1", - "@babel/helper-plugin-utils": "^7.27.1" - }, - "engines": { - "node": ">=6.9.0" - }, - "peerDependencies": { - "@babel/core": "^7.0.0-0" - } - }, - "node_modules/@babel/plugin-transform-unicode-regex": { - "version": "7.27.1", - "resolved": "https://registry.npmjs.org/@babel/plugin-transform-unicode-regex/-/plugin-transform-unicode-regex-7.27.1.tgz", - "integrity": "sha512-xvINq24TRojDuyt6JGtHmkVkrfVV3FPT16uytxImLeBZqW3/H52yN+kM1MGuyPkIQxrzKwPHs5U/MP3qKyzkGw==", - "dev": true, - "license": "MIT", - "dependencies": { - "@babel/helper-create-regexp-features-plugin": "^7.27.1", - "@babel/helper-plugin-utils": "^7.27.1" - }, - "engines": { - "node": ">=6.9.0" - }, - "peerDependencies": { - "@babel/core": "^7.0.0-0" - } - }, - "node_modules/@babel/plugin-transform-unicode-sets-regex": { - "version": "7.27.1", - "resolved": "https://registry.npmjs.org/@babel/plugin-transform-unicode-sets-regex/-/plugin-transform-unicode-sets-regex-7.27.1.tgz", - "integrity": "sha512-EtkOujbc4cgvb0mlpQefi4NTPBzhSIevblFevACNLUspmrALgmEBdL/XfnyyITfd8fKBZrZys92zOWcik7j9Tw==", - "dev": true, - "license": "MIT", - "dependencies": { - "@babel/helper-create-regexp-features-plugin": "^7.27.1", - "@babel/helper-plugin-utils": "^7.27.1" - }, - "engines": { - "node": ">=6.9.0" - }, - "peerDependencies": { - "@babel/core": "^7.0.0" - } - }, - "node_modules/@babel/preset-env": { - "version": "7.28.5", - "resolved": "https://registry.npmjs.org/@babel/preset-env/-/preset-env-7.28.5.tgz", - "integrity": "sha512-S36mOoi1Sb6Fz98fBfE+UZSpYw5mJm0NUHtIKrOuNcqeFauy1J6dIvXm2KRVKobOSaGq4t/hBXdN4HGU3wL9Wg==", - "dev": true, - "license": "MIT", - "dependencies": { - "@babel/compat-data": "^7.28.5", - "@babel/helper-compilation-targets": "^7.27.2", - "@babel/helper-plugin-utils": "^7.27.1", - "@babel/helper-validator-option": "^7.27.1", - "@babel/plugin-bugfix-firefox-class-in-computed-class-key": "^7.28.5", - "@babel/plugin-bugfix-safari-class-field-initializer-scope": "^7.27.1", - "@babel/plugin-bugfix-safari-id-destructuring-collision-in-function-expression": "^7.27.1", - "@babel/plugin-bugfix-v8-spread-parameters-in-optional-chaining": "^7.27.1", - "@babel/plugin-bugfix-v8-static-class-fields-redefine-readonly": "^7.28.3", - "@babel/plugin-proposal-private-property-in-object": "7.21.0-placeholder-for-preset-env.2", - "@babel/plugin-syntax-import-assertions": "^7.27.1", - "@babel/plugin-syntax-import-attributes": "^7.27.1", - "@babel/plugin-syntax-unicode-sets-regex": "^7.18.6", - "@babel/plugin-transform-arrow-functions": "^7.27.1", - "@babel/plugin-transform-async-generator-functions": "^7.28.0", - "@babel/plugin-transform-async-to-generator": "^7.27.1", - "@babel/plugin-transform-block-scoped-functions": "^7.27.1", - "@babel/plugin-transform-block-scoping": "^7.28.5", - "@babel/plugin-transform-class-properties": "^7.27.1", - "@babel/plugin-transform-class-static-block": "^7.28.3", - "@babel/plugin-transform-classes": "^7.28.4", - "@babel/plugin-transform-computed-properties": "^7.27.1", - "@babel/plugin-transform-destructuring": "^7.28.5", - "@babel/plugin-transform-dotall-regex": "^7.27.1", - "@babel/plugin-transform-duplicate-keys": "^7.27.1", - "@babel/plugin-transform-duplicate-named-capturing-groups-regex": "^7.27.1", - "@babel/plugin-transform-dynamic-import": "^7.27.1", - "@babel/plugin-transform-explicit-resource-management": "^7.28.0", - "@babel/plugin-transform-exponentiation-operator": "^7.28.5", - "@babel/plugin-transform-export-namespace-from": "^7.27.1", - "@babel/plugin-transform-for-of": "^7.27.1", - "@babel/plugin-transform-function-name": "^7.27.1", - "@babel/plugin-transform-json-strings": "^7.27.1", - "@babel/plugin-transform-literals": "^7.27.1", - "@babel/plugin-transform-logical-assignment-operators": "^7.28.5", - "@babel/plugin-transform-member-expression-literals": "^7.27.1", - "@babel/plugin-transform-modules-amd": "^7.27.1", - "@babel/plugin-transform-modules-commonjs": "^7.27.1", - "@babel/plugin-transform-modules-systemjs": "^7.28.5", - "@babel/plugin-transform-modules-umd": "^7.27.1", - "@babel/plugin-transform-named-capturing-groups-regex": "^7.27.1", - "@babel/plugin-transform-new-target": "^7.27.1", - "@babel/plugin-transform-nullish-coalescing-operator": "^7.27.1", - "@babel/plugin-transform-numeric-separator": "^7.27.1", - "@babel/plugin-transform-object-rest-spread": "^7.28.4", - "@babel/plugin-transform-object-super": "^7.27.1", - "@babel/plugin-transform-optional-catch-binding": "^7.27.1", - "@babel/plugin-transform-optional-chaining": "^7.28.5", - "@babel/plugin-transform-parameters": "^7.27.7", - "@babel/plugin-transform-private-methods": "^7.27.1", - "@babel/plugin-transform-private-property-in-object": "^7.27.1", - "@babel/plugin-transform-property-literals": "^7.27.1", - "@babel/plugin-transform-regenerator": "^7.28.4", - "@babel/plugin-transform-regexp-modifiers": "^7.27.1", - "@babel/plugin-transform-reserved-words": "^7.27.1", - "@babel/plugin-transform-shorthand-properties": "^7.27.1", - "@babel/plugin-transform-spread": "^7.27.1", - "@babel/plugin-transform-sticky-regex": "^7.27.1", - "@babel/plugin-transform-template-literals": "^7.27.1", - "@babel/plugin-transform-typeof-symbol": "^7.27.1", - "@babel/plugin-transform-unicode-escapes": "^7.27.1", - "@babel/plugin-transform-unicode-property-regex": "^7.27.1", - "@babel/plugin-transform-unicode-regex": "^7.27.1", - "@babel/plugin-transform-unicode-sets-regex": "^7.27.1", - "@babel/preset-modules": "0.1.6-no-external-plugins", - "babel-plugin-polyfill-corejs2": "^0.4.14", - "babel-plugin-polyfill-corejs3": "^0.13.0", - "babel-plugin-polyfill-regenerator": "^0.6.5", - "core-js-compat": "^3.43.0", - "semver": "^6.3.1" - }, - "engines": { - "node": ">=6.9.0" - }, - "peerDependencies": { - "@babel/core": "^7.0.0-0" - } - }, - "node_modules/@babel/preset-env/node_modules/semver": { - "version": "6.3.1", - "resolved": "https://registry.npmjs.org/semver/-/semver-6.3.1.tgz", - "integrity": "sha512-BR7VvDCVHO+q2xBEWskxS6DJE1qRnb7DxzUrogb71CWoSficBxYsiAGd+Kl0mmq/MprG9yArRkyrQxTO6XjMzA==", - "dev": true, - "license": "ISC", - "bin": { - "semver": "bin/semver.js" - } - }, - "node_modules/@babel/preset-modules": { - "version": "0.1.6-no-external-plugins", - "resolved": "https://registry.npmjs.org/@babel/preset-modules/-/preset-modules-0.1.6-no-external-plugins.tgz", - "integrity": "sha512-HrcgcIESLm9aIR842yhJ5RWan/gebQUJ6E/E5+rf0y9o6oj7w0Br+sWuL6kEQ/o/AdfvR1Je9jG18/gnpwjEyA==", - "dev": true, - "license": "MIT", - "dependencies": { - "@babel/helper-plugin-utils": "^7.0.0", - "@babel/types": "^7.4.4", - "esutils": "^2.0.2" - }, - "peerDependencies": { - "@babel/core": "^7.0.0-0 || ^8.0.0-0 <8.0.0" - } - }, - "node_modules/@babel/preset-react": { - "version": "7.28.5", - "resolved": "https://registry.npmjs.org/@babel/preset-react/-/preset-react-7.28.5.tgz", - "integrity": "sha512-Z3J8vhRq7CeLjdC58jLv4lnZ5RKFUJWqH5emvxmv9Hv3BD1T9R/Im713R4MTKwvFaV74ejZ3sM01LyEKk4ugNQ==", - "dev": true, - "license": "MIT", - "dependencies": { - "@babel/helper-plugin-utils": "^7.27.1", - "@babel/helper-validator-option": "^7.27.1", - "@babel/plugin-transform-react-display-name": "^7.28.0", - "@babel/plugin-transform-react-jsx": "^7.27.1", - "@babel/plugin-transform-react-jsx-development": "^7.27.1", - "@babel/plugin-transform-react-pure-annotations": "^7.27.1" - }, - "engines": { - "node": ">=6.9.0" - }, - "peerDependencies": { - "@babel/core": "^7.0.0-0" - } - }, - "node_modules/@babel/preset-typescript": { - "version": "7.28.5", - "resolved": "https://registry.npmjs.org/@babel/preset-typescript/-/preset-typescript-7.28.5.tgz", - "integrity": "sha512-+bQy5WOI2V6LJZpPVxY+yp66XdZ2yifu0Mc1aP5CQKgjn4QM5IN2i5fAZ4xKop47pr8rpVhiAeu+nDQa12C8+g==", - "dev": true, - "license": "MIT", - "dependencies": { - "@babel/helper-plugin-utils": "^7.27.1", - "@babel/helper-validator-option": "^7.27.1", - "@babel/plugin-syntax-jsx": "^7.27.1", - "@babel/plugin-transform-modules-commonjs": "^7.27.1", - "@babel/plugin-transform-typescript": "^7.28.5" - }, - "engines": { - "node": ">=6.9.0" - }, - "peerDependencies": { - "@babel/core": "^7.0.0-0" - } - }, "node_modules/@babel/runtime": { "version": "7.28.4", "resolved": "https://registry.npmjs.org/@babel/runtime/-/runtime-7.28.4.tgz", @@ -2339,19 +684,6 @@ "node": ">=6.9.0" } }, - "node_modules/@babel/runtime-corejs3": { - "version": "7.28.4", - "resolved": "https://registry.npmjs.org/@babel/runtime-corejs3/-/runtime-corejs3-7.28.4.tgz", - "integrity": "sha512-h7iEYiW4HebClDEhtvFObtPmIvrd1SSfpI9EhOeKk4CtIK/ngBWFpuhCzhdmRKtg71ylcue+9I6dv54XYO1epQ==", - "dev": true, - "license": "MIT", - "dependencies": { - "core-js-pure": "^3.43.0" - }, - "engines": { - "node": ">=6.9.0" - } - }, "node_modules/@babel/template": { "version": "7.27.2", "resolved": "https://registry.npmjs.org/@babel/template/-/template-7.27.2.tgz", @@ -2401,11 +733,50 @@ } }, "node_modules/@bcoe/v8-coverage": { - "version": "0.2.3", - "resolved": "https://registry.npmjs.org/@bcoe/v8-coverage/-/v8-coverage-0.2.3.tgz", - "integrity": "sha512-0hYQ8SB4Db5zvZB4axdMHGwEaQjkZzFjQiN9LVYvIFB2nSUHW9tYpxWriPrWDASIxiaXax83REcLxuSdnGPZtw==", + "version": "1.0.2", + "resolved": "https://registry.npmjs.org/@bcoe/v8-coverage/-/v8-coverage-1.0.2.tgz", + "integrity": "sha512-6zABk/ECA/QYSCQ1NGiVwwbQerUCZ+TQbp64Q3AgmfNvurHH0j8TtXa1qbShXA6qqkpAj4V5W8pP6mLe1mcMqA==", "dev": true, - "license": "MIT" + "license": "MIT", + "engines": { + "node": ">=18" + } + }, + "node_modules/@capsizecss/unpack": { + "version": "3.0.1", + "resolved": "https://registry.npmjs.org/@capsizecss/unpack/-/unpack-3.0.1.tgz", + "integrity": "sha512-8XqW8xGn++Eqqbz3e9wKuK7mxryeRjs4LOHLxbh2lwKeSbuNR4NFifDZT4KzvjU6HMOPbiNTsWpniK5EJfTWkg==", + "dev": true, + "license": "MIT", + "dependencies": { + "fontkit": "^2.0.2" + }, + "engines": { + "node": ">=18" + } + }, + "node_modules/@clack/core": { + "version": "0.5.0", + "resolved": "https://registry.npmjs.org/@clack/core/-/core-0.5.0.tgz", + "integrity": "sha512-p3y0FIOwaYRUPRcMO7+dlmLh8PSRcrjuTndsiA0WAFbWES0mLZlrjVoBRZ9DzkPFJZG6KGkJmoEAY0ZcVWTkow==", + "dev": true, + "license": "MIT", + "dependencies": { + "picocolors": "^1.0.0", + "sisteransi": "^1.0.5" + } + }, + "node_modules/@clack/prompts": { + "version": "0.11.0", + "resolved": "https://registry.npmjs.org/@clack/prompts/-/prompts-0.11.0.tgz", + "integrity": "sha512-pMN5FcrEw9hUkZA4f+zLlzivQSeQf5dRGJjSUbvVYDLvpKCdQx5OaknvKzgbtXOizhP+SJJJjqEbOe55uKKfAw==", + "dev": true, + "license": "MIT", + "dependencies": { + "@clack/core": "0.5.0", + "picocolors": "^1.0.0", + "sisteransi": "^1.0.5" + } }, "node_modules/@colors/colors": { "version": "1.5.0", @@ -2417,2320 +788,32 @@ "node": ">=0.1.90" } }, - "node_modules/@csstools/cascade-layer-name-parser": { - "version": "2.0.5", - "resolved": "https://registry.npmjs.org/@csstools/cascade-layer-name-parser/-/cascade-layer-name-parser-2.0.5.tgz", - "integrity": "sha512-p1ko5eHgV+MgXFVa4STPKpvPxr6ReS8oS2jzTukjR74i5zJNyWO1ZM1m8YKBXnzDKWfBN1ztLYlHxbVemDD88A==", - "dev": true, - "funding": [ - { - "type": "github", - "url": "https://github.com/sponsors/csstools" - }, - { - "type": "opencollective", - "url": "https://opencollective.com/csstools" - } - ], - "license": "MIT", - "engines": { - "node": ">=18" - }, - "peerDependencies": { - "@csstools/css-parser-algorithms": "^3.0.5", - "@csstools/css-tokenizer": "^3.0.4" - } - }, - "node_modules/@csstools/color-helpers": { - "version": "5.1.0", - "resolved": "https://registry.npmjs.org/@csstools/color-helpers/-/color-helpers-5.1.0.tgz", - "integrity": "sha512-S11EXWJyy0Mz5SYvRmY8nJYTFFd1LCNV+7cXyAgQtOOuzb4EsgfqDufL+9esx72/eLhsRdGZwaldu/h+E4t4BA==", - "dev": true, - "funding": [ - { - "type": "github", - "url": "https://github.com/sponsors/csstools" - }, - { - "type": "opencollective", - "url": "https://opencollective.com/csstools" - } - ], - "license": "MIT-0", - "engines": { - "node": ">=18" - } - }, - "node_modules/@csstools/css-calc": { - "version": "2.1.4", - "resolved": "https://registry.npmjs.org/@csstools/css-calc/-/css-calc-2.1.4.tgz", - "integrity": "sha512-3N8oaj+0juUw/1H3YwmDDJXCgTB1gKU6Hc/bB502u9zR0q2vd786XJH9QfrKIEgFlZmhZiq6epXl4rHqhzsIgQ==", - "dev": true, - "funding": [ - { - "type": "github", - "url": "https://github.com/sponsors/csstools" - }, - { - "type": "opencollective", - "url": "https://opencollective.com/csstools" - } - ], - "license": "MIT", - "engines": { - "node": ">=18" - }, - "peerDependencies": { - "@csstools/css-parser-algorithms": "^3.0.5", - "@csstools/css-tokenizer": "^3.0.4" - } - }, - "node_modules/@csstools/css-color-parser": { - "version": "3.1.0", - "resolved": "https://registry.npmjs.org/@csstools/css-color-parser/-/css-color-parser-3.1.0.tgz", - "integrity": "sha512-nbtKwh3a6xNVIp/VRuXV64yTKnb1IjTAEEh3irzS+HkKjAOYLTGNb9pmVNntZ8iVBHcWDA2Dof0QtPgFI1BaTA==", - "dev": true, - "funding": [ - { - "type": "github", - "url": "https://github.com/sponsors/csstools" - }, - { - "type": "opencollective", - "url": "https://opencollective.com/csstools" - } - ], - "license": "MIT", - "dependencies": { - "@csstools/color-helpers": "^5.1.0", - "@csstools/css-calc": "^2.1.4" - }, - "engines": { - "node": ">=18" - }, - "peerDependencies": { - "@csstools/css-parser-algorithms": "^3.0.5", - "@csstools/css-tokenizer": "^3.0.4" - } - }, - "node_modules/@csstools/css-parser-algorithms": { - "version": "3.0.5", - "resolved": "https://registry.npmjs.org/@csstools/css-parser-algorithms/-/css-parser-algorithms-3.0.5.tgz", - "integrity": "sha512-DaDeUkXZKjdGhgYaHNJTV9pV7Y9B3b644jCLs9Upc3VeNGg6LWARAT6O+Q+/COo+2gg/bM5rhpMAtf70WqfBdQ==", - "dev": true, - "funding": [ - { - "type": "github", - "url": "https://github.com/sponsors/csstools" - }, - { - "type": "opencollective", - "url": "https://opencollective.com/csstools" - } - ], - "license": "MIT", - "peer": true, - "engines": { - "node": ">=18" - }, - "peerDependencies": { - "@csstools/css-tokenizer": "^3.0.4" - } - }, - "node_modules/@csstools/css-tokenizer": { - "version": "3.0.4", - "resolved": "https://registry.npmjs.org/@csstools/css-tokenizer/-/css-tokenizer-3.0.4.tgz", - "integrity": "sha512-Vd/9EVDiu6PPJt9yAh6roZP6El1xHrdvIVGjyBsHR0RYwNHgL7FJPyIIW4fANJNG6FtyZfvlRPpFI4ZM/lubvw==", - "dev": true, - "funding": [ - { - "type": "github", - "url": "https://github.com/sponsors/csstools" - }, - { - "type": "opencollective", - "url": "https://opencollective.com/csstools" - } - ], - "license": "MIT", - "peer": true, - "engines": { - "node": ">=18" - } - }, - "node_modules/@csstools/media-query-list-parser": { - "version": "4.0.3", - "resolved": "https://registry.npmjs.org/@csstools/media-query-list-parser/-/media-query-list-parser-4.0.3.tgz", - "integrity": "sha512-HAYH7d3TLRHDOUQK4mZKf9k9Ph/m8Akstg66ywKR4SFAigjs3yBiUeZtFxywiTm5moZMAp/5W/ZuFnNXXYLuuQ==", - "dev": true, - "funding": [ - { - "type": "github", - "url": "https://github.com/sponsors/csstools" - }, - { - "type": "opencollective", - "url": "https://opencollective.com/csstools" - } - ], - "license": "MIT", - "engines": { - "node": ">=18" - }, - "peerDependencies": { - "@csstools/css-parser-algorithms": "^3.0.5", - "@csstools/css-tokenizer": "^3.0.4" - } - }, - "node_modules/@csstools/postcss-alpha-function": { - "version": "1.0.1", - "resolved": "https://registry.npmjs.org/@csstools/postcss-alpha-function/-/postcss-alpha-function-1.0.1.tgz", - "integrity": "sha512-isfLLwksH3yHkFXfCI2Gcaqg7wGGHZZwunoJzEZk0yKYIokgre6hYVFibKL3SYAoR1kBXova8LB+JoO5vZzi9w==", - "dev": true, - "funding": [ - { - "type": "github", - "url": "https://github.com/sponsors/csstools" - }, - { - "type": "opencollective", - "url": "https://opencollective.com/csstools" - } - ], - "license": "MIT-0", - "dependencies": { - "@csstools/css-color-parser": "^3.1.0", - "@csstools/css-parser-algorithms": "^3.0.5", - "@csstools/css-tokenizer": "^3.0.4", - "@csstools/postcss-progressive-custom-properties": "^4.2.1", - "@csstools/utilities": "^2.0.0" - }, - "engines": { - "node": ">=18" - }, - "peerDependencies": { - "postcss": "^8.4" - } - }, - "node_modules/@csstools/postcss-cascade-layers": { - "version": "5.0.2", - "resolved": "https://registry.npmjs.org/@csstools/postcss-cascade-layers/-/postcss-cascade-layers-5.0.2.tgz", - "integrity": "sha512-nWBE08nhO8uWl6kSAeCx4im7QfVko3zLrtgWZY4/bP87zrSPpSyN/3W3TDqz1jJuH+kbKOHXg5rJnK+ZVYcFFg==", - "dev": true, - "funding": [ - { - "type": "github", - "url": "https://github.com/sponsors/csstools" - }, - { - "type": "opencollective", - "url": "https://opencollective.com/csstools" - } - ], - "license": "MIT-0", - "dependencies": { - "@csstools/selector-specificity": "^5.0.0", - "postcss-selector-parser": "^7.0.0" - }, - "engines": { - "node": ">=18" - }, - "peerDependencies": { - "postcss": "^8.4" - } - }, - "node_modules/@csstools/postcss-cascade-layers/node_modules/@csstools/selector-specificity": { - "version": "5.0.0", - "resolved": "https://registry.npmjs.org/@csstools/selector-specificity/-/selector-specificity-5.0.0.tgz", - "integrity": "sha512-PCqQV3c4CoVm3kdPhyeZ07VmBRdH2EpMFA/pd9OASpOEC3aXNGoqPDAZ80D0cLpMBxnmk0+yNhGsEx31hq7Gtw==", - "dev": true, - "funding": [ - { - "type": "github", - "url": "https://github.com/sponsors/csstools" - }, - { - "type": "opencollective", - "url": "https://opencollective.com/csstools" - } - ], - "license": "MIT-0", - "engines": { - "node": ">=18" - }, - "peerDependencies": { - "postcss-selector-parser": "^7.0.0" - } - }, - "node_modules/@csstools/postcss-cascade-layers/node_modules/postcss-selector-parser": { - "version": "7.1.1", - "resolved": "https://registry.npmjs.org/postcss-selector-parser/-/postcss-selector-parser-7.1.1.tgz", - "integrity": "sha512-orRsuYpJVw8LdAwqqLykBj9ecS5/cRHlI5+nvTo8LcCKmzDmqVORXtOIYEEQuL9D4BxtA1lm5isAqzQZCoQ6Eg==", - "dev": true, - "license": "MIT", - "peer": true, - "dependencies": { - "cssesc": "^3.0.0", - "util-deprecate": "^1.0.2" - }, - "engines": { - "node": ">=4" - } - }, - "node_modules/@csstools/postcss-color-function": { - "version": "4.0.12", - "resolved": "https://registry.npmjs.org/@csstools/postcss-color-function/-/postcss-color-function-4.0.12.tgz", - "integrity": "sha512-yx3cljQKRaSBc2hfh8rMZFZzChaFgwmO2JfFgFr1vMcF3C/uyy5I4RFIBOIWGq1D+XbKCG789CGkG6zzkLpagA==", - "dev": true, - "funding": [ - { - "type": "github", - "url": "https://github.com/sponsors/csstools" - }, - { - "type": "opencollective", - "url": "https://opencollective.com/csstools" - } - ], - "license": "MIT-0", - "dependencies": { - "@csstools/css-color-parser": "^3.1.0", - "@csstools/css-parser-algorithms": "^3.0.5", - "@csstools/css-tokenizer": "^3.0.4", - "@csstools/postcss-progressive-custom-properties": "^4.2.1", - "@csstools/utilities": "^2.0.0" - }, - "engines": { - "node": ">=18" - }, - "peerDependencies": { - "postcss": "^8.4" - } - }, - "node_modules/@csstools/postcss-color-function-display-p3-linear": { - "version": "1.0.1", - "resolved": "https://registry.npmjs.org/@csstools/postcss-color-function-display-p3-linear/-/postcss-color-function-display-p3-linear-1.0.1.tgz", - "integrity": "sha512-E5qusdzhlmO1TztYzDIi8XPdPoYOjoTY6HBYBCYSj+Gn4gQRBlvjgPQXzfzuPQqt8EhkC/SzPKObg4Mbn8/xMg==", - "dev": true, - "funding": [ - { - "type": "github", - "url": "https://github.com/sponsors/csstools" - }, - { - "type": "opencollective", - "url": "https://opencollective.com/csstools" - } - ], - "license": "MIT-0", - "dependencies": { - "@csstools/css-color-parser": "^3.1.0", - "@csstools/css-parser-algorithms": "^3.0.5", - "@csstools/css-tokenizer": "^3.0.4", - "@csstools/postcss-progressive-custom-properties": "^4.2.1", - "@csstools/utilities": "^2.0.0" - }, - "engines": { - "node": ">=18" - }, - "peerDependencies": { - "postcss": "^8.4" - } - }, - "node_modules/@csstools/postcss-color-mix-function": { - "version": "3.0.12", - "resolved": "https://registry.npmjs.org/@csstools/postcss-color-mix-function/-/postcss-color-mix-function-3.0.12.tgz", - "integrity": "sha512-4STERZfCP5Jcs13P1U5pTvI9SkgLgfMUMhdXW8IlJWkzOOOqhZIjcNhWtNJZes2nkBDsIKJ0CJtFtuaZ00moag==", - "dev": true, - "funding": [ - { - "type": "github", - "url": "https://github.com/sponsors/csstools" - }, - { - "type": "opencollective", - "url": "https://opencollective.com/csstools" - } - ], - "license": "MIT-0", - "dependencies": { - "@csstools/css-color-parser": "^3.1.0", - "@csstools/css-parser-algorithms": "^3.0.5", - "@csstools/css-tokenizer": "^3.0.4", - "@csstools/postcss-progressive-custom-properties": "^4.2.1", - "@csstools/utilities": "^2.0.0" - }, - "engines": { - "node": ">=18" - }, - "peerDependencies": { - "postcss": "^8.4" - } - }, - "node_modules/@csstools/postcss-color-mix-variadic-function-arguments": { - "version": "1.0.2", - "resolved": "https://registry.npmjs.org/@csstools/postcss-color-mix-variadic-function-arguments/-/postcss-color-mix-variadic-function-arguments-1.0.2.tgz", - "integrity": "sha512-rM67Gp9lRAkTo+X31DUqMEq+iK+EFqsidfecmhrteErxJZb6tUoJBVQca1Vn1GpDql1s1rD1pKcuYzMsg7Z1KQ==", - "dev": true, - "funding": [ - { - "type": "github", - "url": "https://github.com/sponsors/csstools" - }, - { - "type": "opencollective", - "url": "https://opencollective.com/csstools" - } - ], - "license": "MIT-0", - "dependencies": { - "@csstools/css-color-parser": "^3.1.0", - "@csstools/css-parser-algorithms": "^3.0.5", - "@csstools/css-tokenizer": "^3.0.4", - "@csstools/postcss-progressive-custom-properties": "^4.2.1", - "@csstools/utilities": "^2.0.0" - }, - "engines": { - "node": ">=18" - }, - "peerDependencies": { - "postcss": "^8.4" - } - }, - "node_modules/@csstools/postcss-content-alt-text": { - "version": "2.0.8", - "resolved": "https://registry.npmjs.org/@csstools/postcss-content-alt-text/-/postcss-content-alt-text-2.0.8.tgz", - "integrity": "sha512-9SfEW9QCxEpTlNMnpSqFaHyzsiRpZ5J5+KqCu1u5/eEJAWsMhzT40qf0FIbeeglEvrGRMdDzAxMIz3wqoGSb+Q==", - "dev": true, - "funding": [ - { - "type": "github", - "url": "https://github.com/sponsors/csstools" - }, - { - "type": "opencollective", - "url": "https://opencollective.com/csstools" - } - ], - "license": "MIT-0", - "dependencies": { - "@csstools/css-parser-algorithms": "^3.0.5", - "@csstools/css-tokenizer": "^3.0.4", - "@csstools/postcss-progressive-custom-properties": "^4.2.1", - "@csstools/utilities": "^2.0.0" - }, - "engines": { - "node": ">=18" - }, - "peerDependencies": { - "postcss": "^8.4" - } - }, - "node_modules/@csstools/postcss-contrast-color-function": { - "version": "2.0.12", - "resolved": "https://registry.npmjs.org/@csstools/postcss-contrast-color-function/-/postcss-contrast-color-function-2.0.12.tgz", - "integrity": "sha512-YbwWckjK3qwKjeYz/CijgcS7WDUCtKTd8ShLztm3/i5dhh4NaqzsbYnhm4bjrpFpnLZ31jVcbK8YL77z3GBPzA==", - "dev": true, - "funding": [ - { - "type": "github", - "url": "https://github.com/sponsors/csstools" - }, - { - "type": "opencollective", - "url": "https://opencollective.com/csstools" - } - ], - "license": "MIT-0", - "dependencies": { - "@csstools/css-color-parser": "^3.1.0", - "@csstools/css-parser-algorithms": "^3.0.5", - "@csstools/css-tokenizer": "^3.0.4", - "@csstools/postcss-progressive-custom-properties": "^4.2.1", - "@csstools/utilities": "^2.0.0" - }, - "engines": { - "node": ">=18" - }, - "peerDependencies": { - "postcss": "^8.4" - } - }, - "node_modules/@csstools/postcss-exponential-functions": { - "version": "2.0.9", - "resolved": "https://registry.npmjs.org/@csstools/postcss-exponential-functions/-/postcss-exponential-functions-2.0.9.tgz", - "integrity": "sha512-abg2W/PI3HXwS/CZshSa79kNWNZHdJPMBXeZNyPQFbbj8sKO3jXxOt/wF7juJVjyDTc6JrvaUZYFcSBZBhaxjw==", - "dev": true, - "funding": [ - { - "type": "github", - "url": "https://github.com/sponsors/csstools" - }, - { - "type": "opencollective", - "url": "https://opencollective.com/csstools" - } - ], - "license": "MIT-0", - "dependencies": { - "@csstools/css-calc": "^2.1.4", - "@csstools/css-parser-algorithms": "^3.0.5", - "@csstools/css-tokenizer": "^3.0.4" - }, - "engines": { - "node": ">=18" - }, - "peerDependencies": { - "postcss": "^8.4" - } - }, - "node_modules/@csstools/postcss-font-format-keywords": { - "version": "4.0.0", - "resolved": "https://registry.npmjs.org/@csstools/postcss-font-format-keywords/-/postcss-font-format-keywords-4.0.0.tgz", - "integrity": "sha512-usBzw9aCRDvchpok6C+4TXC57btc4bJtmKQWOHQxOVKen1ZfVqBUuCZ/wuqdX5GHsD0NRSr9XTP+5ID1ZZQBXw==", - "dev": true, - "funding": [ - { - "type": "github", - "url": "https://github.com/sponsors/csstools" - }, - { - "type": "opencollective", - "url": "https://opencollective.com/csstools" - } - ], - "license": "MIT-0", - "dependencies": { - "@csstools/utilities": "^2.0.0", - "postcss-value-parser": "^4.2.0" - }, - "engines": { - "node": ">=18" - }, - "peerDependencies": { - "postcss": "^8.4" - } - }, - "node_modules/@csstools/postcss-gamut-mapping": { - "version": "2.0.11", - "resolved": "https://registry.npmjs.org/@csstools/postcss-gamut-mapping/-/postcss-gamut-mapping-2.0.11.tgz", - "integrity": "sha512-fCpCUgZNE2piVJKC76zFsgVW1apF6dpYsqGyH8SIeCcM4pTEsRTWTLCaJIMKFEundsCKwY1rwfhtrio04RJ4Dw==", - "dev": true, - "funding": [ - { - "type": "github", - "url": "https://github.com/sponsors/csstools" - }, - { - "type": "opencollective", - "url": "https://opencollective.com/csstools" - } - ], - "license": "MIT-0", - "dependencies": { - "@csstools/css-color-parser": "^3.1.0", - "@csstools/css-parser-algorithms": "^3.0.5", - "@csstools/css-tokenizer": "^3.0.4" - }, - "engines": { - "node": ">=18" - }, - "peerDependencies": { - "postcss": "^8.4" - } - }, - "node_modules/@csstools/postcss-gradients-interpolation-method": { - "version": "5.0.12", - "resolved": "https://registry.npmjs.org/@csstools/postcss-gradients-interpolation-method/-/postcss-gradients-interpolation-method-5.0.12.tgz", - "integrity": "sha512-jugzjwkUY0wtNrZlFeyXzimUL3hN4xMvoPnIXxoZqxDvjZRiSh+itgHcVUWzJ2VwD/VAMEgCLvtaJHX+4Vj3Ow==", - "dev": true, - "funding": [ - { - "type": "github", - "url": "https://github.com/sponsors/csstools" - }, - { - "type": "opencollective", - "url": "https://opencollective.com/csstools" - } - ], - "license": "MIT-0", - "dependencies": { - "@csstools/css-color-parser": "^3.1.0", - "@csstools/css-parser-algorithms": "^3.0.5", - "@csstools/css-tokenizer": "^3.0.4", - "@csstools/postcss-progressive-custom-properties": "^4.2.1", - "@csstools/utilities": "^2.0.0" - }, - "engines": { - "node": ">=18" - }, - "peerDependencies": { - "postcss": "^8.4" - } - }, - "node_modules/@csstools/postcss-hwb-function": { - "version": "4.0.12", - "resolved": "https://registry.npmjs.org/@csstools/postcss-hwb-function/-/postcss-hwb-function-4.0.12.tgz", - "integrity": "sha512-mL/+88Z53KrE4JdePYFJAQWFrcADEqsLprExCM04GDNgHIztwFzj0Mbhd/yxMBngq0NIlz58VVxjt5abNs1VhA==", - "dev": true, - "funding": [ - { - "type": "github", - "url": "https://github.com/sponsors/csstools" - }, - { - "type": "opencollective", - "url": "https://opencollective.com/csstools" - } - ], - "license": "MIT-0", - "dependencies": { - "@csstools/css-color-parser": "^3.1.0", - "@csstools/css-parser-algorithms": "^3.0.5", - "@csstools/css-tokenizer": "^3.0.4", - "@csstools/postcss-progressive-custom-properties": "^4.2.1", - "@csstools/utilities": "^2.0.0" - }, - "engines": { - "node": ">=18" - }, - "peerDependencies": { - "postcss": "^8.4" - } - }, - "node_modules/@csstools/postcss-ic-unit": { - "version": "4.0.4", - "resolved": "https://registry.npmjs.org/@csstools/postcss-ic-unit/-/postcss-ic-unit-4.0.4.tgz", - "integrity": "sha512-yQ4VmossuOAql65sCPppVO1yfb7hDscf4GseF0VCA/DTDaBc0Wtf8MTqVPfjGYlT5+2buokG0Gp7y0atYZpwjg==", - "dev": true, - "funding": [ - { - "type": "github", - "url": "https://github.com/sponsors/csstools" - }, - { - "type": "opencollective", - "url": "https://opencollective.com/csstools" - } - ], - "license": "MIT-0", - "dependencies": { - "@csstools/postcss-progressive-custom-properties": "^4.2.1", - "@csstools/utilities": "^2.0.0", - "postcss-value-parser": "^4.2.0" - }, - "engines": { - "node": ">=18" - }, - "peerDependencies": { - "postcss": "^8.4" - } - }, - "node_modules/@csstools/postcss-initial": { - "version": "2.0.1", - "resolved": "https://registry.npmjs.org/@csstools/postcss-initial/-/postcss-initial-2.0.1.tgz", - "integrity": "sha512-L1wLVMSAZ4wovznquK0xmC7QSctzO4D0Is590bxpGqhqjboLXYA16dWZpfwImkdOgACdQ9PqXsuRroW6qPlEsg==", - "dev": true, - "funding": [ - { - "type": "github", - "url": "https://github.com/sponsors/csstools" - }, - { - "type": "opencollective", - "url": "https://opencollective.com/csstools" - } - ], - "license": "MIT-0", - "engines": { - "node": ">=18" - }, - "peerDependencies": { - "postcss": "^8.4" - } - }, - "node_modules/@csstools/postcss-is-pseudo-class": { - "version": "5.0.3", - "resolved": "https://registry.npmjs.org/@csstools/postcss-is-pseudo-class/-/postcss-is-pseudo-class-5.0.3.tgz", - "integrity": "sha512-jS/TY4SpG4gszAtIg7Qnf3AS2pjcUM5SzxpApOrlndMeGhIbaTzWBzzP/IApXoNWEW7OhcjkRT48jnAUIFXhAQ==", - "dev": true, - "funding": [ - { - "type": "github", - "url": "https://github.com/sponsors/csstools" - }, - { - "type": "opencollective", - "url": "https://opencollective.com/csstools" - } - ], - "license": "MIT-0", - "dependencies": { - "@csstools/selector-specificity": "^5.0.0", - "postcss-selector-parser": "^7.0.0" - }, - "engines": { - "node": ">=18" - }, - "peerDependencies": { - "postcss": "^8.4" - } - }, - "node_modules/@csstools/postcss-is-pseudo-class/node_modules/@csstools/selector-specificity": { - "version": "5.0.0", - "resolved": "https://registry.npmjs.org/@csstools/selector-specificity/-/selector-specificity-5.0.0.tgz", - "integrity": "sha512-PCqQV3c4CoVm3kdPhyeZ07VmBRdH2EpMFA/pd9OASpOEC3aXNGoqPDAZ80D0cLpMBxnmk0+yNhGsEx31hq7Gtw==", - "dev": true, - "funding": [ - { - "type": "github", - "url": "https://github.com/sponsors/csstools" - }, - { - "type": "opencollective", - "url": "https://opencollective.com/csstools" - } - ], - "license": "MIT-0", - "engines": { - "node": ">=18" - }, - "peerDependencies": { - "postcss-selector-parser": "^7.0.0" - } - }, - "node_modules/@csstools/postcss-is-pseudo-class/node_modules/postcss-selector-parser": { - "version": "7.1.1", - "resolved": "https://registry.npmjs.org/postcss-selector-parser/-/postcss-selector-parser-7.1.1.tgz", - "integrity": "sha512-orRsuYpJVw8LdAwqqLykBj9ecS5/cRHlI5+nvTo8LcCKmzDmqVORXtOIYEEQuL9D4BxtA1lm5isAqzQZCoQ6Eg==", - "dev": true, - "license": "MIT", - "peer": true, - "dependencies": { - "cssesc": "^3.0.0", - "util-deprecate": "^1.0.2" - }, - "engines": { - "node": ">=4" - } - }, - "node_modules/@csstools/postcss-light-dark-function": { - "version": "2.0.11", - "resolved": "https://registry.npmjs.org/@csstools/postcss-light-dark-function/-/postcss-light-dark-function-2.0.11.tgz", - "integrity": "sha512-fNJcKXJdPM3Lyrbmgw2OBbaioU7yuKZtiXClf4sGdQttitijYlZMD5K7HrC/eF83VRWRrYq6OZ0Lx92leV2LFA==", - "dev": true, - "funding": [ - { - "type": "github", - "url": "https://github.com/sponsors/csstools" - }, - { - "type": "opencollective", - "url": "https://opencollective.com/csstools" - } - ], - "license": "MIT-0", - "dependencies": { - "@csstools/css-parser-algorithms": "^3.0.5", - "@csstools/css-tokenizer": "^3.0.4", - "@csstools/postcss-progressive-custom-properties": "^4.2.1", - "@csstools/utilities": "^2.0.0" - }, - "engines": { - "node": ">=18" - }, - "peerDependencies": { - "postcss": "^8.4" - } - }, - "node_modules/@csstools/postcss-logical-float-and-clear": { - "version": "3.0.0", - "resolved": "https://registry.npmjs.org/@csstools/postcss-logical-float-and-clear/-/postcss-logical-float-and-clear-3.0.0.tgz", - "integrity": "sha512-SEmaHMszwakI2rqKRJgE+8rpotFfne1ZS6bZqBoQIicFyV+xT1UF42eORPxJkVJVrH9C0ctUgwMSn3BLOIZldQ==", - "dev": true, - "funding": [ - { - "type": "github", - "url": "https://github.com/sponsors/csstools" - }, - { - "type": "opencollective", - "url": "https://opencollective.com/csstools" - } - ], - "license": "MIT-0", - "engines": { - "node": ">=18" - }, - "peerDependencies": { - "postcss": "^8.4" - } - }, - "node_modules/@csstools/postcss-logical-overflow": { - "version": "2.0.0", - "resolved": "https://registry.npmjs.org/@csstools/postcss-logical-overflow/-/postcss-logical-overflow-2.0.0.tgz", - "integrity": "sha512-spzR1MInxPuXKEX2csMamshR4LRaSZ3UXVaRGjeQxl70ySxOhMpP2252RAFsg8QyyBXBzuVOOdx1+bVO5bPIzA==", - "dev": true, - "funding": [ - { - "type": "github", - "url": "https://github.com/sponsors/csstools" - }, - { - "type": "opencollective", - "url": "https://opencollective.com/csstools" - } - ], - "license": "MIT-0", - "engines": { - "node": ">=18" - }, - "peerDependencies": { - "postcss": "^8.4" - } - }, - "node_modules/@csstools/postcss-logical-overscroll-behavior": { - "version": "2.0.0", - "resolved": "https://registry.npmjs.org/@csstools/postcss-logical-overscroll-behavior/-/postcss-logical-overscroll-behavior-2.0.0.tgz", - "integrity": "sha512-e/webMjoGOSYfqLunyzByZj5KKe5oyVg/YSbie99VEaSDE2kimFm0q1f6t/6Jo+VVCQ/jbe2Xy+uX+C4xzWs4w==", - "dev": true, - "funding": [ - { - "type": "github", - "url": "https://github.com/sponsors/csstools" - }, - { - "type": "opencollective", - "url": "https://opencollective.com/csstools" - } - ], - "license": "MIT-0", - "engines": { - "node": ">=18" - }, - "peerDependencies": { - "postcss": "^8.4" - } - }, - "node_modules/@csstools/postcss-logical-resize": { - "version": "3.0.0", - "resolved": "https://registry.npmjs.org/@csstools/postcss-logical-resize/-/postcss-logical-resize-3.0.0.tgz", - "integrity": "sha512-DFbHQOFW/+I+MY4Ycd/QN6Dg4Hcbb50elIJCfnwkRTCX05G11SwViI5BbBlg9iHRl4ytB7pmY5ieAFk3ws7yyg==", - "dev": true, - "funding": [ - { - "type": "github", - "url": "https://github.com/sponsors/csstools" - }, - { - "type": "opencollective", - "url": "https://opencollective.com/csstools" - } - ], - "license": "MIT-0", - "dependencies": { - "postcss-value-parser": "^4.2.0" - }, - "engines": { - "node": ">=18" - }, - "peerDependencies": { - "postcss": "^8.4" - } - }, - "node_modules/@csstools/postcss-logical-viewport-units": { - "version": "3.0.4", - "resolved": "https://registry.npmjs.org/@csstools/postcss-logical-viewport-units/-/postcss-logical-viewport-units-3.0.4.tgz", - "integrity": "sha512-q+eHV1haXA4w9xBwZLKjVKAWn3W2CMqmpNpZUk5kRprvSiBEGMgrNH3/sJZ8UA3JgyHaOt3jwT9uFa4wLX4EqQ==", - "dev": true, - "funding": [ - { - "type": "github", - "url": "https://github.com/sponsors/csstools" - }, - { - "type": "opencollective", - "url": "https://opencollective.com/csstools" - } - ], - "license": "MIT-0", - "dependencies": { - "@csstools/css-tokenizer": "^3.0.4", - "@csstools/utilities": "^2.0.0" - }, - "engines": { - "node": ">=18" - }, - "peerDependencies": { - "postcss": "^8.4" - } - }, - "node_modules/@csstools/postcss-media-minmax": { - "version": "2.0.9", - "resolved": "https://registry.npmjs.org/@csstools/postcss-media-minmax/-/postcss-media-minmax-2.0.9.tgz", - "integrity": "sha512-af9Qw3uS3JhYLnCbqtZ9crTvvkR+0Se+bBqSr7ykAnl9yKhk6895z9rf+2F4dClIDJWxgn0iZZ1PSdkhrbs2ig==", - "dev": true, - "funding": [ - { - "type": "github", - "url": "https://github.com/sponsors/csstools" - }, - { - "type": "opencollective", - "url": "https://opencollective.com/csstools" - } - ], - "license": "MIT", - "dependencies": { - "@csstools/css-calc": "^2.1.4", - "@csstools/css-parser-algorithms": "^3.0.5", - "@csstools/css-tokenizer": "^3.0.4", - "@csstools/media-query-list-parser": "^4.0.3" - }, - "engines": { - "node": ">=18" - }, - "peerDependencies": { - "postcss": "^8.4" - } - }, - "node_modules/@csstools/postcss-media-queries-aspect-ratio-number-values": { - "version": "3.0.5", - "resolved": "https://registry.npmjs.org/@csstools/postcss-media-queries-aspect-ratio-number-values/-/postcss-media-queries-aspect-ratio-number-values-3.0.5.tgz", - "integrity": "sha512-zhAe31xaaXOY2Px8IYfoVTB3wglbJUVigGphFLj6exb7cjZRH9A6adyE22XfFK3P2PzwRk0VDeTJmaxpluyrDg==", - "dev": true, - "funding": [ - { - "type": "github", - "url": "https://github.com/sponsors/csstools" - }, - { - "type": "opencollective", - "url": "https://opencollective.com/csstools" - } - ], - "license": "MIT-0", - "dependencies": { - "@csstools/css-parser-algorithms": "^3.0.5", - "@csstools/css-tokenizer": "^3.0.4", - "@csstools/media-query-list-parser": "^4.0.3" - }, - "engines": { - "node": ">=18" - }, - "peerDependencies": { - "postcss": "^8.4" - } - }, - "node_modules/@csstools/postcss-nested-calc": { - "version": "4.0.0", - "resolved": "https://registry.npmjs.org/@csstools/postcss-nested-calc/-/postcss-nested-calc-4.0.0.tgz", - "integrity": "sha512-jMYDdqrQQxE7k9+KjstC3NbsmC063n1FTPLCgCRS2/qHUbHM0mNy9pIn4QIiQGs9I/Bg98vMqw7mJXBxa0N88A==", - "dev": true, - "funding": [ - { - "type": "github", - "url": "https://github.com/sponsors/csstools" - }, - { - "type": "opencollective", - "url": "https://opencollective.com/csstools" - } - ], - "license": "MIT-0", - "dependencies": { - "@csstools/utilities": "^2.0.0", - "postcss-value-parser": "^4.2.0" - }, - "engines": { - "node": ">=18" - }, - "peerDependencies": { - "postcss": "^8.4" - } - }, - "node_modules/@csstools/postcss-normalize-display-values": { - "version": "4.0.0", - "resolved": "https://registry.npmjs.org/@csstools/postcss-normalize-display-values/-/postcss-normalize-display-values-4.0.0.tgz", - "integrity": "sha512-HlEoG0IDRoHXzXnkV4in47dzsxdsjdz6+j7MLjaACABX2NfvjFS6XVAnpaDyGesz9gK2SC7MbNwdCHusObKJ9Q==", - "dev": true, - "funding": [ - { - "type": "github", - "url": "https://github.com/sponsors/csstools" - }, - { - "type": "opencollective", - "url": "https://opencollective.com/csstools" - } - ], - "license": "MIT-0", - "dependencies": { - "postcss-value-parser": "^4.2.0" - }, - "engines": { - "node": ">=18" - }, - "peerDependencies": { - "postcss": "^8.4" - } - }, - "node_modules/@csstools/postcss-oklab-function": { - "version": "4.0.12", - "resolved": "https://registry.npmjs.org/@csstools/postcss-oklab-function/-/postcss-oklab-function-4.0.12.tgz", - "integrity": "sha512-HhlSmnE1NKBhXsTnNGjxvhryKtO7tJd1w42DKOGFD6jSHtYOrsJTQDKPMwvOfrzUAk8t7GcpIfRyM7ssqHpFjg==", - "dev": true, - "funding": [ - { - "type": "github", - "url": "https://github.com/sponsors/csstools" - }, - { - "type": "opencollective", - "url": "https://opencollective.com/csstools" - } - ], - "license": "MIT-0", - "dependencies": { - "@csstools/css-color-parser": "^3.1.0", - "@csstools/css-parser-algorithms": "^3.0.5", - "@csstools/css-tokenizer": "^3.0.4", - "@csstools/postcss-progressive-custom-properties": "^4.2.1", - "@csstools/utilities": "^2.0.0" - }, - "engines": { - "node": ">=18" - }, - "peerDependencies": { - "postcss": "^8.4" - } - }, - "node_modules/@csstools/postcss-position-area-property": { - "version": "1.0.0", - "resolved": "https://registry.npmjs.org/@csstools/postcss-position-area-property/-/postcss-position-area-property-1.0.0.tgz", - "integrity": "sha512-fUP6KR8qV2NuUZV3Cw8itx0Ep90aRjAZxAEzC3vrl6yjFv+pFsQbR18UuQctEKmA72K9O27CoYiKEgXxkqjg8Q==", - "dev": true, - "funding": [ - { - "type": "github", - "url": "https://github.com/sponsors/csstools" - }, - { - "type": "opencollective", - "url": "https://opencollective.com/csstools" - } - ], - "license": "MIT-0", - "engines": { - "node": ">=18" - }, - "peerDependencies": { - "postcss": "^8.4" - } - }, - "node_modules/@csstools/postcss-progressive-custom-properties": { - "version": "4.2.1", - "resolved": "https://registry.npmjs.org/@csstools/postcss-progressive-custom-properties/-/postcss-progressive-custom-properties-4.2.1.tgz", - "integrity": "sha512-uPiiXf7IEKtUQXsxu6uWtOlRMXd2QWWy5fhxHDnPdXKCQckPP3E34ZgDoZ62r2iT+UOgWsSbM4NvHE5m3mAEdw==", - "dev": true, - "funding": [ - { - "type": "github", - "url": "https://github.com/sponsors/csstools" - }, - { - "type": "opencollective", - "url": "https://opencollective.com/csstools" - } - ], - "license": "MIT-0", - "dependencies": { - "postcss-value-parser": "^4.2.0" - }, - "engines": { - "node": ">=18" - }, - "peerDependencies": { - "postcss": "^8.4" - } - }, - "node_modules/@csstools/postcss-random-function": { - "version": "2.0.1", - "resolved": "https://registry.npmjs.org/@csstools/postcss-random-function/-/postcss-random-function-2.0.1.tgz", - "integrity": "sha512-q+FQaNiRBhnoSNo+GzqGOIBKoHQ43lYz0ICrV+UudfWnEF6ksS6DsBIJSISKQT2Bvu3g4k6r7t0zYrk5pDlo8w==", - "dev": true, - "funding": [ - { - "type": "github", - "url": "https://github.com/sponsors/csstools" - }, - { - "type": "opencollective", - "url": "https://opencollective.com/csstools" - } - ], - "license": "MIT-0", - "dependencies": { - "@csstools/css-calc": "^2.1.4", - "@csstools/css-parser-algorithms": "^3.0.5", - "@csstools/css-tokenizer": "^3.0.4" - }, - "engines": { - "node": ">=18" - }, - "peerDependencies": { - "postcss": "^8.4" - } - }, - "node_modules/@csstools/postcss-relative-color-syntax": { - "version": "3.0.12", - "resolved": "https://registry.npmjs.org/@csstools/postcss-relative-color-syntax/-/postcss-relative-color-syntax-3.0.12.tgz", - "integrity": "sha512-0RLIeONxu/mtxRtf3o41Lq2ghLimw0w9ByLWnnEVuy89exmEEq8bynveBxNW3nyHqLAFEeNtVEmC1QK9MZ8Huw==", - "dev": true, - "funding": [ - { - "type": "github", - "url": "https://github.com/sponsors/csstools" - }, - { - "type": "opencollective", - "url": "https://opencollective.com/csstools" - } - ], - "license": "MIT-0", - "dependencies": { - "@csstools/css-color-parser": "^3.1.0", - "@csstools/css-parser-algorithms": "^3.0.5", - "@csstools/css-tokenizer": "^3.0.4", - "@csstools/postcss-progressive-custom-properties": "^4.2.1", - "@csstools/utilities": "^2.0.0" - }, - "engines": { - "node": ">=18" - }, - "peerDependencies": { - "postcss": "^8.4" - } - }, - "node_modules/@csstools/postcss-scope-pseudo-class": { - "version": "4.0.1", - "resolved": "https://registry.npmjs.org/@csstools/postcss-scope-pseudo-class/-/postcss-scope-pseudo-class-4.0.1.tgz", - "integrity": "sha512-IMi9FwtH6LMNuLea1bjVMQAsUhFxJnyLSgOp/cpv5hrzWmrUYU5fm0EguNDIIOHUqzXode8F/1qkC/tEo/qN8Q==", - "dev": true, - "funding": [ - { - "type": "github", - "url": "https://github.com/sponsors/csstools" - }, - { - "type": "opencollective", - "url": "https://opencollective.com/csstools" - } - ], - "license": "MIT-0", - "dependencies": { - "postcss-selector-parser": "^7.0.0" - }, - "engines": { - "node": ">=18" - }, - "peerDependencies": { - "postcss": "^8.4" - } - }, - "node_modules/@csstools/postcss-scope-pseudo-class/node_modules/postcss-selector-parser": { - "version": "7.1.1", - "resolved": "https://registry.npmjs.org/postcss-selector-parser/-/postcss-selector-parser-7.1.1.tgz", - "integrity": "sha512-orRsuYpJVw8LdAwqqLykBj9ecS5/cRHlI5+nvTo8LcCKmzDmqVORXtOIYEEQuL9D4BxtA1lm5isAqzQZCoQ6Eg==", - "dev": true, - "license": "MIT", - "dependencies": { - "cssesc": "^3.0.0", - "util-deprecate": "^1.0.2" - }, - "engines": { - "node": ">=4" - } - }, - "node_modules/@csstools/postcss-sign-functions": { - "version": "1.1.4", - "resolved": "https://registry.npmjs.org/@csstools/postcss-sign-functions/-/postcss-sign-functions-1.1.4.tgz", - "integrity": "sha512-P97h1XqRPcfcJndFdG95Gv/6ZzxUBBISem0IDqPZ7WMvc/wlO+yU0c5D/OCpZ5TJoTt63Ok3knGk64N+o6L2Pg==", - "dev": true, - "funding": [ - { - "type": "github", - "url": "https://github.com/sponsors/csstools" - }, - { - "type": "opencollective", - "url": "https://opencollective.com/csstools" - } - ], - "license": "MIT-0", - "dependencies": { - "@csstools/css-calc": "^2.1.4", - "@csstools/css-parser-algorithms": "^3.0.5", - "@csstools/css-tokenizer": "^3.0.4" - }, - "engines": { - "node": ">=18" - }, - "peerDependencies": { - "postcss": "^8.4" - } - }, - "node_modules/@csstools/postcss-stepped-value-functions": { - "version": "4.0.9", - "resolved": "https://registry.npmjs.org/@csstools/postcss-stepped-value-functions/-/postcss-stepped-value-functions-4.0.9.tgz", - "integrity": "sha512-h9btycWrsex4dNLeQfyU3y3w40LMQooJWFMm/SK9lrKguHDcFl4VMkncKKoXi2z5rM9YGWbUQABI8BT2UydIcA==", - "dev": true, - "funding": [ - { - "type": "github", - "url": "https://github.com/sponsors/csstools" - }, - { - "type": "opencollective", - "url": "https://opencollective.com/csstools" - } - ], - "license": "MIT-0", - "dependencies": { - "@csstools/css-calc": "^2.1.4", - "@csstools/css-parser-algorithms": "^3.0.5", - "@csstools/css-tokenizer": "^3.0.4" - }, - "engines": { - "node": ">=18" - }, - "peerDependencies": { - "postcss": "^8.4" - } - }, - "node_modules/@csstools/postcss-system-ui-font-family": { - "version": "1.0.0", - "resolved": "https://registry.npmjs.org/@csstools/postcss-system-ui-font-family/-/postcss-system-ui-font-family-1.0.0.tgz", - "integrity": "sha512-s3xdBvfWYfoPSBsikDXbuorcMG1nN1M6GdU0qBsGfcmNR0A/qhloQZpTxjA3Xsyrk1VJvwb2pOfiOT3at/DuIQ==", - "dev": true, - "funding": [ - { - "type": "github", - "url": "https://github.com/sponsors/csstools" - }, - { - "type": "opencollective", - "url": "https://opencollective.com/csstools" - } - ], - "license": "MIT-0", - "dependencies": { - "@csstools/css-parser-algorithms": "^3.0.5", - "@csstools/css-tokenizer": "^3.0.4" - }, - "engines": { - "node": ">=18" - }, - "peerDependencies": { - "postcss": "^8.4" - } - }, - "node_modules/@csstools/postcss-text-decoration-shorthand": { - "version": "4.0.3", - "resolved": "https://registry.npmjs.org/@csstools/postcss-text-decoration-shorthand/-/postcss-text-decoration-shorthand-4.0.3.tgz", - "integrity": "sha512-KSkGgZfx0kQjRIYnpsD7X2Om9BUXX/Kii77VBifQW9Ih929hK0KNjVngHDH0bFB9GmfWcR9vJYJJRvw/NQjkrA==", - "dev": true, - "funding": [ - { - "type": "github", - "url": "https://github.com/sponsors/csstools" - }, - { - "type": "opencollective", - "url": "https://opencollective.com/csstools" - } - ], - "license": "MIT-0", - "dependencies": { - "@csstools/color-helpers": "^5.1.0", - "postcss-value-parser": "^4.2.0" - }, - "engines": { - "node": ">=18" - }, - "peerDependencies": { - "postcss": "^8.4" - } - }, - "node_modules/@csstools/postcss-trigonometric-functions": { - "version": "4.0.9", - "resolved": "https://registry.npmjs.org/@csstools/postcss-trigonometric-functions/-/postcss-trigonometric-functions-4.0.9.tgz", - "integrity": "sha512-Hnh5zJUdpNrJqK9v1/E3BbrQhaDTj5YiX7P61TOvUhoDHnUmsNNxcDAgkQ32RrcWx9GVUvfUNPcUkn8R3vIX6A==", - "dev": true, - "funding": [ - { - "type": "github", - "url": "https://github.com/sponsors/csstools" - }, - { - "type": "opencollective", - "url": "https://opencollective.com/csstools" - } - ], - "license": "MIT-0", - "dependencies": { - "@csstools/css-calc": "^2.1.4", - "@csstools/css-parser-algorithms": "^3.0.5", - "@csstools/css-tokenizer": "^3.0.4" - }, - "engines": { - "node": ">=18" - }, - "peerDependencies": { - "postcss": "^8.4" - } - }, - "node_modules/@csstools/postcss-unset-value": { - "version": "4.0.0", - "resolved": "https://registry.npmjs.org/@csstools/postcss-unset-value/-/postcss-unset-value-4.0.0.tgz", - "integrity": "sha512-cBz3tOCI5Fw6NIFEwU3RiwK6mn3nKegjpJuzCndoGq3BZPkUjnsq7uQmIeMNeMbMk7YD2MfKcgCpZwX5jyXqCA==", - "dev": true, - "funding": [ - { - "type": "github", - "url": "https://github.com/sponsors/csstools" - }, - { - "type": "opencollective", - "url": "https://opencollective.com/csstools" - } - ], - "license": "MIT-0", - "engines": { - "node": ">=18" - }, - "peerDependencies": { - "postcss": "^8.4" - } - }, - "node_modules/@csstools/utilities": { - "version": "2.0.0", - "resolved": "https://registry.npmjs.org/@csstools/utilities/-/utilities-2.0.0.tgz", - "integrity": "sha512-5VdOr0Z71u+Yp3ozOx8T11N703wIFGVRgOWbOZMKgglPJsWA54MRIoMNVMa7shUToIhx5J8vX4sOZgD2XiihiQ==", - "dev": true, - "funding": [ - { - "type": "github", - "url": "https://github.com/sponsors/csstools" - }, - { - "type": "opencollective", - "url": "https://opencollective.com/csstools" - } - ], - "license": "MIT-0", - "engines": { - "node": ">=18" - }, - "peerDependencies": { - "postcss": "^8.4" - } - }, - "node_modules/@discoveryjs/json-ext": { - "version": "0.5.7", - "resolved": "https://registry.npmjs.org/@discoveryjs/json-ext/-/json-ext-0.5.7.tgz", - "integrity": "sha512-dBVuXR082gk3jsFp7Rd/JI4kytwGHecnCoTtXFb7DB6CNHp4rg5k1bhg0nWdLGLnOV71lmDzGQaLMy8iPLY0pw==", + "node_modules/@ctrl/tinycolor": { + "version": "4.2.0", + "resolved": "https://registry.npmjs.org/@ctrl/tinycolor/-/tinycolor-4.2.0.tgz", + "integrity": "sha512-kzyuwOAQnXJNLS9PSyrk0CWk35nWJW/zl/6KvnTBMFK65gm7U1/Z5BqjxeapjZCIhQcM/DsrEmcbRwDyXyXK4A==", "dev": true, "license": "MIT", "engines": { - "node": ">=10.0.0" - } - }, - "node_modules/@docsearch/core": { - "version": "4.3.1", - "resolved": "https://registry.npmjs.org/@docsearch/core/-/core-4.3.1.tgz", - "integrity": "sha512-ktVbkePE+2h9RwqCUMbWXOoebFyDOxHqImAqfs+lC8yOU+XwEW4jgvHGJK079deTeHtdhUNj0PXHSnhJINvHzQ==", - "dev": true, - "license": "MIT", - "peerDependencies": { - "@types/react": ">= 16.8.0 < 20.0.0", - "react": ">= 16.8.0 < 20.0.0", - "react-dom": ">= 16.8.0 < 20.0.0" - }, - "peerDependenciesMeta": { - "@types/react": { - "optional": true - }, - "react": { - "optional": true - }, - "react-dom": { - "optional": true - } - } - }, - "node_modules/@docsearch/css": { - "version": "4.3.2", - "resolved": "https://registry.npmjs.org/@docsearch/css/-/css-4.3.2.tgz", - "integrity": "sha512-K3Yhay9MgkBjJJ0WEL5MxnACModX9xuNt3UlQQkDEDZJZ0+aeWKtOkxHNndMRkMBnHdYvQjxkm6mdlneOtU1IQ==", - "dev": true, - "license": "MIT" - }, - "node_modules/@docsearch/react": { - "version": "4.3.2", - "resolved": "https://registry.npmjs.org/@docsearch/react/-/react-4.3.2.tgz", - "integrity": "sha512-74SFD6WluwvgsOPqifYOviEEVwDxslxfhakTlra+JviaNcs7KK/rjsPj89kVEoQc9FUxRkAofaJnHIR7pb4TSQ==", - "dev": true, - "license": "MIT", - "dependencies": { - "@ai-sdk/react": "^2.0.30", - "@algolia/autocomplete-core": "1.19.2", - "@docsearch/core": "4.3.1", - "@docsearch/css": "4.3.2", - "ai": "^5.0.30", - "algoliasearch": "^5.28.0", - "marked": "^16.3.0", - "zod": "^4.1.8" - }, - "peerDependencies": { - "@types/react": ">= 16.8.0 < 20.0.0", - "react": ">= 16.8.0 < 20.0.0", - "react-dom": ">= 16.8.0 < 20.0.0", - "search-insights": ">= 1 < 3" - }, - "peerDependenciesMeta": { - "@types/react": { - "optional": true - }, - "react": { - "optional": true - }, - "react-dom": { - "optional": true - }, - "search-insights": { - "optional": true - } - } - }, - "node_modules/@docusaurus/babel": { - "version": "3.9.2", - "resolved": "https://registry.npmjs.org/@docusaurus/babel/-/babel-3.9.2.tgz", - "integrity": "sha512-GEANdi/SgER+L7Japs25YiGil/AUDnFFHaCGPBbundxoWtCkA2lmy7/tFmgED4y1htAy6Oi4wkJEQdGssnw9MA==", - "dev": true, - "license": "MIT", - "dependencies": { - "@babel/core": "^7.25.9", - "@babel/generator": "^7.25.9", - "@babel/plugin-syntax-dynamic-import": "^7.8.3", - "@babel/plugin-transform-runtime": "^7.25.9", - "@babel/preset-env": "^7.25.9", - "@babel/preset-react": "^7.25.9", - "@babel/preset-typescript": "^7.25.9", - "@babel/runtime": "^7.25.9", - "@babel/runtime-corejs3": "^7.25.9", - "@babel/traverse": "^7.25.9", - "@docusaurus/logger": "3.9.2", - "@docusaurus/utils": "3.9.2", - "babel-plugin-dynamic-import-node": "^2.3.3", - "fs-extra": "^11.1.1", - "tslib": "^2.6.0" - }, - "engines": { - "node": ">=20.0" - } - }, - "node_modules/@docusaurus/bundler": { - "version": "3.9.2", - "resolved": "https://registry.npmjs.org/@docusaurus/bundler/-/bundler-3.9.2.tgz", - "integrity": "sha512-ZOVi6GYgTcsZcUzjblpzk3wH1Fya2VNpd5jtHoCCFcJlMQ1EYXZetfAnRHLcyiFeBABaI1ltTYbOBtH/gahGVA==", - "dev": true, - "license": "MIT", - "dependencies": { - "@babel/core": "^7.25.9", - "@docusaurus/babel": "3.9.2", - "@docusaurus/cssnano-preset": "3.9.2", - "@docusaurus/logger": "3.9.2", - "@docusaurus/types": "3.9.2", - "@docusaurus/utils": "3.9.2", - "babel-loader": "^9.2.1", - "clean-css": "^5.3.3", - "copy-webpack-plugin": "^11.0.0", - "css-loader": "^6.11.0", - "css-minimizer-webpack-plugin": "^5.0.1", - "cssnano": "^6.1.2", - "file-loader": "^6.2.0", - "html-minifier-terser": "^7.2.0", - "mini-css-extract-plugin": "^2.9.2", - "null-loader": "^4.0.1", - "postcss": "^8.5.4", - "postcss-loader": "^7.3.4", - "postcss-preset-env": "^10.2.1", - "terser-webpack-plugin": "^5.3.9", - "tslib": "^2.6.0", - "url-loader": "^4.1.1", - "webpack": "^5.95.0", - "webpackbar": "^6.0.1" - }, - "engines": { - "node": ">=20.0" - }, - "peerDependencies": { - "@docusaurus/faster": "*" - }, - "peerDependenciesMeta": { - "@docusaurus/faster": { - "optional": true - } - } - }, - "node_modules/@docusaurus/core": { - "version": "3.9.2", - "resolved": "https://registry.npmjs.org/@docusaurus/core/-/core-3.9.2.tgz", - "integrity": "sha512-HbjwKeC+pHUFBfLMNzuSjqFE/58+rLVKmOU3lxQrpsxLBOGosYco/Q0GduBb0/jEMRiyEqjNT/01rRdOMWq5pw==", - "dev": true, - "license": "MIT", - "dependencies": { - "@docusaurus/babel": "3.9.2", - "@docusaurus/bundler": "3.9.2", - "@docusaurus/logger": "3.9.2", - "@docusaurus/mdx-loader": "3.9.2", - "@docusaurus/utils": "3.9.2", - "@docusaurus/utils-common": "3.9.2", - "@docusaurus/utils-validation": "3.9.2", - "boxen": "^6.2.1", - "chalk": "^4.1.2", - "chokidar": "^3.5.3", - "cli-table3": "^0.6.3", - "combine-promises": "^1.1.0", - "commander": "^5.1.0", - "core-js": "^3.31.1", - "detect-port": "^1.5.1", - "escape-html": "^1.0.3", - "eta": "^2.2.0", - "eval": "^0.1.8", - "execa": "5.1.1", - "fs-extra": "^11.1.1", - "html-tags": "^3.3.1", - "html-webpack-plugin": "^5.6.0", - "leven": "^3.1.0", - "lodash": "^4.17.21", - "open": "^8.4.0", - "p-map": "^4.0.0", - "prompts": "^2.4.2", - "react-helmet-async": "npm:@slorber/react-helmet-async@1.3.0", - "react-loadable": "npm:@docusaurus/react-loadable@6.0.0", - "react-loadable-ssr-addon-v5-slorber": "^1.0.1", - "react-router": "^5.3.4", - "react-router-config": "^5.1.1", - "react-router-dom": "^5.3.4", - "semver": "^7.5.4", - "serve-handler": "^6.1.6", - "tinypool": "^1.0.2", - "tslib": "^2.6.0", - "update-notifier": "^6.0.2", - "webpack": "^5.95.0", - "webpack-bundle-analyzer": "^4.10.2", - "webpack-dev-server": "^5.2.2", - "webpack-merge": "^6.0.1" - }, - "bin": { - "docusaurus": "bin/docusaurus.mjs" - }, - "engines": { - "node": ">=20.0" - }, - "peerDependencies": { - "@mdx-js/react": "^3.0.0", - "react": "^18.0.0 || ^19.0.0", - "react-dom": "^18.0.0 || ^19.0.0" - } - }, - "node_modules/@docusaurus/core/node_modules/ansi-regex": { - "version": "6.2.2", - "resolved": "https://registry.npmjs.org/ansi-regex/-/ansi-regex-6.2.2.tgz", - "integrity": "sha512-Bq3SmSpyFHaWjPk8If9yc6svM8c56dB5BAtW4Qbw5jHTwwXXcTLoRMkpDJp6VL0XzlWaCHTXrkFURMYmD0sLqg==", - "dev": true, - "license": "MIT", - "engines": { - "node": ">=12" - }, - "funding": { - "url": "https://github.com/chalk/ansi-regex?sponsor=1" - } - }, - "node_modules/@docusaurus/core/node_modules/ansi-styles": { - "version": "6.2.3", - "resolved": "https://registry.npmjs.org/ansi-styles/-/ansi-styles-6.2.3.tgz", - "integrity": "sha512-4Dj6M28JB+oAH8kFkTLUo+a2jwOFkuqb3yucU0CANcRRUbxS0cP0nZYCGjcc3BNXwRIsUVmDGgzawme7zvJHvg==", - "dev": true, - "license": "MIT", - "engines": { - "node": ">=12" - }, - "funding": { - "url": "https://github.com/chalk/ansi-styles?sponsor=1" - } - }, - "node_modules/@docusaurus/core/node_modules/boxen": { - "version": "6.2.1", - "resolved": "https://registry.npmjs.org/boxen/-/boxen-6.2.1.tgz", - "integrity": "sha512-H4PEsJXfFI/Pt8sjDWbHlQPx4zL/bvSQjcilJmaulGt5mLDorHOHpmdXAJcBcmru7PhYSp/cDMWRko4ZUMFkSw==", - "dev": true, - "license": "MIT", - "dependencies": { - "ansi-align": "^3.0.1", - "camelcase": "^6.2.0", - "chalk": "^4.1.2", - "cli-boxes": "^3.0.0", - "string-width": "^5.0.1", - "type-fest": "^2.5.0", - "widest-line": "^4.0.1", - "wrap-ansi": "^8.0.1" - }, - "engines": { - "node": "^12.20.0 || ^14.13.1 || >=16.0.0" - }, - "funding": { - "url": "https://github.com/sponsors/sindresorhus" - } - }, - "node_modules/@docusaurus/core/node_modules/camelcase": { - "version": "6.3.0", - "resolved": "https://registry.npmjs.org/camelcase/-/camelcase-6.3.0.tgz", - "integrity": "sha512-Gmy6FhYlCY7uOElZUSbxo2UCDH8owEk996gkbrpsgGtrJLM3J7jGxl9Ic7Qwwj4ivOE5AWZWRMecDdF7hqGjFA==", - "dev": true, - "license": "MIT", - "engines": { - "node": ">=10" - }, - "funding": { - "url": "https://github.com/sponsors/sindresorhus" - } - }, - "node_modules/@docusaurus/core/node_modules/cli-boxes": { - "version": "3.0.0", - "resolved": "https://registry.npmjs.org/cli-boxes/-/cli-boxes-3.0.0.tgz", - "integrity": "sha512-/lzGpEWL/8PfI0BmBOPRwp0c/wFNX1RdUML3jK/RcSBA9T8mZDdQpqYBKtCFTOfQbwPqWEOpjqW+Fnayc0969g==", - "dev": true, - "license": "MIT", - "engines": { - "node": ">=10" - }, - "funding": { - "url": "https://github.com/sponsors/sindresorhus" - } - }, - "node_modules/@docusaurus/core/node_modules/commander": { - "version": "5.1.0", - "resolved": "https://registry.npmjs.org/commander/-/commander-5.1.0.tgz", - "integrity": "sha512-P0CysNDQ7rtVw4QIQtm+MRxV66vKFSvlsQvGYXZWR3qFU0jlMKHZZZgw8e+8DSah4UDKMqnknRDQz+xuQXQ/Zg==", - "dev": true, - "license": "MIT", - "engines": { - "node": ">= 6" - } - }, - "node_modules/@docusaurus/core/node_modules/emoji-regex": { - "version": "9.2.2", - "resolved": "https://registry.npmjs.org/emoji-regex/-/emoji-regex-9.2.2.tgz", - "integrity": "sha512-L18DaJsXSUk2+42pv8mLs5jJT2hqFkFE4j21wOmgbUqsZ2hL72NsUU785g9RXgo3s0ZNgVl42TiHp3ZtOv/Vyg==", - "dev": true, - "license": "MIT" - }, - "node_modules/@docusaurus/core/node_modules/string-width": { - "version": "5.1.2", - "resolved": "https://registry.npmjs.org/string-width/-/string-width-5.1.2.tgz", - "integrity": "sha512-HnLOCR3vjcY8beoNLtcjZ5/nxn2afmME6lhrDrebokqMap+XbeW8n9TXpPDOqdGK5qcI3oT0GKTW6wC7EMiVqA==", - "dev": true, - "license": "MIT", - "dependencies": { - "eastasianwidth": "^0.2.0", - "emoji-regex": "^9.2.2", - "strip-ansi": "^7.0.1" - }, - "engines": { - "node": ">=12" - }, - "funding": { - "url": "https://github.com/sponsors/sindresorhus" - } - }, - "node_modules/@docusaurus/core/node_modules/strip-ansi": { - "version": "7.1.2", - "resolved": "https://registry.npmjs.org/strip-ansi/-/strip-ansi-7.1.2.tgz", - "integrity": "sha512-gmBGslpoQJtgnMAvOVqGZpEz9dyoKTCzy2nfz/n8aIFhN/jCE/rCmcxabB6jOOHV+0WNnylOxaxBQPSvcWklhA==", - "dev": true, - "license": "MIT", - "dependencies": { - "ansi-regex": "^6.0.1" - }, - "engines": { - "node": ">=12" - }, - "funding": { - "url": "https://github.com/chalk/strip-ansi?sponsor=1" - } - }, - "node_modules/@docusaurus/core/node_modules/type-fest": { - "version": "2.19.0", - "resolved": "https://registry.npmjs.org/type-fest/-/type-fest-2.19.0.tgz", - "integrity": "sha512-RAH822pAdBgcNMAfWnCBU3CFZcfZ/i1eZjwFU/dsLKumyuuP3niueg2UAukXYF0E2AAoc82ZSSf9J0WQBinzHA==", - "dev": true, - "license": "(MIT OR CC0-1.0)", - "engines": { - "node": ">=12.20" - }, - "funding": { - "url": "https://github.com/sponsors/sindresorhus" - } - }, - "node_modules/@docusaurus/core/node_modules/widest-line": { - "version": "4.0.1", - "resolved": "https://registry.npmjs.org/widest-line/-/widest-line-4.0.1.tgz", - "integrity": "sha512-o0cyEG0e8GPzT4iGHphIOh0cJOV8fivsXxddQasHPHfoZf1ZexrfeA21w2NaEN1RHE+fXlfISmOE8R9N3u3Qig==", - "dev": true, - "license": "MIT", - "dependencies": { - "string-width": "^5.0.1" - }, - "engines": { - "node": ">=12" - }, - "funding": { - "url": "https://github.com/sponsors/sindresorhus" - } - }, - "node_modules/@docusaurus/core/node_modules/wrap-ansi": { - "version": "8.1.0", - "resolved": "https://registry.npmjs.org/wrap-ansi/-/wrap-ansi-8.1.0.tgz", - "integrity": "sha512-si7QWI6zUMq56bESFvagtmzMdGOtoxfR+Sez11Mobfc7tm+VkUckk9bW2UeffTGVUbOksxmSw0AA2gs8g71NCQ==", - "dev": true, - "license": "MIT", - "dependencies": { - "ansi-styles": "^6.1.0", - "string-width": "^5.0.1", - "strip-ansi": "^7.0.1" - }, - "engines": { - "node": ">=12" - }, - "funding": { - "url": "https://github.com/chalk/wrap-ansi?sponsor=1" - } - }, - "node_modules/@docusaurus/cssnano-preset": { - "version": "3.9.2", - "resolved": "https://registry.npmjs.org/@docusaurus/cssnano-preset/-/cssnano-preset-3.9.2.tgz", - "integrity": "sha512-8gBKup94aGttRduABsj7bpPFTX7kbwu+xh3K9NMCF5K4bWBqTFYW+REKHF6iBVDHRJ4grZdIPbvkiHd/XNKRMQ==", - "dev": true, - "license": "MIT", - "dependencies": { - "cssnano-preset-advanced": "^6.1.2", - "postcss": "^8.5.4", - "postcss-sort-media-queries": "^5.2.0", - "tslib": "^2.6.0" - }, - "engines": { - "node": ">=20.0" - } - }, - "node_modules/@docusaurus/logger": { - "version": "3.9.2", - "resolved": "https://registry.npmjs.org/@docusaurus/logger/-/logger-3.9.2.tgz", - "integrity": "sha512-/SVCc57ByARzGSU60c50rMyQlBuMIJCjcsJlkphxY6B0GV4UH3tcA1994N8fFfbJ9kX3jIBe/xg3XP5qBtGDbA==", - "dev": true, - "license": "MIT", - "dependencies": { - "chalk": "^4.1.2", - "tslib": "^2.6.0" - }, - "engines": { - "node": ">=20.0" - } - }, - "node_modules/@docusaurus/mdx-loader": { - "version": "3.9.2", - "resolved": "https://registry.npmjs.org/@docusaurus/mdx-loader/-/mdx-loader-3.9.2.tgz", - "integrity": "sha512-wiYoGwF9gdd6rev62xDU8AAM8JuLI/hlwOtCzMmYcspEkzecKrP8J8X+KpYnTlACBUUtXNJpSoCwFWJhLRevzQ==", - "dev": true, - "license": "MIT", - "dependencies": { - "@docusaurus/logger": "3.9.2", - "@docusaurus/utils": "3.9.2", - "@docusaurus/utils-validation": "3.9.2", - "@mdx-js/mdx": "^3.0.0", - "@slorber/remark-comment": "^1.0.0", - "escape-html": "^1.0.3", - "estree-util-value-to-estree": "^3.0.1", - "file-loader": "^6.2.0", - "fs-extra": "^11.1.1", - "image-size": "^2.0.2", - "mdast-util-mdx": "^3.0.0", - "mdast-util-to-string": "^4.0.0", - "rehype-raw": "^7.0.0", - "remark-directive": "^3.0.0", - "remark-emoji": "^4.0.0", - "remark-frontmatter": "^5.0.0", - "remark-gfm": "^4.0.0", - "stringify-object": "^3.3.0", - "tslib": "^2.6.0", - "unified": "^11.0.3", - "unist-util-visit": "^5.0.0", - "url-loader": "^4.1.1", - "vfile": "^6.0.1", - "webpack": "^5.88.1" - }, - "engines": { - "node": ">=20.0" - }, - "peerDependencies": { - "react": "^18.0.0 || ^19.0.0", - "react-dom": "^18.0.0 || ^19.0.0" - } - }, - "node_modules/@docusaurus/module-type-aliases": { - "version": "3.9.2", - "resolved": "https://registry.npmjs.org/@docusaurus/module-type-aliases/-/module-type-aliases-3.9.2.tgz", - "integrity": "sha512-8qVe2QA9hVLzvnxP46ysuofJUIc/yYQ82tvA/rBTrnpXtCjNSFLxEZfd5U8cYZuJIVlkPxamsIgwd5tGZXfvew==", - "dev": true, - "license": "MIT", - "dependencies": { - "@docusaurus/types": "3.9.2", - "@types/history": "^4.7.11", - "@types/react": "*", - "@types/react-router-config": "*", - "@types/react-router-dom": "*", - "react-helmet-async": "npm:@slorber/react-helmet-async@1.3.0", - "react-loadable": "npm:@docusaurus/react-loadable@6.0.0" - }, - "peerDependencies": { - "react": "*", - "react-dom": "*" - } - }, - "node_modules/@docusaurus/plugin-content-blog": { - "version": "3.9.2", - "resolved": "https://registry.npmjs.org/@docusaurus/plugin-content-blog/-/plugin-content-blog-3.9.2.tgz", - "integrity": "sha512-3I2HXy3L1QcjLJLGAoTvoBnpOwa6DPUa3Q0dMK19UTY9mhPkKQg/DYhAGTiBUKcTR0f08iw7kLPqOhIgdV3eVQ==", - "dev": true, - "license": "MIT", - "dependencies": { - "@docusaurus/core": "3.9.2", - "@docusaurus/logger": "3.9.2", - "@docusaurus/mdx-loader": "3.9.2", - "@docusaurus/theme-common": "3.9.2", - "@docusaurus/types": "3.9.2", - "@docusaurus/utils": "3.9.2", - "@docusaurus/utils-common": "3.9.2", - "@docusaurus/utils-validation": "3.9.2", - "cheerio": "1.0.0-rc.12", - "feed": "^4.2.2", - "fs-extra": "^11.1.1", - "lodash": "^4.17.21", - "schema-dts": "^1.1.2", - "srcset": "^4.0.0", - "tslib": "^2.6.0", - "unist-util-visit": "^5.0.0", - "utility-types": "^3.10.0", - "webpack": "^5.88.1" - }, - "engines": { - "node": ">=20.0" - }, - "peerDependencies": { - "@docusaurus/plugin-content-docs": "*", - "react": "^18.0.0 || ^19.0.0", - "react-dom": "^18.0.0 || ^19.0.0" - } - }, - "node_modules/@docusaurus/plugin-content-docs": { - "version": "3.9.2", - "resolved": "https://registry.npmjs.org/@docusaurus/plugin-content-docs/-/plugin-content-docs-3.9.2.tgz", - "integrity": "sha512-C5wZsGuKTY8jEYsqdxhhFOe1ZDjH0uIYJ9T/jebHwkyxqnr4wW0jTkB72OMqNjsoQRcb0JN3PcSeTwFlVgzCZg==", - "dev": true, - "license": "MIT", - "peer": true, - "dependencies": { - "@docusaurus/core": "3.9.2", - "@docusaurus/logger": "3.9.2", - "@docusaurus/mdx-loader": "3.9.2", - "@docusaurus/module-type-aliases": "3.9.2", - "@docusaurus/theme-common": "3.9.2", - "@docusaurus/types": "3.9.2", - "@docusaurus/utils": "3.9.2", - "@docusaurus/utils-common": "3.9.2", - "@docusaurus/utils-validation": "3.9.2", - "@types/react-router-config": "^5.0.7", - "combine-promises": "^1.1.0", - "fs-extra": "^11.1.1", - "js-yaml": "^4.1.0", - "lodash": "^4.17.21", - "schema-dts": "^1.1.2", - "tslib": "^2.6.0", - "utility-types": "^3.10.0", - "webpack": "^5.88.1" - }, - "engines": { - "node": ">=20.0" - }, - "peerDependencies": { - "react": "^18.0.0 || ^19.0.0", - "react-dom": "^18.0.0 || ^19.0.0" - } - }, - "node_modules/@docusaurus/plugin-content-pages": { - "version": "3.9.2", - "resolved": "https://registry.npmjs.org/@docusaurus/plugin-content-pages/-/plugin-content-pages-3.9.2.tgz", - "integrity": "sha512-s4849w/p4noXUrGpPUF0BPqIAfdAe76BLaRGAGKZ1gTDNiGxGcpsLcwJ9OTi1/V8A+AzvsmI9pkjie2zjIQZKA==", - "dev": true, - "license": "MIT", - "dependencies": { - "@docusaurus/core": "3.9.2", - "@docusaurus/mdx-loader": "3.9.2", - "@docusaurus/types": "3.9.2", - "@docusaurus/utils": "3.9.2", - "@docusaurus/utils-validation": "3.9.2", - "fs-extra": "^11.1.1", - "tslib": "^2.6.0", - "webpack": "^5.88.1" - }, - "engines": { - "node": ">=20.0" - }, - "peerDependencies": { - "react": "^18.0.0 || ^19.0.0", - "react-dom": "^18.0.0 || ^19.0.0" - } - }, - "node_modules/@docusaurus/plugin-css-cascade-layers": { - "version": "3.9.2", - "resolved": "https://registry.npmjs.org/@docusaurus/plugin-css-cascade-layers/-/plugin-css-cascade-layers-3.9.2.tgz", - "integrity": "sha512-w1s3+Ss+eOQbscGM4cfIFBlVg/QKxyYgj26k5AnakuHkKxH6004ZtuLe5awMBotIYF2bbGDoDhpgQ4r/kcj4rQ==", - "dev": true, - "license": "MIT", - "dependencies": { - "@docusaurus/core": "3.9.2", - "@docusaurus/types": "3.9.2", - "@docusaurus/utils": "3.9.2", - "@docusaurus/utils-validation": "3.9.2", - "tslib": "^2.6.0" - }, - "engines": { - "node": ">=20.0" - } - }, - "node_modules/@docusaurus/plugin-debug": { - "version": "3.9.2", - "resolved": "https://registry.npmjs.org/@docusaurus/plugin-debug/-/plugin-debug-3.9.2.tgz", - "integrity": "sha512-j7a5hWuAFxyQAkilZwhsQ/b3T7FfHZ+0dub6j/GxKNFJp2h9qk/P1Bp7vrGASnvA9KNQBBL1ZXTe7jlh4VdPdA==", - "dev": true, - "license": "MIT", - "dependencies": { - "@docusaurus/core": "3.9.2", - "@docusaurus/types": "3.9.2", - "@docusaurus/utils": "3.9.2", - "fs-extra": "^11.1.1", - "react-json-view-lite": "^2.3.0", - "tslib": "^2.6.0" - }, - "engines": { - "node": ">=20.0" - }, - "peerDependencies": { - "react": "^18.0.0 || ^19.0.0", - "react-dom": "^18.0.0 || ^19.0.0" - } - }, - "node_modules/@docusaurus/plugin-google-analytics": { - "version": "3.9.2", - "resolved": "https://registry.npmjs.org/@docusaurus/plugin-google-analytics/-/plugin-google-analytics-3.9.2.tgz", - "integrity": "sha512-mAwwQJ1Us9jL/lVjXtErXto4p4/iaLlweC54yDUK1a97WfkC6Z2k5/769JsFgwOwOP+n5mUQGACXOEQ0XDuVUw==", - "dev": true, - "license": "MIT", - "dependencies": { - "@docusaurus/core": "3.9.2", - "@docusaurus/types": "3.9.2", - "@docusaurus/utils-validation": "3.9.2", - "tslib": "^2.6.0" - }, - "engines": { - "node": ">=20.0" - }, - "peerDependencies": { - "react": "^18.0.0 || ^19.0.0", - "react-dom": "^18.0.0 || ^19.0.0" - } - }, - "node_modules/@docusaurus/plugin-google-gtag": { - "version": "3.9.2", - "resolved": "https://registry.npmjs.org/@docusaurus/plugin-google-gtag/-/plugin-google-gtag-3.9.2.tgz", - "integrity": "sha512-YJ4lDCphabBtw19ooSlc1MnxtYGpjFV9rEdzjLsUnBCeis2djUyCozZaFhCg6NGEwOn7HDDyMh0yzcdRpnuIvA==", - "dev": true, - "license": "MIT", - "dependencies": { - "@docusaurus/core": "3.9.2", - "@docusaurus/types": "3.9.2", - "@docusaurus/utils-validation": "3.9.2", - "@types/gtag.js": "^0.0.12", - "tslib": "^2.6.0" - }, - "engines": { - "node": ">=20.0" - }, - "peerDependencies": { - "react": "^18.0.0 || ^19.0.0", - "react-dom": "^18.0.0 || ^19.0.0" - } - }, - "node_modules/@docusaurus/plugin-google-tag-manager": { - "version": "3.9.2", - "resolved": "https://registry.npmjs.org/@docusaurus/plugin-google-tag-manager/-/plugin-google-tag-manager-3.9.2.tgz", - "integrity": "sha512-LJtIrkZN/tuHD8NqDAW1Tnw0ekOwRTfobWPsdO15YxcicBo2ykKF0/D6n0vVBfd3srwr9Z6rzrIWYrMzBGrvNw==", - "dev": true, - "license": "MIT", - "dependencies": { - "@docusaurus/core": "3.9.2", - "@docusaurus/types": "3.9.2", - "@docusaurus/utils-validation": "3.9.2", - "tslib": "^2.6.0" - }, - "engines": { - "node": ">=20.0" - }, - "peerDependencies": { - "react": "^18.0.0 || ^19.0.0", - "react-dom": "^18.0.0 || ^19.0.0" - } - }, - "node_modules/@docusaurus/plugin-sitemap": { - "version": "3.9.2", - "resolved": "https://registry.npmjs.org/@docusaurus/plugin-sitemap/-/plugin-sitemap-3.9.2.tgz", - "integrity": "sha512-WLh7ymgDXjG8oPoM/T4/zUP7KcSuFYRZAUTl8vR6VzYkfc18GBM4xLhcT+AKOwun6kBivYKUJf+vlqYJkm+RHw==", - "dev": true, - "license": "MIT", - "dependencies": { - "@docusaurus/core": "3.9.2", - "@docusaurus/logger": "3.9.2", - "@docusaurus/types": "3.9.2", - "@docusaurus/utils": "3.9.2", - "@docusaurus/utils-common": "3.9.2", - "@docusaurus/utils-validation": "3.9.2", - "fs-extra": "^11.1.1", - "sitemap": "^7.1.1", - "tslib": "^2.6.0" - }, - "engines": { - "node": ">=20.0" - }, - "peerDependencies": { - "react": "^18.0.0 || ^19.0.0", - "react-dom": "^18.0.0 || ^19.0.0" - } - }, - "node_modules/@docusaurus/plugin-svgr": { - "version": "3.9.2", - "resolved": "https://registry.npmjs.org/@docusaurus/plugin-svgr/-/plugin-svgr-3.9.2.tgz", - "integrity": "sha512-n+1DE+5b3Lnf27TgVU5jM1d4x5tUh2oW5LTsBxJX4PsAPV0JGcmI6p3yLYtEY0LRVEIJh+8RsdQmRE66wSV8mw==", - "dev": true, - "license": "MIT", - "dependencies": { - "@docusaurus/core": "3.9.2", - "@docusaurus/types": "3.9.2", - "@docusaurus/utils": "3.9.2", - "@docusaurus/utils-validation": "3.9.2", - "@svgr/core": "8.1.0", - "@svgr/webpack": "^8.1.0", - "tslib": "^2.6.0", - "webpack": "^5.88.1" - }, - "engines": { - "node": ">=20.0" - }, - "peerDependencies": { - "react": "^18.0.0 || ^19.0.0", - "react-dom": "^18.0.0 || ^19.0.0" - } - }, - "node_modules/@docusaurus/preset-classic": { - "version": "3.9.2", - "resolved": "https://registry.npmjs.org/@docusaurus/preset-classic/-/preset-classic-3.9.2.tgz", - "integrity": "sha512-IgyYO2Gvaigi21LuDIe+nvmN/dfGXAiMcV/murFqcpjnZc7jxFAxW+9LEjdPt61uZLxG4ByW/oUmX/DDK9t/8w==", - "dev": true, - "license": "MIT", - "dependencies": { - "@docusaurus/core": "3.9.2", - "@docusaurus/plugin-content-blog": "3.9.2", - "@docusaurus/plugin-content-docs": "3.9.2", - "@docusaurus/plugin-content-pages": "3.9.2", - "@docusaurus/plugin-css-cascade-layers": "3.9.2", - "@docusaurus/plugin-debug": "3.9.2", - "@docusaurus/plugin-google-analytics": "3.9.2", - "@docusaurus/plugin-google-gtag": "3.9.2", - "@docusaurus/plugin-google-tag-manager": "3.9.2", - "@docusaurus/plugin-sitemap": "3.9.2", - "@docusaurus/plugin-svgr": "3.9.2", - "@docusaurus/theme-classic": "3.9.2", - "@docusaurus/theme-common": "3.9.2", - "@docusaurus/theme-search-algolia": "3.9.2", - "@docusaurus/types": "3.9.2" - }, - "engines": { - "node": ">=20.0" - }, - "peerDependencies": { - "react": "^18.0.0 || ^19.0.0", - "react-dom": "^18.0.0 || ^19.0.0" - } - }, - "node_modules/@docusaurus/theme-classic": { - "version": "3.9.2", - "resolved": "https://registry.npmjs.org/@docusaurus/theme-classic/-/theme-classic-3.9.2.tgz", - "integrity": "sha512-IGUsArG5hhekXd7RDb11v94ycpJpFdJPkLnt10fFQWOVxAtq5/D7hT6lzc2fhyQKaaCE62qVajOMKL7OiAFAIA==", - "dev": true, - "license": "MIT", - "dependencies": { - "@docusaurus/core": "3.9.2", - "@docusaurus/logger": "3.9.2", - "@docusaurus/mdx-loader": "3.9.2", - "@docusaurus/module-type-aliases": "3.9.2", - "@docusaurus/plugin-content-blog": "3.9.2", - "@docusaurus/plugin-content-docs": "3.9.2", - "@docusaurus/plugin-content-pages": "3.9.2", - "@docusaurus/theme-common": "3.9.2", - "@docusaurus/theme-translations": "3.9.2", - "@docusaurus/types": "3.9.2", - "@docusaurus/utils": "3.9.2", - "@docusaurus/utils-common": "3.9.2", - "@docusaurus/utils-validation": "3.9.2", - "@mdx-js/react": "^3.0.0", - "clsx": "^2.0.0", - "infima": "0.2.0-alpha.45", - "lodash": "^4.17.21", - "nprogress": "^0.2.0", - "postcss": "^8.5.4", - "prism-react-renderer": "^2.3.0", - "prismjs": "^1.29.0", - "react-router-dom": "^5.3.4", - "rtlcss": "^4.1.0", - "tslib": "^2.6.0", - "utility-types": "^3.10.0" - }, - "engines": { - "node": ">=20.0" - }, - "peerDependencies": { - "react": "^18.0.0 || ^19.0.0", - "react-dom": "^18.0.0 || ^19.0.0" - } - }, - "node_modules/@docusaurus/theme-common": { - "version": "3.9.2", - "resolved": "https://registry.npmjs.org/@docusaurus/theme-common/-/theme-common-3.9.2.tgz", - "integrity": "sha512-6c4DAbR6n6nPbnZhY2V3tzpnKnGL+6aOsLvFL26VRqhlczli9eWG0VDUNoCQEPnGwDMhPS42UhSAnz5pThm5Ag==", - "dev": true, - "license": "MIT", - "dependencies": { - "@docusaurus/mdx-loader": "3.9.2", - "@docusaurus/module-type-aliases": "3.9.2", - "@docusaurus/utils": "3.9.2", - "@docusaurus/utils-common": "3.9.2", - "@types/history": "^4.7.11", - "@types/react": "*", - "@types/react-router-config": "*", - "clsx": "^2.0.0", - "parse-numeric-range": "^1.3.0", - "prism-react-renderer": "^2.3.0", - "tslib": "^2.6.0", - "utility-types": "^3.10.0" - }, - "engines": { - "node": ">=20.0" - }, - "peerDependencies": { - "@docusaurus/plugin-content-docs": "*", - "react": "^18.0.0 || ^19.0.0", - "react-dom": "^18.0.0 || ^19.0.0" - } - }, - "node_modules/@docusaurus/theme-search-algolia": { - "version": "3.9.2", - "resolved": "https://registry.npmjs.org/@docusaurus/theme-search-algolia/-/theme-search-algolia-3.9.2.tgz", - "integrity": "sha512-GBDSFNwjnh5/LdkxCKQHkgO2pIMX1447BxYUBG2wBiajS21uj64a+gH/qlbQjDLxmGrbrllBrtJkUHxIsiwRnw==", - "dev": true, - "license": "MIT", - "dependencies": { - "@docsearch/react": "^3.9.0 || ^4.1.0", - "@docusaurus/core": "3.9.2", - "@docusaurus/logger": "3.9.2", - "@docusaurus/plugin-content-docs": "3.9.2", - "@docusaurus/theme-common": "3.9.2", - "@docusaurus/theme-translations": "3.9.2", - "@docusaurus/utils": "3.9.2", - "@docusaurus/utils-validation": "3.9.2", - "algoliasearch": "^5.37.0", - "algoliasearch-helper": "^3.26.0", - "clsx": "^2.0.0", - "eta": "^2.2.0", - "fs-extra": "^11.1.1", - "lodash": "^4.17.21", - "tslib": "^2.6.0", - "utility-types": "^3.10.0" - }, - "engines": { - "node": ">=20.0" - }, - "peerDependencies": { - "react": "^18.0.0 || ^19.0.0", - "react-dom": "^18.0.0 || ^19.0.0" - } - }, - "node_modules/@docusaurus/theme-translations": { - "version": "3.9.2", - "resolved": "https://registry.npmjs.org/@docusaurus/theme-translations/-/theme-translations-3.9.2.tgz", - "integrity": "sha512-vIryvpP18ON9T9rjgMRFLr2xJVDpw1rtagEGf8Ccce4CkTrvM/fRB8N2nyWYOW5u3DdjkwKw5fBa+3tbn9P4PA==", - "dev": true, - "license": "MIT", - "dependencies": { - "fs-extra": "^11.1.1", - "tslib": "^2.6.0" - }, - "engines": { - "node": ">=20.0" - } - }, - "node_modules/@docusaurus/types": { - "version": "3.9.2", - "resolved": "https://registry.npmjs.org/@docusaurus/types/-/types-3.9.2.tgz", - "integrity": "sha512-Ux1JUNswg+EfUEmajJjyhIohKceitY/yzjRUpu04WXgvVz+fbhVC0p+R0JhvEu4ytw8zIAys2hrdpQPBHRIa8Q==", - "dev": true, - "license": "MIT", - "dependencies": { - "@mdx-js/mdx": "^3.0.0", - "@types/history": "^4.7.11", - "@types/mdast": "^4.0.2", - "@types/react": "*", - "commander": "^5.1.0", - "joi": "^17.9.2", - "react-helmet-async": "npm:@slorber/react-helmet-async@1.3.0", - "utility-types": "^3.10.0", - "webpack": "^5.95.0", - "webpack-merge": "^5.9.0" - }, - "peerDependencies": { - "react": "^18.0.0 || ^19.0.0", - "react-dom": "^18.0.0 || ^19.0.0" - } - }, - "node_modules/@docusaurus/types/node_modules/commander": { - "version": "5.1.0", - "resolved": "https://registry.npmjs.org/commander/-/commander-5.1.0.tgz", - "integrity": "sha512-P0CysNDQ7rtVw4QIQtm+MRxV66vKFSvlsQvGYXZWR3qFU0jlMKHZZZgw8e+8DSah4UDKMqnknRDQz+xuQXQ/Zg==", - "dev": true, - "license": "MIT", - "engines": { - "node": ">= 6" - } - }, - "node_modules/@docusaurus/types/node_modules/webpack-merge": { - "version": "5.10.0", - "resolved": "https://registry.npmjs.org/webpack-merge/-/webpack-merge-5.10.0.tgz", - "integrity": "sha512-+4zXKdx7UnO+1jaN4l2lHVD+mFvnlZQP/6ljaJVb4SZiwIKeUnrT5l0gkT8z+n4hKpC+jpOv6O9R+gLtag7pSA==", - "dev": true, - "license": "MIT", - "dependencies": { - "clone-deep": "^4.0.1", - "flat": "^5.0.2", - "wildcard": "^2.0.0" - }, - "engines": { - "node": ">=10.0.0" - } - }, - "node_modules/@docusaurus/utils": { - "version": "3.9.2", - "resolved": "https://registry.npmjs.org/@docusaurus/utils/-/utils-3.9.2.tgz", - "integrity": "sha512-lBSBiRruFurFKXr5Hbsl2thmGweAPmddhF3jb99U4EMDA5L+e5Y1rAkOS07Nvrup7HUMBDrCV45meaxZnt28nQ==", - "dev": true, - "license": "MIT", - "dependencies": { - "@docusaurus/logger": "3.9.2", - "@docusaurus/types": "3.9.2", - "@docusaurus/utils-common": "3.9.2", - "escape-string-regexp": "^4.0.0", - "execa": "5.1.1", - "file-loader": "^6.2.0", - "fs-extra": "^11.1.1", - "github-slugger": "^1.5.0", - "globby": "^11.1.0", - "gray-matter": "^4.0.3", - "jiti": "^1.20.0", - "js-yaml": "^4.1.0", - "lodash": "^4.17.21", - "micromatch": "^4.0.5", - "p-queue": "^6.6.2", - "prompts": "^2.4.2", - "resolve-pathname": "^3.0.0", - "tslib": "^2.6.0", - "url-loader": "^4.1.1", - "utility-types": "^3.10.0", - "webpack": "^5.88.1" - }, - "engines": { - "node": ">=20.0" - } - }, - "node_modules/@docusaurus/utils-common": { - "version": "3.9.2", - "resolved": "https://registry.npmjs.org/@docusaurus/utils-common/-/utils-common-3.9.2.tgz", - "integrity": "sha512-I53UC1QctruA6SWLvbjbhCpAw7+X7PePoe5pYcwTOEXD/PxeP8LnECAhTHHwWCblyUX5bMi4QLRkxvyZ+IT8Aw==", - "dev": true, - "license": "MIT", - "dependencies": { - "@docusaurus/types": "3.9.2", - "tslib": "^2.6.0" - }, - "engines": { - "node": ">=20.0" - } - }, - "node_modules/@docusaurus/utils-validation": { - "version": "3.9.2", - "resolved": "https://registry.npmjs.org/@docusaurus/utils-validation/-/utils-validation-3.9.2.tgz", - "integrity": "sha512-l7yk3X5VnNmATbwijJkexdhulNsQaNDwoagiwujXoxFbWLcxHQqNQ+c/IAlzrfMMOfa/8xSBZ7KEKDesE/2J7A==", - "dev": true, - "license": "MIT", - "dependencies": { - "@docusaurus/logger": "3.9.2", - "@docusaurus/utils": "3.9.2", - "@docusaurus/utils-common": "3.9.2", - "fs-extra": "^11.2.0", - "joi": "^17.9.2", - "js-yaml": "^4.1.0", - "lodash": "^4.17.21", - "tslib": "^2.6.0" - }, - "engines": { - "node": ">=20.0" + "node": ">=14" } }, "node_modules/@emnapi/core": { - "version": "1.4.5", - "resolved": "https://registry.npmjs.org/@emnapi/core/-/core-1.4.5.tgz", - "integrity": "sha512-XsLw1dEOpkSX/WucdqUhPWP7hDxSvZiY+fsUC14h+FtQ2Ifni4znbBt8punRX+Uj2JG/uDb8nEHVKvrVlvdZ5Q==", + "version": "1.8.1", + "resolved": "https://registry.npmjs.org/@emnapi/core/-/core-1.8.1.tgz", + "integrity": "sha512-AvT9QFpxK0Zd8J0jopedNm+w/2fIzvtPKPjqyw9jwvBaReTTqPBk9Hixaz7KbjimP+QNz605/XnjFcDAL2pqBg==", "dev": true, "license": "MIT", "optional": true, "dependencies": { - "@emnapi/wasi-threads": "1.0.4", + "@emnapi/wasi-threads": "1.1.0", "tslib": "^2.4.0" } }, "node_modules/@emnapi/runtime": { - "version": "1.4.5", - "resolved": "https://registry.npmjs.org/@emnapi/runtime/-/runtime-1.4.5.tgz", - "integrity": "sha512-++LApOtY0pEEz1zrd9vy1/zXVaVJJ/EbAF3u0fXIzPJEDtnITsBGbbK0EkM72amhl/R5b+5xx0Y/QhcVOpuulg==", + "version": "1.8.1", + "resolved": "https://registry.npmjs.org/@emnapi/runtime/-/runtime-1.8.1.tgz", + "integrity": "sha512-mehfKSMWjjNol8659Z8KxEMrdSJDDot5SXMq00dM8BN4o+CLNXQ0xH2V7EchNHV4RmbZLmmPdEaXZc5H2FXmDg==", "dev": true, "license": "MIT", "optional": true, @@ -4739,9 +822,9 @@ } }, "node_modules/@emnapi/wasi-threads": { - "version": "1.0.4", - "resolved": "https://registry.npmjs.org/@emnapi/wasi-threads/-/wasi-threads-1.0.4.tgz", - "integrity": "sha512-PJR+bOmMOPH8AtcTGAyYNiuJ3/Fcoj2XN/gBEWzDIKh254XO+mM9XoXHk5GNEhodxeMznbg7BlRojVbKN+gC6g==", + "version": "1.1.0", + "resolved": "https://registry.npmjs.org/@emnapi/wasi-threads/-/wasi-threads-1.1.0.tgz", + "integrity": "sha512-WI0DdZ8xFSbgMjR1sFsKABJ/C5OnRrjT06JXbZKexJGrDuPTzZdDYfFlsgcCXCyf+suG5QU2e/y1Wo2V/OapLQ==", "dev": true, "license": "MIT", "optional": true, @@ -4749,10 +832,452 @@ "tslib": "^2.4.0" } }, + "node_modules/@esbuild/aix-ppc64": { + "version": "0.25.12", + "resolved": "https://registry.npmjs.org/@esbuild/aix-ppc64/-/aix-ppc64-0.25.12.tgz", + "integrity": "sha512-Hhmwd6CInZ3dwpuGTF8fJG6yoWmsToE+vYgD4nytZVxcu1ulHpUQRAB1UJ8+N1Am3Mz4+xOByoQoSZf4D+CpkA==", + "cpu": [ + "ppc64" + ], + "dev": true, + "license": "MIT", + "optional": true, + "os": [ + "aix" + ], + "engines": { + "node": ">=18" + } + }, + "node_modules/@esbuild/android-arm": { + "version": "0.25.12", + "resolved": "https://registry.npmjs.org/@esbuild/android-arm/-/android-arm-0.25.12.tgz", + "integrity": "sha512-VJ+sKvNA/GE7Ccacc9Cha7bpS8nyzVv0jdVgwNDaR4gDMC/2TTRc33Ip8qrNYUcpkOHUT5OZ0bUcNNVZQ9RLlg==", + "cpu": [ + "arm" + ], + "dev": true, + "license": "MIT", + "optional": true, + "os": [ + "android" + ], + "engines": { + "node": ">=18" + } + }, + "node_modules/@esbuild/android-arm64": { + "version": "0.25.12", + "resolved": "https://registry.npmjs.org/@esbuild/android-arm64/-/android-arm64-0.25.12.tgz", + "integrity": "sha512-6AAmLG7zwD1Z159jCKPvAxZd4y/VTO0VkprYy+3N2FtJ8+BQWFXU+OxARIwA46c5tdD9SsKGZ/1ocqBS/gAKHg==", + "cpu": [ + "arm64" + ], + "dev": true, + "license": "MIT", + "optional": true, + "os": [ + "android" + ], + "engines": { + "node": ">=18" + } + }, + "node_modules/@esbuild/android-x64": { + "version": "0.25.12", + "resolved": "https://registry.npmjs.org/@esbuild/android-x64/-/android-x64-0.25.12.tgz", + "integrity": "sha512-5jbb+2hhDHx5phYR2By8GTWEzn6I9UqR11Kwf22iKbNpYrsmRB18aX/9ivc5cabcUiAT/wM+YIZ6SG9QO6a8kg==", + "cpu": [ + "x64" + ], + "dev": true, + "license": "MIT", + "optional": true, + "os": [ + "android" + ], + "engines": { + "node": ">=18" + } + }, + "node_modules/@esbuild/darwin-arm64": { + "version": "0.25.12", + "resolved": "https://registry.npmjs.org/@esbuild/darwin-arm64/-/darwin-arm64-0.25.12.tgz", + "integrity": "sha512-N3zl+lxHCifgIlcMUP5016ESkeQjLj/959RxxNYIthIg+CQHInujFuXeWbWMgnTo4cp5XVHqFPmpyu9J65C1Yg==", + "cpu": [ + "arm64" + ], + "dev": true, + "license": "MIT", + "optional": true, + "os": [ + "darwin" + ], + "engines": { + "node": ">=18" + } + }, + "node_modules/@esbuild/darwin-x64": { + "version": "0.25.12", + "resolved": "https://registry.npmjs.org/@esbuild/darwin-x64/-/darwin-x64-0.25.12.tgz", + "integrity": "sha512-HQ9ka4Kx21qHXwtlTUVbKJOAnmG1ipXhdWTmNXiPzPfWKpXqASVcWdnf2bnL73wgjNrFXAa3yYvBSd9pzfEIpA==", + "cpu": [ + "x64" + ], + "dev": true, + "license": "MIT", + "optional": true, + "os": [ + "darwin" + ], + "engines": { + "node": ">=18" + } + }, + "node_modules/@esbuild/freebsd-arm64": { + "version": "0.25.12", + "resolved": "https://registry.npmjs.org/@esbuild/freebsd-arm64/-/freebsd-arm64-0.25.12.tgz", + "integrity": "sha512-gA0Bx759+7Jve03K1S0vkOu5Lg/85dou3EseOGUes8flVOGxbhDDh/iZaoek11Y8mtyKPGF3vP8XhnkDEAmzeg==", + "cpu": [ + "arm64" + ], + "dev": true, + "license": "MIT", + "optional": true, + "os": [ + "freebsd" + ], + "engines": { + "node": ">=18" + } + }, + "node_modules/@esbuild/freebsd-x64": { + "version": "0.25.12", + "resolved": "https://registry.npmjs.org/@esbuild/freebsd-x64/-/freebsd-x64-0.25.12.tgz", + "integrity": "sha512-TGbO26Yw2xsHzxtbVFGEXBFH0FRAP7gtcPE7P5yP7wGy7cXK2oO7RyOhL5NLiqTlBh47XhmIUXuGciXEqYFfBQ==", + "cpu": [ + "x64" + ], + "dev": true, + "license": "MIT", + "optional": true, + "os": [ + "freebsd" + ], + "engines": { + "node": ">=18" + } + }, + "node_modules/@esbuild/linux-arm": { + "version": "0.25.12", + "resolved": "https://registry.npmjs.org/@esbuild/linux-arm/-/linux-arm-0.25.12.tgz", + "integrity": "sha512-lPDGyC1JPDou8kGcywY0YILzWlhhnRjdof3UlcoqYmS9El818LLfJJc3PXXgZHrHCAKs/Z2SeZtDJr5MrkxtOw==", + "cpu": [ + "arm" + ], + "dev": true, + "license": "MIT", + "optional": true, + "os": [ + "linux" + ], + "engines": { + "node": ">=18" + } + }, + "node_modules/@esbuild/linux-arm64": { + "version": "0.25.12", + "resolved": "https://registry.npmjs.org/@esbuild/linux-arm64/-/linux-arm64-0.25.12.tgz", + "integrity": "sha512-8bwX7a8FghIgrupcxb4aUmYDLp8pX06rGh5HqDT7bB+8Rdells6mHvrFHHW2JAOPZUbnjUpKTLg6ECyzvas2AQ==", + "cpu": [ + "arm64" + ], + "dev": true, + "license": "MIT", + "optional": true, + "os": [ + "linux" + ], + "engines": { + "node": ">=18" + } + }, + "node_modules/@esbuild/linux-ia32": { + "version": "0.25.12", + "resolved": "https://registry.npmjs.org/@esbuild/linux-ia32/-/linux-ia32-0.25.12.tgz", + "integrity": "sha512-0y9KrdVnbMM2/vG8KfU0byhUN+EFCny9+8g202gYqSSVMonbsCfLjUO+rCci7pM0WBEtz+oK/PIwHkzxkyharA==", + "cpu": [ + "ia32" + ], + "dev": true, + "license": "MIT", + "optional": true, + "os": [ + "linux" + ], + "engines": { + "node": ">=18" + } + }, + "node_modules/@esbuild/linux-loong64": { + "version": "0.25.12", + "resolved": "https://registry.npmjs.org/@esbuild/linux-loong64/-/linux-loong64-0.25.12.tgz", + "integrity": "sha512-h///Lr5a9rib/v1GGqXVGzjL4TMvVTv+s1DPoxQdz7l/AYv6LDSxdIwzxkrPW438oUXiDtwM10o9PmwS/6Z0Ng==", + "cpu": [ + "loong64" + ], + "dev": true, + "license": "MIT", + "optional": true, + "os": [ + "linux" + ], + "engines": { + "node": ">=18" + } + }, + "node_modules/@esbuild/linux-mips64el": { + "version": "0.25.12", + "resolved": "https://registry.npmjs.org/@esbuild/linux-mips64el/-/linux-mips64el-0.25.12.tgz", + "integrity": "sha512-iyRrM1Pzy9GFMDLsXn1iHUm18nhKnNMWscjmp4+hpafcZjrr2WbT//d20xaGljXDBYHqRcl8HnxbX6uaA/eGVw==", + "cpu": [ + "mips64el" + ], + "dev": true, + "license": "MIT", + "optional": true, + "os": [ + "linux" + ], + "engines": { + "node": ">=18" + } + }, + "node_modules/@esbuild/linux-ppc64": { + "version": "0.25.12", + "resolved": "https://registry.npmjs.org/@esbuild/linux-ppc64/-/linux-ppc64-0.25.12.tgz", + "integrity": "sha512-9meM/lRXxMi5PSUqEXRCtVjEZBGwB7P/D4yT8UG/mwIdze2aV4Vo6U5gD3+RsoHXKkHCfSxZKzmDssVlRj1QQA==", + "cpu": [ + "ppc64" + ], + "dev": true, + "license": "MIT", + "optional": true, + "os": [ + "linux" + ], + "engines": { + "node": ">=18" + } + }, + "node_modules/@esbuild/linux-riscv64": { + "version": "0.25.12", + "resolved": "https://registry.npmjs.org/@esbuild/linux-riscv64/-/linux-riscv64-0.25.12.tgz", + "integrity": "sha512-Zr7KR4hgKUpWAwb1f3o5ygT04MzqVrGEGXGLnj15YQDJErYu/BGg+wmFlIDOdJp0PmB0lLvxFIOXZgFRrdjR0w==", + "cpu": [ + "riscv64" + ], + "dev": true, + "license": "MIT", + "optional": true, + "os": [ + "linux" + ], + "engines": { + "node": ">=18" + } + }, + "node_modules/@esbuild/linux-s390x": { + "version": "0.25.12", + "resolved": "https://registry.npmjs.org/@esbuild/linux-s390x/-/linux-s390x-0.25.12.tgz", + "integrity": "sha512-MsKncOcgTNvdtiISc/jZs/Zf8d0cl/t3gYWX8J9ubBnVOwlk65UIEEvgBORTiljloIWnBzLs4qhzPkJcitIzIg==", + "cpu": [ + "s390x" + ], + "dev": true, + "license": "MIT", + "optional": true, + "os": [ + "linux" + ], + "engines": { + "node": ">=18" + } + }, + "node_modules/@esbuild/linux-x64": { + "version": "0.25.12", + "resolved": "https://registry.npmjs.org/@esbuild/linux-x64/-/linux-x64-0.25.12.tgz", + "integrity": "sha512-uqZMTLr/zR/ed4jIGnwSLkaHmPjOjJvnm6TVVitAa08SLS9Z0VM8wIRx7gWbJB5/J54YuIMInDquWyYvQLZkgw==", + "cpu": [ + "x64" + ], + "dev": true, + "license": "MIT", + "optional": true, + "os": [ + "linux" + ], + "engines": { + "node": ">=18" + } + }, + "node_modules/@esbuild/netbsd-arm64": { + "version": "0.25.12", + "resolved": "https://registry.npmjs.org/@esbuild/netbsd-arm64/-/netbsd-arm64-0.25.12.tgz", + "integrity": "sha512-xXwcTq4GhRM7J9A8Gv5boanHhRa/Q9KLVmcyXHCTaM4wKfIpWkdXiMog/KsnxzJ0A1+nD+zoecuzqPmCRyBGjg==", + "cpu": [ + "arm64" + ], + "dev": true, + "license": "MIT", + "optional": true, + "os": [ + "netbsd" + ], + "engines": { + "node": ">=18" + } + }, + "node_modules/@esbuild/netbsd-x64": { + "version": "0.25.12", + "resolved": "https://registry.npmjs.org/@esbuild/netbsd-x64/-/netbsd-x64-0.25.12.tgz", + "integrity": "sha512-Ld5pTlzPy3YwGec4OuHh1aCVCRvOXdH8DgRjfDy/oumVovmuSzWfnSJg+VtakB9Cm0gxNO9BzWkj6mtO1FMXkQ==", + "cpu": [ + "x64" + ], + "dev": true, + "license": "MIT", + "optional": true, + "os": [ + "netbsd" + ], + "engines": { + "node": ">=18" + } + }, + "node_modules/@esbuild/openbsd-arm64": { + "version": "0.25.12", + "resolved": "https://registry.npmjs.org/@esbuild/openbsd-arm64/-/openbsd-arm64-0.25.12.tgz", + "integrity": "sha512-fF96T6KsBo/pkQI950FARU9apGNTSlZGsv1jZBAlcLL1MLjLNIWPBkj5NlSz8aAzYKg+eNqknrUJ24QBybeR5A==", + "cpu": [ + "arm64" + ], + "dev": true, + "license": "MIT", + "optional": true, + "os": [ + "openbsd" + ], + "engines": { + "node": ">=18" + } + }, + "node_modules/@esbuild/openbsd-x64": { + "version": "0.25.12", + "resolved": "https://registry.npmjs.org/@esbuild/openbsd-x64/-/openbsd-x64-0.25.12.tgz", + "integrity": "sha512-MZyXUkZHjQxUvzK7rN8DJ3SRmrVrke8ZyRusHlP+kuwqTcfWLyqMOE3sScPPyeIXN/mDJIfGXvcMqCgYKekoQw==", + "cpu": [ + "x64" + ], + "dev": true, + "license": "MIT", + "optional": true, + "os": [ + "openbsd" + ], + "engines": { + "node": ">=18" + } + }, + "node_modules/@esbuild/openharmony-arm64": { + "version": "0.25.12", + "resolved": "https://registry.npmjs.org/@esbuild/openharmony-arm64/-/openharmony-arm64-0.25.12.tgz", + "integrity": "sha512-rm0YWsqUSRrjncSXGA7Zv78Nbnw4XL6/dzr20cyrQf7ZmRcsovpcRBdhD43Nuk3y7XIoW2OxMVvwuRvk9XdASg==", + "cpu": [ + "arm64" + ], + "dev": true, + "license": "MIT", + "optional": true, + "os": [ + "openharmony" + ], + "engines": { + "node": ">=18" + } + }, + "node_modules/@esbuild/sunos-x64": { + "version": "0.25.12", + "resolved": "https://registry.npmjs.org/@esbuild/sunos-x64/-/sunos-x64-0.25.12.tgz", + "integrity": "sha512-3wGSCDyuTHQUzt0nV7bocDy72r2lI33QL3gkDNGkod22EsYl04sMf0qLb8luNKTOmgF/eDEDP5BFNwoBKH441w==", + "cpu": [ + "x64" + ], + "dev": true, + "license": "MIT", + "optional": true, + "os": [ + "sunos" + ], + "engines": { + "node": ">=18" + } + }, + "node_modules/@esbuild/win32-arm64": { + "version": "0.25.12", + "resolved": "https://registry.npmjs.org/@esbuild/win32-arm64/-/win32-arm64-0.25.12.tgz", + "integrity": "sha512-rMmLrur64A7+DKlnSuwqUdRKyd3UE7oPJZmnljqEptesKM8wx9J8gx5u0+9Pq0fQQW8vqeKebwNXdfOyP+8Bsg==", + "cpu": [ + "arm64" + ], + "dev": true, + "license": "MIT", + "optional": true, + "os": [ + "win32" + ], + "engines": { + "node": ">=18" + } + }, + "node_modules/@esbuild/win32-ia32": { + "version": "0.25.12", + "resolved": "https://registry.npmjs.org/@esbuild/win32-ia32/-/win32-ia32-0.25.12.tgz", + "integrity": "sha512-HkqnmmBoCbCwxUKKNPBixiWDGCpQGVsrQfJoVGYLPT41XWF8lHuE5N6WhVia2n4o5QK5M4tYr21827fNhi4byQ==", + "cpu": [ + "ia32" + ], + "dev": true, + "license": "MIT", + "optional": true, + "os": [ + "win32" + ], + "engines": { + "node": ">=18" + } + }, + "node_modules/@esbuild/win32-x64": { + "version": "0.25.12", + "resolved": "https://registry.npmjs.org/@esbuild/win32-x64/-/win32-x64-0.25.12.tgz", + "integrity": "sha512-alJC0uCZpTFrSL0CCDjcgleBXPnCrEAhTBILpeAp7M/OFgoqtAetfBzX0xM00MUsVVPpVjlPuMbREqnZCXaTnA==", + "cpu": [ + "x64" + ], + "dev": true, + "license": "MIT", + "optional": true, + "os": [ + "win32" + ], + "engines": { + "node": ">=18" + } + }, "node_modules/@eslint-community/eslint-utils": { - "version": "4.7.0", - "resolved": "https://registry.npmjs.org/@eslint-community/eslint-utils/-/eslint-utils-4.7.0.tgz", - "integrity": "sha512-dyybb3AcajC7uha6CvhdVRJqaKyn7w2YKqKyAN37NKYgZT36w+iRb0Dymmc5qEJ549c/S31cMMSFd75bteCpCw==", + "version": "4.9.1", + "resolved": "https://registry.npmjs.org/@eslint-community/eslint-utils/-/eslint-utils-4.9.1.tgz", + "integrity": "sha512-phrYmNiYppR7znFEdqgfWHXR6NCkZEK7hwWDHZUjit/2/U0r6XvkDl0SYnoM51Hq7FhCGdLDT6zxCCOY1hexsQ==", "dev": true, "license": "MIT", "dependencies": { @@ -4782,9 +1307,9 @@ } }, "node_modules/@eslint-community/regexpp": { - "version": "4.12.1", - "resolved": "https://registry.npmjs.org/@eslint-community/regexpp/-/regexpp-4.12.1.tgz", - "integrity": "sha512-CCZCDJuduB9OUkFkY2IgppNZMi2lBQgD2qzwXkEia16cge2pijY/aXi96CJMquDMn3nJdlPV1A5KrJEXwfLNzQ==", + "version": "4.12.2", + "resolved": "https://registry.npmjs.org/@eslint-community/regexpp/-/regexpp-4.12.2.tgz", + "integrity": "sha512-EriSTlt5OC9/7SXkRSCAhfSxxoSUgBm33OH+IkwbdpgoqsSsUg7y3uh+IICI/Qg4BBWr3U2i39RpmycbxMq4ew==", "dev": true, "license": "MIT", "engines": { @@ -4792,13 +1317,13 @@ } }, "node_modules/@eslint/config-array": { - "version": "0.21.0", - "resolved": "https://registry.npmjs.org/@eslint/config-array/-/config-array-0.21.0.tgz", - "integrity": "sha512-ENIdc4iLu0d93HeYirvKmrzshzofPw6VkZRKQGe9Nv46ZnWUzcF1xV01dcvEg/1wXUR61OmmlSfyeyO7EvjLxQ==", + "version": "0.21.1", + "resolved": "https://registry.npmjs.org/@eslint/config-array/-/config-array-0.21.1.tgz", + "integrity": "sha512-aw1gNayWpdI/jSYVgzN5pL0cfzU02GT3NBpeT/DXbx1/1x7ZKxFPd9bwrzygx/qiwIQiJ1sw/zD8qY/kRvlGHA==", "dev": true, "license": "Apache-2.0", "dependencies": { - "@eslint/object-schema": "^2.1.6", + "@eslint/object-schema": "^2.1.7", "debug": "^4.3.1", "minimatch": "^3.1.2" }, @@ -4807,19 +1332,22 @@ } }, "node_modules/@eslint/config-helpers": { - "version": "0.3.1", - "resolved": "https://registry.npmjs.org/@eslint/config-helpers/-/config-helpers-0.3.1.tgz", - "integrity": "sha512-xR93k9WhrDYpXHORXpxVL5oHj3Era7wo6k/Wd8/IsQNnZUTzkGS29lyn3nAT05v6ltUuTFVCCYDEGfy2Or/sPA==", + "version": "0.4.2", + "resolved": "https://registry.npmjs.org/@eslint/config-helpers/-/config-helpers-0.4.2.tgz", + "integrity": "sha512-gBrxN88gOIf3R7ja5K9slwNayVcZgK6SOUORm2uBzTeIEfeVaIhOpCtTox3P6R7o2jLFwLFTLnC7kU/RGcYEgw==", "dev": true, "license": "Apache-2.0", + "dependencies": { + "@eslint/core": "^0.17.0" + }, "engines": { "node": "^18.18.0 || ^20.9.0 || >=21.1.0" } }, "node_modules/@eslint/core": { - "version": "0.15.2", - "resolved": "https://registry.npmjs.org/@eslint/core/-/core-0.15.2.tgz", - "integrity": "sha512-78Md3/Rrxh83gCxoUc0EiciuOHsIITzLy53m3d9UyiW8y9Dj2D29FeETqyKA+BRK76tnTp6RXWb3pCay8Oyomg==", + "version": "0.17.0", + "resolved": "https://registry.npmjs.org/@eslint/core/-/core-0.17.0.tgz", + "integrity": "sha512-yL/sLrpmtDaFEiUj1osRP4TI2MDz1AddJL+jZ7KSqvBuliN4xqYY54IfdN8qD8Toa6g1iloph1fxQNkjOxrrpQ==", "dev": true, "license": "Apache-2.0", "dependencies": { @@ -4830,9 +1358,9 @@ } }, "node_modules/@eslint/eslintrc": { - "version": "3.3.1", - "resolved": "https://registry.npmjs.org/@eslint/eslintrc/-/eslintrc-3.3.1.tgz", - "integrity": "sha512-gtF186CXhIl1p4pJNGZw8Yc6RlshoePRvE0X91oPGb3vZ8pM3qOS9W9NGPat9LziaBV7XrJWGylNQXkGcnM3IQ==", + "version": "3.3.3", + "resolved": "https://registry.npmjs.org/@eslint/eslintrc/-/eslintrc-3.3.3.tgz", + "integrity": "sha512-Kr+LPIUVKz2qkx1HAMH8q1q6azbqBAsXJUxBl/ODDuVPX45Z9DfwB8tPjTi6nNZ8BuM3nbJxC5zCAg5elnBUTQ==", "dev": true, "license": "MIT", "dependencies": { @@ -4842,7 +1370,7 @@ "globals": "^14.0.0", "ignore": "^5.2.0", "import-fresh": "^3.2.1", - "js-yaml": "^4.1.0", + "js-yaml": "^4.1.1", "minimatch": "^3.1.2", "strip-json-comments": "^3.1.1" }, @@ -4864,9 +1392,9 @@ } }, "node_modules/@eslint/js": { - "version": "9.34.0", - "resolved": "https://registry.npmjs.org/@eslint/js/-/js-9.34.0.tgz", - "integrity": "sha512-EoyvqQnBNsV1CWaEJ559rxXL4c8V92gxirbawSmVUOWXlsRxxQXl6LmCpdUblgxgSkDIqKnhzba2SjRTI/A5Rw==", + "version": "9.39.2", + "resolved": "https://registry.npmjs.org/@eslint/js/-/js-9.39.2.tgz", + "integrity": "sha512-q1mjIoW1VX4IvSocvM/vbTiveKC4k9eLrajNEuSsmjymSDEbpGddtpfOoN7YGAqBK3NG+uqo8ia4PDTt8buCYA==", "dev": true, "license": "MIT", "engines": { @@ -4877,9 +1405,9 @@ } }, "node_modules/@eslint/object-schema": { - "version": "2.1.6", - "resolved": "https://registry.npmjs.org/@eslint/object-schema/-/object-schema-2.1.6.tgz", - "integrity": "sha512-RBMg5FRL0I0gs51M/guSAj5/e14VQ4tpZnQNWwuDT66P14I43ItmPfIZRhO9fUVIPOAQXU47atlywZ/czoqFPA==", + "version": "2.1.7", + "resolved": "https://registry.npmjs.org/@eslint/object-schema/-/object-schema-2.1.7.tgz", + "integrity": "sha512-VtAOaymWVfZcmZbp6E2mympDIHvyjXs/12LqWYjVw6qjrfF+VK+fyG33kChz3nnK+SU5/NeHOqrTEHS8sXO3OA==", "dev": true, "license": "Apache-2.0", "engines": { @@ -4887,34 +1415,66 @@ } }, "node_modules/@eslint/plugin-kit": { - "version": "0.3.5", - "resolved": "https://registry.npmjs.org/@eslint/plugin-kit/-/plugin-kit-0.3.5.tgz", - "integrity": "sha512-Z5kJ+wU3oA7MMIqVR9tyZRtjYPr4OC004Q4Rw7pgOKUOKkJfZ3O24nz3WYfGRpMDNmcOi3TwQOmgm7B7Tpii0w==", + "version": "0.4.1", + "resolved": "https://registry.npmjs.org/@eslint/plugin-kit/-/plugin-kit-0.4.1.tgz", + "integrity": "sha512-43/qtrDUokr7LJqoF2c3+RInu/t4zfrpYdoSDfYyhg52rwLV6TnOvdG4fXm7IkSB3wErkcmJS9iEhjVtOSEjjA==", "dev": true, "license": "Apache-2.0", "dependencies": { - "@eslint/core": "^0.15.2", + "@eslint/core": "^0.17.0", "levn": "^0.4.1" }, "engines": { "node": "^18.18.0 || ^20.9.0 || >=21.1.0" } }, - "node_modules/@hapi/hoek": { - "version": "9.3.0", - "resolved": "https://registry.npmjs.org/@hapi/hoek/-/hoek-9.3.0.tgz", - "integrity": "sha512-/c6rf4UJlmHlC9b5BaNvzAcFv7HZ2QHaV0D4/HNlBdvFnvQq8RI4kYdhyPCl7Xj+oWvTWQ8ujhqS53LIgAe6KQ==", + "node_modules/@expressive-code/core": { + "version": "0.41.5", + "resolved": "https://registry.npmjs.org/@expressive-code/core/-/core-0.41.5.tgz", + "integrity": "sha512-II5TEy5eOoXiqPwqtpSqwamUd7lZS3YH3ofxR1ZyQMmygqORZn8/7SzgfF8G0kB7uKCBzFZT6RgKgCuHcJuPpA==", "dev": true, - "license": "BSD-3-Clause" - }, - "node_modules/@hapi/topo": { - "version": "5.1.0", - "resolved": "https://registry.npmjs.org/@hapi/topo/-/topo-5.1.0.tgz", - "integrity": "sha512-foQZKJig7Ob0BMAYBfcJk8d77QtOe7Wo4ox7ff1lQYoNNAb6jwcY1ncdoy2e9wQZzvNy7ODZCYJkK8kzmcAnAg==", - "dev": true, - "license": "BSD-3-Clause", + "license": "MIT", "dependencies": { - "@hapi/hoek": "^9.0.0" + "@ctrl/tinycolor": "^4.0.4", + "hast-util-select": "^6.0.2", + "hast-util-to-html": "^9.0.1", + "hast-util-to-text": "^4.0.1", + "hastscript": "^9.0.0", + "postcss": "^8.4.38", + "postcss-nested": "^6.0.1", + "unist-util-visit": "^5.0.0", + "unist-util-visit-parents": "^6.0.1" + } + }, + "node_modules/@expressive-code/plugin-frames": { + "version": "0.41.5", + "resolved": "https://registry.npmjs.org/@expressive-code/plugin-frames/-/plugin-frames-0.41.5.tgz", + "integrity": "sha512-qU0cvAQGfRLX7XwGf3/+hqIVmAc/mNNTlqVLR0iBfJF6EKvtP3R7/uAlPrAxnxQxn0meTazCz8D+PsPyOpHKrQ==", + "dev": true, + "license": "MIT", + "dependencies": { + "@expressive-code/core": "^0.41.5" + } + }, + "node_modules/@expressive-code/plugin-shiki": { + "version": "0.41.5", + "resolved": "https://registry.npmjs.org/@expressive-code/plugin-shiki/-/plugin-shiki-0.41.5.tgz", + "integrity": "sha512-gw6OWvnmDmvcKJ5AZSzl2VkuixJMQ/zWSwPLFNzitqCa8aPfIFunb0K8IIOsE43LELgOWkie9lRFspOxwDVwrg==", + "dev": true, + "license": "MIT", + "dependencies": { + "@expressive-code/core": "^0.41.5", + "shiki": "^3.2.2" + } + }, + "node_modules/@expressive-code/plugin-text-markers": { + "version": "0.41.5", + "resolved": "https://registry.npmjs.org/@expressive-code/plugin-text-markers/-/plugin-text-markers-0.41.5.tgz", + "integrity": "sha512-0DSiTsjWFEz6/iuLOGNNy2GaeCW41OwnVJMKx1tS+XKeQxAL89UkZP3egWNzxjWNHNMzEv3ZWWWYqbonEQlv/Q==", + "dev": true, + "license": "MIT", + "dependencies": { + "@expressive-code/core": "^0.41.5" } }, "node_modules/@humanfs/core": { @@ -4928,33 +1488,19 @@ } }, "node_modules/@humanfs/node": { - "version": "0.16.6", - "resolved": "https://registry.npmjs.org/@humanfs/node/-/node-0.16.6.tgz", - "integrity": "sha512-YuI2ZHQL78Q5HbhDiBA1X4LmYdXCKCMQIfw0pw7piHJwyREFebJUvrQN4cMssyES6x+vfUbx1CIpaQUKYdQZOw==", + "version": "0.16.7", + "resolved": "https://registry.npmjs.org/@humanfs/node/-/node-0.16.7.tgz", + "integrity": "sha512-/zUx+yOsIrG4Y43Eh2peDeKCxlRt/gET6aHfaKpuq267qXdYDFViVHfMaLyygZOnl0kGWxFIgsBy8QFuTLUXEQ==", "dev": true, "license": "Apache-2.0", "dependencies": { "@humanfs/core": "^0.19.1", - "@humanwhocodes/retry": "^0.3.0" + "@humanwhocodes/retry": "^0.4.0" }, "engines": { "node": ">=18.18.0" } }, - "node_modules/@humanfs/node/node_modules/@humanwhocodes/retry": { - "version": "0.3.1", - "resolved": "https://registry.npmjs.org/@humanwhocodes/retry/-/retry-0.3.1.tgz", - "integrity": "sha512-JBxkERygn7Bv/GbN5Rv8Ul6LVknS+5Bp6RgDC/O8gEBU/yeH5Ui5C/OlWrTb6qct7LjjfT6Re2NxB0ln0yYybA==", - "dev": true, - "license": "Apache-2.0", - "engines": { - "node": ">=18.18" - }, - "funding": { - "type": "github", - "url": "https://github.com/sponsors/nzakas" - } - }, "node_modules/@humanwhocodes/module-importer": { "version": "1.0.1", "resolved": "https://registry.npmjs.org/@humanwhocodes/module-importer/-/module-importer-1.0.1.tgz", @@ -4983,25 +1529,495 @@ "url": "https://github.com/sponsors/nzakas" } }, - "node_modules/@inquirer/external-editor": { - "version": "1.0.1", - "resolved": "https://registry.npmjs.org/@inquirer/external-editor/-/external-editor-1.0.1.tgz", - "integrity": "sha512-Oau4yL24d2B5IL4ma4UpbQigkVhzPDXLoqy1ggK4gnHg/stmkffJE4oOXHXF3uz0UEpywG68KcyXsyYpA1Re/Q==", + "node_modules/@img/colour": { + "version": "1.0.0", + "resolved": "https://registry.npmjs.org/@img/colour/-/colour-1.0.0.tgz", + "integrity": "sha512-A5P/LfWGFSl6nsckYtjw9da+19jB8hkJ6ACTGcDfEJ0aE+l2n2El7dsVM7UVHZQ9s2lmYMWlrS21YLy2IR1LUw==", + "dev": true, "license": "MIT", - "dependencies": { - "chardet": "^2.1.0", - "iconv-lite": "^0.6.3" - }, + "optional": true, "engines": { "node": ">=18" + } + }, + "node_modules/@img/sharp-darwin-arm64": { + "version": "0.33.5", + "resolved": "https://registry.npmjs.org/@img/sharp-darwin-arm64/-/sharp-darwin-arm64-0.33.5.tgz", + "integrity": "sha512-UT4p+iz/2H4twwAoLCqfA9UH5pI6DggwKEGuaPy7nCVQ8ZsiY5PIcrRvD1DzuY3qYL07NtIQcWnBSY/heikIFQ==", + "cpu": [ + "arm64" + ], + "dev": true, + "license": "Apache-2.0", + "optional": true, + "os": [ + "darwin" + ], + "engines": { + "node": "^18.17.0 || ^20.3.0 || >=21.0.0" }, - "peerDependencies": { - "@types/node": ">=18" + "funding": { + "url": "https://opencollective.com/libvips" }, - "peerDependenciesMeta": { - "@types/node": { - "optional": true - } + "optionalDependencies": { + "@img/sharp-libvips-darwin-arm64": "1.0.4" + } + }, + "node_modules/@img/sharp-darwin-x64": { + "version": "0.33.5", + "resolved": "https://registry.npmjs.org/@img/sharp-darwin-x64/-/sharp-darwin-x64-0.33.5.tgz", + "integrity": "sha512-fyHac4jIc1ANYGRDxtiqelIbdWkIuQaI84Mv45KvGRRxSAa7o7d1ZKAOBaYbnepLC1WqxfpimdeWfvqqSGwR2Q==", + "cpu": [ + "x64" + ], + "dev": true, + "license": "Apache-2.0", + "optional": true, + "os": [ + "darwin" + ], + "engines": { + "node": "^18.17.0 || ^20.3.0 || >=21.0.0" + }, + "funding": { + "url": "https://opencollective.com/libvips" + }, + "optionalDependencies": { + "@img/sharp-libvips-darwin-x64": "1.0.4" + } + }, + "node_modules/@img/sharp-libvips-darwin-arm64": { + "version": "1.0.4", + "resolved": "https://registry.npmjs.org/@img/sharp-libvips-darwin-arm64/-/sharp-libvips-darwin-arm64-1.0.4.tgz", + "integrity": "sha512-XblONe153h0O2zuFfTAbQYAX2JhYmDHeWikp1LM9Hul9gVPjFY427k6dFEcOL72O01QxQsWi761svJ/ev9xEDg==", + "cpu": [ + "arm64" + ], + "dev": true, + "license": "LGPL-3.0-or-later", + "optional": true, + "os": [ + "darwin" + ], + "funding": { + "url": "https://opencollective.com/libvips" + } + }, + "node_modules/@img/sharp-libvips-darwin-x64": { + "version": "1.0.4", + "resolved": "https://registry.npmjs.org/@img/sharp-libvips-darwin-x64/-/sharp-libvips-darwin-x64-1.0.4.tgz", + "integrity": "sha512-xnGR8YuZYfJGmWPvmlunFaWJsb9T/AO2ykoP3Fz/0X5XV2aoYBPkX6xqCQvUTKKiLddarLaxpzNe+b1hjeWHAQ==", + "cpu": [ + "x64" + ], + "dev": true, + "license": "LGPL-3.0-or-later", + "optional": true, + "os": [ + "darwin" + ], + "funding": { + "url": "https://opencollective.com/libvips" + } + }, + "node_modules/@img/sharp-libvips-linux-arm": { + "version": "1.0.5", + "resolved": "https://registry.npmjs.org/@img/sharp-libvips-linux-arm/-/sharp-libvips-linux-arm-1.0.5.tgz", + "integrity": "sha512-gvcC4ACAOPRNATg/ov8/MnbxFDJqf/pDePbBnuBDcjsI8PssmjoKMAz4LtLaVi+OnSb5FK/yIOamqDwGmXW32g==", + "cpu": [ + "arm" + ], + "dev": true, + "license": "LGPL-3.0-or-later", + "optional": true, + "os": [ + "linux" + ], + "funding": { + "url": "https://opencollective.com/libvips" + } + }, + "node_modules/@img/sharp-libvips-linux-arm64": { + "version": "1.0.4", + "resolved": "https://registry.npmjs.org/@img/sharp-libvips-linux-arm64/-/sharp-libvips-linux-arm64-1.0.4.tgz", + "integrity": "sha512-9B+taZ8DlyyqzZQnoeIvDVR/2F4EbMepXMc/NdVbkzsJbzkUjhXv/70GQJ7tdLA4YJgNP25zukcxpX2/SueNrA==", + "cpu": [ + "arm64" + ], + "dev": true, + "license": "LGPL-3.0-or-later", + "optional": true, + "os": [ + "linux" + ], + "funding": { + "url": "https://opencollective.com/libvips" + } + }, + "node_modules/@img/sharp-libvips-linux-ppc64": { + "version": "1.2.4", + "resolved": "https://registry.npmjs.org/@img/sharp-libvips-linux-ppc64/-/sharp-libvips-linux-ppc64-1.2.4.tgz", + "integrity": "sha512-FMuvGijLDYG6lW+b/UvyilUWu5Ayu+3r2d1S8notiGCIyYU/76eig1UfMmkZ7vwgOrzKzlQbFSuQfgm7GYUPpA==", + "cpu": [ + "ppc64" + ], + "dev": true, + "license": "LGPL-3.0-or-later", + "optional": true, + "os": [ + "linux" + ], + "funding": { + "url": "https://opencollective.com/libvips" + } + }, + "node_modules/@img/sharp-libvips-linux-riscv64": { + "version": "1.2.4", + "resolved": "https://registry.npmjs.org/@img/sharp-libvips-linux-riscv64/-/sharp-libvips-linux-riscv64-1.2.4.tgz", + "integrity": "sha512-oVDbcR4zUC0ce82teubSm+x6ETixtKZBh/qbREIOcI3cULzDyb18Sr/Wcyx7NRQeQzOiHTNbZFF1UwPS2scyGA==", + "cpu": [ + "riscv64" + ], + "dev": true, + "license": "LGPL-3.0-or-later", + "optional": true, + "os": [ + "linux" + ], + "funding": { + "url": "https://opencollective.com/libvips" + } + }, + "node_modules/@img/sharp-libvips-linux-s390x": { + "version": "1.0.4", + "resolved": "https://registry.npmjs.org/@img/sharp-libvips-linux-s390x/-/sharp-libvips-linux-s390x-1.0.4.tgz", + "integrity": "sha512-u7Wz6ntiSSgGSGcjZ55im6uvTrOxSIS8/dgoVMoiGE9I6JAfU50yH5BoDlYA1tcuGS7g/QNtetJnxA6QEsCVTA==", + "cpu": [ + "s390x" + ], + "dev": true, + "license": "LGPL-3.0-or-later", + "optional": true, + "os": [ + "linux" + ], + "funding": { + "url": "https://opencollective.com/libvips" + } + }, + "node_modules/@img/sharp-libvips-linux-x64": { + "version": "1.0.4", + "resolved": "https://registry.npmjs.org/@img/sharp-libvips-linux-x64/-/sharp-libvips-linux-x64-1.0.4.tgz", + "integrity": "sha512-MmWmQ3iPFZr0Iev+BAgVMb3ZyC4KeFc3jFxnNbEPas60e1cIfevbtuyf9nDGIzOaW9PdnDciJm+wFFaTlj5xYw==", + "cpu": [ + "x64" + ], + "dev": true, + "license": "LGPL-3.0-or-later", + "optional": true, + "os": [ + "linux" + ], + "funding": { + "url": "https://opencollective.com/libvips" + } + }, + "node_modules/@img/sharp-libvips-linuxmusl-arm64": { + "version": "1.0.4", + "resolved": "https://registry.npmjs.org/@img/sharp-libvips-linuxmusl-arm64/-/sharp-libvips-linuxmusl-arm64-1.0.4.tgz", + "integrity": "sha512-9Ti+BbTYDcsbp4wfYib8Ctm1ilkugkA/uscUn6UXK1ldpC1JjiXbLfFZtRlBhjPZ5o1NCLiDbg8fhUPKStHoTA==", + "cpu": [ + "arm64" + ], + "dev": true, + "license": "LGPL-3.0-or-later", + "optional": true, + "os": [ + "linux" + ], + "funding": { + "url": "https://opencollective.com/libvips" + } + }, + "node_modules/@img/sharp-libvips-linuxmusl-x64": { + "version": "1.0.4", + "resolved": "https://registry.npmjs.org/@img/sharp-libvips-linuxmusl-x64/-/sharp-libvips-linuxmusl-x64-1.0.4.tgz", + "integrity": "sha512-viYN1KX9m+/hGkJtvYYp+CCLgnJXwiQB39damAO7WMdKWlIhmYTfHjwSbQeUK/20vY154mwezd9HflVFM1wVSw==", + "cpu": [ + "x64" + ], + "dev": true, + "license": "LGPL-3.0-or-later", + "optional": true, + "os": [ + "linux" + ], + "funding": { + "url": "https://opencollective.com/libvips" + } + }, + "node_modules/@img/sharp-linux-arm": { + "version": "0.33.5", + "resolved": "https://registry.npmjs.org/@img/sharp-linux-arm/-/sharp-linux-arm-0.33.5.tgz", + "integrity": "sha512-JTS1eldqZbJxjvKaAkxhZmBqPRGmxgu+qFKSInv8moZ2AmT5Yib3EQ1c6gp493HvrvV8QgdOXdyaIBrhvFhBMQ==", + "cpu": [ + "arm" + ], + "dev": true, + "license": "Apache-2.0", + "optional": true, + "os": [ + "linux" + ], + "engines": { + "node": "^18.17.0 || ^20.3.0 || >=21.0.0" + }, + "funding": { + "url": "https://opencollective.com/libvips" + }, + "optionalDependencies": { + "@img/sharp-libvips-linux-arm": "1.0.5" + } + }, + "node_modules/@img/sharp-linux-arm64": { + "version": "0.33.5", + "resolved": "https://registry.npmjs.org/@img/sharp-linux-arm64/-/sharp-linux-arm64-0.33.5.tgz", + "integrity": "sha512-JMVv+AMRyGOHtO1RFBiJy/MBsgz0x4AWrT6QoEVVTyh1E39TrCUpTRI7mx9VksGX4awWASxqCYLCV4wBZHAYxA==", + "cpu": [ + "arm64" + ], + "dev": true, + "license": "Apache-2.0", + "optional": true, + "os": [ + "linux" + ], + "engines": { + "node": "^18.17.0 || ^20.3.0 || >=21.0.0" + }, + "funding": { + "url": "https://opencollective.com/libvips" + }, + "optionalDependencies": { + "@img/sharp-libvips-linux-arm64": "1.0.4" + } + }, + "node_modules/@img/sharp-linux-ppc64": { + "version": "0.34.5", + "resolved": "https://registry.npmjs.org/@img/sharp-linux-ppc64/-/sharp-linux-ppc64-0.34.5.tgz", + "integrity": "sha512-7zznwNaqW6YtsfrGGDA6BRkISKAAE1Jo0QdpNYXNMHu2+0dTrPflTLNkpc8l7MUP5M16ZJcUvysVWWrMefZquA==", + "cpu": [ + "ppc64" + ], + "dev": true, + "license": "Apache-2.0", + "optional": true, + "os": [ + "linux" + ], + "engines": { + "node": "^18.17.0 || ^20.3.0 || >=21.0.0" + }, + "funding": { + "url": "https://opencollective.com/libvips" + }, + "optionalDependencies": { + "@img/sharp-libvips-linux-ppc64": "1.2.4" + } + }, + "node_modules/@img/sharp-linux-riscv64": { + "version": "0.34.5", + "resolved": "https://registry.npmjs.org/@img/sharp-linux-riscv64/-/sharp-linux-riscv64-0.34.5.tgz", + "integrity": "sha512-51gJuLPTKa7piYPaVs8GmByo7/U7/7TZOq+cnXJIHZKavIRHAP77e3N2HEl3dgiqdD/w0yUfiJnII77PuDDFdw==", + "cpu": [ + "riscv64" + ], + "dev": true, + "license": "Apache-2.0", + "optional": true, + "os": [ + "linux" + ], + "engines": { + "node": "^18.17.0 || ^20.3.0 || >=21.0.0" + }, + "funding": { + "url": "https://opencollective.com/libvips" + }, + "optionalDependencies": { + "@img/sharp-libvips-linux-riscv64": "1.2.4" + } + }, + "node_modules/@img/sharp-linux-s390x": { + "version": "0.33.5", + "resolved": "https://registry.npmjs.org/@img/sharp-linux-s390x/-/sharp-linux-s390x-0.33.5.tgz", + "integrity": "sha512-y/5PCd+mP4CA/sPDKl2961b+C9d+vPAveS33s6Z3zfASk2j5upL6fXVPZi7ztePZ5CuH+1kW8JtvxgbuXHRa4Q==", + "cpu": [ + "s390x" + ], + "dev": true, + "license": "Apache-2.0", + "optional": true, + "os": [ + "linux" + ], + "engines": { + "node": "^18.17.0 || ^20.3.0 || >=21.0.0" + }, + "funding": { + "url": "https://opencollective.com/libvips" + }, + "optionalDependencies": { + "@img/sharp-libvips-linux-s390x": "1.0.4" + } + }, + "node_modules/@img/sharp-linux-x64": { + "version": "0.33.5", + "resolved": "https://registry.npmjs.org/@img/sharp-linux-x64/-/sharp-linux-x64-0.33.5.tgz", + "integrity": "sha512-opC+Ok5pRNAzuvq1AG0ar+1owsu842/Ab+4qvU879ippJBHvyY5n2mxF1izXqkPYlGuP/M556uh53jRLJmzTWA==", + "cpu": [ + "x64" + ], + "dev": true, + "license": "Apache-2.0", + "optional": true, + "os": [ + "linux" + ], + "engines": { + "node": "^18.17.0 || ^20.3.0 || >=21.0.0" + }, + "funding": { + "url": "https://opencollective.com/libvips" + }, + "optionalDependencies": { + "@img/sharp-libvips-linux-x64": "1.0.4" + } + }, + "node_modules/@img/sharp-linuxmusl-arm64": { + "version": "0.33.5", + "resolved": "https://registry.npmjs.org/@img/sharp-linuxmusl-arm64/-/sharp-linuxmusl-arm64-0.33.5.tgz", + "integrity": "sha512-XrHMZwGQGvJg2V/oRSUfSAfjfPxO+4DkiRh6p2AFjLQztWUuY/o8Mq0eMQVIY7HJ1CDQUJlxGGZRw1a5bqmd1g==", + "cpu": [ + "arm64" + ], + "dev": true, + "license": "Apache-2.0", + "optional": true, + "os": [ + "linux" + ], + "engines": { + "node": "^18.17.0 || ^20.3.0 || >=21.0.0" + }, + "funding": { + "url": "https://opencollective.com/libvips" + }, + "optionalDependencies": { + "@img/sharp-libvips-linuxmusl-arm64": "1.0.4" + } + }, + "node_modules/@img/sharp-linuxmusl-x64": { + "version": "0.33.5", + "resolved": "https://registry.npmjs.org/@img/sharp-linuxmusl-x64/-/sharp-linuxmusl-x64-0.33.5.tgz", + "integrity": "sha512-WT+d/cgqKkkKySYmqoZ8y3pxx7lx9vVejxW/W4DOFMYVSkErR+w7mf2u8m/y4+xHe7yY9DAXQMWQhpnMuFfScw==", + "cpu": [ + "x64" + ], + "dev": true, + "license": "Apache-2.0", + "optional": true, + "os": [ + "linux" + ], + "engines": { + "node": "^18.17.0 || ^20.3.0 || >=21.0.0" + }, + "funding": { + "url": "https://opencollective.com/libvips" + }, + "optionalDependencies": { + "@img/sharp-libvips-linuxmusl-x64": "1.0.4" + } + }, + "node_modules/@img/sharp-wasm32": { + "version": "0.33.5", + "resolved": "https://registry.npmjs.org/@img/sharp-wasm32/-/sharp-wasm32-0.33.5.tgz", + "integrity": "sha512-ykUW4LVGaMcU9lu9thv85CbRMAwfeadCJHRsg2GmeRa/cJxsVY9Rbd57JcMxBkKHag5U/x7TSBpScF4U8ElVzg==", + "cpu": [ + "wasm32" + ], + "dev": true, + "license": "Apache-2.0 AND LGPL-3.0-or-later AND MIT", + "optional": true, + "dependencies": { + "@emnapi/runtime": "^1.2.0" + }, + "engines": { + "node": "^18.17.0 || ^20.3.0 || >=21.0.0" + }, + "funding": { + "url": "https://opencollective.com/libvips" + } + }, + "node_modules/@img/sharp-win32-arm64": { + "version": "0.34.5", + "resolved": "https://registry.npmjs.org/@img/sharp-win32-arm64/-/sharp-win32-arm64-0.34.5.tgz", + "integrity": "sha512-WQ3AgWCWYSb2yt+IG8mnC6Jdk9Whs7O0gxphblsLvdhSpSTtmu69ZG1Gkb6NuvxsNACwiPV6cNSZNzt0KPsw7g==", + "cpu": [ + "arm64" + ], + "dev": true, + "license": "Apache-2.0 AND LGPL-3.0-or-later", + "optional": true, + "os": [ + "win32" + ], + "engines": { + "node": "^18.17.0 || ^20.3.0 || >=21.0.0" + }, + "funding": { + "url": "https://opencollective.com/libvips" + } + }, + "node_modules/@img/sharp-win32-ia32": { + "version": "0.33.5", + "resolved": "https://registry.npmjs.org/@img/sharp-win32-ia32/-/sharp-win32-ia32-0.33.5.tgz", + "integrity": "sha512-T36PblLaTwuVJ/zw/LaH0PdZkRz5rd3SmMHX8GSmR7vtNSP5Z6bQkExdSK7xGWyxLw4sUknBuugTelgw2faBbQ==", + "cpu": [ + "ia32" + ], + "dev": true, + "license": "Apache-2.0 AND LGPL-3.0-or-later", + "optional": true, + "os": [ + "win32" + ], + "engines": { + "node": "^18.17.0 || ^20.3.0 || >=21.0.0" + }, + "funding": { + "url": "https://opencollective.com/libvips" + } + }, + "node_modules/@img/sharp-win32-x64": { + "version": "0.33.5", + "resolved": "https://registry.npmjs.org/@img/sharp-win32-x64/-/sharp-win32-x64-0.33.5.tgz", + "integrity": "sha512-MpY/o8/8kj+EcnxwvrP4aTJSWw/aZ7JIGR4aBeZkZw5B7/Jn+tY9/VNwtcoGmdT7GfggGIU4kygOMSbYnOrAbg==", + "cpu": [ + "x64" + ], + "dev": true, + "license": "Apache-2.0 AND LGPL-3.0-or-later", + "optional": true, + "os": [ + "win32" + ], + "engines": { + "node": "^18.17.0 || ^20.3.0 || >=21.0.0" + }, + "funding": { + "url": "https://opencollective.com/libvips" } }, "node_modules/@isaacs/balanced-match": { @@ -5043,9 +2059,9 @@ } }, "node_modules/@isaacs/cliui/node_modules/ansi-regex": { - "version": "6.2.0", - "resolved": "https://registry.npmjs.org/ansi-regex/-/ansi-regex-6.2.0.tgz", - "integrity": "sha512-TKY5pyBkHyADOPYlRT9Lx6F544mPl0vS5Ew7BJ45hA08Q+t3GjbueLliBWN3sMICk6+y7HdyxSzC4bWS8baBdg==", + "version": "6.2.2", + "resolved": "https://registry.npmjs.org/ansi-regex/-/ansi-regex-6.2.2.tgz", + "integrity": "sha512-Bq3SmSpyFHaWjPk8If9yc6svM8c56dB5BAtW4Qbw5jHTwwXXcTLoRMkpDJp6VL0XzlWaCHTXrkFURMYmD0sLqg==", "license": "MIT", "engines": { "node": ">=12" @@ -5055,9 +2071,9 @@ } }, "node_modules/@isaacs/cliui/node_modules/ansi-styles": { - "version": "6.2.1", - "resolved": "https://registry.npmjs.org/ansi-styles/-/ansi-styles-6.2.1.tgz", - "integrity": "sha512-bN798gFfQX+viw3R7yrGWRqnrN2oRkEkUjjl4JNn4E8GxxbjtG3FbrEIIY3l8/hrwUwIeCZvi4QuOTP4MErVug==", + "version": "6.2.3", + "resolved": "https://registry.npmjs.org/ansi-styles/-/ansi-styles-6.2.3.tgz", + "integrity": "sha512-4Dj6M28JB+oAH8kFkTLUo+a2jwOFkuqb3yucU0CANcRRUbxS0cP0nZYCGjcc3BNXwRIsUVmDGgzawme7zvJHvg==", "license": "MIT", "engines": { "node": ">=12" @@ -5090,9 +2106,9 @@ } }, "node_modules/@isaacs/cliui/node_modules/strip-ansi": { - "version": "7.1.0", - "resolved": "https://registry.npmjs.org/strip-ansi/-/strip-ansi-7.1.0.tgz", - "integrity": "sha512-iq6eVVI64nQQTRYq2KtEg2d2uU7LElhTJwsH4YzIHZshxlgZms/wIc4VoDQTlG/IvVIrBKG06CrZnp0qv7hkcQ==", + "version": "7.1.2", + "resolved": "https://registry.npmjs.org/strip-ansi/-/strip-ansi-7.1.2.tgz", + "integrity": "sha512-gmBGslpoQJtgnMAvOVqGZpEz9dyoKTCzy2nfz/n8aIFhN/jCE/rCmcxabB6jOOHV+0WNnylOxaxBQPSvcWklhA==", "license": "MIT", "dependencies": { "ansi-regex": "^6.0.1" @@ -5148,6 +2164,16 @@ "sprintf-js": "~1.0.2" } }, + "node_modules/@istanbuljs/load-nyc-config/node_modules/camelcase": { + "version": "5.3.1", + "resolved": "https://registry.npmjs.org/camelcase/-/camelcase-5.3.1.tgz", + "integrity": "sha512-L28STB170nwWS63UjtlEOE3dldQApaJXZkOI1uMFfzf3rRuPegHaHesyee+YxQ+W6SvRDQV6UrdOdRiR153wJg==", + "dev": true, + "license": "MIT", + "engines": { + "node": ">=6" + } + }, "node_modules/@istanbuljs/load-nyc-config/node_modules/find-up": { "version": "4.1.0", "resolved": "https://registry.npmjs.org/find-up/-/find-up-4.1.0.tgz", @@ -5239,17 +2265,17 @@ } }, "node_modules/@jest/console": { - "version": "30.0.5", - "resolved": "https://registry.npmjs.org/@jest/console/-/console-30.0.5.tgz", - "integrity": "sha512-xY6b0XiL0Nav3ReresUarwl2oIz1gTnxGbGpho9/rbUWsLH0f1OD/VT84xs8c7VmH7MChnLb0pag6PhZhAdDiA==", + "version": "30.2.0", + "resolved": "https://registry.npmjs.org/@jest/console/-/console-30.2.0.tgz", + "integrity": "sha512-+O1ifRjkvYIkBqASKWgLxrpEhQAAE7hY77ALLUufSk5717KfOShg6IbqLmdsLMPdUiFvA2kTs0R7YZy+l0IzZQ==", "dev": true, "license": "MIT", "dependencies": { - "@jest/types": "30.0.5", + "@jest/types": "30.2.0", "@types/node": "*", "chalk": "^4.1.2", - "jest-message-util": "30.0.5", - "jest-util": "30.0.5", + "jest-message-util": "30.2.0", + "jest-util": "30.2.0", "slash": "^3.0.0" }, "engines": { @@ -5257,39 +2283,39 @@ } }, "node_modules/@jest/core": { - "version": "30.0.5", - "resolved": "https://registry.npmjs.org/@jest/core/-/core-30.0.5.tgz", - "integrity": "sha512-fKD0OulvRsXF1hmaFgHhVJzczWzA1RXMMo9LTPuFXo9q/alDbME3JIyWYqovWsUBWSoBcsHaGPSLF9rz4l9Qeg==", + "version": "30.2.0", + "resolved": "https://registry.npmjs.org/@jest/core/-/core-30.2.0.tgz", + "integrity": "sha512-03W6IhuhjqTlpzh/ojut/pDB2LPRygyWX8ExpgHtQA8H/3K7+1vKmcINx5UzeOX1se6YEsBsOHQ1CRzf3fOwTQ==", "dev": true, "license": "MIT", "dependencies": { - "@jest/console": "30.0.5", + "@jest/console": "30.2.0", "@jest/pattern": "30.0.1", - "@jest/reporters": "30.0.5", - "@jest/test-result": "30.0.5", - "@jest/transform": "30.0.5", - "@jest/types": "30.0.5", + "@jest/reporters": "30.2.0", + "@jest/test-result": "30.2.0", + "@jest/transform": "30.2.0", + "@jest/types": "30.2.0", "@types/node": "*", "ansi-escapes": "^4.3.2", "chalk": "^4.1.2", "ci-info": "^4.2.0", "exit-x": "^0.2.2", "graceful-fs": "^4.2.11", - "jest-changed-files": "30.0.5", - "jest-config": "30.0.5", - "jest-haste-map": "30.0.5", - "jest-message-util": "30.0.5", + "jest-changed-files": "30.2.0", + "jest-config": "30.2.0", + "jest-haste-map": "30.2.0", + "jest-message-util": "30.2.0", "jest-regex-util": "30.0.1", - "jest-resolve": "30.0.5", - "jest-resolve-dependencies": "30.0.5", - "jest-runner": "30.0.5", - "jest-runtime": "30.0.5", - "jest-snapshot": "30.0.5", - "jest-util": "30.0.5", - "jest-validate": "30.0.5", - "jest-watcher": "30.0.5", + "jest-resolve": "30.2.0", + "jest-resolve-dependencies": "30.2.0", + "jest-runner": "30.2.0", + "jest-runtime": "30.2.0", + "jest-snapshot": "30.2.0", + "jest-util": "30.2.0", + "jest-validate": "30.2.0", + "jest-watcher": "30.2.0", "micromatch": "^4.0.8", - "pretty-format": "30.0.5", + "pretty-format": "30.2.0", "slash": "^3.0.0" }, "engines": { @@ -5315,70 +2341,70 @@ } }, "node_modules/@jest/environment": { - "version": "30.0.5", - "resolved": "https://registry.npmjs.org/@jest/environment/-/environment-30.0.5.tgz", - "integrity": "sha512-aRX7WoaWx1oaOkDQvCWImVQ8XNtdv5sEWgk4gxR6NXb7WBUnL5sRak4WRzIQRZ1VTWPvV4VI4mgGjNL9TeKMYA==", + "version": "30.2.0", + "resolved": "https://registry.npmjs.org/@jest/environment/-/environment-30.2.0.tgz", + "integrity": "sha512-/QPTL7OBJQ5ac09UDRa3EQes4gt1FTEG/8jZ/4v5IVzx+Cv7dLxlVIvfvSVRiiX2drWyXeBjkMSR8hvOWSog5g==", "dev": true, "license": "MIT", "dependencies": { - "@jest/fake-timers": "30.0.5", - "@jest/types": "30.0.5", + "@jest/fake-timers": "30.2.0", + "@jest/types": "30.2.0", "@types/node": "*", - "jest-mock": "30.0.5" + "jest-mock": "30.2.0" }, "engines": { "node": "^18.14.0 || ^20.0.0 || ^22.0.0 || >=24.0.0" } }, "node_modules/@jest/expect": { - "version": "30.0.5", - "resolved": "https://registry.npmjs.org/@jest/expect/-/expect-30.0.5.tgz", - "integrity": "sha512-6udac8KKrtTtC+AXZ2iUN/R7dp7Ydry+Fo6FPFnDG54wjVMnb6vW/XNlf7Xj8UDjAE3aAVAsR4KFyKk3TCXmTA==", + "version": "30.2.0", + "resolved": "https://registry.npmjs.org/@jest/expect/-/expect-30.2.0.tgz", + "integrity": "sha512-V9yxQK5erfzx99Sf+7LbhBwNWEZ9eZay8qQ9+JSC0TrMR1pMDHLMY+BnVPacWU6Jamrh252/IKo4F1Xn/zfiqA==", "dev": true, "license": "MIT", "dependencies": { - "expect": "30.0.5", - "jest-snapshot": "30.0.5" + "expect": "30.2.0", + "jest-snapshot": "30.2.0" }, "engines": { "node": "^18.14.0 || ^20.0.0 || ^22.0.0 || >=24.0.0" } }, "node_modules/@jest/expect-utils": { - "version": "30.0.5", - "resolved": "https://registry.npmjs.org/@jest/expect-utils/-/expect-utils-30.0.5.tgz", - "integrity": "sha512-F3lmTT7CXWYywoVUGTCmom0vXq3HTTkaZyTAzIy+bXSBizB7o5qzlC9VCtq0arOa8GqmNsbg/cE9C6HLn7Szew==", + "version": "30.2.0", + "resolved": "https://registry.npmjs.org/@jest/expect-utils/-/expect-utils-30.2.0.tgz", + "integrity": "sha512-1JnRfhqpD8HGpOmQp180Fo9Zt69zNtC+9lR+kT7NVL05tNXIi+QC8Csz7lfidMoVLPD3FnOtcmp0CEFnxExGEA==", "dev": true, "license": "MIT", "dependencies": { - "@jest/get-type": "30.0.1" + "@jest/get-type": "30.1.0" }, "engines": { "node": "^18.14.0 || ^20.0.0 || ^22.0.0 || >=24.0.0" } }, "node_modules/@jest/fake-timers": { - "version": "30.0.5", - "resolved": "https://registry.npmjs.org/@jest/fake-timers/-/fake-timers-30.0.5.tgz", - "integrity": "sha512-ZO5DHfNV+kgEAeP3gK3XlpJLL4U3Sz6ebl/n68Uwt64qFFs5bv4bfEEjyRGK5uM0C90ewooNgFuKMdkbEoMEXw==", + "version": "30.2.0", + "resolved": "https://registry.npmjs.org/@jest/fake-timers/-/fake-timers-30.2.0.tgz", + "integrity": "sha512-HI3tRLjRxAbBy0VO8dqqm7Hb2mIa8d5bg/NJkyQcOk7V118ObQML8RC5luTF/Zsg4474a+gDvhce7eTnP4GhYw==", "dev": true, "license": "MIT", "dependencies": { - "@jest/types": "30.0.5", + "@jest/types": "30.2.0", "@sinonjs/fake-timers": "^13.0.0", "@types/node": "*", - "jest-message-util": "30.0.5", - "jest-mock": "30.0.5", - "jest-util": "30.0.5" + "jest-message-util": "30.2.0", + "jest-mock": "30.2.0", + "jest-util": "30.2.0" }, "engines": { "node": "^18.14.0 || ^20.0.0 || ^22.0.0 || >=24.0.0" } }, "node_modules/@jest/get-type": { - "version": "30.0.1", - "resolved": "https://registry.npmjs.org/@jest/get-type/-/get-type-30.0.1.tgz", - "integrity": "sha512-AyYdemXCptSRFirI5EPazNxyPwAL0jXt3zceFjaj8NFiKP9pOi0bfXonf6qkf82z2t3QWPeLCWWw4stPBzctLw==", + "version": "30.1.0", + "resolved": "https://registry.npmjs.org/@jest/get-type/-/get-type-30.1.0.tgz", + "integrity": "sha512-eMbZE2hUnx1WV0pmURZY9XoXPkUYjpc55mb0CrhtdWLtzMQPFvu/rZkTLZFTsdaVQa+Tr4eWAteqcUzoawq/uA==", "dev": true, "license": "MIT", "engines": { @@ -5386,16 +2412,16 @@ } }, "node_modules/@jest/globals": { - "version": "30.0.5", - "resolved": "https://registry.npmjs.org/@jest/globals/-/globals-30.0.5.tgz", - "integrity": "sha512-7oEJT19WW4oe6HR7oLRvHxwlJk2gev0U9px3ufs8sX9PoD1Eza68KF0/tlN7X0dq/WVsBScXQGgCldA1V9Y/jA==", + "version": "30.2.0", + "resolved": "https://registry.npmjs.org/@jest/globals/-/globals-30.2.0.tgz", + "integrity": "sha512-b63wmnKPaK+6ZZfpYhz9K61oybvbI1aMcIs80++JI1O1rR1vaxHUCNqo3ITu6NU0d4V34yZFoHMn/uoKr/Rwfw==", "dev": true, "license": "MIT", "dependencies": { - "@jest/environment": "30.0.5", - "@jest/expect": "30.0.5", - "@jest/types": "30.0.5", - "jest-mock": "30.0.5" + "@jest/environment": "30.2.0", + "@jest/expect": "30.2.0", + "@jest/types": "30.2.0", + "jest-mock": "30.2.0" }, "engines": { "node": "^18.14.0 || ^20.0.0 || ^22.0.0 || >=24.0.0" @@ -5416,17 +2442,17 @@ } }, "node_modules/@jest/reporters": { - "version": "30.0.5", - "resolved": "https://registry.npmjs.org/@jest/reporters/-/reporters-30.0.5.tgz", - "integrity": "sha512-mafft7VBX4jzED1FwGC1o/9QUM2xebzavImZMeqnsklgcyxBto8mV4HzNSzUrryJ+8R9MFOM3HgYuDradWR+4g==", + "version": "30.2.0", + "resolved": "https://registry.npmjs.org/@jest/reporters/-/reporters-30.2.0.tgz", + "integrity": "sha512-DRyW6baWPqKMa9CzeiBjHwjd8XeAyco2Vt8XbcLFjiwCOEKOvy82GJ8QQnJE9ofsxCMPjH4MfH8fCWIHHDKpAQ==", "dev": true, "license": "MIT", "dependencies": { "@bcoe/v8-coverage": "^0.2.3", - "@jest/console": "30.0.5", - "@jest/test-result": "30.0.5", - "@jest/transform": "30.0.5", - "@jest/types": "30.0.5", + "@jest/console": "30.2.0", + "@jest/test-result": "30.2.0", + "@jest/transform": "30.2.0", + "@jest/types": "30.2.0", "@jridgewell/trace-mapping": "^0.3.25", "@types/node": "*", "chalk": "^4.1.2", @@ -5439,9 +2465,9 @@ "istanbul-lib-report": "^3.0.0", "istanbul-lib-source-maps": "^5.0.0", "istanbul-reports": "^3.1.3", - "jest-message-util": "30.0.5", - "jest-util": "30.0.5", - "jest-worker": "30.0.5", + "jest-message-util": "30.2.0", + "jest-util": "30.2.0", + "jest-worker": "30.2.0", "slash": "^3.0.0", "string-length": "^4.0.2", "v8-to-istanbul": "^9.0.1" @@ -5458,6 +2484,13 @@ } } }, + "node_modules/@jest/reporters/node_modules/@bcoe/v8-coverage": { + "version": "0.2.3", + "resolved": "https://registry.npmjs.org/@bcoe/v8-coverage/-/v8-coverage-0.2.3.tgz", + "integrity": "sha512-0hYQ8SB4Db5zvZB4axdMHGwEaQjkZzFjQiN9LVYvIFB2nSUHW9tYpxWriPrWDASIxiaXax83REcLxuSdnGPZtw==", + "dev": true, + "license": "MIT" + }, "node_modules/@jest/reporters/node_modules/brace-expansion": { "version": "2.0.2", "resolved": "https://registry.npmjs.org/brace-expansion/-/brace-expansion-2.0.2.tgz", @@ -5559,13 +2592,13 @@ } }, "node_modules/@jest/snapshot-utils": { - "version": "30.0.5", - "resolved": "https://registry.npmjs.org/@jest/snapshot-utils/-/snapshot-utils-30.0.5.tgz", - "integrity": "sha512-XcCQ5qWHLvi29UUrowgDFvV4t7ETxX91CbDczMnoqXPOIcZOxyNdSjm6kV5XMc8+HkxfRegU/MUmnTbJRzGrUQ==", + "version": "30.2.0", + "resolved": "https://registry.npmjs.org/@jest/snapshot-utils/-/snapshot-utils-30.2.0.tgz", + "integrity": "sha512-0aVxM3RH6DaiLcjj/b0KrIBZhSX1373Xci4l3cW5xiUWPctZ59zQ7jj4rqcJQ/Z8JuN/4wX3FpJSa3RssVvCug==", "dev": true, "license": "MIT", "dependencies": { - "@jest/types": "30.0.5", + "@jest/types": "30.2.0", "chalk": "^4.1.2", "graceful-fs": "^4.2.11", "natural-compare": "^1.4.0" @@ -5590,14 +2623,14 @@ } }, "node_modules/@jest/test-result": { - "version": "30.0.5", - "resolved": "https://registry.npmjs.org/@jest/test-result/-/test-result-30.0.5.tgz", - "integrity": "sha512-wPyztnK0gbDMQAJZ43tdMro+qblDHH1Ru/ylzUo21TBKqt88ZqnKKK2m30LKmLLoKtR2lxdpCC/P3g1vfKcawQ==", + "version": "30.2.0", + "resolved": "https://registry.npmjs.org/@jest/test-result/-/test-result-30.2.0.tgz", + "integrity": "sha512-RF+Z+0CCHkARz5HT9mcQCBulb1wgCP3FBvl9VFokMX27acKphwyQsNuWH3c+ojd1LeWBLoTYoxF0zm6S/66mjg==", "dev": true, "license": "MIT", "dependencies": { - "@jest/console": "30.0.5", - "@jest/types": "30.0.5", + "@jest/console": "30.2.0", + "@jest/types": "30.2.0", "@types/istanbul-lib-coverage": "^2.0.6", "collect-v8-coverage": "^1.0.2" }, @@ -5606,15 +2639,15 @@ } }, "node_modules/@jest/test-sequencer": { - "version": "30.0.5", - "resolved": "https://registry.npmjs.org/@jest/test-sequencer/-/test-sequencer-30.0.5.tgz", - "integrity": "sha512-Aea/G1egWoIIozmDD7PBXUOxkekXl7ueGzrsGGi1SbeKgQqCYCIf+wfbflEbf2LiPxL8j2JZGLyrzZagjvW4YQ==", + "version": "30.2.0", + "resolved": "https://registry.npmjs.org/@jest/test-sequencer/-/test-sequencer-30.2.0.tgz", + "integrity": "sha512-wXKgU/lk8fKXMu/l5Hog1R61bL4q5GCdT6OJvdAFz1P+QrpoFuLU68eoKuVc4RbrTtNnTL5FByhWdLgOPSph+Q==", "dev": true, "license": "MIT", "dependencies": { - "@jest/test-result": "30.0.5", + "@jest/test-result": "30.2.0", "graceful-fs": "^4.2.11", - "jest-haste-map": "30.0.5", + "jest-haste-map": "30.2.0", "slash": "^3.0.0" }, "engines": { @@ -5622,23 +2655,23 @@ } }, "node_modules/@jest/transform": { - "version": "30.0.5", - "resolved": "https://registry.npmjs.org/@jest/transform/-/transform-30.0.5.tgz", - "integrity": "sha512-Vk8amLQCmuZyy6GbBht1Jfo9RSdBtg7Lks+B0PecnjI8J+PCLQPGh7uI8Q/2wwpW2gLdiAfiHNsmekKlywULqg==", + "version": "30.2.0", + "resolved": "https://registry.npmjs.org/@jest/transform/-/transform-30.2.0.tgz", + "integrity": "sha512-XsauDV82o5qXbhalKxD7p4TZYYdwcaEXC77PPD2HixEFF+6YGppjrAAQurTl2ECWcEomHBMMNS9AH3kcCFx8jA==", "dev": true, "license": "MIT", "dependencies": { "@babel/core": "^7.27.4", - "@jest/types": "30.0.5", + "@jest/types": "30.2.0", "@jridgewell/trace-mapping": "^0.3.25", - "babel-plugin-istanbul": "^7.0.0", + "babel-plugin-istanbul": "^7.0.1", "chalk": "^4.1.2", "convert-source-map": "^2.0.0", "fast-json-stable-stringify": "^2.1.0", "graceful-fs": "^4.2.11", - "jest-haste-map": "30.0.5", + "jest-haste-map": "30.2.0", "jest-regex-util": "30.0.1", - "jest-util": "30.0.5", + "jest-util": "30.2.0", "micromatch": "^4.0.8", "pirates": "^4.0.7", "slash": "^3.0.0", @@ -5649,9 +2682,9 @@ } }, "node_modules/@jest/types": { - "version": "30.0.5", - "resolved": "https://registry.npmjs.org/@jest/types/-/types-30.0.5.tgz", - "integrity": "sha512-aREYa3aku9SSnea4aX6bhKn4bgv3AXkgijoQgbYV3yvbiGt6z+MQ85+6mIhx9DsKW2BuB/cLR/A+tcMThx+KLQ==", + "version": "30.2.0", + "resolved": "https://registry.npmjs.org/@jest/types/-/types-30.2.0.tgz", + "integrity": "sha512-H9xg1/sfVvyfU7o3zMfBEjQ1gcsdeTMgqHoYdN79tuLqfTtuu7WckRA1R5whDwOzxaZAeMKTYWqP+WCAi0CHsg==", "dev": true, "license": "MIT", "dependencies": { @@ -5678,6 +2711,17 @@ "@jridgewell/trace-mapping": "^0.3.24" } }, + "node_modules/@jridgewell/remapping": { + "version": "2.3.5", + "resolved": "https://registry.npmjs.org/@jridgewell/remapping/-/remapping-2.3.5.tgz", + "integrity": "sha512-LI9u/+laYG4Ds1TDKSJW2YPrIlcVYOwi2fUC6xB43lueCjgxV4lffOCZCtYFiH6TNOX+tQKXx97T4IKHbhyHEQ==", + "dev": true, + "license": "MIT", + "dependencies": { + "@jridgewell/gen-mapping": "^0.3.5", + "@jridgewell/trace-mapping": "^0.3.24" + } + }, "node_modules/@jridgewell/resolve-uri": { "version": "3.1.2", "resolved": "https://registry.npmjs.org/@jridgewell/resolve-uri/-/resolve-uri-3.1.2.tgz", @@ -5688,17 +2732,6 @@ "node": ">=6.0.0" } }, - "node_modules/@jridgewell/source-map": { - "version": "0.3.11", - "resolved": "https://registry.npmjs.org/@jridgewell/source-map/-/source-map-0.3.11.tgz", - "integrity": "sha512-ZMp1V8ZFcPG5dIWnQLr3NSI1MiCU7UETdS/A0G8V/XWHvJv3ZsFqutJn1Y5RPmAPX6F3BiE397OqveU/9NCuIA==", - "dev": true, - "license": "MIT", - "dependencies": { - "@jridgewell/gen-mapping": "^0.3.5", - "@jridgewell/trace-mapping": "^0.3.25" - } - }, "node_modules/@jridgewell/sourcemap-codec": { "version": "1.5.5", "resolved": "https://registry.npmjs.org/@jridgewell/sourcemap-codec/-/sourcemap-codec-1.5.5.tgz", @@ -5707,9 +2740,9 @@ "license": "MIT" }, "node_modules/@jridgewell/trace-mapping": { - "version": "0.3.30", - "resolved": "https://registry.npmjs.org/@jridgewell/trace-mapping/-/trace-mapping-0.3.30.tgz", - "integrity": "sha512-GQ7Nw5G2lTu/BtHTKfXhKHok2WGetd4XYcVKGx00SjAk8GMwgJM3zr6zORiPGuOE+/vkc90KtTosSSvaCjKb2Q==", + "version": "0.3.31", + "resolved": "https://registry.npmjs.org/@jridgewell/trace-mapping/-/trace-mapping-0.3.31.tgz", + "integrity": "sha512-zzNR+SdQSDJzc8joaeP8QQoCQr8NuYx2dIIytl1QeBEZHJ9uW6hebsrYgbz8hJwUQao3TWCMtmfV8Nu1twOLAw==", "dev": true, "license": "MIT", "dependencies": { @@ -5717,126 +2750,6 @@ "@jridgewell/sourcemap-codec": "^1.4.14" } }, - "node_modules/@jsonjoy.com/base64": { - "version": "1.1.2", - "resolved": "https://registry.npmjs.org/@jsonjoy.com/base64/-/base64-1.1.2.tgz", - "integrity": "sha512-q6XAnWQDIMA3+FTiOYajoYqySkO+JSat0ytXGSuRdq9uXE7o92gzuQwQM14xaCRlBLGq3v5miDGC4vkVTn54xA==", - "dev": true, - "license": "Apache-2.0", - "engines": { - "node": ">=10.0" - }, - "funding": { - "type": "github", - "url": "https://github.com/sponsors/streamich" - }, - "peerDependencies": { - "tslib": "2" - } - }, - "node_modules/@jsonjoy.com/buffers": { - "version": "1.2.1", - "resolved": "https://registry.npmjs.org/@jsonjoy.com/buffers/-/buffers-1.2.1.tgz", - "integrity": "sha512-12cdlDwX4RUM3QxmUbVJWqZ/mrK6dFQH4Zxq6+r1YXKXYBNgZXndx2qbCJwh3+WWkCSn67IjnlG3XYTvmvYtgA==", - "dev": true, - "license": "Apache-2.0", - "engines": { - "node": ">=10.0" - }, - "funding": { - "type": "github", - "url": "https://github.com/sponsors/streamich" - }, - "peerDependencies": { - "tslib": "2" - } - }, - "node_modules/@jsonjoy.com/codegen": { - "version": "1.0.0", - "resolved": "https://registry.npmjs.org/@jsonjoy.com/codegen/-/codegen-1.0.0.tgz", - "integrity": "sha512-E8Oy+08cmCf0EK/NMxpaJZmOxPqM+6iSe2S4nlSBrPZOORoDJILxtbSUEDKQyTamm/BVAhIGllOBNU79/dwf0g==", - "dev": true, - "license": "Apache-2.0", - "engines": { - "node": ">=10.0" - }, - "funding": { - "type": "github", - "url": "https://github.com/sponsors/streamich" - }, - "peerDependencies": { - "tslib": "2" - } - }, - "node_modules/@jsonjoy.com/json-pack": { - "version": "1.21.0", - "resolved": "https://registry.npmjs.org/@jsonjoy.com/json-pack/-/json-pack-1.21.0.tgz", - "integrity": "sha512-+AKG+R2cfZMShzrF2uQw34v3zbeDYUqnQ+jg7ORic3BGtfw9p/+N6RJbq/kkV8JmYZaINknaEQ2m0/f693ZPpg==", - "dev": true, - "license": "Apache-2.0", - "dependencies": { - "@jsonjoy.com/base64": "^1.1.2", - "@jsonjoy.com/buffers": "^1.2.0", - "@jsonjoy.com/codegen": "^1.0.0", - "@jsonjoy.com/json-pointer": "^1.0.2", - "@jsonjoy.com/util": "^1.9.0", - "hyperdyperid": "^1.2.0", - "thingies": "^2.5.0", - "tree-dump": "^1.1.0" - }, - "engines": { - "node": ">=10.0" - }, - "funding": { - "type": "github", - "url": "https://github.com/sponsors/streamich" - }, - "peerDependencies": { - "tslib": "2" - } - }, - "node_modules/@jsonjoy.com/json-pointer": { - "version": "1.0.2", - "resolved": "https://registry.npmjs.org/@jsonjoy.com/json-pointer/-/json-pointer-1.0.2.tgz", - "integrity": "sha512-Fsn6wM2zlDzY1U+v4Nc8bo3bVqgfNTGcn6dMgs6FjrEnt4ZCe60o6ByKRjOGlI2gow0aE/Q41QOigdTqkyK5fg==", - "dev": true, - "license": "Apache-2.0", - "dependencies": { - "@jsonjoy.com/codegen": "^1.0.0", - "@jsonjoy.com/util": "^1.9.0" - }, - "engines": { - "node": ">=10.0" - }, - "funding": { - "type": "github", - "url": "https://github.com/sponsors/streamich" - }, - "peerDependencies": { - "tslib": "2" - } - }, - "node_modules/@jsonjoy.com/util": { - "version": "1.9.0", - "resolved": "https://registry.npmjs.org/@jsonjoy.com/util/-/util-1.9.0.tgz", - "integrity": "sha512-pLuQo+VPRnN8hfPqUTLTHk126wuYdXVxE6aDmjSeV4NCAgyxWbiOIeNJVtID3h1Vzpoi9m4jXezf73I6LgabgQ==", - "dev": true, - "license": "Apache-2.0", - "dependencies": { - "@jsonjoy.com/buffers": "^1.0.0", - "@jsonjoy.com/codegen": "^1.0.0" - }, - "engines": { - "node": ">=10.0" - }, - "funding": { - "type": "github", - "url": "https://github.com/sponsors/streamich" - }, - "peerDependencies": { - "tslib": "2" - } - }, "node_modules/@kayvan/markdown-tree-parser": { "version": "1.6.1", "resolved": "https://registry.npmjs.org/@kayvan/markdown-tree-parser/-/markdown-tree-parser-1.6.1.tgz", @@ -5861,13 +2774,6 @@ "url": "https://github.com/sponsors/ksylvan" } }, - "node_modules/@leichtgewicht/ip-codec": { - "version": "2.0.5", - "resolved": "https://registry.npmjs.org/@leichtgewicht/ip-codec/-/ip-codec-2.0.5.tgz", - "integrity": "sha512-Vo+PSpZG2/fmgmiNzYK9qWRh8h/CHrwD0mo1h1DzL4yzHNSfWYujGTYsWGreD000gcgmZ7K4Ys6Tx9TxtsKdDw==", - "dev": true, - "license": "MIT" - }, "node_modules/@mdx-js/mdx": { "version": "3.1.1", "resolved": "https://registry.npmjs.org/@mdx-js/mdx/-/mdx-3.1.1.tgz", @@ -5906,35 +2812,6 @@ "url": "https://opencollective.com/unified" } }, - "node_modules/@mdx-js/mdx/node_modules/source-map": { - "version": "0.7.6", - "resolved": "https://registry.npmjs.org/source-map/-/source-map-0.7.6.tgz", - "integrity": "sha512-i5uvt8C3ikiWeNZSVZNWcfZPItFQOsYTUAOkcUPGd8DqDy1uOUikjt5dG+uRlwyvR108Fb9DOd4GvXfT0N2/uQ==", - "dev": true, - "license": "BSD-3-Clause", - "engines": { - "node": ">= 12" - } - }, - "node_modules/@mdx-js/react": { - "version": "3.1.1", - "resolved": "https://registry.npmjs.org/@mdx-js/react/-/react-3.1.1.tgz", - "integrity": "sha512-f++rKLQgUVYDAtECQ6fn/is15GkEH9+nZPM3MS0RcxVqoTfawHvDlSCH7JbMhAM6uJ32v3eXLvLmLvjGu7PTQw==", - "dev": true, - "license": "MIT", - "peer": true, - "dependencies": { - "@types/mdx": "^2.0.0" - }, - "funding": { - "type": "opencollective", - "url": "https://opencollective.com/unified" - }, - "peerDependencies": { - "@types/react": ">=16", - "react": ">=16" - } - }, "node_modules/@napi-rs/wasm-runtime": { "version": "0.2.12", "resolved": "https://registry.npmjs.org/@napi-rs/wasm-runtime/-/wasm-runtime-0.2.12.tgz", @@ -5986,15 +2863,103 @@ "node": ">= 8" } }, - "node_modules/@opentelemetry/api": { - "version": "1.9.0", - "resolved": "https://registry.npmjs.org/@opentelemetry/api/-/api-1.9.0.tgz", - "integrity": "sha512-3giAOQvZiH5F9bMlMiv8+GSPMeqg0dbaeo58/0SlA9sxSqZhnUtxzX9/2FzyhS9sWQf5S0GJE0AKBrFqjpeYcg==", + "node_modules/@oslojs/encoding": { + "version": "1.1.0", + "resolved": "https://registry.npmjs.org/@oslojs/encoding/-/encoding-1.1.0.tgz", + "integrity": "sha512-70wQhgYmndg4GCPxPPxPGevRKqTIJ2Nh4OkiMWmDAVYsTQ+Ta7Sq+rPevXyXGdzr30/qZBnyOalCszoMxlyldQ==", "dev": true, - "license": "Apache-2.0", - "engines": { - "node": ">=8.0.0" - } + "license": "MIT" + }, + "node_modules/@pagefind/darwin-arm64": { + "version": "1.4.0", + "resolved": "https://registry.npmjs.org/@pagefind/darwin-arm64/-/darwin-arm64-1.4.0.tgz", + "integrity": "sha512-2vMqkbv3lbx1Awea90gTaBsvpzgRs7MuSgKDxW0m9oV1GPZCZbZBJg/qL83GIUEN2BFlY46dtUZi54pwH+/pTQ==", + "cpu": [ + "arm64" + ], + "dev": true, + "license": "MIT", + "optional": true, + "os": [ + "darwin" + ] + }, + "node_modules/@pagefind/darwin-x64": { + "version": "1.4.0", + "resolved": "https://registry.npmjs.org/@pagefind/darwin-x64/-/darwin-x64-1.4.0.tgz", + "integrity": "sha512-e7JPIS6L9/cJfow+/IAqknsGqEPjJnVXGjpGm25bnq+NPdoD3c/7fAwr1OXkG4Ocjx6ZGSCijXEV4ryMcH2E3A==", + "cpu": [ + "x64" + ], + "dev": true, + "license": "MIT", + "optional": true, + "os": [ + "darwin" + ] + }, + "node_modules/@pagefind/default-ui": { + "version": "1.4.0", + "resolved": "https://registry.npmjs.org/@pagefind/default-ui/-/default-ui-1.4.0.tgz", + "integrity": "sha512-wie82VWn3cnGEdIjh4YwNESyS1G6vRHwL6cNjy9CFgNnWW/PGRjsLq300xjVH5sfPFK3iK36UxvIBymtQIEiSQ==", + "dev": true, + "license": "MIT" + }, + "node_modules/@pagefind/freebsd-x64": { + "version": "1.4.0", + "resolved": "https://registry.npmjs.org/@pagefind/freebsd-x64/-/freebsd-x64-1.4.0.tgz", + "integrity": "sha512-WcJVypXSZ+9HpiqZjFXMUobfFfZZ6NzIYtkhQ9eOhZrQpeY5uQFqNWLCk7w9RkMUwBv1HAMDW3YJQl/8OqsV0Q==", + "cpu": [ + "x64" + ], + "dev": true, + "license": "MIT", + "optional": true, + "os": [ + "freebsd" + ] + }, + "node_modules/@pagefind/linux-arm64": { + "version": "1.4.0", + "resolved": "https://registry.npmjs.org/@pagefind/linux-arm64/-/linux-arm64-1.4.0.tgz", + "integrity": "sha512-PIt8dkqt4W06KGmQjONw7EZbhDF+uXI7i0XtRLN1vjCUxM9vGPdtJc2mUyVPevjomrGz5M86M8bqTr6cgDp1Uw==", + "cpu": [ + "arm64" + ], + "dev": true, + "license": "MIT", + "optional": true, + "os": [ + "linux" + ] + }, + "node_modules/@pagefind/linux-x64": { + "version": "1.4.0", + "resolved": "https://registry.npmjs.org/@pagefind/linux-x64/-/linux-x64-1.4.0.tgz", + "integrity": "sha512-z4oddcWwQ0UHrTHR8psLnVlz6USGJ/eOlDPTDYZ4cI8TK8PgwRUPQZp9D2iJPNIPcS6Qx/E4TebjuGJOyK8Mmg==", + "cpu": [ + "x64" + ], + "dev": true, + "license": "MIT", + "optional": true, + "os": [ + "linux" + ] + }, + "node_modules/@pagefind/windows-x64": { + "version": "1.4.0", + "resolved": "https://registry.npmjs.org/@pagefind/windows-x64/-/windows-x64-1.4.0.tgz", + "integrity": "sha512-NkT+YAdgS2FPCn8mIA9bQhiBs+xmniMGq1LFPDhcFn0+2yIUEiIG06t7bsZlhdjknEQRTSdT7YitP6fC5qwP0g==", + "cpu": [ + "x64" + ], + "dev": true, + "license": "MIT", + "optional": true, + "os": [ + "win32" + ] }, "node_modules/@pkgjs/parseargs": { "version": "0.11.0", @@ -6020,102 +2985,425 @@ "url": "https://opencollective.com/pkgr" } }, - "node_modules/@pnpm/config.env-replace": { - "version": "1.1.0", - "resolved": "https://registry.npmjs.org/@pnpm/config.env-replace/-/config.env-replace-1.1.0.tgz", - "integrity": "sha512-htyl8TWnKL7K/ESFa1oW2UB5lVDxuF5DpM7tBi6Hu2LNL3mWkIzNLG6N4zoCUP1lCKNxWy/3iu8mS8MvToGd6w==", - "dev": true, - "license": "MIT", - "engines": { - "node": ">=12.22.0" - } - }, - "node_modules/@pnpm/network.ca-file": { - "version": "1.0.2", - "resolved": "https://registry.npmjs.org/@pnpm/network.ca-file/-/network.ca-file-1.0.2.tgz", - "integrity": "sha512-YcPQ8a0jwYU9bTdJDpXjMi7Brhkr1mXsXrUJvjqM2mQDgkRiz8jFaQGOdaLxgjtUfQgZhKy/O3cG/YwmgKaxLA==", + "node_modules/@rollup/pluginutils": { + "version": "5.3.0", + "resolved": "https://registry.npmjs.org/@rollup/pluginutils/-/pluginutils-5.3.0.tgz", + "integrity": "sha512-5EdhGZtnu3V88ces7s53hhfK5KSASnJZv8Lulpc04cWO3REESroJXg73DFsOmgbU2BhwV0E20bu2IDZb3VKW4Q==", "dev": true, "license": "MIT", "dependencies": { - "graceful-fs": "4.2.10" + "@types/estree": "^1.0.0", + "estree-walker": "^2.0.2", + "picomatch": "^4.0.2" }, "engines": { - "node": ">=12.22.0" - } - }, - "node_modules/@pnpm/network.ca-file/node_modules/graceful-fs": { - "version": "4.2.10", - "resolved": "https://registry.npmjs.org/graceful-fs/-/graceful-fs-4.2.10.tgz", - "integrity": "sha512-9ByhssR2fPVsNZj478qUUbKfmL0+t5BDVyjShtyZZLiK7ZDAArFFfopyOTj0M05wE2tJPisA4iTnnXl2YoPvOA==", - "dev": true, - "license": "ISC" - }, - "node_modules/@pnpm/npm-conf": { - "version": "2.3.1", - "resolved": "https://registry.npmjs.org/@pnpm/npm-conf/-/npm-conf-2.3.1.tgz", - "integrity": "sha512-c83qWb22rNRuB0UaVCI0uRPNRr8Z0FWnEIvT47jiHAmOIUHbBOg5XvV7pM5x+rKn9HRpjxquDbXYSXr3fAKFcw==", - "dev": true, - "license": "MIT", - "dependencies": { - "@pnpm/config.env-replace": "^1.1.0", - "@pnpm/network.ca-file": "^1.0.1", - "config-chain": "^1.1.11" + "node": ">=14.0.0" }, - "engines": { - "node": ">=12" + "peerDependencies": { + "rollup": "^1.20.0||^2.0.0||^3.0.0||^4.0.0" + }, + "peerDependenciesMeta": { + "rollup": { + "optional": true + } } }, - "node_modules/@polka/url": { - "version": "1.0.0-next.29", - "resolved": "https://registry.npmjs.org/@polka/url/-/url-1.0.0-next.29.tgz", - "integrity": "sha512-wwQAWhWSuHaag8c4q/KN/vCoeOJYshAIvMQwD4GpSb3OiZklFfvAgmj0VCBBImRpuF/aFgIRzllXlVX93Jevww==", + "node_modules/@rollup/pluginutils/node_modules/estree-walker": { + "version": "2.0.2", + "resolved": "https://registry.npmjs.org/estree-walker/-/estree-walker-2.0.2.tgz", + "integrity": "sha512-Rfkk/Mp/DL7JVje3u18FxFujQlTNR2q6QfMSMB7AvCBx91NGj/ba3kCfza0f6dVDbw7YlRf/nDrn7pQrCCyQ/w==", "dev": true, "license": "MIT" }, - "node_modules/@sideway/address": { - "version": "4.1.5", - "resolved": "https://registry.npmjs.org/@sideway/address/-/address-4.1.5.tgz", - "integrity": "sha512-IqO/DUQHUkPeixNQ8n0JA6102hT9CmaljNTPmQ1u8MEhBo/R4Q8eKLN/vGZxuebwOroDB4cbpjheD4+/sKFK4Q==", + "node_modules/@rollup/rollup-android-arm-eabi": { + "version": "4.54.0", + "resolved": "https://registry.npmjs.org/@rollup/rollup-android-arm-eabi/-/rollup-android-arm-eabi-4.54.0.tgz", + "integrity": "sha512-OywsdRHrFvCdvsewAInDKCNyR3laPA2mc9bRYJ6LBp5IyvF3fvXbbNR0bSzHlZVFtn6E0xw2oZlyjg4rKCVcng==", + "cpu": [ + "arm" + ], "dev": true, - "license": "BSD-3-Clause", + "license": "MIT", + "optional": true, + "os": [ + "android" + ] + }, + "node_modules/@rollup/rollup-android-arm64": { + "version": "4.54.0", + "resolved": "https://registry.npmjs.org/@rollup/rollup-android-arm64/-/rollup-android-arm64-4.54.0.tgz", + "integrity": "sha512-Skx39Uv+u7H224Af+bDgNinitlmHyQX1K/atIA32JP3JQw6hVODX5tkbi2zof/E69M1qH2UoN3Xdxgs90mmNYw==", + "cpu": [ + "arm64" + ], + "dev": true, + "license": "MIT", + "optional": true, + "os": [ + "android" + ] + }, + "node_modules/@rollup/rollup-darwin-arm64": { + "version": "4.54.0", + "resolved": "https://registry.npmjs.org/@rollup/rollup-darwin-arm64/-/rollup-darwin-arm64-4.54.0.tgz", + "integrity": "sha512-k43D4qta/+6Fq+nCDhhv9yP2HdeKeP56QrUUTW7E6PhZP1US6NDqpJj4MY0jBHlJivVJD5P8NxrjuobZBJTCRw==", + "cpu": [ + "arm64" + ], + "dev": true, + "license": "MIT", + "optional": true, + "os": [ + "darwin" + ] + }, + "node_modules/@rollup/rollup-darwin-x64": { + "version": "4.54.0", + "resolved": "https://registry.npmjs.org/@rollup/rollup-darwin-x64/-/rollup-darwin-x64-4.54.0.tgz", + "integrity": "sha512-cOo7biqwkpawslEfox5Vs8/qj83M/aZCSSNIWpVzfU2CYHa2G3P1UN5WF01RdTHSgCkri7XOlTdtk17BezlV3A==", + "cpu": [ + "x64" + ], + "dev": true, + "license": "MIT", + "optional": true, + "os": [ + "darwin" + ] + }, + "node_modules/@rollup/rollup-freebsd-arm64": { + "version": "4.54.0", + "resolved": "https://registry.npmjs.org/@rollup/rollup-freebsd-arm64/-/rollup-freebsd-arm64-4.54.0.tgz", + "integrity": "sha512-miSvuFkmvFbgJ1BevMa4CPCFt5MPGw094knM64W9I0giUIMMmRYcGW/JWZDriaw/k1kOBtsWh1z6nIFV1vPNtA==", + "cpu": [ + "arm64" + ], + "dev": true, + "license": "MIT", + "optional": true, + "os": [ + "freebsd" + ] + }, + "node_modules/@rollup/rollup-freebsd-x64": { + "version": "4.54.0", + "resolved": "https://registry.npmjs.org/@rollup/rollup-freebsd-x64/-/rollup-freebsd-x64-4.54.0.tgz", + "integrity": "sha512-KGXIs55+b/ZfZsq9aR026tmr/+7tq6VG6MsnrvF4H8VhwflTIuYh+LFUlIsRdQSgrgmtM3fVATzEAj4hBQlaqQ==", + "cpu": [ + "x64" + ], + "dev": true, + "license": "MIT", + "optional": true, + "os": [ + "freebsd" + ] + }, + "node_modules/@rollup/rollup-linux-arm-gnueabihf": { + "version": "4.54.0", + "resolved": "https://registry.npmjs.org/@rollup/rollup-linux-arm-gnueabihf/-/rollup-linux-arm-gnueabihf-4.54.0.tgz", + "integrity": "sha512-EHMUcDwhtdRGlXZsGSIuXSYwD5kOT9NVnx9sqzYiwAc91wfYOE1g1djOEDseZJKKqtHAHGwnGPQu3kytmfaXLQ==", + "cpu": [ + "arm" + ], + "dev": true, + "license": "MIT", + "optional": true, + "os": [ + "linux" + ] + }, + "node_modules/@rollup/rollup-linux-arm-musleabihf": { + "version": "4.54.0", + "resolved": "https://registry.npmjs.org/@rollup/rollup-linux-arm-musleabihf/-/rollup-linux-arm-musleabihf-4.54.0.tgz", + "integrity": "sha512-+pBrqEjaakN2ySv5RVrj/qLytYhPKEUwk+e3SFU5jTLHIcAtqh2rLrd/OkbNuHJpsBgxsD8ccJt5ga/SeG0JmA==", + "cpu": [ + "arm" + ], + "dev": true, + "license": "MIT", + "optional": true, + "os": [ + "linux" + ] + }, + "node_modules/@rollup/rollup-linux-arm64-gnu": { + "version": "4.54.0", + "resolved": "https://registry.npmjs.org/@rollup/rollup-linux-arm64-gnu/-/rollup-linux-arm64-gnu-4.54.0.tgz", + "integrity": "sha512-NSqc7rE9wuUaRBsBp5ckQ5CVz5aIRKCwsoa6WMF7G01sX3/qHUw/z4pv+D+ahL1EIKy6Enpcnz1RY8pf7bjwng==", + "cpu": [ + "arm64" + ], + "dev": true, + "license": "MIT", + "optional": true, + "os": [ + "linux" + ] + }, + "node_modules/@rollup/rollup-linux-arm64-musl": { + "version": "4.54.0", + "resolved": "https://registry.npmjs.org/@rollup/rollup-linux-arm64-musl/-/rollup-linux-arm64-musl-4.54.0.tgz", + "integrity": "sha512-gr5vDbg3Bakga5kbdpqx81m2n9IX8M6gIMlQQIXiLTNeQW6CucvuInJ91EuCJ/JYvc+rcLLsDFcfAD1K7fMofg==", + "cpu": [ + "arm64" + ], + "dev": true, + "license": "MIT", + "optional": true, + "os": [ + "linux" + ] + }, + "node_modules/@rollup/rollup-linux-loong64-gnu": { + "version": "4.54.0", + "resolved": "https://registry.npmjs.org/@rollup/rollup-linux-loong64-gnu/-/rollup-linux-loong64-gnu-4.54.0.tgz", + "integrity": "sha512-gsrtB1NA3ZYj2vq0Rzkylo9ylCtW/PhpLEivlgWe0bpgtX5+9j9EZa0wtZiCjgu6zmSeZWyI/e2YRX1URozpIw==", + "cpu": [ + "loong64" + ], + "dev": true, + "license": "MIT", + "optional": true, + "os": [ + "linux" + ] + }, + "node_modules/@rollup/rollup-linux-ppc64-gnu": { + "version": "4.54.0", + "resolved": "https://registry.npmjs.org/@rollup/rollup-linux-ppc64-gnu/-/rollup-linux-ppc64-gnu-4.54.0.tgz", + "integrity": "sha512-y3qNOfTBStmFNq+t4s7Tmc9hW2ENtPg8FeUD/VShI7rKxNW7O4fFeaYbMsd3tpFlIg1Q8IapFgy7Q9i2BqeBvA==", + "cpu": [ + "ppc64" + ], + "dev": true, + "license": "MIT", + "optional": true, + "os": [ + "linux" + ] + }, + "node_modules/@rollup/rollup-linux-riscv64-gnu": { + "version": "4.54.0", + "resolved": "https://registry.npmjs.org/@rollup/rollup-linux-riscv64-gnu/-/rollup-linux-riscv64-gnu-4.54.0.tgz", + "integrity": "sha512-89sepv7h2lIVPsFma8iwmccN7Yjjtgz0Rj/Ou6fEqg3HDhpCa+Et+YSufy27i6b0Wav69Qv4WBNl3Rs6pwhebQ==", + "cpu": [ + "riscv64" + ], + "dev": true, + "license": "MIT", + "optional": true, + "os": [ + "linux" + ] + }, + "node_modules/@rollup/rollup-linux-riscv64-musl": { + "version": "4.54.0", + "resolved": "https://registry.npmjs.org/@rollup/rollup-linux-riscv64-musl/-/rollup-linux-riscv64-musl-4.54.0.tgz", + "integrity": "sha512-ZcU77ieh0M2Q8Ur7D5X7KvK+UxbXeDHwiOt/CPSBTI1fBmeDMivW0dPkdqkT4rOgDjrDDBUed9x4EgraIKoR2A==", + "cpu": [ + "riscv64" + ], + "dev": true, + "license": "MIT", + "optional": true, + "os": [ + "linux" + ] + }, + "node_modules/@rollup/rollup-linux-s390x-gnu": { + "version": "4.54.0", + "resolved": "https://registry.npmjs.org/@rollup/rollup-linux-s390x-gnu/-/rollup-linux-s390x-gnu-4.54.0.tgz", + "integrity": "sha512-2AdWy5RdDF5+4YfG/YesGDDtbyJlC9LHmL6rZw6FurBJ5n4vFGupsOBGfwMRjBYH7qRQowT8D/U4LoSvVwOhSQ==", + "cpu": [ + "s390x" + ], + "dev": true, + "license": "MIT", + "optional": true, + "os": [ + "linux" + ] + }, + "node_modules/@rollup/rollup-linux-x64-gnu": { + "version": "4.54.0", + "resolved": "https://registry.npmjs.org/@rollup/rollup-linux-x64-gnu/-/rollup-linux-x64-gnu-4.54.0.tgz", + "integrity": "sha512-WGt5J8Ij/rvyqpFexxk3ffKqqbLf9AqrTBbWDk7ApGUzaIs6V+s2s84kAxklFwmMF/vBNGrVdYgbblCOFFezMQ==", + "cpu": [ + "x64" + ], + "dev": true, + "license": "MIT", + "optional": true, + "os": [ + "linux" + ] + }, + "node_modules/@rollup/rollup-linux-x64-musl": { + "version": "4.54.0", + "resolved": "https://registry.npmjs.org/@rollup/rollup-linux-x64-musl/-/rollup-linux-x64-musl-4.54.0.tgz", + "integrity": "sha512-JzQmb38ATzHjxlPHuTH6tE7ojnMKM2kYNzt44LO/jJi8BpceEC8QuXYA908n8r3CNuG/B3BV8VR3Hi1rYtmPiw==", + "cpu": [ + "x64" + ], + "dev": true, + "license": "MIT", + "optional": true, + "os": [ + "linux" + ] + }, + "node_modules/@rollup/rollup-openharmony-arm64": { + "version": "4.54.0", + "resolved": "https://registry.npmjs.org/@rollup/rollup-openharmony-arm64/-/rollup-openharmony-arm64-4.54.0.tgz", + "integrity": "sha512-huT3fd0iC7jigGh7n3q/+lfPcXxBi+om/Rs3yiFxjvSxbSB6aohDFXbWvlspaqjeOh+hx7DDHS+5Es5qRkWkZg==", + "cpu": [ + "arm64" + ], + "dev": true, + "license": "MIT", + "optional": true, + "os": [ + "openharmony" + ] + }, + "node_modules/@rollup/rollup-win32-arm64-msvc": { + "version": "4.54.0", + "resolved": "https://registry.npmjs.org/@rollup/rollup-win32-arm64-msvc/-/rollup-win32-arm64-msvc-4.54.0.tgz", + "integrity": "sha512-c2V0W1bsKIKfbLMBu/WGBz6Yci8nJ/ZJdheE0EwB73N3MvHYKiKGs3mVilX4Gs70eGeDaMqEob25Tw2Gb9Nqyw==", + "cpu": [ + "arm64" + ], + "dev": true, + "license": "MIT", + "optional": true, + "os": [ + "win32" + ] + }, + "node_modules/@rollup/rollup-win32-ia32-msvc": { + "version": "4.54.0", + "resolved": "https://registry.npmjs.org/@rollup/rollup-win32-ia32-msvc/-/rollup-win32-ia32-msvc-4.54.0.tgz", + "integrity": "sha512-woEHgqQqDCkAzrDhvDipnSirm5vxUXtSKDYTVpZG3nUdW/VVB5VdCYA2iReSj/u3yCZzXID4kuKG7OynPnB3WQ==", + "cpu": [ + "ia32" + ], + "dev": true, + "license": "MIT", + "optional": true, + "os": [ + "win32" + ] + }, + "node_modules/@rollup/rollup-win32-x64-gnu": { + "version": "4.54.0", + "resolved": "https://registry.npmjs.org/@rollup/rollup-win32-x64-gnu/-/rollup-win32-x64-gnu-4.54.0.tgz", + "integrity": "sha512-dzAc53LOuFvHwbCEOS0rPbXp6SIhAf2txMP5p6mGyOXXw5mWY8NGGbPMPrs4P1WItkfApDathBj/NzMLUZ9rtQ==", + "cpu": [ + "x64" + ], + "dev": true, + "license": "MIT", + "optional": true, + "os": [ + "win32" + ] + }, + "node_modules/@rollup/rollup-win32-x64-msvc": { + "version": "4.54.0", + "resolved": "https://registry.npmjs.org/@rollup/rollup-win32-x64-msvc/-/rollup-win32-x64-msvc-4.54.0.tgz", + "integrity": "sha512-hYT5d3YNdSh3mbCU1gwQyPgQd3T2ne0A3KG8KSBdav5TiBg6eInVmV+TeR5uHufiIgSFg0XsOWGW5/RhNcSvPg==", + "cpu": [ + "x64" + ], + "dev": true, + "license": "MIT", + "optional": true, + "os": [ + "win32" + ] + }, + "node_modules/@shikijs/core": { + "version": "3.20.0", + "resolved": "https://registry.npmjs.org/@shikijs/core/-/core-3.20.0.tgz", + "integrity": "sha512-f2ED7HYV4JEk827mtMDwe/yQ25pRiXZmtHjWF8uzZKuKiEsJR7Ce1nuQ+HhV9FzDcbIo4ObBCD9GPTzNuy9S1g==", + "dev": true, + "license": "MIT", "dependencies": { - "@hapi/hoek": "^9.0.0" + "@shikijs/types": "3.20.0", + "@shikijs/vscode-textmate": "^10.0.2", + "@types/hast": "^3.0.4", + "hast-util-to-html": "^9.0.5" } }, - "node_modules/@sideway/formula": { - "version": "3.0.1", - "resolved": "https://registry.npmjs.org/@sideway/formula/-/formula-3.0.1.tgz", - "integrity": "sha512-/poHZJJVjx3L+zVD6g9KgHfYnb443oi7wLu/XKojDviHy6HOEOA6z1Trk5aR1dGcmPenJEgb2sK2I80LeS3MIg==", + "node_modules/@shikijs/engine-javascript": { + "version": "3.20.0", + "resolved": "https://registry.npmjs.org/@shikijs/engine-javascript/-/engine-javascript-3.20.0.tgz", + "integrity": "sha512-OFx8fHAZuk7I42Z9YAdZ95To6jDePQ9Rnfbw9uSRTSbBhYBp1kEOKv/3jOimcj3VRUKusDYM6DswLauwfhboLg==", "dev": true, - "license": "BSD-3-Clause" + "license": "MIT", + "dependencies": { + "@shikijs/types": "3.20.0", + "@shikijs/vscode-textmate": "^10.0.2", + "oniguruma-to-es": "^4.3.4" + } }, - "node_modules/@sideway/pinpoint": { - "version": "2.0.0", - "resolved": "https://registry.npmjs.org/@sideway/pinpoint/-/pinpoint-2.0.0.tgz", - "integrity": "sha512-RNiOoTPkptFtSVzQevY/yWtZwf/RxyVnPy/OcA9HBM3MlGDnBEYL5B41H0MTn0Uec8Hi+2qUtTfG2WWZBmMejQ==", + "node_modules/@shikijs/engine-oniguruma": { + "version": "3.20.0", + "resolved": "https://registry.npmjs.org/@shikijs/engine-oniguruma/-/engine-oniguruma-3.20.0.tgz", + "integrity": "sha512-Yx3gy7xLzM0ZOjqoxciHjA7dAt5tyzJE3L4uQoM83agahy+PlW244XJSrmJRSBvGYELDhYXPacD4R/cauV5bzQ==", "dev": true, - "license": "BSD-3-Clause" + "license": "MIT", + "dependencies": { + "@shikijs/types": "3.20.0", + "@shikijs/vscode-textmate": "^10.0.2" + } + }, + "node_modules/@shikijs/langs": { + "version": "3.20.0", + "resolved": "https://registry.npmjs.org/@shikijs/langs/-/langs-3.20.0.tgz", + "integrity": "sha512-le+bssCxcSHrygCWuOrYJHvjus6zhQ2K7q/0mgjiffRbkhM4o1EWu2m+29l0yEsHDbWaWPNnDUTRVVBvBBeKaA==", + "dev": true, + "license": "MIT", + "dependencies": { + "@shikijs/types": "3.20.0" + } + }, + "node_modules/@shikijs/themes": { + "version": "3.20.0", + "resolved": "https://registry.npmjs.org/@shikijs/themes/-/themes-3.20.0.tgz", + "integrity": "sha512-U1NSU7Sl26Q7ErRvJUouArxfM2euWqq1xaSrbqMu2iqa+tSp0D1Yah8216sDYbdDHw4C8b75UpE65eWorm2erQ==", + "dev": true, + "license": "MIT", + "dependencies": { + "@shikijs/types": "3.20.0" + } + }, + "node_modules/@shikijs/types": { + "version": "3.20.0", + "resolved": "https://registry.npmjs.org/@shikijs/types/-/types-3.20.0.tgz", + "integrity": "sha512-lhYAATn10nkZcBQ0BlzSbJA3wcmL5MXUUF8d2Zzon6saZDlToKaiRX60n2+ZaHJCmXEcZRWNzn+k9vplr8Jhsw==", + "dev": true, + "license": "MIT", + "dependencies": { + "@shikijs/vscode-textmate": "^10.0.2", + "@types/hast": "^3.0.4" + } + }, + "node_modules/@shikijs/vscode-textmate": { + "version": "10.0.2", + "resolved": "https://registry.npmjs.org/@shikijs/vscode-textmate/-/vscode-textmate-10.0.2.tgz", + "integrity": "sha512-83yeghZ2xxin3Nj8z1NMd/NCuca+gsYXswywDy5bHvwlWL8tpTQmzGeUuHd9FC3E/SBEMvzJRwWEOz5gGes9Qg==", + "dev": true, + "license": "MIT" }, "node_modules/@sinclair/typebox": { - "version": "0.34.40", - "resolved": "https://registry.npmjs.org/@sinclair/typebox/-/typebox-0.34.40.tgz", - "integrity": "sha512-gwBNIP8ZAYev/ORDWW0QvxdwPXwxBtLsdsJgSc7eDIRt8ubP+rxUBzPsrwnu16fgEF8Bx4lh/+mvQvJzcTM6Kw==", + "version": "0.34.46", + "resolved": "https://registry.npmjs.org/@sinclair/typebox/-/typebox-0.34.46.tgz", + "integrity": "sha512-kiW7CtS/NkdvTUjkjUJo7d5JsFfbJ14YjdhDk9KoEgK6nFjKNXZPrX0jfLA8ZlET4cFLHxOZ/0vFKOP+bOxIOQ==", "dev": true, "license": "MIT" }, - "node_modules/@sindresorhus/is": { - "version": "4.6.0", - "resolved": "https://registry.npmjs.org/@sindresorhus/is/-/is-4.6.0.tgz", - "integrity": "sha512-t09vSN3MdfsyCHoFcTRCH/iUtG7OJ0CsjzB8cjAmKc/va/kIgeDI/TxsigdncE/4be734m0cvIYwNaV4i2XqAw==", - "dev": true, - "license": "MIT", - "engines": { - "node": ">=10" - }, - "funding": { - "url": "https://github.com/sindresorhus/is?sponsor=1" - } - }, "node_modules/@sindresorhus/merge-streams": { "version": "4.0.0", "resolved": "https://registry.npmjs.org/@sindresorhus/merge-streams/-/merge-streams-4.0.0.tgz", @@ -6149,413 +3437,20 @@ "@sinonjs/commons": "^3.0.1" } }, - "node_modules/@slorber/remark-comment": { - "version": "1.0.0", - "resolved": "https://registry.npmjs.org/@slorber/remark-comment/-/remark-comment-1.0.0.tgz", - "integrity": "sha512-RCE24n7jsOj1M0UPvIQCHTe7fI0sFL4S2nwKVWwHyVr/wI/H8GosgsJGyhnsZoGFnD/P2hLf1mSbrrgSLN93NA==", + "node_modules/@swc/helpers": { + "version": "0.5.18", + "resolved": "https://registry.npmjs.org/@swc/helpers/-/helpers-0.5.18.tgz", + "integrity": "sha512-TXTnIcNJQEKwThMMqBXsZ4VGAza6bvN4pa41Rkqoio6QBKMvo+5lexeTMScGCIxtzgQJzElcvIltani+adC5PQ==", "dev": true, - "license": "MIT", + "license": "Apache-2.0", "dependencies": { - "micromark-factory-space": "^1.0.0", - "micromark-util-character": "^1.1.0", - "micromark-util-symbol": "^1.0.1" - } - }, - "node_modules/@slorber/remark-comment/node_modules/micromark-factory-space": { - "version": "1.1.0", - "resolved": "https://registry.npmjs.org/micromark-factory-space/-/micromark-factory-space-1.1.0.tgz", - "integrity": "sha512-cRzEj7c0OL4Mw2v6nwzttyOZe8XY/Z8G0rzmWQZTBi/jjwyw/U4uqKtUORXQrR5bAZZnbTI/feRV/R7hc4jQYQ==", - "dev": true, - "funding": [ - { - "type": "GitHub Sponsors", - "url": "https://github.com/sponsors/unifiedjs" - }, - { - "type": "OpenCollective", - "url": "https://opencollective.com/unified" - } - ], - "license": "MIT", - "dependencies": { - "micromark-util-character": "^1.0.0", - "micromark-util-types": "^1.0.0" - } - }, - "node_modules/@slorber/remark-comment/node_modules/micromark-util-character": { - "version": "1.2.0", - "resolved": "https://registry.npmjs.org/micromark-util-character/-/micromark-util-character-1.2.0.tgz", - "integrity": "sha512-lXraTwcX3yH/vMDaFWCQJP1uIszLVebzUa3ZHdrgxr7KEU/9mL4mVgCpGbyhvNLNlauROiNUq7WN5u7ndbY6xg==", - "dev": true, - "funding": [ - { - "type": "GitHub Sponsors", - "url": "https://github.com/sponsors/unifiedjs" - }, - { - "type": "OpenCollective", - "url": "https://opencollective.com/unified" - } - ], - "license": "MIT", - "dependencies": { - "micromark-util-symbol": "^1.0.0", - "micromark-util-types": "^1.0.0" - } - }, - "node_modules/@slorber/remark-comment/node_modules/micromark-util-symbol": { - "version": "1.1.0", - "resolved": "https://registry.npmjs.org/micromark-util-symbol/-/micromark-util-symbol-1.1.0.tgz", - "integrity": "sha512-uEjpEYY6KMs1g7QfJ2eX1SQEV+ZT4rUD3UcF6l57acZvLNK7PBZL+ty82Z1qhK1/yXIY4bdx04FKMgR0g4IAag==", - "dev": true, - "funding": [ - { - "type": "GitHub Sponsors", - "url": "https://github.com/sponsors/unifiedjs" - }, - { - "type": "OpenCollective", - "url": "https://opencollective.com/unified" - } - ], - "license": "MIT" - }, - "node_modules/@slorber/remark-comment/node_modules/micromark-util-types": { - "version": "1.1.0", - "resolved": "https://registry.npmjs.org/micromark-util-types/-/micromark-util-types-1.1.0.tgz", - "integrity": "sha512-ukRBgie8TIAcacscVHSiddHjO4k/q3pnedmzMQ4iwDcK0FtFCohKOlFbaOL/mPgfnPsL3C1ZyxJa4sbWrBl3jg==", - "dev": true, - "funding": [ - { - "type": "GitHub Sponsors", - "url": "https://github.com/sponsors/unifiedjs" - }, - { - "type": "OpenCollective", - "url": "https://opencollective.com/unified" - } - ], - "license": "MIT" - }, - "node_modules/@standard-schema/spec": { - "version": "1.1.0", - "resolved": "https://registry.npmjs.org/@standard-schema/spec/-/spec-1.1.0.tgz", - "integrity": "sha512-l2aFy5jALhniG5HgqrD6jXLi/rUWrKvqN/qJx6yoJsgKhblVd+iqqU4RCXavm/jPityDo5TCvKMnpjKnOriy0w==", - "dev": true, - "license": "MIT" - }, - "node_modules/@svgr/babel-plugin-add-jsx-attribute": { - "version": "8.0.0", - "resolved": "https://registry.npmjs.org/@svgr/babel-plugin-add-jsx-attribute/-/babel-plugin-add-jsx-attribute-8.0.0.tgz", - "integrity": "sha512-b9MIk7yhdS1pMCZM8VeNfUlSKVRhsHZNMl5O9SfaX0l0t5wjdgu4IDzGB8bpnGBBOjGST3rRFVsaaEtI4W6f7g==", - "dev": true, - "license": "MIT", - "engines": { - "node": ">=14" - }, - "funding": { - "type": "github", - "url": "https://github.com/sponsors/gregberge" - }, - "peerDependencies": { - "@babel/core": "^7.0.0-0" - } - }, - "node_modules/@svgr/babel-plugin-remove-jsx-attribute": { - "version": "8.0.0", - "resolved": "https://registry.npmjs.org/@svgr/babel-plugin-remove-jsx-attribute/-/babel-plugin-remove-jsx-attribute-8.0.0.tgz", - "integrity": "sha512-BcCkm/STipKvbCl6b7QFrMh/vx00vIP63k2eM66MfHJzPr6O2U0jYEViXkHJWqXqQYjdeA9cuCl5KWmlwjDvbA==", - "dev": true, - "license": "MIT", - "engines": { - "node": ">=14" - }, - "funding": { - "type": "github", - "url": "https://github.com/sponsors/gregberge" - }, - "peerDependencies": { - "@babel/core": "^7.0.0-0" - } - }, - "node_modules/@svgr/babel-plugin-remove-jsx-empty-expression": { - "version": "8.0.0", - "resolved": "https://registry.npmjs.org/@svgr/babel-plugin-remove-jsx-empty-expression/-/babel-plugin-remove-jsx-empty-expression-8.0.0.tgz", - "integrity": "sha512-5BcGCBfBxB5+XSDSWnhTThfI9jcO5f0Ai2V24gZpG+wXF14BzwxxdDb4g6trdOux0rhibGs385BeFMSmxtS3uA==", - "dev": true, - "license": "MIT", - "engines": { - "node": ">=14" - }, - "funding": { - "type": "github", - "url": "https://github.com/sponsors/gregberge" - }, - "peerDependencies": { - "@babel/core": "^7.0.0-0" - } - }, - "node_modules/@svgr/babel-plugin-replace-jsx-attribute-value": { - "version": "8.0.0", - "resolved": "https://registry.npmjs.org/@svgr/babel-plugin-replace-jsx-attribute-value/-/babel-plugin-replace-jsx-attribute-value-8.0.0.tgz", - "integrity": "sha512-KVQ+PtIjb1BuYT3ht8M5KbzWBhdAjjUPdlMtpuw/VjT8coTrItWX6Qafl9+ji831JaJcu6PJNKCV0bp01lBNzQ==", - "dev": true, - "license": "MIT", - "engines": { - "node": ">=14" - }, - "funding": { - "type": "github", - "url": "https://github.com/sponsors/gregberge" - }, - "peerDependencies": { - "@babel/core": "^7.0.0-0" - } - }, - "node_modules/@svgr/babel-plugin-svg-dynamic-title": { - "version": "8.0.0", - "resolved": "https://registry.npmjs.org/@svgr/babel-plugin-svg-dynamic-title/-/babel-plugin-svg-dynamic-title-8.0.0.tgz", - "integrity": "sha512-omNiKqwjNmOQJ2v6ge4SErBbkooV2aAWwaPFs2vUY7p7GhVkzRkJ00kILXQvRhA6miHnNpXv7MRnnSjdRjK8og==", - "dev": true, - "license": "MIT", - "engines": { - "node": ">=14" - }, - "funding": { - "type": "github", - "url": "https://github.com/sponsors/gregberge" - }, - "peerDependencies": { - "@babel/core": "^7.0.0-0" - } - }, - "node_modules/@svgr/babel-plugin-svg-em-dimensions": { - "version": "8.0.0", - "resolved": "https://registry.npmjs.org/@svgr/babel-plugin-svg-em-dimensions/-/babel-plugin-svg-em-dimensions-8.0.0.tgz", - "integrity": "sha512-mURHYnu6Iw3UBTbhGwE/vsngtCIbHE43xCRK7kCw4t01xyGqb2Pd+WXekRRoFOBIY29ZoOhUCTEweDMdrjfi9g==", - "dev": true, - "license": "MIT", - "engines": { - "node": ">=14" - }, - "funding": { - "type": "github", - "url": "https://github.com/sponsors/gregberge" - }, - "peerDependencies": { - "@babel/core": "^7.0.0-0" - } - }, - "node_modules/@svgr/babel-plugin-transform-react-native-svg": { - "version": "8.1.0", - "resolved": "https://registry.npmjs.org/@svgr/babel-plugin-transform-react-native-svg/-/babel-plugin-transform-react-native-svg-8.1.0.tgz", - "integrity": "sha512-Tx8T58CHo+7nwJ+EhUwx3LfdNSG9R2OKfaIXXs5soiy5HtgoAEkDay9LIimLOcG8dJQH1wPZp/cnAv6S9CrR1Q==", - "dev": true, - "license": "MIT", - "engines": { - "node": ">=14" - }, - "funding": { - "type": "github", - "url": "https://github.com/sponsors/gregberge" - }, - "peerDependencies": { - "@babel/core": "^7.0.0-0" - } - }, - "node_modules/@svgr/babel-plugin-transform-svg-component": { - "version": "8.0.0", - "resolved": "https://registry.npmjs.org/@svgr/babel-plugin-transform-svg-component/-/babel-plugin-transform-svg-component-8.0.0.tgz", - "integrity": "sha512-DFx8xa3cZXTdb/k3kfPeaixecQLgKh5NVBMwD0AQxOzcZawK4oo1Jh9LbrcACUivsCA7TLG8eeWgrDXjTMhRmw==", - "dev": true, - "license": "MIT", - "engines": { - "node": ">=12" - }, - "funding": { - "type": "github", - "url": "https://github.com/sponsors/gregberge" - }, - "peerDependencies": { - "@babel/core": "^7.0.0-0" - } - }, - "node_modules/@svgr/babel-preset": { - "version": "8.1.0", - "resolved": "https://registry.npmjs.org/@svgr/babel-preset/-/babel-preset-8.1.0.tgz", - "integrity": "sha512-7EYDbHE7MxHpv4sxvnVPngw5fuR6pw79SkcrILHJ/iMpuKySNCl5W1qcwPEpU+LgyRXOaAFgH0KhwD18wwg6ug==", - "dev": true, - "license": "MIT", - "dependencies": { - "@svgr/babel-plugin-add-jsx-attribute": "8.0.0", - "@svgr/babel-plugin-remove-jsx-attribute": "8.0.0", - "@svgr/babel-plugin-remove-jsx-empty-expression": "8.0.0", - "@svgr/babel-plugin-replace-jsx-attribute-value": "8.0.0", - "@svgr/babel-plugin-svg-dynamic-title": "8.0.0", - "@svgr/babel-plugin-svg-em-dimensions": "8.0.0", - "@svgr/babel-plugin-transform-react-native-svg": "8.1.0", - "@svgr/babel-plugin-transform-svg-component": "8.0.0" - }, - "engines": { - "node": ">=14" - }, - "funding": { - "type": "github", - "url": "https://github.com/sponsors/gregberge" - }, - "peerDependencies": { - "@babel/core": "^7.0.0-0" - } - }, - "node_modules/@svgr/core": { - "version": "8.1.0", - "resolved": "https://registry.npmjs.org/@svgr/core/-/core-8.1.0.tgz", - "integrity": "sha512-8QqtOQT5ACVlmsvKOJNEaWmRPmcojMOzCz4Hs2BGG/toAp/K38LcsMRyLp349glq5AzJbCEeimEoxaX6v/fLrA==", - "dev": true, - "license": "MIT", - "peer": true, - "dependencies": { - "@babel/core": "^7.21.3", - "@svgr/babel-preset": "8.1.0", - "camelcase": "^6.2.0", - "cosmiconfig": "^8.1.3", - "snake-case": "^3.0.4" - }, - "engines": { - "node": ">=14" - }, - "funding": { - "type": "github", - "url": "https://github.com/sponsors/gregberge" - } - }, - "node_modules/@svgr/core/node_modules/camelcase": { - "version": "6.3.0", - "resolved": "https://registry.npmjs.org/camelcase/-/camelcase-6.3.0.tgz", - "integrity": "sha512-Gmy6FhYlCY7uOElZUSbxo2UCDH8owEk996gkbrpsgGtrJLM3J7jGxl9Ic7Qwwj4ivOE5AWZWRMecDdF7hqGjFA==", - "dev": true, - "license": "MIT", - "engines": { - "node": ">=10" - }, - "funding": { - "url": "https://github.com/sponsors/sindresorhus" - } - }, - "node_modules/@svgr/hast-util-to-babel-ast": { - "version": "8.0.0", - "resolved": "https://registry.npmjs.org/@svgr/hast-util-to-babel-ast/-/hast-util-to-babel-ast-8.0.0.tgz", - "integrity": "sha512-EbDKwO9GpfWP4jN9sGdYwPBU0kdomaPIL2Eu4YwmgP+sJeXT+L7bMwJUBnhzfH8Q2qMBqZ4fJwpCyYsAN3mt2Q==", - "dev": true, - "license": "MIT", - "dependencies": { - "@babel/types": "^7.21.3", - "entities": "^4.4.0" - }, - "engines": { - "node": ">=14" - }, - "funding": { - "type": "github", - "url": "https://github.com/sponsors/gregberge" - } - }, - "node_modules/@svgr/plugin-jsx": { - "version": "8.1.0", - "resolved": "https://registry.npmjs.org/@svgr/plugin-jsx/-/plugin-jsx-8.1.0.tgz", - "integrity": "sha512-0xiIyBsLlr8quN+WyuxooNW9RJ0Dpr8uOnH/xrCVO8GLUcwHISwj1AG0k+LFzteTkAA0GbX0kj9q6Dk70PTiPA==", - "dev": true, - "license": "MIT", - "dependencies": { - "@babel/core": "^7.21.3", - "@svgr/babel-preset": "8.1.0", - "@svgr/hast-util-to-babel-ast": "8.0.0", - "svg-parser": "^2.0.4" - }, - "engines": { - "node": ">=14" - }, - "funding": { - "type": "github", - "url": "https://github.com/sponsors/gregberge" - }, - "peerDependencies": { - "@svgr/core": "*" - } - }, - "node_modules/@svgr/plugin-svgo": { - "version": "8.1.0", - "resolved": "https://registry.npmjs.org/@svgr/plugin-svgo/-/plugin-svgo-8.1.0.tgz", - "integrity": "sha512-Ywtl837OGO9pTLIN/onoWLmDQ4zFUycI1g76vuKGEz6evR/ZTJlJuz3G/fIkb6OVBJ2g0o6CGJzaEjfmEo3AHA==", - "dev": true, - "license": "MIT", - "dependencies": { - "cosmiconfig": "^8.1.3", - "deepmerge": "^4.3.1", - "svgo": "^3.0.2" - }, - "engines": { - "node": ">=14" - }, - "funding": { - "type": "github", - "url": "https://github.com/sponsors/gregberge" - }, - "peerDependencies": { - "@svgr/core": "*" - } - }, - "node_modules/@svgr/webpack": { - "version": "8.1.0", - "resolved": "https://registry.npmjs.org/@svgr/webpack/-/webpack-8.1.0.tgz", - "integrity": "sha512-LnhVjMWyMQV9ZmeEy26maJk+8HTIbd59cH4F2MJ439k9DqejRisfFNGAPvRYlKETuh9LrImlS8aKsBgKjMA8WA==", - "dev": true, - "license": "MIT", - "dependencies": { - "@babel/core": "^7.21.3", - "@babel/plugin-transform-react-constant-elements": "^7.21.3", - "@babel/preset-env": "^7.20.2", - "@babel/preset-react": "^7.18.6", - "@babel/preset-typescript": "^7.21.0", - "@svgr/core": "8.1.0", - "@svgr/plugin-jsx": "8.1.0", - "@svgr/plugin-svgo": "8.1.0" - }, - "engines": { - "node": ">=14" - }, - "funding": { - "type": "github", - "url": "https://github.com/sponsors/gregberge" - } - }, - "node_modules/@szmarczak/http-timer": { - "version": "5.0.1", - "resolved": "https://registry.npmjs.org/@szmarczak/http-timer/-/http-timer-5.0.1.tgz", - "integrity": "sha512-+PmQX0PiAYPMeVYe237LJAYvOMYW1j2rH5YROyS3b4CTVJum34HfRvKvAzozHAQG0TnHNdUfY9nCeUyRAs//cw==", - "dev": true, - "license": "MIT", - "dependencies": { - "defer-to-connect": "^2.0.1" - }, - "engines": { - "node": ">=14.16" - } - }, - "node_modules/@trysound/sax": { - "version": "0.2.0", - "resolved": "https://registry.npmjs.org/@trysound/sax/-/sax-0.2.0.tgz", - "integrity": "sha512-L7z9BgrNEcYyUYtF+HaEfiS5ebkh9jXqbszz7pC0hRBPaatV0XjSD3+eHrpqFemQfgwiFF0QPIarnIihIDn7OA==", - "dev": true, - "license": "ISC", - "engines": { - "node": ">=10.13.0" + "tslib": "^2.8.0" } }, "node_modules/@tybys/wasm-util": { - "version": "0.10.0", - "resolved": "https://registry.npmjs.org/@tybys/wasm-util/-/wasm-util-0.10.0.tgz", - "integrity": "sha512-VyyPYFlOMNylG45GoAe0xDoLwWuowvf92F9kySqzYh8vmYm7D2u4iUJKa1tOUpS70Ku13ASrOkS4ScXFsTaCNQ==", + "version": "0.10.1", + "resolved": "https://registry.npmjs.org/@tybys/wasm-util/-/wasm-util-0.10.1.tgz", + "integrity": "sha512-9tTaPJLSiejZKx+Bmog4uSubteqTvFrVrURwkmHixBo0G4seD0zUxp98E1DzUBJxLQ3NPwXrGKDiVjwx/DpPsg==", "dev": true, "license": "MIT", "optional": true, @@ -6608,48 +3503,6 @@ "@babel/types": "^7.28.2" } }, - "node_modules/@types/body-parser": { - "version": "1.19.6", - "resolved": "https://registry.npmjs.org/@types/body-parser/-/body-parser-1.19.6.tgz", - "integrity": "sha512-HLFeCYgz89uk22N5Qg3dvGvsv46B8GLvKKo1zKG4NybA8U2DiEO3w9lqGg29t/tfLRJpJ6iQxnVw4OnB7MoM9g==", - "dev": true, - "license": "MIT", - "dependencies": { - "@types/connect": "*", - "@types/node": "*" - } - }, - "node_modules/@types/bonjour": { - "version": "3.5.13", - "resolved": "https://registry.npmjs.org/@types/bonjour/-/bonjour-3.5.13.tgz", - "integrity": "sha512-z9fJ5Im06zvUL548KvYNecEVlA7cVDkGUi6kZusb04mpyEFKCIZJvloCcmpmLaIahDpOQGHaHmG6imtPMmPXGQ==", - "dev": true, - "license": "MIT", - "dependencies": { - "@types/node": "*" - } - }, - "node_modules/@types/connect": { - "version": "3.4.38", - "resolved": "https://registry.npmjs.org/@types/connect/-/connect-3.4.38.tgz", - "integrity": "sha512-K6uROf1LD88uDQqJCktA4yzL1YYAK6NgfsI0v/mTgyPKWsX1CnJ0XPSDhViejru1GcRkLWb8RlzFYJRqGUbaug==", - "dev": true, - "license": "MIT", - "dependencies": { - "@types/node": "*" - } - }, - "node_modules/@types/connect-history-api-fallback": { - "version": "1.5.4", - "resolved": "https://registry.npmjs.org/@types/connect-history-api-fallback/-/connect-history-api-fallback-1.5.4.tgz", - "integrity": "sha512-n6Cr2xS1h4uAulPRdlw6Jl6s1oG8KrVilPN2yUITEs+K48EzMJJ3W1xy8K5eWuFvjp3R74AOIGSmp2UfBJ8HFw==", - "dev": true, - "license": "MIT", - "dependencies": { - "@types/express-serve-static-core": "*", - "@types/node": "*" - } - }, "node_modules/@types/debug": { "version": "4.1.12", "resolved": "https://registry.npmjs.org/@types/debug/-/debug-4.1.12.tgz", @@ -6659,28 +3512,6 @@ "@types/ms": "*" } }, - "node_modules/@types/eslint": { - "version": "9.6.1", - "resolved": "https://registry.npmjs.org/@types/eslint/-/eslint-9.6.1.tgz", - "integrity": "sha512-FXx2pKgId/WyYo2jXw63kk7/+TY7u7AziEJxJAnSFzHlqTAS3Ync6SvgYAN/k4/PQpnnVuzoMuVnByKK2qp0ag==", - "dev": true, - "license": "MIT", - "dependencies": { - "@types/estree": "*", - "@types/json-schema": "*" - } - }, - "node_modules/@types/eslint-scope": { - "version": "3.7.7", - "resolved": "https://registry.npmjs.org/@types/eslint-scope/-/eslint-scope-3.7.7.tgz", - "integrity": "sha512-MzMFlSLBqNF2gcHWO0G1vP/YQyfvrxZ0bF+u7mzUdZ1/xK4A4sru+nraZz5i3iEIk1l1uyicaDVTB4QbbEkAYg==", - "dev": true, - "license": "MIT", - "dependencies": { - "@types/eslint": "*", - "@types/estree": "*" - } - }, "node_modules/@types/estree": { "version": "1.0.8", "resolved": "https://registry.npmjs.org/@types/estree/-/estree-1.0.8.tgz", @@ -6698,39 +3529,16 @@ "@types/estree": "*" } }, - "node_modules/@types/express": { - "version": "4.17.25", - "resolved": "https://registry.npmjs.org/@types/express/-/express-4.17.25.tgz", - "integrity": "sha512-dVd04UKsfpINUnK0yBoYHDF3xu7xVH4BuDotC/xGuycx4CgbP48X/KF/586bcObxT0HENHXEU8Nqtu6NR+eKhw==", + "node_modules/@types/fontkit": { + "version": "2.0.8", + "resolved": "https://registry.npmjs.org/@types/fontkit/-/fontkit-2.0.8.tgz", + "integrity": "sha512-wN+8bYxIpJf+5oZdrdtaX04qUuWHcKxcDEgRS9Qm9ZClSHjzEn13SxUC+5eRM+4yXIeTYk8mTzLAWGF64847ew==", "dev": true, "license": "MIT", "dependencies": { - "@types/body-parser": "*", - "@types/express-serve-static-core": "^4.17.33", - "@types/qs": "*", - "@types/serve-static": "^1" + "@types/node": "*" } }, - "node_modules/@types/express-serve-static-core": { - "version": "4.19.7", - "resolved": "https://registry.npmjs.org/@types/express-serve-static-core/-/express-serve-static-core-4.19.7.tgz", - "integrity": "sha512-FvPtiIf1LfhzsaIXhv/PHan/2FeQBbtBDtfX2QfvPxdUelMDEckK08SM6nqo1MIZY3RUlfA+HV8+hFUSio78qg==", - "dev": true, - "license": "MIT", - "dependencies": { - "@types/node": "*", - "@types/qs": "*", - "@types/range-parser": "*", - "@types/send": "*" - } - }, - "node_modules/@types/gtag.js": { - "version": "0.0.12", - "resolved": "https://registry.npmjs.org/@types/gtag.js/-/gtag.js-0.0.12.tgz", - "integrity": "sha512-YQV9bUsemkzG81Ea295/nF/5GijnD2Af7QhEofh7xu+kvCN6RdodgNwwGWXB5GMI3NoyvQo0odNctoH/qLMIpg==", - "dev": true, - "license": "MIT" - }, "node_modules/@types/hast": { "version": "3.0.4", "resolved": "https://registry.npmjs.org/@types/hast/-/hast-3.0.4.tgz", @@ -6741,44 +3549,6 @@ "@types/unist": "*" } }, - "node_modules/@types/history": { - "version": "4.7.11", - "resolved": "https://registry.npmjs.org/@types/history/-/history-4.7.11.tgz", - "integrity": "sha512-qjDJRrmvBMiTx+jyLxvLfJU7UznFuokDv4f3WRuriHKERccVpFU+8XMQUAbDzoiJCsmexxRExQeMwwCdamSKDA==", - "dev": true, - "license": "MIT" - }, - "node_modules/@types/html-minifier-terser": { - "version": "6.1.0", - "resolved": "https://registry.npmjs.org/@types/html-minifier-terser/-/html-minifier-terser-6.1.0.tgz", - "integrity": "sha512-oh/6byDPnL1zeNXFrDXFLyZjkr1MsBG667IM792caf1L2UPOOMf65NFzjUH/ltyfwjAGfs1rsX1eftK0jC/KIg==", - "dev": true, - "license": "MIT" - }, - "node_modules/@types/http-cache-semantics": { - "version": "4.0.4", - "resolved": "https://registry.npmjs.org/@types/http-cache-semantics/-/http-cache-semantics-4.0.4.tgz", - "integrity": "sha512-1m0bIFVc7eJWyve9S0RnuRgcQqF/Xd5QsUZAZeQFr1Q3/p9JWoQQEqmVy+DPTNpGXwhgIetAoYF8JSc33q29QA==", - "dev": true, - "license": "MIT" - }, - "node_modules/@types/http-errors": { - "version": "2.0.5", - "resolved": "https://registry.npmjs.org/@types/http-errors/-/http-errors-2.0.5.tgz", - "integrity": "sha512-r8Tayk8HJnX0FztbZN7oVqGccWgw98T/0neJphO91KkmOzug1KkofZURD4UaD5uH8AqcFLfdPErnBod0u71/qg==", - "dev": true, - "license": "MIT" - }, - "node_modules/@types/http-proxy": { - "version": "1.17.17", - "resolved": "https://registry.npmjs.org/@types/http-proxy/-/http-proxy-1.17.17.tgz", - "integrity": "sha512-ED6LB+Z1AVylNTu7hdzuBqOgMnvG/ld6wGCG8wFnAzKX5uyW2K3WD52v0gnLCTK/VLpXtKckgWuyScYK6cSPaw==", - "dev": true, - "license": "MIT", - "dependencies": { - "@types/node": "*" - } - }, "node_modules/@types/istanbul-lib-coverage": { "version": "2.0.6", "resolved": "https://registry.npmjs.org/@types/istanbul-lib-coverage/-/istanbul-lib-coverage-2.0.6.tgz", @@ -6806,6 +3576,13 @@ "@types/istanbul-lib-report": "*" } }, + "node_modules/@types/js-yaml": { + "version": "4.0.9", + "resolved": "https://registry.npmjs.org/@types/js-yaml/-/js-yaml-4.0.9.tgz", + "integrity": "sha512-k4MGaQl5TGo/iipqb2UDG2UwjXziSWkh0uysQelTlJpX1qGlpUZYm8PnO4DxG1qBomtJUdYJ6qR6xdIah10JLg==", + "dev": true, + "license": "MIT" + }, "node_modules/@types/json-schema": { "version": "7.0.15", "resolved": "https://registry.npmjs.org/@types/json-schema/-/json-schema-7.0.15.tgz", @@ -6836,114 +3613,32 @@ "dev": true, "license": "MIT" }, - "node_modules/@types/mime": { - "version": "1.3.5", - "resolved": "https://registry.npmjs.org/@types/mime/-/mime-1.3.5.tgz", - "integrity": "sha512-/pyBZWSLD2n0dcHE3hq8s8ZvcETHtEuF+3E7XVt0Ig2nvsVQXdghHVcEkIWjy9A0wKfTn97a/PSDYohKIlnP/w==", - "dev": true, - "license": "MIT" - }, "node_modules/@types/ms": { "version": "2.1.0", "resolved": "https://registry.npmjs.org/@types/ms/-/ms-2.1.0.tgz", "integrity": "sha512-GsCCIZDE/p3i96vtEqx+7dBUGXrc7zeSK3wwPHIaRThS+9OhWIXRqzs4d6k1SVU8g91DrNRWxWUGhp5KXQb2VA==", "license": "MIT" }, + "node_modules/@types/nlcst": { + "version": "2.0.3", + "resolved": "https://registry.npmjs.org/@types/nlcst/-/nlcst-2.0.3.tgz", + "integrity": "sha512-vSYNSDe6Ix3q+6Z7ri9lyWqgGhJTmzRjZRqyq15N0Z/1/UnVsno9G/N40NBijoYx2seFDIl0+B2mgAb9mezUCA==", + "dev": true, + "license": "MIT", + "dependencies": { + "@types/unist": "*" + } + }, "node_modules/@types/node": { - "version": "24.3.0", - "resolved": "https://registry.npmjs.org/@types/node/-/node-24.3.0.tgz", - "integrity": "sha512-aPTXCrfwnDLj4VvXrm+UUCQjNEvJgNA8s5F1cvwQU+3KNltTOkBm1j30uNLyqqPNe7gE3KFzImYoZEfLhp4Yow==", - "devOptional": true, - "license": "MIT", - "peer": true, - "dependencies": { - "undici-types": "~7.10.0" - } - }, - "node_modules/@types/node-forge": { - "version": "1.3.14", - "resolved": "https://registry.npmjs.org/@types/node-forge/-/node-forge-1.3.14.tgz", - "integrity": "sha512-mhVF2BnD4BO+jtOp7z1CdzaK4mbuK0LLQYAvdOLqHTavxFNq4zA1EmYkpnFjP8HOUzedfQkRnp0E2ulSAYSzAw==", + "version": "25.0.3", + "resolved": "https://registry.npmjs.org/@types/node/-/node-25.0.3.tgz", + "integrity": "sha512-W609buLVRVmeW693xKfzHeIV6nJGGz98uCPfeXI1ELMLXVeKYZ9m15fAMSaUPBHYLGFsVRcMmSCksQOrZV9BYA==", "dev": true, "license": "MIT", "dependencies": { - "@types/node": "*" + "undici-types": "~7.16.0" } }, - "node_modules/@types/prismjs": { - "version": "1.26.5", - "resolved": "https://registry.npmjs.org/@types/prismjs/-/prismjs-1.26.5.tgz", - "integrity": "sha512-AUZTa7hQ2KY5L7AmtSiqxlhWxb4ina0yd8hNbl4TWuqnv/pFP0nDMb3YrfSBf4hJVGLh2YEIBfKaBW/9UEl6IQ==", - "dev": true, - "license": "MIT" - }, - "node_modules/@types/qs": { - "version": "6.14.0", - "resolved": "https://registry.npmjs.org/@types/qs/-/qs-6.14.0.tgz", - "integrity": "sha512-eOunJqu0K1923aExK6y8p6fsihYEn/BYuQ4g0CxAAgFc4b/ZLN4CrsRZ55srTdqoiLzU2B2evC+apEIxprEzkQ==", - "dev": true, - "license": "MIT" - }, - "node_modules/@types/range-parser": { - "version": "1.2.7", - "resolved": "https://registry.npmjs.org/@types/range-parser/-/range-parser-1.2.7.tgz", - "integrity": "sha512-hKormJbkJqzQGhziax5PItDUTMAM9uE2XXQmM37dyd4hVM+5aVl7oVxMVUiVQn2oCQFN/LKCZdvSM0pFRqbSmQ==", - "dev": true, - "license": "MIT" - }, - "node_modules/@types/react": { - "version": "19.2.7", - "resolved": "https://registry.npmjs.org/@types/react/-/react-19.2.7.tgz", - "integrity": "sha512-MWtvHrGZLFttgeEj28VXHxpmwYbor/ATPYbBfSFZEIRK0ecCFLl2Qo55z52Hss+UV9CRN7trSeq1zbgx7YDWWg==", - "dev": true, - "license": "MIT", - "peer": true, - "dependencies": { - "csstype": "^3.2.2" - } - }, - "node_modules/@types/react-router": { - "version": "5.1.20", - "resolved": "https://registry.npmjs.org/@types/react-router/-/react-router-5.1.20.tgz", - "integrity": "sha512-jGjmu/ZqS7FjSH6owMcD5qpq19+1RS9DeVRqfl1FeBMxTDQAGwlMWOcs52NDoXaNKyG3d1cYQFMs9rCrb88o9Q==", - "dev": true, - "license": "MIT", - "dependencies": { - "@types/history": "^4.7.11", - "@types/react": "*" - } - }, - "node_modules/@types/react-router-config": { - "version": "5.0.11", - "resolved": "https://registry.npmjs.org/@types/react-router-config/-/react-router-config-5.0.11.tgz", - "integrity": "sha512-WmSAg7WgqW7m4x8Mt4N6ZyKz0BubSj/2tVUMsAHp+Yd2AMwcSbeFq9WympT19p5heCFmF97R9eD5uUR/t4HEqw==", - "dev": true, - "license": "MIT", - "dependencies": { - "@types/history": "^4.7.11", - "@types/react": "*", - "@types/react-router": "^5.1.0" - } - }, - "node_modules/@types/react-router-dom": { - "version": "5.3.3", - "resolved": "https://registry.npmjs.org/@types/react-router-dom/-/react-router-dom-5.3.3.tgz", - "integrity": "sha512-kpqnYK4wcdm5UaWI3fLcELopqLrHgLqNsdpHauzlQktfkHL3npOSwtj1Uz9oKBAzs7lFtVkV8j83voAz2D8fhw==", - "dev": true, - "license": "MIT", - "dependencies": { - "@types/history": "^4.7.11", - "@types/react": "*", - "@types/react-router": "*" - } - }, - "node_modules/@types/retry": { - "version": "0.12.2", - "resolved": "https://registry.npmjs.org/@types/retry/-/retry-0.12.2.tgz", - "integrity": "sha512-XISRgDJ2Tc5q4TRqvgJtzsRkFYNJzZrhTdtMoGVBttwzzQJkPnS3WWTFc7kuDRoPtPakl+T+OfdEUjYJj7Jbow==", - "dev": true, - "license": "MIT" - }, "node_modules/@types/sax": { "version": "1.2.7", "resolved": "https://registry.npmjs.org/@types/sax/-/sax-1.2.7.tgz", @@ -6954,59 +3649,6 @@ "@types/node": "*" } }, - "node_modules/@types/send": { - "version": "1.2.1", - "resolved": "https://registry.npmjs.org/@types/send/-/send-1.2.1.tgz", - "integrity": "sha512-arsCikDvlU99zl1g69TcAB3mzZPpxgw0UQnaHeC1Nwb015xp8bknZv5rIfri9xTOcMuaVgvabfIRA7PSZVuZIQ==", - "dev": true, - "license": "MIT", - "dependencies": { - "@types/node": "*" - } - }, - "node_modules/@types/serve-index": { - "version": "1.9.4", - "resolved": "https://registry.npmjs.org/@types/serve-index/-/serve-index-1.9.4.tgz", - "integrity": "sha512-qLpGZ/c2fhSs5gnYsQxtDEq3Oy8SXPClIXkW5ghvAvsNuVSA8k+gCONcUCS/UjLEYvYps+e8uBtfgXgvhwfNug==", - "dev": true, - "license": "MIT", - "dependencies": { - "@types/express": "*" - } - }, - "node_modules/@types/serve-static": { - "version": "1.15.10", - "resolved": "https://registry.npmjs.org/@types/serve-static/-/serve-static-1.15.10.tgz", - "integrity": "sha512-tRs1dB+g8Itk72rlSI2ZrW6vZg0YrLI81iQSTkMmOqnqCaNr/8Ek4VwWcN5vZgCYWbg/JJSGBlUaYGAOP73qBw==", - "dev": true, - "license": "MIT", - "dependencies": { - "@types/http-errors": "*", - "@types/node": "*", - "@types/send": "<1" - } - }, - "node_modules/@types/serve-static/node_modules/@types/send": { - "version": "0.17.6", - "resolved": "https://registry.npmjs.org/@types/send/-/send-0.17.6.tgz", - "integrity": "sha512-Uqt8rPBE8SY0RK8JB1EzVOIZ32uqy8HwdxCnoCOsYrvnswqmFZ/k+9Ikidlk/ImhsdvBsloHbAlewb2IEBV/Og==", - "dev": true, - "license": "MIT", - "dependencies": { - "@types/mime": "^1", - "@types/node": "*" - } - }, - "node_modules/@types/sockjs": { - "version": "0.3.36", - "resolved": "https://registry.npmjs.org/@types/sockjs/-/sockjs-0.3.36.tgz", - "integrity": "sha512-MK9V6NzAS1+Ud7JV9lJLFqW85VbC9dq3LmwZCuBe4wBDgKC0Kj/jd8Xl+nSviU+Qc3+m7umHHyHg//2KSa0a0Q==", - "dev": true, - "license": "MIT", - "dependencies": { - "@types/node": "*" - } - }, "node_modules/@types/stack-utils": { "version": "2.0.3", "resolved": "https://registry.npmjs.org/@types/stack-utils/-/stack-utils-2.0.3.tgz", @@ -7020,20 +3662,10 @@ "integrity": "sha512-ko/gIFJRv177XgZsZcBwnqJN5x/Gien8qNOn0D5bQU/zAzVf9Zt3BlcUiLqhV9y4ARk0GbT3tnUiPNgnTXzc/Q==", "license": "MIT" }, - "node_modules/@types/ws": { - "version": "8.18.1", - "resolved": "https://registry.npmjs.org/@types/ws/-/ws-8.18.1.tgz", - "integrity": "sha512-ThVF6DCVhA8kUGy+aazFQ4kXQ7E1Ty7A3ypFOe0IcJV8O/M511G99AW24irKrW56Wt44yG9+ij8FaqoBGkuBXg==", - "dev": true, - "license": "MIT", - "dependencies": { - "@types/node": "*" - } - }, "node_modules/@types/yargs": { - "version": "17.0.33", - "resolved": "https://registry.npmjs.org/@types/yargs/-/yargs-17.0.33.tgz", - "integrity": "sha512-WpxBCKWPLr4xSsHgz511rFJAM+wS28w2zEO1QDNY5zM/S8ok70NNfztH0xwhqKyaK0OHCbN98LDAZuy1ctxDkA==", + "version": "17.0.35", + "resolved": "https://registry.npmjs.org/@types/yargs/-/yargs-17.0.35.tgz", + "integrity": "sha512-qUHkeCyQFxMXg79wQfTtfndEC+N9ZZg76HJftDJp+qH2tV7Gj4OJi7l+PiWwJ+pWtW8GwSmqsDj/oymhrTWXjg==", "dev": true, "license": "MIT", "dependencies": { @@ -7323,191 +3955,6 @@ "win32" ] }, - "node_modules/@vercel/oidc": { - "version": "3.0.5", - "resolved": "https://registry.npmjs.org/@vercel/oidc/-/oidc-3.0.5.tgz", - "integrity": "sha512-fnYhv671l+eTTp48gB4zEsTW/YtRgRPnkI2nT7x6qw5rkI1Lq2hTmQIpHPgyThI0znLK+vX2n9XxKdXZ7BUbbw==", - "dev": true, - "license": "Apache-2.0", - "engines": { - "node": ">= 20" - } - }, - "node_modules/@webassemblyjs/ast": { - "version": "1.14.1", - "resolved": "https://registry.npmjs.org/@webassemblyjs/ast/-/ast-1.14.1.tgz", - "integrity": "sha512-nuBEDgQfm1ccRp/8bCQrx1frohyufl4JlbMMZ4P1wpeOfDhF6FQkxZJ1b/e+PLwr6X1Nhw6OLme5usuBWYBvuQ==", - "dev": true, - "license": "MIT", - "dependencies": { - "@webassemblyjs/helper-numbers": "1.13.2", - "@webassemblyjs/helper-wasm-bytecode": "1.13.2" - } - }, - "node_modules/@webassemblyjs/floating-point-hex-parser": { - "version": "1.13.2", - "resolved": "https://registry.npmjs.org/@webassemblyjs/floating-point-hex-parser/-/floating-point-hex-parser-1.13.2.tgz", - "integrity": "sha512-6oXyTOzbKxGH4steLbLNOu71Oj+C8Lg34n6CqRvqfS2O71BxY6ByfMDRhBytzknj9yGUPVJ1qIKhRlAwO1AovA==", - "dev": true, - "license": "MIT" - }, - "node_modules/@webassemblyjs/helper-api-error": { - "version": "1.13.2", - "resolved": "https://registry.npmjs.org/@webassemblyjs/helper-api-error/-/helper-api-error-1.13.2.tgz", - "integrity": "sha512-U56GMYxy4ZQCbDZd6JuvvNV/WFildOjsaWD3Tzzvmw/mas3cXzRJPMjP83JqEsgSbyrmaGjBfDtV7KDXV9UzFQ==", - "dev": true, - "license": "MIT" - }, - "node_modules/@webassemblyjs/helper-buffer": { - "version": "1.14.1", - "resolved": "https://registry.npmjs.org/@webassemblyjs/helper-buffer/-/helper-buffer-1.14.1.tgz", - "integrity": "sha512-jyH7wtcHiKssDtFPRB+iQdxlDf96m0E39yb0k5uJVhFGleZFoNw1c4aeIcVUPPbXUVJ94wwnMOAqUHyzoEPVMA==", - "dev": true, - "license": "MIT" - }, - "node_modules/@webassemblyjs/helper-numbers": { - "version": "1.13.2", - "resolved": "https://registry.npmjs.org/@webassemblyjs/helper-numbers/-/helper-numbers-1.13.2.tgz", - "integrity": "sha512-FE8aCmS5Q6eQYcV3gI35O4J789wlQA+7JrqTTpJqn5emA4U2hvwJmvFRC0HODS+3Ye6WioDklgd6scJ3+PLnEA==", - "dev": true, - "license": "MIT", - "dependencies": { - "@webassemblyjs/floating-point-hex-parser": "1.13.2", - "@webassemblyjs/helper-api-error": "1.13.2", - "@xtuc/long": "4.2.2" - } - }, - "node_modules/@webassemblyjs/helper-wasm-bytecode": { - "version": "1.13.2", - "resolved": "https://registry.npmjs.org/@webassemblyjs/helper-wasm-bytecode/-/helper-wasm-bytecode-1.13.2.tgz", - "integrity": "sha512-3QbLKy93F0EAIXLh0ogEVR6rOubA9AoZ+WRYhNbFyuB70j3dRdwH9g+qXhLAO0kiYGlg3TxDV+I4rQTr/YNXkA==", - "dev": true, - "license": "MIT" - }, - "node_modules/@webassemblyjs/helper-wasm-section": { - "version": "1.14.1", - "resolved": "https://registry.npmjs.org/@webassemblyjs/helper-wasm-section/-/helper-wasm-section-1.14.1.tgz", - "integrity": "sha512-ds5mXEqTJ6oxRoqjhWDU83OgzAYjwsCV8Lo/N+oRsNDmx/ZDpqalmrtgOMkHwxsG0iI//3BwWAErYRHtgn0dZw==", - "dev": true, - "license": "MIT", - "dependencies": { - "@webassemblyjs/ast": "1.14.1", - "@webassemblyjs/helper-buffer": "1.14.1", - "@webassemblyjs/helper-wasm-bytecode": "1.13.2", - "@webassemblyjs/wasm-gen": "1.14.1" - } - }, - "node_modules/@webassemblyjs/ieee754": { - "version": "1.13.2", - "resolved": "https://registry.npmjs.org/@webassemblyjs/ieee754/-/ieee754-1.13.2.tgz", - "integrity": "sha512-4LtOzh58S/5lX4ITKxnAK2USuNEvpdVV9AlgGQb8rJDHaLeHciwG4zlGr0j/SNWlr7x3vO1lDEsuePvtcDNCkw==", - "dev": true, - "license": "MIT", - "dependencies": { - "@xtuc/ieee754": "^1.2.0" - } - }, - "node_modules/@webassemblyjs/leb128": { - "version": "1.13.2", - "resolved": "https://registry.npmjs.org/@webassemblyjs/leb128/-/leb128-1.13.2.tgz", - "integrity": "sha512-Lde1oNoIdzVzdkNEAWZ1dZ5orIbff80YPdHx20mrHwHrVNNTjNr8E3xz9BdpcGqRQbAEa+fkrCb+fRFTl/6sQw==", - "dev": true, - "license": "Apache-2.0", - "dependencies": { - "@xtuc/long": "4.2.2" - } - }, - "node_modules/@webassemblyjs/utf8": { - "version": "1.13.2", - "resolved": "https://registry.npmjs.org/@webassemblyjs/utf8/-/utf8-1.13.2.tgz", - "integrity": "sha512-3NQWGjKTASY1xV5m7Hr0iPeXD9+RDobLll3T9d2AO+g3my8xy5peVyjSag4I50mR1bBSN/Ct12lo+R9tJk0NZQ==", - "dev": true, - "license": "MIT" - }, - "node_modules/@webassemblyjs/wasm-edit": { - "version": "1.14.1", - "resolved": "https://registry.npmjs.org/@webassemblyjs/wasm-edit/-/wasm-edit-1.14.1.tgz", - "integrity": "sha512-RNJUIQH/J8iA/1NzlE4N7KtyZNHi3w7at7hDjvRNm5rcUXa00z1vRz3glZoULfJ5mpvYhLybmVcwcjGrC1pRrQ==", - "dev": true, - "license": "MIT", - "dependencies": { - "@webassemblyjs/ast": "1.14.1", - "@webassemblyjs/helper-buffer": "1.14.1", - "@webassemblyjs/helper-wasm-bytecode": "1.13.2", - "@webassemblyjs/helper-wasm-section": "1.14.1", - "@webassemblyjs/wasm-gen": "1.14.1", - "@webassemblyjs/wasm-opt": "1.14.1", - "@webassemblyjs/wasm-parser": "1.14.1", - "@webassemblyjs/wast-printer": "1.14.1" - } - }, - "node_modules/@webassemblyjs/wasm-gen": { - "version": "1.14.1", - "resolved": "https://registry.npmjs.org/@webassemblyjs/wasm-gen/-/wasm-gen-1.14.1.tgz", - "integrity": "sha512-AmomSIjP8ZbfGQhumkNvgC33AY7qtMCXnN6bL2u2Js4gVCg8fp735aEiMSBbDR7UQIj90n4wKAFUSEd0QN2Ukg==", - "dev": true, - "license": "MIT", - "dependencies": { - "@webassemblyjs/ast": "1.14.1", - "@webassemblyjs/helper-wasm-bytecode": "1.13.2", - "@webassemblyjs/ieee754": "1.13.2", - "@webassemblyjs/leb128": "1.13.2", - "@webassemblyjs/utf8": "1.13.2" - } - }, - "node_modules/@webassemblyjs/wasm-opt": { - "version": "1.14.1", - "resolved": "https://registry.npmjs.org/@webassemblyjs/wasm-opt/-/wasm-opt-1.14.1.tgz", - "integrity": "sha512-PTcKLUNvBqnY2U6E5bdOQcSM+oVP/PmrDY9NzowJjislEjwP/C4an2303MCVS2Mg9d3AJpIGdUFIQQWbPds0Sw==", - "dev": true, - "license": "MIT", - "dependencies": { - "@webassemblyjs/ast": "1.14.1", - "@webassemblyjs/helper-buffer": "1.14.1", - "@webassemblyjs/wasm-gen": "1.14.1", - "@webassemblyjs/wasm-parser": "1.14.1" - } - }, - "node_modules/@webassemblyjs/wasm-parser": { - "version": "1.14.1", - "resolved": "https://registry.npmjs.org/@webassemblyjs/wasm-parser/-/wasm-parser-1.14.1.tgz", - "integrity": "sha512-JLBl+KZ0R5qB7mCnud/yyX08jWFw5MsoalJ1pQ4EdFlgj9VdXKGuENGsiCIjegI1W7p91rUlcB/LB5yRJKNTcQ==", - "dev": true, - "license": "MIT", - "dependencies": { - "@webassemblyjs/ast": "1.14.1", - "@webassemblyjs/helper-api-error": "1.13.2", - "@webassemblyjs/helper-wasm-bytecode": "1.13.2", - "@webassemblyjs/ieee754": "1.13.2", - "@webassemblyjs/leb128": "1.13.2", - "@webassemblyjs/utf8": "1.13.2" - } - }, - "node_modules/@webassemblyjs/wast-printer": { - "version": "1.14.1", - "resolved": "https://registry.npmjs.org/@webassemblyjs/wast-printer/-/wast-printer-1.14.1.tgz", - "integrity": "sha512-kPSSXE6De1XOR820C90RIo2ogvZG+c3KiHzqUoO/F34Y2shGzesfqv7o57xrxovZJH/MetF5UjroJ/R/3isoiw==", - "dev": true, - "license": "MIT", - "dependencies": { - "@webassemblyjs/ast": "1.14.1", - "@xtuc/long": "4.2.2" - } - }, - "node_modules/@xtuc/ieee754": { - "version": "1.2.0", - "resolved": "https://registry.npmjs.org/@xtuc/ieee754/-/ieee754-1.2.0.tgz", - "integrity": "sha512-DX8nKgqcGwsc0eJSqYt5lwP4DH5FlHnmuWWBRy7X0NcaGR0ZtuyeESgMwTYVEtxmsNGY+qit4QYT/MIYTOTPeA==", - "dev": true, - "license": "BSD-3-Clause" - }, - "node_modules/@xtuc/long": { - "version": "4.2.2", - "resolved": "https://registry.npmjs.org/@xtuc/long/-/long-4.2.2.tgz", - "integrity": "sha512-NuHqBY1PB/D8xU6s/thBgOAiAP7HOYDQ32+BFZILJ8ivkUkAHQnWfn6WhL79Owj1qmUnoN/YPhktdIoucipkAQ==", - "dev": true, - "license": "Apache-2.0" - }, "node_modules/abort-controller": { "version": "3.0.0", "resolved": "https://registry.npmjs.org/abort-controller/-/abort-controller-3.0.0.tgz", @@ -7521,60 +3968,12 @@ "node": ">=6.5" } }, - "node_modules/accepts": { - "version": "1.3.8", - "resolved": "https://registry.npmjs.org/accepts/-/accepts-1.3.8.tgz", - "integrity": "sha512-PYAthTa2m2VKxuvSD3DPC/Gy+U+sOA1LAuT8mkmRuvw+NACSaeXEQ+NHcVF7rONl6qcaxV3Uuemwawk+7+SJLw==", - "dev": true, - "license": "MIT", - "dependencies": { - "mime-types": "~2.1.34", - "negotiator": "0.6.3" - }, - "engines": { - "node": ">= 0.6" - } - }, - "node_modules/accepts/node_modules/mime-db": { - "version": "1.52.0", - "resolved": "https://registry.npmjs.org/mime-db/-/mime-db-1.52.0.tgz", - "integrity": "sha512-sPU4uV7dYlvtWJxwwxHD0PuihVNiE7TyAbQ5SWxDCB9mUYvOgroQOwYQQOKPJ8CIbE+1ETVlOoK1UC2nU3gYvg==", - "dev": true, - "license": "MIT", - "engines": { - "node": ">= 0.6" - } - }, - "node_modules/accepts/node_modules/mime-types": { - "version": "2.1.35", - "resolved": "https://registry.npmjs.org/mime-types/-/mime-types-2.1.35.tgz", - "integrity": "sha512-ZDY+bPm5zTTF+YpCrAU9nK0UgICYPT0QtT1NZWFv4s++TNkcgVaT0g6+4R2uI4MjQjzysHB1zxuWL50hzaeXiw==", - "dev": true, - "license": "MIT", - "dependencies": { - "mime-db": "1.52.0" - }, - "engines": { - "node": ">= 0.6" - } - }, - "node_modules/accepts/node_modules/negotiator": { - "version": "0.6.3", - "resolved": "https://registry.npmjs.org/negotiator/-/negotiator-0.6.3.tgz", - "integrity": "sha512-+EUsqGPLsM+j/zdChZjsnX51g4XrHFOIXwfnCVPGlQk/k5giakcKsuxCObBRu6DSm9opw/O6slWbJdghQM4bBg==", - "dev": true, - "license": "MIT", - "engines": { - "node": ">= 0.6" - } - }, "node_modules/acorn": { "version": "8.15.0", "resolved": "https://registry.npmjs.org/acorn/-/acorn-8.15.0.tgz", "integrity": "sha512-NZyJarBfL7nWwIq+FDL6Zp/yHEhePMNnnJ0y3qfieCrmNvYct8uvtiV41UvlSe6apAfk0fY1FbWx+NwfmpvtTg==", "dev": true, "license": "MIT", - "peer": true, "bin": { "acorn": "bin/acorn" }, @@ -7582,19 +3981,6 @@ "node": ">=0.4.0" } }, - "node_modules/acorn-import-phases": { - "version": "1.0.4", - "resolved": "https://registry.npmjs.org/acorn-import-phases/-/acorn-import-phases-1.0.4.tgz", - "integrity": "sha512-wKmbr/DDiIXzEOiWrTTUcDm24kQ2vGfZQvM2fwg2vXqR5uW6aapr7ObPtj1th32b9u90/Pf4AItvdTh42fBmVQ==", - "dev": true, - "license": "MIT", - "engines": { - "node": ">=10.13.0" - }, - "peerDependencies": { - "acorn": "^8.14.0" - } - }, "node_modules/acorn-jsx": { "version": "5.3.2", "resolved": "https://registry.npmjs.org/acorn-jsx/-/acorn-jsx-5.3.2.tgz", @@ -7605,79 +3991,12 @@ "acorn": "^6.0.0 || ^7.0.0 || ^8.0.0" } }, - "node_modules/acorn-walk": { - "version": "8.3.4", - "resolved": "https://registry.npmjs.org/acorn-walk/-/acorn-walk-8.3.4.tgz", - "integrity": "sha512-ueEepnujpqee2o5aIYnvHU6C0A42MNdsIDeqy5BydrkuC5R1ZuUFnm27EeFJGoEHJQgn3uleRvmTXaJgfXbt4g==", - "dev": true, - "license": "MIT", - "dependencies": { - "acorn": "^8.11.0" - }, - "engines": { - "node": ">=0.4.0" - } - }, - "node_modules/address": { - "version": "1.2.2", - "resolved": "https://registry.npmjs.org/address/-/address-1.2.2.tgz", - "integrity": "sha512-4B/qKCfeE/ODUaAUpSwfzazo5x29WD4r3vXiWsB7I2mSDAihwEqKO+g8GELZUQSSAo5e1XTYh3ZVfLyxBc12nA==", - "dev": true, - "license": "MIT", - "engines": { - "node": ">= 10.0.0" - } - }, - "node_modules/aggregate-error": { - "version": "3.1.0", - "resolved": "https://registry.npmjs.org/aggregate-error/-/aggregate-error-3.1.0.tgz", - "integrity": "sha512-4I7Td01quW/RpocfNayFdFVk1qSuoh0E7JrbRJ16nH01HhKFQ88INq9Sd+nd72zqRySlr9BmDA8xlEJ6vJMrYA==", - "dev": true, - "license": "MIT", - "dependencies": { - "clean-stack": "^2.0.0", - "indent-string": "^4.0.0" - }, - "engines": { - "node": ">=8" - } - }, - "node_modules/aggregate-error/node_modules/indent-string": { - "version": "4.0.0", - "resolved": "https://registry.npmjs.org/indent-string/-/indent-string-4.0.0.tgz", - "integrity": "sha512-EdDDZu4A2OyIK7Lr/2zG+w5jmbuk1DVBnEwREQvBzspBJkCEbRa8GxU1lghYcaGJCnRWibjDXlq779X1/y5xwg==", - "dev": true, - "license": "MIT", - "engines": { - "node": ">=8" - } - }, - "node_modules/ai": { - "version": "5.0.115", - "resolved": "https://registry.npmjs.org/ai/-/ai-5.0.115.tgz", - "integrity": "sha512-aVuHx0orGxXvhyL7oXUyW8TnWQE6Al8f3Bl6VZjz0WHMV+WaACHPkSyvQ3wje2QCUGzdl5DBF5d+OaXyghPQyg==", - "dev": true, - "license": "Apache-2.0", - "dependencies": { - "@ai-sdk/gateway": "2.0.22", - "@ai-sdk/provider": "2.0.0", - "@ai-sdk/provider-utils": "3.0.19", - "@opentelemetry/api": "1.9.0" - }, - "engines": { - "node": ">=18" - }, - "peerDependencies": { - "zod": "^3.25.76 || ^4.1.8" - } - }, "node_modules/ajv": { "version": "6.12.6", "resolved": "https://registry.npmjs.org/ajv/-/ajv-6.12.6.tgz", "integrity": "sha512-j3fVLgvTo527anyYyJOGTYJbG+vnnQYvE0m5mmkc1TK+nxAppkCLMIL0aZ4dblVCNoGShhm+kzE4ZUykBoMg4g==", "dev": true, "license": "MIT", - "peer": true, "dependencies": { "fast-deep-equal": "^3.1.1", "fast-json-stable-stringify": "^2.0.0", @@ -7689,98 +4008,6 @@ "url": "https://github.com/sponsors/epoberezkin" } }, - "node_modules/ajv-formats": { - "version": "2.1.1", - "resolved": "https://registry.npmjs.org/ajv-formats/-/ajv-formats-2.1.1.tgz", - "integrity": "sha512-Wx0Kx52hxE7C18hkMEggYlEifqWZtYaRgouJor+WMdPnQyEK13vgEWyVNup7SoeeoLMsr4kf5h6dOW11I15MUA==", - "dev": true, - "license": "MIT", - "dependencies": { - "ajv": "^8.0.0" - }, - "peerDependencies": { - "ajv": "^8.0.0" - }, - "peerDependenciesMeta": { - "ajv": { - "optional": true - } - } - }, - "node_modules/ajv-formats/node_modules/ajv": { - "version": "8.17.1", - "resolved": "https://registry.npmjs.org/ajv/-/ajv-8.17.1.tgz", - "integrity": "sha512-B/gBuNg5SiMTrPkC+A2+cW0RszwxYmn6VYxB/inlBStS5nx6xHIt/ehKRhIMhqusl7a8LjQoZnjCs5vhwxOQ1g==", - "dev": true, - "license": "MIT", - "dependencies": { - "fast-deep-equal": "^3.1.3", - "fast-uri": "^3.0.1", - "json-schema-traverse": "^1.0.0", - "require-from-string": "^2.0.2" - }, - "funding": { - "type": "github", - "url": "https://github.com/sponsors/epoberezkin" - } - }, - "node_modules/ajv-formats/node_modules/json-schema-traverse": { - "version": "1.0.0", - "resolved": "https://registry.npmjs.org/json-schema-traverse/-/json-schema-traverse-1.0.0.tgz", - "integrity": "sha512-NM8/P9n3XjXhIZn1lLhkFaACTOURQXjWhV4BA/RnOv8xvgqtqpAX9IO4mRQxSx1Rlo4tqzeqb0sOlruaOy3dug==", - "dev": true, - "license": "MIT" - }, - "node_modules/ajv-keywords": { - "version": "3.5.2", - "resolved": "https://registry.npmjs.org/ajv-keywords/-/ajv-keywords-3.5.2.tgz", - "integrity": "sha512-5p6WTN0DdTGVQk6VjcEju19IgaHudalcfabD7yhDGeA6bcQnmL+CpveLJq/3hvfwd1aof6L386Ougkx6RfyMIQ==", - "dev": true, - "license": "MIT", - "peerDependencies": { - "ajv": "^6.9.1" - } - }, - "node_modules/algoliasearch": { - "version": "5.46.1", - "resolved": "https://registry.npmjs.org/algoliasearch/-/algoliasearch-5.46.1.tgz", - "integrity": "sha512-39ol8Ulqb3MntofkXHlrcXKyU8BU0PXvQrXPBIX6eXj/EO4VT7651mhGVORI2oF8ydya9nFzT3fYDoqme/KL6w==", - "dev": true, - "license": "MIT", - "peer": true, - "dependencies": { - "@algolia/abtesting": "1.12.1", - "@algolia/client-abtesting": "5.46.1", - "@algolia/client-analytics": "5.46.1", - "@algolia/client-common": "5.46.1", - "@algolia/client-insights": "5.46.1", - "@algolia/client-personalization": "5.46.1", - "@algolia/client-query-suggestions": "5.46.1", - "@algolia/client-search": "5.46.1", - "@algolia/ingestion": "1.46.1", - "@algolia/monitoring": "1.46.1", - "@algolia/recommend": "5.46.1", - "@algolia/requester-browser-xhr": "5.46.1", - "@algolia/requester-fetch": "5.46.1", - "@algolia/requester-node-http": "5.46.1" - }, - "engines": { - "node": ">= 14.0.0" - } - }, - "node_modules/algoliasearch-helper": { - "version": "3.26.1", - "resolved": "https://registry.npmjs.org/algoliasearch-helper/-/algoliasearch-helper-3.26.1.tgz", - "integrity": "sha512-CAlCxm4fYBXtvc5MamDzP6Svu8rW4z9me4DCBY1rQ2UDJ0u0flWmusQ8M3nOExZsLLRcUwUPoRAPMrhzOG3erw==", - "dev": true, - "license": "MIT", - "dependencies": { - "@algolia/events": "^4.0.1" - }, - "peerDependencies": { - "algoliasearch": ">= 3.1 < 6" - } - }, "node_modules/ansi-align": { "version": "3.0.1", "resolved": "https://registry.npmjs.org/ansi-align/-/ansi-align-3.0.1.tgz", @@ -7794,6 +4021,7 @@ "version": "4.3.2", "resolved": "https://registry.npmjs.org/ansi-escapes/-/ansi-escapes-4.3.2.tgz", "integrity": "sha512-gKXj5ALrKWQLsYG9jlTRmR/xKluxHV+Z9QEwNIgCfM1/uwPMCuzVVnh5mwTd+OuBZcwSIMbqssNWRm1lE51QaQ==", + "dev": true, "license": "MIT", "dependencies": { "type-fest": "^0.21.3" @@ -7805,17 +4033,17 @@ "url": "https://github.com/sponsors/sindresorhus" } }, - "node_modules/ansi-html-community": { - "version": "0.0.8", - "resolved": "https://registry.npmjs.org/ansi-html-community/-/ansi-html-community-0.0.8.tgz", - "integrity": "sha512-1APHAyr3+PCamwNw3bXCPp4HFLONZt/yIH0sZp0/469KWNTEy+qN5jQ3GVX6DMZ1UXAi34yVwtTeaG/HpBuuzw==", + "node_modules/ansi-escapes/node_modules/type-fest": { + "version": "0.21.3", + "resolved": "https://registry.npmjs.org/type-fest/-/type-fest-0.21.3.tgz", + "integrity": "sha512-t0rzBq87m3fVcduHDUFhKmyyX+9eo6WQjZvf51Ea/M0Q7+T374Jp1aUiyUl0GKxp8M/OETVHSDvmkyPgvX+X2w==", "dev": true, - "engines": [ - "node >= 0.8.0" - ], - "license": "Apache-2.0", - "bin": { - "ansi-html": "bin/ansi-html" + "license": "(MIT OR CC0-1.0)", + "engines": { + "node": ">=10" + }, + "funding": { + "url": "https://github.com/sponsors/sindresorhus" } }, "node_modules/ansi-regex": { @@ -7856,6 +4084,19 @@ "node": ">= 8" } }, + "node_modules/anymatch/node_modules/picomatch": { + "version": "2.3.1", + "resolved": "https://registry.npmjs.org/picomatch/-/picomatch-2.3.1.tgz", + "integrity": "sha512-JU3teHTNjmE2VCGFzuY8EXzCDVwEqB2a8fsIvwaStHhAWJEeVd1o1QD80CU6+ZdEXXSLbSsuLwJjkCBWqRQUVA==", + "dev": true, + "license": "MIT", + "engines": { + "node": ">=8.6" + }, + "funding": { + "url": "https://github.com/sponsors/jonschlinkert" + } + }, "node_modules/archiver": { "version": "7.0.1", "resolved": "https://registry.npmjs.org/archiver/-/archiver-7.0.1.tgz", @@ -7904,31 +4145,6 @@ "balanced-match": "^1.0.0" } }, - "node_modules/archiver-utils/node_modules/buffer": { - "version": "6.0.3", - "resolved": "https://registry.npmjs.org/buffer/-/buffer-6.0.3.tgz", - "integrity": "sha512-FTiCpNxtwiZZHEZbcbTIcZjERVICn9yq/pDFkTl95/AxzD1naBctN7YO68riM/gLSDY7sdrMby8hofADYuuqOA==", - "dev": true, - "funding": [ - { - "type": "github", - "url": "https://github.com/sponsors/feross" - }, - { - "type": "patreon", - "url": "https://www.patreon.com/feross" - }, - { - "type": "consulting", - "url": "https://feross.org/support" - } - ], - "license": "MIT", - "dependencies": { - "base64-js": "^1.3.1", - "ieee754": "^1.2.1" - } - }, "node_modules/archiver-utils/node_modules/glob": { "version": "10.5.0", "resolved": "https://registry.npmjs.org/glob/-/glob-10.5.0.tgz", @@ -8006,65 +4222,6 @@ "url": "https://github.com/sponsors/isaacs" } }, - "node_modules/archiver-utils/node_modules/readable-stream": { - "version": "4.7.0", - "resolved": "https://registry.npmjs.org/readable-stream/-/readable-stream-4.7.0.tgz", - "integrity": "sha512-oIGGmcpTLwPga8Bn6/Z75SVaH1z5dUut2ibSyAMVhmUggWpmDn2dapB0n7f8nwaSiRtepAsfJyfXIO5DCVAODg==", - "dev": true, - "license": "MIT", - "dependencies": { - "abort-controller": "^3.0.0", - "buffer": "^6.0.3", - "events": "^3.3.0", - "process": "^0.11.10", - "string_decoder": "^1.3.0" - }, - "engines": { - "node": "^12.22.0 || ^14.17.0 || >=16.0.0" - } - }, - "node_modules/archiver/node_modules/buffer": { - "version": "6.0.3", - "resolved": "https://registry.npmjs.org/buffer/-/buffer-6.0.3.tgz", - "integrity": "sha512-FTiCpNxtwiZZHEZbcbTIcZjERVICn9yq/pDFkTl95/AxzD1naBctN7YO68riM/gLSDY7sdrMby8hofADYuuqOA==", - "dev": true, - "funding": [ - { - "type": "github", - "url": "https://github.com/sponsors/feross" - }, - { - "type": "patreon", - "url": "https://www.patreon.com/feross" - }, - { - "type": "consulting", - "url": "https://feross.org/support" - } - ], - "license": "MIT", - "dependencies": { - "base64-js": "^1.3.1", - "ieee754": "^1.2.1" - } - }, - "node_modules/archiver/node_modules/readable-stream": { - "version": "4.7.0", - "resolved": "https://registry.npmjs.org/readable-stream/-/readable-stream-4.7.0.tgz", - "integrity": "sha512-oIGGmcpTLwPga8Bn6/Z75SVaH1z5dUut2ibSyAMVhmUggWpmDn2dapB0n7f8nwaSiRtepAsfJyfXIO5DCVAODg==", - "dev": true, - "license": "MIT", - "dependencies": { - "abort-controller": "^3.0.0", - "buffer": "^6.0.3", - "events": "^3.3.0", - "process": "^0.11.10", - "string_decoder": "^1.3.0" - }, - "engines": { - "node": "^12.22.0 || ^14.17.0 || >=16.0.0" - } - }, "node_modules/arg": { "version": "5.0.2", "resolved": "https://registry.npmjs.org/arg/-/arg-5.0.2.tgz", @@ -8078,12 +4235,26 @@ "integrity": "sha512-8+9WqebbFzpX9OR+Wa6O29asIogeRMzcGtAINdpMHHyAg10f05aSFVBbcEqGf/PXw1EjAZ+q2/bEBg3DvurK3Q==", "license": "Python-2.0" }, - "node_modules/array-flatten": { - "version": "1.1.1", - "resolved": "https://registry.npmjs.org/array-flatten/-/array-flatten-1.1.1.tgz", - "integrity": "sha512-PCVAQswWemu6UdxsDFFX/+gVeYqKAod3D3UVm91jHwynguOwAvYPhx8nNlM++NqRcK6CxxpUafjmhIdKiHibqg==", + "node_modules/aria-query": { + "version": "5.3.2", + "resolved": "https://registry.npmjs.org/aria-query/-/aria-query-5.3.2.tgz", + "integrity": "sha512-COROpnaoap1E2F000S62r6A60uHZnmlvomhfyT2DlTcrY1OrBKn2UhH7qn5wTC9zMvD0AY7csdPSNwKP+7WiQw==", "dev": true, - "license": "MIT" + "license": "Apache-2.0", + "engines": { + "node": ">= 0.4" + } + }, + "node_modules/array-iterate": { + "version": "2.0.1", + "resolved": "https://registry.npmjs.org/array-iterate/-/array-iterate-2.0.1.tgz", + "integrity": "sha512-I1jXZMjAgCMmxT4qxXfPXa6SthSoE8h6gkSI9BGGNv8mP8G/v0blc+qFnZu6K42vTOiuME596QaLO0TP3Lk0xg==", + "dev": true, + "license": "MIT", + "funding": { + "type": "github", + "url": "https://github.com/sponsors/wooorm" + } }, "node_modules/array-union": { "version": "2.1.0", @@ -8105,6 +4276,708 @@ "astring": "bin/astring" } }, + "node_modules/astro": { + "version": "5.16.6", + "resolved": "https://registry.npmjs.org/astro/-/astro-5.16.6.tgz", + "integrity": "sha512-6mF/YrvwwRxLTu+aMEa5pwzKUNl5ZetWbTyZCs9Um0F12HUmxUiF5UHiZPy4rifzU3gtpM3xP2DfdmkNX9eZRg==", + "dev": true, + "license": "MIT", + "dependencies": { + "@astrojs/compiler": "^2.13.0", + "@astrojs/internal-helpers": "0.7.5", + "@astrojs/markdown-remark": "6.3.10", + "@astrojs/telemetry": "3.3.0", + "@capsizecss/unpack": "^3.0.1", + "@oslojs/encoding": "^1.1.0", + "@rollup/pluginutils": "^5.3.0", + "acorn": "^8.15.0", + "aria-query": "^5.3.2", + "axobject-query": "^4.1.0", + "boxen": "8.0.1", + "ci-info": "^4.3.1", + "clsx": "^2.1.1", + "common-ancestor-path": "^1.0.1", + "cookie": "^1.0.2", + "cssesc": "^3.0.0", + "debug": "^4.4.3", + "deterministic-object-hash": "^2.0.2", + "devalue": "^5.5.0", + "diff": "^5.2.0", + "dlv": "^1.1.3", + "dset": "^3.1.4", + "es-module-lexer": "^1.7.0", + "esbuild": "^0.25.0", + "estree-walker": "^3.0.3", + "flattie": "^1.1.1", + "fontace": "~0.3.1", + "github-slugger": "^2.0.0", + "html-escaper": "3.0.3", + "http-cache-semantics": "^4.2.0", + "import-meta-resolve": "^4.2.0", + "js-yaml": "^4.1.1", + "magic-string": "^0.30.21", + "magicast": "^0.5.1", + "mrmime": "^2.0.1", + "neotraverse": "^0.6.18", + "p-limit": "^6.2.0", + "p-queue": "^8.1.1", + "package-manager-detector": "^1.5.0", + "piccolore": "^0.1.3", + "picomatch": "^4.0.3", + "prompts": "^2.4.2", + "rehype": "^13.0.2", + "semver": "^7.7.3", + "shiki": "^3.15.0", + "smol-toml": "^1.5.2", + "svgo": "^4.0.0", + "tinyexec": "^1.0.2", + "tinyglobby": "^0.2.15", + "tsconfck": "^3.1.6", + "ultrahtml": "^1.6.0", + "unifont": "~0.6.0", + "unist-util-visit": "^5.0.0", + "unstorage": "^1.17.3", + "vfile": "^6.0.3", + "vite": "^6.4.1", + "vitefu": "^1.1.1", + "xxhash-wasm": "^1.1.0", + "yargs-parser": "^21.1.1", + "yocto-spinner": "^0.2.3", + "zod": "^3.25.76", + "zod-to-json-schema": "^3.25.0", + "zod-to-ts": "^1.2.0" + }, + "bin": { + "astro": "astro.js" + }, + "engines": { + "node": "18.20.8 || ^20.3.0 || >=22.0.0", + "npm": ">=9.6.5", + "pnpm": ">=7.1.0" + }, + "funding": { + "type": "opencollective", + "url": "https://opencollective.com/astrodotbuild" + }, + "optionalDependencies": { + "sharp": "^0.34.0" + } + }, + "node_modules/astro-expressive-code": { + "version": "0.41.5", + "resolved": "https://registry.npmjs.org/astro-expressive-code/-/astro-expressive-code-0.41.5.tgz", + "integrity": "sha512-6jfABbPO0fkRD1ROAPBQtJR2p7gjbmk/GjfblOpo5Z7F+gwhL7+s8bEhLz9GdW10yfbn+gJvwEf7f9Lu2clh2A==", + "dev": true, + "license": "MIT", + "dependencies": { + "rehype-expressive-code": "^0.41.5" + }, + "peerDependencies": { + "astro": "^4.0.0-beta || ^5.0.0-beta || ^3.3.0" + } + }, + "node_modules/astro/node_modules/@img/sharp-darwin-arm64": { + "version": "0.34.5", + "resolved": "https://registry.npmjs.org/@img/sharp-darwin-arm64/-/sharp-darwin-arm64-0.34.5.tgz", + "integrity": "sha512-imtQ3WMJXbMY4fxb/Ndp6HBTNVtWCUI0WdobyheGf5+ad6xX8VIDO8u2xE4qc/fr08CKG/7dDseFtn6M6g/r3w==", + "cpu": [ + "arm64" + ], + "dev": true, + "license": "Apache-2.0", + "optional": true, + "os": [ + "darwin" + ], + "engines": { + "node": "^18.17.0 || ^20.3.0 || >=21.0.0" + }, + "funding": { + "url": "https://opencollective.com/libvips" + }, + "optionalDependencies": { + "@img/sharp-libvips-darwin-arm64": "1.2.4" + } + }, + "node_modules/astro/node_modules/@img/sharp-darwin-x64": { + "version": "0.34.5", + "resolved": "https://registry.npmjs.org/@img/sharp-darwin-x64/-/sharp-darwin-x64-0.34.5.tgz", + "integrity": "sha512-YNEFAF/4KQ/PeW0N+r+aVVsoIY0/qxxikF2SWdp+NRkmMB7y9LBZAVqQ4yhGCm/H3H270OSykqmQMKLBhBJDEw==", + "cpu": [ + "x64" + ], + "dev": true, + "license": "Apache-2.0", + "optional": true, + "os": [ + "darwin" + ], + "engines": { + "node": "^18.17.0 || ^20.3.0 || >=21.0.0" + }, + "funding": { + "url": "https://opencollective.com/libvips" + }, + "optionalDependencies": { + "@img/sharp-libvips-darwin-x64": "1.2.4" + } + }, + "node_modules/astro/node_modules/@img/sharp-libvips-darwin-arm64": { + "version": "1.2.4", + "resolved": "https://registry.npmjs.org/@img/sharp-libvips-darwin-arm64/-/sharp-libvips-darwin-arm64-1.2.4.tgz", + "integrity": "sha512-zqjjo7RatFfFoP0MkQ51jfuFZBnVE2pRiaydKJ1G/rHZvnsrHAOcQALIi9sA5co5xenQdTugCvtb1cuf78Vf4g==", + "cpu": [ + "arm64" + ], + "dev": true, + "license": "LGPL-3.0-or-later", + "optional": true, + "os": [ + "darwin" + ], + "funding": { + "url": "https://opencollective.com/libvips" + } + }, + "node_modules/astro/node_modules/@img/sharp-libvips-darwin-x64": { + "version": "1.2.4", + "resolved": "https://registry.npmjs.org/@img/sharp-libvips-darwin-x64/-/sharp-libvips-darwin-x64-1.2.4.tgz", + "integrity": "sha512-1IOd5xfVhlGwX+zXv2N93k0yMONvUlANylbJw1eTah8K/Jtpi15KC+WSiaX/nBmbm2HxRM1gZ0nSdjSsrZbGKg==", + "cpu": [ + "x64" + ], + "dev": true, + "license": "LGPL-3.0-or-later", + "optional": true, + "os": [ + "darwin" + ], + "funding": { + "url": "https://opencollective.com/libvips" + } + }, + "node_modules/astro/node_modules/@img/sharp-libvips-linux-arm": { + "version": "1.2.4", + "resolved": "https://registry.npmjs.org/@img/sharp-libvips-linux-arm/-/sharp-libvips-linux-arm-1.2.4.tgz", + "integrity": "sha512-bFI7xcKFELdiNCVov8e44Ia4u2byA+l3XtsAj+Q8tfCwO6BQ8iDojYdvoPMqsKDkuoOo+X6HZA0s0q11ANMQ8A==", + "cpu": [ + "arm" + ], + "dev": true, + "license": "LGPL-3.0-or-later", + "optional": true, + "os": [ + "linux" + ], + "funding": { + "url": "https://opencollective.com/libvips" + } + }, + "node_modules/astro/node_modules/@img/sharp-libvips-linux-arm64": { + "version": "1.2.4", + "resolved": "https://registry.npmjs.org/@img/sharp-libvips-linux-arm64/-/sharp-libvips-linux-arm64-1.2.4.tgz", + "integrity": "sha512-excjX8DfsIcJ10x1Kzr4RcWe1edC9PquDRRPx3YVCvQv+U5p7Yin2s32ftzikXojb1PIFc/9Mt28/y+iRklkrw==", + "cpu": [ + "arm64" + ], + "dev": true, + "license": "LGPL-3.0-or-later", + "optional": true, + "os": [ + "linux" + ], + "funding": { + "url": "https://opencollective.com/libvips" + } + }, + "node_modules/astro/node_modules/@img/sharp-libvips-linux-s390x": { + "version": "1.2.4", + "resolved": "https://registry.npmjs.org/@img/sharp-libvips-linux-s390x/-/sharp-libvips-linux-s390x-1.2.4.tgz", + "integrity": "sha512-qmp9VrzgPgMoGZyPvrQHqk02uyjA0/QrTO26Tqk6l4ZV0MPWIW6LTkqOIov+J1yEu7MbFQaDpwdwJKhbJvuRxQ==", + "cpu": [ + "s390x" + ], + "dev": true, + "license": "LGPL-3.0-or-later", + "optional": true, + "os": [ + "linux" + ], + "funding": { + "url": "https://opencollective.com/libvips" + } + }, + "node_modules/astro/node_modules/@img/sharp-libvips-linux-x64": { + "version": "1.2.4", + "resolved": "https://registry.npmjs.org/@img/sharp-libvips-linux-x64/-/sharp-libvips-linux-x64-1.2.4.tgz", + "integrity": "sha512-tJxiiLsmHc9Ax1bz3oaOYBURTXGIRDODBqhveVHonrHJ9/+k89qbLl0bcJns+e4t4rvaNBxaEZsFtSfAdquPrw==", + "cpu": [ + "x64" + ], + "dev": true, + "license": "LGPL-3.0-or-later", + "optional": true, + "os": [ + "linux" + ], + "funding": { + "url": "https://opencollective.com/libvips" + } + }, + "node_modules/astro/node_modules/@img/sharp-libvips-linuxmusl-arm64": { + "version": "1.2.4", + "resolved": "https://registry.npmjs.org/@img/sharp-libvips-linuxmusl-arm64/-/sharp-libvips-linuxmusl-arm64-1.2.4.tgz", + "integrity": "sha512-FVQHuwx1IIuNow9QAbYUzJ+En8KcVm9Lk5+uGUQJHaZmMECZmOlix9HnH7n1TRkXMS0pGxIJokIVB9SuqZGGXw==", + "cpu": [ + "arm64" + ], + "dev": true, + "license": "LGPL-3.0-or-later", + "optional": true, + "os": [ + "linux" + ], + "funding": { + "url": "https://opencollective.com/libvips" + } + }, + "node_modules/astro/node_modules/@img/sharp-libvips-linuxmusl-x64": { + "version": "1.2.4", + "resolved": "https://registry.npmjs.org/@img/sharp-libvips-linuxmusl-x64/-/sharp-libvips-linuxmusl-x64-1.2.4.tgz", + "integrity": "sha512-+LpyBk7L44ZIXwz/VYfglaX/okxezESc6UxDSoyo2Ks6Jxc4Y7sGjpgU9s4PMgqgjj1gZCylTieNamqA1MF7Dg==", + "cpu": [ + "x64" + ], + "dev": true, + "license": "LGPL-3.0-or-later", + "optional": true, + "os": [ + "linux" + ], + "funding": { + "url": "https://opencollective.com/libvips" + } + }, + "node_modules/astro/node_modules/@img/sharp-linux-arm": { + "version": "0.34.5", + "resolved": "https://registry.npmjs.org/@img/sharp-linux-arm/-/sharp-linux-arm-0.34.5.tgz", + "integrity": "sha512-9dLqsvwtg1uuXBGZKsxem9595+ujv0sJ6Vi8wcTANSFpwV/GONat5eCkzQo/1O6zRIkh0m/8+5BjrRr7jDUSZw==", + "cpu": [ + "arm" + ], + "dev": true, + "license": "Apache-2.0", + "optional": true, + "os": [ + "linux" + ], + "engines": { + "node": "^18.17.0 || ^20.3.0 || >=21.0.0" + }, + "funding": { + "url": "https://opencollective.com/libvips" + }, + "optionalDependencies": { + "@img/sharp-libvips-linux-arm": "1.2.4" + } + }, + "node_modules/astro/node_modules/@img/sharp-linux-arm64": { + "version": "0.34.5", + "resolved": "https://registry.npmjs.org/@img/sharp-linux-arm64/-/sharp-linux-arm64-0.34.5.tgz", + "integrity": "sha512-bKQzaJRY/bkPOXyKx5EVup7qkaojECG6NLYswgktOZjaXecSAeCWiZwwiFf3/Y+O1HrauiE3FVsGxFg8c24rZg==", + "cpu": [ + "arm64" + ], + "dev": true, + "license": "Apache-2.0", + "optional": true, + "os": [ + "linux" + ], + "engines": { + "node": "^18.17.0 || ^20.3.0 || >=21.0.0" + }, + "funding": { + "url": "https://opencollective.com/libvips" + }, + "optionalDependencies": { + "@img/sharp-libvips-linux-arm64": "1.2.4" + } + }, + "node_modules/astro/node_modules/@img/sharp-linux-s390x": { + "version": "0.34.5", + "resolved": "https://registry.npmjs.org/@img/sharp-linux-s390x/-/sharp-linux-s390x-0.34.5.tgz", + "integrity": "sha512-nQtCk0PdKfho3eC5MrbQoigJ2gd1CgddUMkabUj+rBevs8tZ2cULOx46E7oyX+04WGfABgIwmMC0VqieTiR4jg==", + "cpu": [ + "s390x" + ], + "dev": true, + "license": "Apache-2.0", + "optional": true, + "os": [ + "linux" + ], + "engines": { + "node": "^18.17.0 || ^20.3.0 || >=21.0.0" + }, + "funding": { + "url": "https://opencollective.com/libvips" + }, + "optionalDependencies": { + "@img/sharp-libvips-linux-s390x": "1.2.4" + } + }, + "node_modules/astro/node_modules/@img/sharp-linux-x64": { + "version": "0.34.5", + "resolved": "https://registry.npmjs.org/@img/sharp-linux-x64/-/sharp-linux-x64-0.34.5.tgz", + "integrity": "sha512-MEzd8HPKxVxVenwAa+JRPwEC7QFjoPWuS5NZnBt6B3pu7EG2Ge0id1oLHZpPJdn3OQK+BQDiw9zStiHBTJQQQQ==", + "cpu": [ + "x64" + ], + "dev": true, + "license": "Apache-2.0", + "optional": true, + "os": [ + "linux" + ], + "engines": { + "node": "^18.17.0 || ^20.3.0 || >=21.0.0" + }, + "funding": { + "url": "https://opencollective.com/libvips" + }, + "optionalDependencies": { + "@img/sharp-libvips-linux-x64": "1.2.4" + } + }, + "node_modules/astro/node_modules/@img/sharp-linuxmusl-arm64": { + "version": "0.34.5", + "resolved": "https://registry.npmjs.org/@img/sharp-linuxmusl-arm64/-/sharp-linuxmusl-arm64-0.34.5.tgz", + "integrity": "sha512-fprJR6GtRsMt6Kyfq44IsChVZeGN97gTD331weR1ex1c1rypDEABN6Tm2xa1wE6lYb5DdEnk03NZPqA7Id21yg==", + "cpu": [ + "arm64" + ], + "dev": true, + "license": "Apache-2.0", + "optional": true, + "os": [ + "linux" + ], + "engines": { + "node": "^18.17.0 || ^20.3.0 || >=21.0.0" + }, + "funding": { + "url": "https://opencollective.com/libvips" + }, + "optionalDependencies": { + "@img/sharp-libvips-linuxmusl-arm64": "1.2.4" + } + }, + "node_modules/astro/node_modules/@img/sharp-linuxmusl-x64": { + "version": "0.34.5", + "resolved": "https://registry.npmjs.org/@img/sharp-linuxmusl-x64/-/sharp-linuxmusl-x64-0.34.5.tgz", + "integrity": "sha512-Jg8wNT1MUzIvhBFxViqrEhWDGzqymo3sV7z7ZsaWbZNDLXRJZoRGrjulp60YYtV4wfY8VIKcWidjojlLcWrd8Q==", + "cpu": [ + "x64" + ], + "dev": true, + "license": "Apache-2.0", + "optional": true, + "os": [ + "linux" + ], + "engines": { + "node": "^18.17.0 || ^20.3.0 || >=21.0.0" + }, + "funding": { + "url": "https://opencollective.com/libvips" + }, + "optionalDependencies": { + "@img/sharp-libvips-linuxmusl-x64": "1.2.4" + } + }, + "node_modules/astro/node_modules/@img/sharp-wasm32": { + "version": "0.34.5", + "resolved": "https://registry.npmjs.org/@img/sharp-wasm32/-/sharp-wasm32-0.34.5.tgz", + "integrity": "sha512-OdWTEiVkY2PHwqkbBI8frFxQQFekHaSSkUIJkwzclWZe64O1X4UlUjqqqLaPbUpMOQk6FBu/HtlGXNblIs0huw==", + "cpu": [ + "wasm32" + ], + "dev": true, + "license": "Apache-2.0 AND LGPL-3.0-or-later AND MIT", + "optional": true, + "dependencies": { + "@emnapi/runtime": "^1.7.0" + }, + "engines": { + "node": "^18.17.0 || ^20.3.0 || >=21.0.0" + }, + "funding": { + "url": "https://opencollective.com/libvips" + } + }, + "node_modules/astro/node_modules/@img/sharp-win32-ia32": { + "version": "0.34.5", + "resolved": "https://registry.npmjs.org/@img/sharp-win32-ia32/-/sharp-win32-ia32-0.34.5.tgz", + "integrity": "sha512-FV9m/7NmeCmSHDD5j4+4pNI8Cp3aW+JvLoXcTUo0IqyjSfAZJ8dIUmijx1qaJsIiU+Hosw6xM5KijAWRJCSgNg==", + "cpu": [ + "ia32" + ], + "dev": true, + "license": "Apache-2.0 AND LGPL-3.0-or-later", + "optional": true, + "os": [ + "win32" + ], + "engines": { + "node": "^18.17.0 || ^20.3.0 || >=21.0.0" + }, + "funding": { + "url": "https://opencollective.com/libvips" + } + }, + "node_modules/astro/node_modules/@img/sharp-win32-x64": { + "version": "0.34.5", + "resolved": "https://registry.npmjs.org/@img/sharp-win32-x64/-/sharp-win32-x64-0.34.5.tgz", + "integrity": "sha512-+29YMsqY2/9eFEiW93eqWnuLcWcufowXewwSNIT6UwZdUUCrM3oFjMWH/Z6/TMmb4hlFenmfAVbpWeup2jryCw==", + "cpu": [ + "x64" + ], + "dev": true, + "license": "Apache-2.0 AND LGPL-3.0-or-later", + "optional": true, + "os": [ + "win32" + ], + "engines": { + "node": "^18.17.0 || ^20.3.0 || >=21.0.0" + }, + "funding": { + "url": "https://opencollective.com/libvips" + } + }, + "node_modules/astro/node_modules/ansi-regex": { + "version": "6.2.2", + "resolved": "https://registry.npmjs.org/ansi-regex/-/ansi-regex-6.2.2.tgz", + "integrity": "sha512-Bq3SmSpyFHaWjPk8If9yc6svM8c56dB5BAtW4Qbw5jHTwwXXcTLoRMkpDJp6VL0XzlWaCHTXrkFURMYmD0sLqg==", + "dev": true, + "license": "MIT", + "engines": { + "node": ">=12" + }, + "funding": { + "url": "https://github.com/chalk/ansi-regex?sponsor=1" + } + }, + "node_modules/astro/node_modules/ansi-styles": { + "version": "6.2.3", + "resolved": "https://registry.npmjs.org/ansi-styles/-/ansi-styles-6.2.3.tgz", + "integrity": "sha512-4Dj6M28JB+oAH8kFkTLUo+a2jwOFkuqb3yucU0CANcRRUbxS0cP0nZYCGjcc3BNXwRIsUVmDGgzawme7zvJHvg==", + "dev": true, + "license": "MIT", + "engines": { + "node": ">=12" + }, + "funding": { + "url": "https://github.com/chalk/ansi-styles?sponsor=1" + } + }, + "node_modules/astro/node_modules/boxen": { + "version": "8.0.1", + "resolved": "https://registry.npmjs.org/boxen/-/boxen-8.0.1.tgz", + "integrity": "sha512-F3PH5k5juxom4xktynS7MoFY+NUWH5LC4CnH11YB8NPew+HLpmBLCybSAEyb2F+4pRXhuhWqFesoQd6DAyc2hw==", + "dev": true, + "license": "MIT", + "dependencies": { + "ansi-align": "^3.0.1", + "camelcase": "^8.0.0", + "chalk": "^5.3.0", + "cli-boxes": "^3.0.0", + "string-width": "^7.2.0", + "type-fest": "^4.21.0", + "widest-line": "^5.0.0", + "wrap-ansi": "^9.0.0" + }, + "engines": { + "node": ">=18" + }, + "funding": { + "url": "https://github.com/sponsors/sindresorhus" + } + }, + "node_modules/astro/node_modules/camelcase": { + "version": "8.0.0", + "resolved": "https://registry.npmjs.org/camelcase/-/camelcase-8.0.0.tgz", + "integrity": "sha512-8WB3Jcas3swSvjIeA2yvCJ+Miyz5l1ZmB6HFb9R1317dt9LCQoswg/BGrmAmkWVEszSrrg4RwmO46qIm2OEnSA==", + "dev": true, + "license": "MIT", + "engines": { + "node": ">=16" + }, + "funding": { + "url": "https://github.com/sponsors/sindresorhus" + } + }, + "node_modules/astro/node_modules/chalk": { + "version": "5.6.2", + "resolved": "https://registry.npmjs.org/chalk/-/chalk-5.6.2.tgz", + "integrity": "sha512-7NzBL0rN6fMUW+f7A6Io4h40qQlG+xGmtMxfbnH/K7TAtt8JQWVQK+6g0UXKMeVJoyV5EkkNsErQ8pVD3bLHbA==", + "dev": true, + "license": "MIT", + "engines": { + "node": "^12.17.0 || ^14.13 || >=16.0.0" + }, + "funding": { + "url": "https://github.com/chalk/chalk?sponsor=1" + } + }, + "node_modules/astro/node_modules/cli-boxes": { + "version": "3.0.0", + "resolved": "https://registry.npmjs.org/cli-boxes/-/cli-boxes-3.0.0.tgz", + "integrity": "sha512-/lzGpEWL/8PfI0BmBOPRwp0c/wFNX1RdUML3jK/RcSBA9T8mZDdQpqYBKtCFTOfQbwPqWEOpjqW+Fnayc0969g==", + "dev": true, + "license": "MIT", + "engines": { + "node": ">=10" + }, + "funding": { + "url": "https://github.com/sponsors/sindresorhus" + } + }, + "node_modules/astro/node_modules/emoji-regex": { + "version": "10.6.0", + "resolved": "https://registry.npmjs.org/emoji-regex/-/emoji-regex-10.6.0.tgz", + "integrity": "sha512-toUI84YS5YmxW219erniWD0CIVOo46xGKColeNQRgOzDorgBi1v4D71/OFzgD9GO2UGKIv1C3Sp8DAn0+j5w7A==", + "dev": true, + "license": "MIT" + }, + "node_modules/astro/node_modules/sharp": { + "version": "0.34.5", + "resolved": "https://registry.npmjs.org/sharp/-/sharp-0.34.5.tgz", + "integrity": "sha512-Ou9I5Ft9WNcCbXrU9cMgPBcCK8LiwLqcbywW3t4oDV37n1pzpuNLsYiAV8eODnjbtQlSDwZ2cUEeQz4E54Hltg==", + "dev": true, + "hasInstallScript": true, + "license": "Apache-2.0", + "optional": true, + "dependencies": { + "@img/colour": "^1.0.0", + "detect-libc": "^2.1.2", + "semver": "^7.7.3" + }, + "engines": { + "node": "^18.17.0 || ^20.3.0 || >=21.0.0" + }, + "funding": { + "url": "https://opencollective.com/libvips" + }, + "optionalDependencies": { + "@img/sharp-darwin-arm64": "0.34.5", + "@img/sharp-darwin-x64": "0.34.5", + "@img/sharp-libvips-darwin-arm64": "1.2.4", + "@img/sharp-libvips-darwin-x64": "1.2.4", + "@img/sharp-libvips-linux-arm": "1.2.4", + "@img/sharp-libvips-linux-arm64": "1.2.4", + "@img/sharp-libvips-linux-ppc64": "1.2.4", + "@img/sharp-libvips-linux-riscv64": "1.2.4", + "@img/sharp-libvips-linux-s390x": "1.2.4", + "@img/sharp-libvips-linux-x64": "1.2.4", + "@img/sharp-libvips-linuxmusl-arm64": "1.2.4", + "@img/sharp-libvips-linuxmusl-x64": "1.2.4", + "@img/sharp-linux-arm": "0.34.5", + "@img/sharp-linux-arm64": "0.34.5", + "@img/sharp-linux-ppc64": "0.34.5", + "@img/sharp-linux-riscv64": "0.34.5", + "@img/sharp-linux-s390x": "0.34.5", + "@img/sharp-linux-x64": "0.34.5", + "@img/sharp-linuxmusl-arm64": "0.34.5", + "@img/sharp-linuxmusl-x64": "0.34.5", + "@img/sharp-wasm32": "0.34.5", + "@img/sharp-win32-arm64": "0.34.5", + "@img/sharp-win32-ia32": "0.34.5", + "@img/sharp-win32-x64": "0.34.5" + } + }, + "node_modules/astro/node_modules/string-width": { + "version": "7.2.0", + "resolved": "https://registry.npmjs.org/string-width/-/string-width-7.2.0.tgz", + "integrity": "sha512-tsaTIkKW9b4N+AEj+SVA+WhJzV7/zMhcSu78mLKWSk7cXMOSHsBKFWUs0fWwq8QyK3MgJBQRX6Gbi4kYbdvGkQ==", + "dev": true, + "license": "MIT", + "dependencies": { + "emoji-regex": "^10.3.0", + "get-east-asian-width": "^1.0.0", + "strip-ansi": "^7.1.0" + }, + "engines": { + "node": ">=18" + }, + "funding": { + "url": "https://github.com/sponsors/sindresorhus" + } + }, + "node_modules/astro/node_modules/strip-ansi": { + "version": "7.1.2", + "resolved": "https://registry.npmjs.org/strip-ansi/-/strip-ansi-7.1.2.tgz", + "integrity": "sha512-gmBGslpoQJtgnMAvOVqGZpEz9dyoKTCzy2nfz/n8aIFhN/jCE/rCmcxabB6jOOHV+0WNnylOxaxBQPSvcWklhA==", + "dev": true, + "license": "MIT", + "dependencies": { + "ansi-regex": "^6.0.1" + }, + "engines": { + "node": ">=12" + }, + "funding": { + "url": "https://github.com/chalk/strip-ansi?sponsor=1" + } + }, + "node_modules/astro/node_modules/type-fest": { + "version": "4.41.0", + "resolved": "https://registry.npmjs.org/type-fest/-/type-fest-4.41.0.tgz", + "integrity": "sha512-TeTSQ6H5YHvpqVwBRcnLDCBnDOHWYu7IvGbHT6N8AOymcr9PJGjc1GTtiWZTYg0NCgYwvnYWEkVChQAr9bjfwA==", + "dev": true, + "license": "(MIT OR CC0-1.0)", + "engines": { + "node": ">=16" + }, + "funding": { + "url": "https://github.com/sponsors/sindresorhus" + } + }, + "node_modules/astro/node_modules/widest-line": { + "version": "5.0.0", + "resolved": "https://registry.npmjs.org/widest-line/-/widest-line-5.0.0.tgz", + "integrity": "sha512-c9bZp7b5YtRj2wOe6dlj32MK+Bx/M/d+9VB2SHM1OtsUHR0aV0tdP6DWh/iMt0kWi1t5g1Iudu6hQRNd1A4PVA==", + "dev": true, + "license": "MIT", + "dependencies": { + "string-width": "^7.0.0" + }, + "engines": { + "node": ">=18" + }, + "funding": { + "url": "https://github.com/sponsors/sindresorhus" + } + }, + "node_modules/astro/node_modules/wrap-ansi": { + "version": "9.0.2", + "resolved": "https://registry.npmjs.org/wrap-ansi/-/wrap-ansi-9.0.2.tgz", + "integrity": "sha512-42AtmgqjV+X1VpdOfyTGOYRi0/zsoLqtXQckTmqTeybT+BDIbM/Guxo7x3pE2vtpr1ok6xRqM9OpBe+Jyoqyww==", + "dev": true, + "license": "MIT", + "dependencies": { + "ansi-styles": "^6.2.1", + "string-width": "^7.0.0", + "strip-ansi": "^7.1.0" + }, + "engines": { + "node": ">=18" + }, + "funding": { + "url": "https://github.com/chalk/wrap-ansi?sponsor=1" + } + }, "node_modules/async": { "version": "3.2.6", "resolved": "https://registry.npmjs.org/async/-/async-3.2.6.tgz", @@ -8112,54 +4985,42 @@ "dev": true, "license": "MIT" }, - "node_modules/autoprefixer": { - "version": "10.4.23", - "resolved": "https://registry.npmjs.org/autoprefixer/-/autoprefixer-10.4.23.tgz", - "integrity": "sha512-YYTXSFulfwytnjAPlw8QHncHJmlvFKtczb8InXaAx9Q0LbfDnfEYDE55omerIJKihhmU61Ft+cAOSzQVaBUmeA==", + "node_modules/axobject-query": { + "version": "4.1.0", + "resolved": "https://registry.npmjs.org/axobject-query/-/axobject-query-4.1.0.tgz", + "integrity": "sha512-qIj0G9wZbMGNLjLmg1PT6v2mE9AH2zlnADJD/2tC6E00hgmhUOfEB6greHPAfLRSufHqROIUTkw6E+M3lH0PTQ==", "dev": true, - "funding": [ - { - "type": "opencollective", - "url": "https://opencollective.com/postcss/" - }, - { - "type": "tidelift", - "url": "https://tidelift.com/funding/github/npm/autoprefixer" - }, - { - "type": "github", - "url": "https://github.com/sponsors/ai" - } - ], - "license": "MIT", - "dependencies": { - "browserslist": "^4.28.1", - "caniuse-lite": "^1.0.30001760", - "fraction.js": "^5.3.4", - "picocolors": "^1.1.1", - "postcss-value-parser": "^4.2.0" - }, - "bin": { - "autoprefixer": "bin/autoprefixer" - }, + "license": "Apache-2.0", "engines": { - "node": "^10 || ^12 || >=14" - }, + "node": ">= 0.4" + } + }, + "node_modules/b4a": { + "version": "1.7.3", + "resolved": "https://registry.npmjs.org/b4a/-/b4a-1.7.3.tgz", + "integrity": "sha512-5Q2mfq2WfGuFp3uS//0s6baOJLMoVduPYVeNmDYxu5OUA1/cBfvr2RIS7vi62LdNj/urk1hfmj867I3qt6uZ7Q==", + "dev": true, + "license": "Apache-2.0", "peerDependencies": { - "postcss": "^8.1.0" + "react-native-b4a": "*" + }, + "peerDependenciesMeta": { + "react-native-b4a": { + "optional": true + } } }, "node_modules/babel-jest": { - "version": "30.0.5", - "resolved": "https://registry.npmjs.org/babel-jest/-/babel-jest-30.0.5.tgz", - "integrity": "sha512-mRijnKimhGDMsizTvBTWotwNpzrkHr+VvZUQBof2AufXKB8NXrL1W69TG20EvOz7aevx6FTJIaBuBkYxS8zolg==", + "version": "30.2.0", + "resolved": "https://registry.npmjs.org/babel-jest/-/babel-jest-30.2.0.tgz", + "integrity": "sha512-0YiBEOxWqKkSQWL9nNGGEgndoeL0ZpWrbLMNL5u/Kaxrli3Eaxlt3ZtIDktEvXt4L/R9r3ODr2zKwGM/2BjxVw==", "dev": true, "license": "MIT", "dependencies": { - "@jest/transform": "30.0.5", + "@jest/transform": "30.2.0", "@types/babel__core": "^7.20.5", - "babel-plugin-istanbul": "^7.0.0", - "babel-preset-jest": "30.0.1", + "babel-plugin-istanbul": "^7.0.1", + "babel-preset-jest": "30.2.0", "chalk": "^4.1.2", "graceful-fs": "^4.2.11", "slash": "^3.0.0" @@ -8168,43 +5029,18 @@ "node": "^18.14.0 || ^20.0.0 || ^22.0.0 || >=24.0.0" }, "peerDependencies": { - "@babel/core": "^7.11.0" - } - }, - "node_modules/babel-loader": { - "version": "9.2.1", - "resolved": "https://registry.npmjs.org/babel-loader/-/babel-loader-9.2.1.tgz", - "integrity": "sha512-fqe8naHt46e0yIdkjUZYqddSXfej3AHajX+CSO5X7oy0EmPc6o5Xh+RClNoHjnieWz9AW4kZxW9yyFMhVB1QLA==", - "dev": true, - "license": "MIT", - "dependencies": { - "find-cache-dir": "^4.0.0", - "schema-utils": "^4.0.0" - }, - "engines": { - "node": ">= 14.15.0" - }, - "peerDependencies": { - "@babel/core": "^7.12.0", - "webpack": ">=5" - } - }, - "node_modules/babel-plugin-dynamic-import-node": { - "version": "2.3.3", - "resolved": "https://registry.npmjs.org/babel-plugin-dynamic-import-node/-/babel-plugin-dynamic-import-node-2.3.3.tgz", - "integrity": "sha512-jZVI+s9Zg3IqA/kdi0i6UDCybUI3aSBLnglhYbSSjKlV7yF1F/5LWv8MakQmvYpnbJDS6fcBL2KzHSxNCMtWSQ==", - "dev": true, - "license": "MIT", - "dependencies": { - "object.assign": "^4.1.0" + "@babel/core": "^7.11.0 || ^8.0.0-0" } }, "node_modules/babel-plugin-istanbul": { - "version": "7.0.0", - "resolved": "https://registry.npmjs.org/babel-plugin-istanbul/-/babel-plugin-istanbul-7.0.0.tgz", - "integrity": "sha512-C5OzENSx/A+gt7t4VH1I2XsflxyPUmXRFPKBxt33xncdOmq7oROVM3bZv9Ysjjkv8OJYDMa+tKuKMvqU/H3xdw==", + "version": "7.0.1", + "resolved": "https://registry.npmjs.org/babel-plugin-istanbul/-/babel-plugin-istanbul-7.0.1.tgz", + "integrity": "sha512-D8Z6Qm8jCvVXtIRkBnqNHX0zJ37rQcFJ9u8WOS6tkYOsRdHBzypCstaxWiu5ZIlqQtviRYbgnRLSoCEvjqcqbA==", "dev": true, "license": "BSD-3-Clause", + "workspaces": [ + "test/babel-8" + ], "dependencies": { "@babel/helper-plugin-utils": "^7.0.0", "@istanbuljs/load-nyc-config": "^1.0.0", @@ -8216,73 +5052,56 @@ "node": ">=12" } }, + "node_modules/babel-plugin-istanbul/node_modules/glob": { + "version": "7.2.3", + "resolved": "https://registry.npmjs.org/glob/-/glob-7.2.3.tgz", + "integrity": "sha512-nFR0zLpU2YCaRxwoCJvL6UvCH2JFyFVIvwTLsIf21AuHlMskA1hhTdk+LlYJtOlYt9v6dvszD2BGRqBL+iQK9Q==", + "deprecated": "Glob versions prior to v9 are no longer supported", + "dev": true, + "license": "ISC", + "dependencies": { + "fs.realpath": "^1.0.0", + "inflight": "^1.0.4", + "inherits": "2", + "minimatch": "^3.1.1", + "once": "^1.3.0", + "path-is-absolute": "^1.0.0" + }, + "engines": { + "node": "*" + }, + "funding": { + "url": "https://github.com/sponsors/isaacs" + } + }, + "node_modules/babel-plugin-istanbul/node_modules/test-exclude": { + "version": "6.0.0", + "resolved": "https://registry.npmjs.org/test-exclude/-/test-exclude-6.0.0.tgz", + "integrity": "sha512-cAGWPIyOHU6zlmg88jwm7VRyXnMN7iV68OGAbYDk/Mh/xC/pzVPlQtY6ngoIH/5/tciuhGfvESU8GrHrcxD56w==", + "dev": true, + "license": "ISC", + "dependencies": { + "@istanbuljs/schema": "^0.1.2", + "glob": "^7.1.4", + "minimatch": "^3.0.4" + }, + "engines": { + "node": ">=8" + } + }, "node_modules/babel-plugin-jest-hoist": { - "version": "30.0.1", - "resolved": "https://registry.npmjs.org/babel-plugin-jest-hoist/-/babel-plugin-jest-hoist-30.0.1.tgz", - "integrity": "sha512-zTPME3pI50NsFW8ZBaVIOeAxzEY7XHlmWeXXu9srI+9kNfzCUTy8MFan46xOGZY8NZThMqq+e3qZUKsvXbasnQ==", + "version": "30.2.0", + "resolved": "https://registry.npmjs.org/babel-plugin-jest-hoist/-/babel-plugin-jest-hoist-30.2.0.tgz", + "integrity": "sha512-ftzhzSGMUnOzcCXd6WHdBGMyuwy15Wnn0iyyWGKgBDLxf9/s5ABuraCSpBX2uG0jUg4rqJnxsLc5+oYBqoxVaA==", "dev": true, "license": "MIT", "dependencies": { - "@babel/template": "^7.27.2", - "@babel/types": "^7.27.3", "@types/babel__core": "^7.20.5" }, "engines": { "node": "^18.14.0 || ^20.0.0 || ^22.0.0 || >=24.0.0" } }, - "node_modules/babel-plugin-polyfill-corejs2": { - "version": "0.4.14", - "resolved": "https://registry.npmjs.org/babel-plugin-polyfill-corejs2/-/babel-plugin-polyfill-corejs2-0.4.14.tgz", - "integrity": "sha512-Co2Y9wX854ts6U8gAAPXfn0GmAyctHuK8n0Yhfjd6t30g7yvKjspvvOo9yG+z52PZRgFErt7Ka2pYnXCjLKEpg==", - "dev": true, - "license": "MIT", - "dependencies": { - "@babel/compat-data": "^7.27.7", - "@babel/helper-define-polyfill-provider": "^0.6.5", - "semver": "^6.3.1" - }, - "peerDependencies": { - "@babel/core": "^7.4.0 || ^8.0.0-0 <8.0.0" - } - }, - "node_modules/babel-plugin-polyfill-corejs2/node_modules/semver": { - "version": "6.3.1", - "resolved": "https://registry.npmjs.org/semver/-/semver-6.3.1.tgz", - "integrity": "sha512-BR7VvDCVHO+q2xBEWskxS6DJE1qRnb7DxzUrogb71CWoSficBxYsiAGd+Kl0mmq/MprG9yArRkyrQxTO6XjMzA==", - "dev": true, - "license": "ISC", - "bin": { - "semver": "bin/semver.js" - } - }, - "node_modules/babel-plugin-polyfill-corejs3": { - "version": "0.13.0", - "resolved": "https://registry.npmjs.org/babel-plugin-polyfill-corejs3/-/babel-plugin-polyfill-corejs3-0.13.0.tgz", - "integrity": "sha512-U+GNwMdSFgzVmfhNm8GJUX88AadB3uo9KpJqS3FaqNIPKgySuvMb+bHPsOmmuWyIcuqZj/pzt1RUIUZns4y2+A==", - "dev": true, - "license": "MIT", - "dependencies": { - "@babel/helper-define-polyfill-provider": "^0.6.5", - "core-js-compat": "^3.43.0" - }, - "peerDependencies": { - "@babel/core": "^7.4.0 || ^8.0.0-0 <8.0.0" - } - }, - "node_modules/babel-plugin-polyfill-regenerator": { - "version": "0.6.5", - "resolved": "https://registry.npmjs.org/babel-plugin-polyfill-regenerator/-/babel-plugin-polyfill-regenerator-0.6.5.tgz", - "integrity": "sha512-ISqQ2frbiNU9vIJkzg7dlPpznPZ4jOiUQ1uSmB0fEHeowtN3COYRsXr/xexn64NpU13P06jc/L5TgiJXOgrbEg==", - "dev": true, - "license": "MIT", - "dependencies": { - "@babel/helper-define-polyfill-provider": "^0.6.5" - }, - "peerDependencies": { - "@babel/core": "^7.4.0 || ^8.0.0-0 <8.0.0" - } - }, "node_modules/babel-preset-current-node-syntax": { "version": "1.2.0", "resolved": "https://registry.npmjs.org/babel-preset-current-node-syntax/-/babel-preset-current-node-syntax-1.2.0.tgz", @@ -8311,20 +5130,20 @@ } }, "node_modules/babel-preset-jest": { - "version": "30.0.1", - "resolved": "https://registry.npmjs.org/babel-preset-jest/-/babel-preset-jest-30.0.1.tgz", - "integrity": "sha512-+YHejD5iTWI46cZmcc/YtX4gaKBtdqCHCVfuVinizVpbmyjO3zYmeuyFdfA8duRqQZfgCAMlsfmkVbJ+e2MAJw==", + "version": "30.2.0", + "resolved": "https://registry.npmjs.org/babel-preset-jest/-/babel-preset-jest-30.2.0.tgz", + "integrity": "sha512-US4Z3NOieAQumwFnYdUWKvUKh8+YSnS/gB3t6YBiz0bskpu7Pine8pPCheNxlPEW4wnUkma2a94YuW2q3guvCQ==", "dev": true, "license": "MIT", "dependencies": { - "babel-plugin-jest-hoist": "30.0.1", - "babel-preset-current-node-syntax": "^1.1.0" + "babel-plugin-jest-hoist": "30.2.0", + "babel-preset-current-node-syntax": "^1.2.0" }, "engines": { "node": "^18.14.0 || ^20.0.0 || ^22.0.0 || >=24.0.0" }, "peerDependencies": { - "@babel/core": "^7.11.0" + "@babel/core": "^7.11.0 || ^8.0.0-beta.1" } }, "node_modules/bail": { @@ -8359,6 +5178,13 @@ } } }, + "node_modules/base-64": { + "version": "1.0.0", + "resolved": "https://registry.npmjs.org/base-64/-/base-64-1.0.0.tgz", + "integrity": "sha512-kwDPIFCGx0NZHog36dj+tHiwP4QMzsZ3AgMViUBKI0+V5n4U0ufTCUMhnQ04diaRI8EX/QcPfql7zlhZ7j4zgg==", + "dev": true, + "license": "MIT" + }, "node_modules/base64-js": { "version": "1.5.1", "resolved": "https://registry.npmjs.org/base64-js/-/base64-js-1.5.1.tgz", @@ -8380,43 +5206,40 @@ "license": "MIT" }, "node_modules/baseline-browser-mapping": { - "version": "2.9.10", - "resolved": "https://registry.npmjs.org/baseline-browser-mapping/-/baseline-browser-mapping-2.9.10.tgz", - "integrity": "sha512-2VIKvDx8Z1a9rTB2eCkdPE5nSe28XnA+qivGnWHoB40hMMt/h1hSz0960Zqsn6ZyxWXUie0EBdElKv8may20AA==", + "version": "2.9.11", + "resolved": "https://registry.npmjs.org/baseline-browser-mapping/-/baseline-browser-mapping-2.9.11.tgz", + "integrity": "sha512-Sg0xJUNDU1sJNGdfGWhVHX0kkZ+HWcvmVymJbj6NSgZZmW/8S9Y2HQ5euytnIgakgxN6papOAWiwDo1ctFDcoQ==", "dev": true, "license": "Apache-2.0", "bin": { "baseline-browser-mapping": "dist/cli.js" } }, - "node_modules/batch": { - "version": "0.6.1", - "resolved": "https://registry.npmjs.org/batch/-/batch-0.6.1.tgz", - "integrity": "sha512-x+VAiMRL6UPkx+kudNvxTl6hB2XNNCG2r+7wixVfIYwu/2HKRXimwQyaumLjMveWvT2Hkd/cAJw+QBMfJ/EKVw==", - "dev": true, - "license": "MIT" - }, - "node_modules/big.js": { - "version": "5.2.2", - "resolved": "https://registry.npmjs.org/big.js/-/big.js-5.2.2.tgz", - "integrity": "sha512-vyL2OymJxmarO8gxMr0mhChsO9QGwhynfuu4+MHTAW6czfq9humCB7rKpUjDd9YUiDPU4mzpyupFSvOClAwbmQ==", + "node_modules/bcp-47": { + "version": "2.1.0", + "resolved": "https://registry.npmjs.org/bcp-47/-/bcp-47-2.1.0.tgz", + "integrity": "sha512-9IIS3UPrvIa1Ej+lVDdDwO7zLehjqsaByECw0bu2RRGP73jALm6FYbzI5gWbgHLvNdkvfXB5YrSbocZdOS0c0w==", "dev": true, "license": "MIT", - "engines": { - "node": "*" - } - }, - "node_modules/binary-extensions": { - "version": "2.3.0", - "resolved": "https://registry.npmjs.org/binary-extensions/-/binary-extensions-2.3.0.tgz", - "integrity": "sha512-Ceh+7ox5qe7LJuLHoY0feh3pHuUDHAcRUeyL2VYghZwfpkNIy/+8Ocg0a3UuSoYzavmylwuLWQOf3hl0jjMMIw==", - "dev": true, - "license": "MIT", - "engines": { - "node": ">=8" + "dependencies": { + "is-alphabetical": "^2.0.0", + "is-alphanumerical": "^2.0.0", + "is-decimal": "^2.0.0" }, "funding": { - "url": "https://github.com/sponsors/sindresorhus" + "type": "github", + "url": "https://github.com/sponsors/wooorm" + } + }, + "node_modules/bcp-47-match": { + "version": "2.0.3", + "resolved": "https://registry.npmjs.org/bcp-47-match/-/bcp-47-match-2.0.3.tgz", + "integrity": "sha512-JtTezzbAibu8G0R9op9zb3vcWZd9JF6M0xOYGPn0fNCd7wOpRB1mU2mH9T8gaBGbAAyIIVgB2G7xG0GP98zMAQ==", + "dev": true, + "license": "MIT", + "funding": { + "type": "github", + "url": "https://github.com/sponsors/wooorm" } }, "node_modules/bl": { @@ -8430,80 +5253,18 @@ "readable-stream": "^3.4.0" } }, - "node_modules/body-parser": { - "version": "1.20.4", - "resolved": "https://registry.npmjs.org/body-parser/-/body-parser-1.20.4.tgz", - "integrity": "sha512-ZTgYYLMOXY9qKU/57FAo8F+HA2dGX7bqGc71txDRC1rS4frdFI5R7NhluHxH6M0YItAP0sHB4uqAOcYKxO6uGA==", - "dev": true, + "node_modules/bl/node_modules/readable-stream": { + "version": "3.6.2", + "resolved": "https://registry.npmjs.org/readable-stream/-/readable-stream-3.6.2.tgz", + "integrity": "sha512-9u/sniCrY3D5WdsERHzHE4G2YCXqoG5FTHUiCC4SIbr6XcLZBY05ya9EKjYek9O5xOAwjGq+1JdGBAS7Q9ScoA==", "license": "MIT", "dependencies": { - "bytes": "~3.1.2", - "content-type": "~1.0.5", - "debug": "2.6.9", - "depd": "2.0.0", - "destroy": "~1.2.0", - "http-errors": "~2.0.1", - "iconv-lite": "~0.4.24", - "on-finished": "~2.4.1", - "qs": "~6.14.0", - "raw-body": "~2.5.3", - "type-is": "~1.6.18", - "unpipe": "~1.0.0" + "inherits": "^2.0.3", + "string_decoder": "^1.1.1", + "util-deprecate": "^1.0.1" }, "engines": { - "node": ">= 0.8", - "npm": "1.2.8000 || >= 1.4.16" - } - }, - "node_modules/body-parser/node_modules/bytes": { - "version": "3.1.2", - "resolved": "https://registry.npmjs.org/bytes/-/bytes-3.1.2.tgz", - "integrity": "sha512-/Nf7TyzTx6S3yRJObOAV7956r8cr2+Oj8AC5dt8wSP3BQAoeX58NoHyCU8P8zGkNXStjTSi6fzO6F0pBdcYbEg==", - "dev": true, - "license": "MIT", - "engines": { - "node": ">= 0.8" - } - }, - "node_modules/body-parser/node_modules/debug": { - "version": "2.6.9", - "resolved": "https://registry.npmjs.org/debug/-/debug-2.6.9.tgz", - "integrity": "sha512-bC7ElrdJaJnPbAP+1EotYvqZsb3ecl5wi6Bfi6BJTUcNowp6cvspg0jXznRTKDjm/E7AdgFBVeAPVMNcKGsHMA==", - "dev": true, - "license": "MIT", - "dependencies": { - "ms": "2.0.0" - } - }, - "node_modules/body-parser/node_modules/iconv-lite": { - "version": "0.4.24", - "resolved": "https://registry.npmjs.org/iconv-lite/-/iconv-lite-0.4.24.tgz", - "integrity": "sha512-v3MXnZAcvnywkTUEZomIActle7RXXeedOR31wwl7VlyoXO4Qi9arvSenNQWne1TcRwhCL1HwLI21bEqdpj8/rA==", - "dev": true, - "license": "MIT", - "dependencies": { - "safer-buffer": ">= 2.1.2 < 3" - }, - "engines": { - "node": ">=0.10.0" - } - }, - "node_modules/body-parser/node_modules/ms": { - "version": "2.0.0", - "resolved": "https://registry.npmjs.org/ms/-/ms-2.0.0.tgz", - "integrity": "sha512-Tpp60P6IUJDTuOq/5Z8cdskzJujfwqfOTkrwIwj7IRISpnkJnT6SyJ4PCPnGMoFjC9ddhal5KVIYtAt97ix05A==", - "dev": true, - "license": "MIT" - }, - "node_modules/bonjour-service": { - "version": "1.3.0", - "resolved": "https://registry.npmjs.org/bonjour-service/-/bonjour-service-1.3.0.tgz", - "integrity": "sha512-3YuAUiSkWykd+2Azjgyxei8OWf8thdn8AITIog2M4UICzoqfjlqr64WIjEXZllf/W6vK1goqleSR6brGomxQqA==", - "dev": true, - "license": "MIT", - "dependencies": { - "fast-deep-equal": "^3.1.3", - "multicast-dns": "^7.2.5" + "node": ">= 6" } }, "node_modules/boolbase": { @@ -8534,30 +5295,6 @@ "url": "https://github.com/sponsors/sindresorhus" } }, - "node_modules/boxen/node_modules/camelcase": { - "version": "6.3.0", - "resolved": "https://registry.npmjs.org/camelcase/-/camelcase-6.3.0.tgz", - "integrity": "sha512-Gmy6FhYlCY7uOElZUSbxo2UCDH8owEk996gkbrpsgGtrJLM3J7jGxl9Ic7Qwwj4ivOE5AWZWRMecDdF7hqGjFA==", - "license": "MIT", - "engines": { - "node": ">=10" - }, - "funding": { - "url": "https://github.com/sponsors/sindresorhus" - } - }, - "node_modules/boxen/node_modules/type-fest": { - "version": "0.20.2", - "resolved": "https://registry.npmjs.org/type-fest/-/type-fest-0.20.2.tgz", - "integrity": "sha512-Ne+eE4r0/iWnpAxD852z3A+N0Bt5RN//NjJwRd2VFHEmrywxf5vsZlh4R6lixl6B+wz/8d+maTSAkN1FIkI3LQ==", - "license": "(MIT OR CC0-1.0)", - "engines": { - "node": ">=10" - }, - "funding": { - "url": "https://github.com/sponsors/sindresorhus" - } - }, "node_modules/brace-expansion": { "version": "1.1.12", "resolved": "https://registry.npmjs.org/brace-expansion/-/brace-expansion-1.1.12.tgz", @@ -8582,6 +5319,16 @@ "node": ">=8" } }, + "node_modules/brotli": { + "version": "1.3.3", + "resolved": "https://registry.npmjs.org/brotli/-/brotli-1.3.3.tgz", + "integrity": "sha512-oTKjJdShmDuGW94SyyaoQvAjf30dZaHnjJ8uAF+u2/vGJkJbJPJAT1gDiOJP5v1Zb6f9KEyW/1HpuaWIXtGHPg==", + "dev": true, + "license": "MIT", + "dependencies": { + "base64-js": "^1.1.2" + } + }, "node_modules/browserslist": { "version": "4.28.1", "resolved": "https://registry.npmjs.org/browserslist/-/browserslist-4.28.1.tgz", @@ -8602,7 +5349,6 @@ } ], "license": "MIT", - "peer": true, "dependencies": { "baseline-browser-mapping": "^2.9.0", "caniuse-lite": "^1.0.30001759", @@ -8681,32 +5427,6 @@ "url": "https://github.com/sponsors/sindresorhus" } }, - "node_modules/bundle-name": { - "version": "4.1.0", - "resolved": "https://registry.npmjs.org/bundle-name/-/bundle-name-4.1.0.tgz", - "integrity": "sha512-tjwM5exMg6BGRI+kNmTntNsvdZS1X8BFYS6tnJ2hdH0kVxM6/eVZ2xy+FqStSWvYmtfFMDLIxurorHwDKfDz5Q==", - "dev": true, - "license": "MIT", - "dependencies": { - "run-applescript": "^7.0.0" - }, - "engines": { - "node": ">=18" - }, - "funding": { - "url": "https://github.com/sponsors/sindresorhus" - } - }, - "node_modules/bytes": { - "version": "3.0.0", - "resolved": "https://registry.npmjs.org/bytes/-/bytes-3.0.0.tgz", - "integrity": "sha512-pMhOfFDPiv9t5jjIXkHosWmkSyQbvsgEVNkz0ERHbuLh2T/7j4Mqqpz523Fe8MVY89KC6Sh/QfS2sM+SjgFDcw==", - "dev": true, - "license": "MIT", - "engines": { - "node": ">= 0.8" - } - }, "node_modules/c8": { "version": "10.1.3", "resolved": "https://registry.npmjs.org/c8/-/c8-10.1.3.tgz", @@ -8741,197 +5461,6 @@ } } }, - "node_modules/c8/node_modules/@bcoe/v8-coverage": { - "version": "1.0.2", - "resolved": "https://registry.npmjs.org/@bcoe/v8-coverage/-/v8-coverage-1.0.2.tgz", - "integrity": "sha512-6zABk/ECA/QYSCQ1NGiVwwbQerUCZ+TQbp64Q3AgmfNvurHH0j8TtXa1qbShXA6qqkpAj4V5W8pP6mLe1mcMqA==", - "dev": true, - "license": "MIT", - "engines": { - "node": ">=18" - } - }, - "node_modules/c8/node_modules/brace-expansion": { - "version": "2.0.2", - "resolved": "https://registry.npmjs.org/brace-expansion/-/brace-expansion-2.0.2.tgz", - "integrity": "sha512-Jt0vHyM+jmUBqojB7E1NIYadt0vI0Qxjxd2TErW94wDz+E2LAm5vKMXXwg6ZZBTHPuUlDgQHKXvjGBdfcF1ZDQ==", - "dev": true, - "license": "MIT", - "dependencies": { - "balanced-match": "^1.0.0" - } - }, - "node_modules/c8/node_modules/glob": { - "version": "10.5.0", - "resolved": "https://registry.npmjs.org/glob/-/glob-10.5.0.tgz", - "integrity": "sha512-DfXN8DfhJ7NH3Oe7cFmu3NCu1wKbkReJ8TorzSAFbSKrlNaQSKfIzqYqVY8zlbs2NLBbWpRiU52GX2PbaBVNkg==", - "dev": true, - "license": "ISC", - "dependencies": { - "foreground-child": "^3.1.0", - "jackspeak": "^3.1.2", - "minimatch": "^9.0.4", - "minipass": "^7.1.2", - "package-json-from-dist": "^1.0.0", - "path-scurry": "^1.11.1" - }, - "bin": { - "glob": "dist/esm/bin.mjs" - }, - "funding": { - "url": "https://github.com/sponsors/isaacs" - } - }, - "node_modules/c8/node_modules/jackspeak": { - "version": "3.4.3", - "resolved": "https://registry.npmjs.org/jackspeak/-/jackspeak-3.4.3.tgz", - "integrity": "sha512-OGlZQpz2yfahA/Rd1Y8Cd9SIEsqvXkLVoSw/cgwhnhFMDbsQFeZYoJJ7bIZBS9BcamUW96asq/npPWugM+RQBw==", - "dev": true, - "license": "BlueOak-1.0.0", - "dependencies": { - "@isaacs/cliui": "^8.0.2" - }, - "funding": { - "url": "https://github.com/sponsors/isaacs" - }, - "optionalDependencies": { - "@pkgjs/parseargs": "^0.11.0" - } - }, - "node_modules/c8/node_modules/lru-cache": { - "version": "10.4.3", - "resolved": "https://registry.npmjs.org/lru-cache/-/lru-cache-10.4.3.tgz", - "integrity": "sha512-JNAzZcXrCt42VGLuYz0zfAzDfAvJWW6AfYlDBQyDV5DClI2m5sAmK+OIO7s59XfsRsWHp02jAJrRadPRGTt6SQ==", - "dev": true, - "license": "ISC" - }, - "node_modules/c8/node_modules/minimatch": { - "version": "9.0.5", - "resolved": "https://registry.npmjs.org/minimatch/-/minimatch-9.0.5.tgz", - "integrity": "sha512-G6T0ZX48xgozx7587koeX9Ys2NYy6Gmv//P89sEte9V9whIapMNF4idKxnW2QtCcLiTWlb/wfCabAtAFWhhBow==", - "dev": true, - "license": "ISC", - "dependencies": { - "brace-expansion": "^2.0.1" - }, - "engines": { - "node": ">=16 || 14 >=14.17" - }, - "funding": { - "url": "https://github.com/sponsors/isaacs" - } - }, - "node_modules/c8/node_modules/path-scurry": { - "version": "1.11.1", - "resolved": "https://registry.npmjs.org/path-scurry/-/path-scurry-1.11.1.tgz", - "integrity": "sha512-Xa4Nw17FS9ApQFJ9umLiJS4orGjm7ZzwUrwamcGQuHSzDyth9boKDaycYdDcZDuqYATXw4HFXgaqWTctW/v1HA==", - "dev": true, - "license": "BlueOak-1.0.0", - "dependencies": { - "lru-cache": "^10.2.0", - "minipass": "^5.0.0 || ^6.0.2 || ^7.0.0" - }, - "engines": { - "node": ">=16 || 14 >=14.18" - }, - "funding": { - "url": "https://github.com/sponsors/isaacs" - } - }, - "node_modules/c8/node_modules/test-exclude": { - "version": "7.0.1", - "resolved": "https://registry.npmjs.org/test-exclude/-/test-exclude-7.0.1.tgz", - "integrity": "sha512-pFYqmTw68LXVjeWJMST4+borgQP2AyMNbg1BpZh9LbyhUeNkeaPF9gzfPGUAnSMV3qPYdWUwDIjjCLiSDOl7vg==", - "dev": true, - "license": "ISC", - "dependencies": { - "@istanbuljs/schema": "^0.1.2", - "glob": "^10.4.1", - "minimatch": "^9.0.4" - }, - "engines": { - "node": ">=18" - } - }, - "node_modules/cacheable-lookup": { - "version": "7.0.0", - "resolved": "https://registry.npmjs.org/cacheable-lookup/-/cacheable-lookup-7.0.0.tgz", - "integrity": "sha512-+qJyx4xiKra8mZrcwhjMRMUhD5NR1R8esPkzIYxX96JiecFoxAXFuz/GpR3+ev4PE1WamHip78wV0vcmPQtp8w==", - "dev": true, - "license": "MIT", - "engines": { - "node": ">=14.16" - } - }, - "node_modules/cacheable-request": { - "version": "10.2.14", - "resolved": "https://registry.npmjs.org/cacheable-request/-/cacheable-request-10.2.14.tgz", - "integrity": "sha512-zkDT5WAF4hSSoUgyfg5tFIxz8XQK+25W/TLVojJTMKBaxevLBBtLxgqguAuVQB8PVW79FVjHcU+GJ9tVbDZ9mQ==", - "dev": true, - "license": "MIT", - "dependencies": { - "@types/http-cache-semantics": "^4.0.2", - "get-stream": "^6.0.1", - "http-cache-semantics": "^4.1.1", - "keyv": "^4.5.3", - "mimic-response": "^4.0.0", - "normalize-url": "^8.0.0", - "responselike": "^3.0.0" - }, - "engines": { - "node": ">=14.16" - } - }, - "node_modules/call-bind": { - "version": "1.0.8", - "resolved": "https://registry.npmjs.org/call-bind/-/call-bind-1.0.8.tgz", - "integrity": "sha512-oKlSFMcMwpUg2ednkhQ454wfWiU/ul3CkJe/PEHcTKuiX6RpbehUiFMXu13HalGZxfUwCQzZG747YXBn1im9ww==", - "dev": true, - "license": "MIT", - "dependencies": { - "call-bind-apply-helpers": "^1.0.0", - "es-define-property": "^1.0.0", - "get-intrinsic": "^1.2.4", - "set-function-length": "^1.2.2" - }, - "engines": { - "node": ">= 0.4" - }, - "funding": { - "url": "https://github.com/sponsors/ljharb" - } - }, - "node_modules/call-bind-apply-helpers": { - "version": "1.0.2", - "resolved": "https://registry.npmjs.org/call-bind-apply-helpers/-/call-bind-apply-helpers-1.0.2.tgz", - "integrity": "sha512-Sp1ablJ0ivDkSzjcaJdxEunN5/XvksFJ2sMBFfq6x0ryhQV/2b/KwFe21cMpmHtPOSij8K99/wSfoEuTObmuMQ==", - "dev": true, - "license": "MIT", - "dependencies": { - "es-errors": "^1.3.0", - "function-bind": "^1.1.2" - }, - "engines": { - "node": ">= 0.4" - } - }, - "node_modules/call-bound": { - "version": "1.0.4", - "resolved": "https://registry.npmjs.org/call-bound/-/call-bound-1.0.4.tgz", - "integrity": "sha512-+ys997U96po4Kx/ABpBCqhA9EuxJaQWDQg7295H4hBphv3IZg0boBKuwYpt4YXp6MZ5AmZQnU/tyMTlRpaSejg==", - "dev": true, - "license": "MIT", - "dependencies": { - "call-bind-apply-helpers": "^1.0.2", - "get-intrinsic": "^1.3.0" - }, - "engines": { - "node": ">= 0.4" - }, - "funding": { - "url": "https://github.com/sponsors/ljharb" - } - }, "node_modules/callsites": { "version": "3.1.0", "resolved": "https://registry.npmjs.org/callsites/-/callsites-3.1.0.tgz", @@ -8942,44 +5471,22 @@ "node": ">=6" } }, - "node_modules/camel-case": { - "version": "4.1.2", - "resolved": "https://registry.npmjs.org/camel-case/-/camel-case-4.1.2.tgz", - "integrity": "sha512-gxGWBrTT1JuMx6R+o5PTXMmUnhnVzLQ9SNutD4YqKtI6ap897t3tKECYla6gCWEkplXnlNybEkZg9GEGxKFCgw==", - "dev": true, - "license": "MIT", - "dependencies": { - "pascal-case": "^3.1.2", - "tslib": "^2.0.3" - } - }, "node_modules/camelcase": { - "version": "5.3.1", - "resolved": "https://registry.npmjs.org/camelcase/-/camelcase-5.3.1.tgz", - "integrity": "sha512-L28STB170nwWS63UjtlEOE3dldQApaJXZkOI1uMFfzf3rRuPegHaHesyee+YxQ+W6SvRDQV6UrdOdRiR153wJg==", - "dev": true, + "version": "6.3.0", + "resolved": "https://registry.npmjs.org/camelcase/-/camelcase-6.3.0.tgz", + "integrity": "sha512-Gmy6FhYlCY7uOElZUSbxo2UCDH8owEk996gkbrpsgGtrJLM3J7jGxl9Ic7Qwwj4ivOE5AWZWRMecDdF7hqGjFA==", "license": "MIT", "engines": { - "node": ">=6" - } - }, - "node_modules/caniuse-api": { - "version": "3.0.0", - "resolved": "https://registry.npmjs.org/caniuse-api/-/caniuse-api-3.0.0.tgz", - "integrity": "sha512-bsTwuIg/BZZK/vreVTYYbSWoe2F+71P7K5QGEX+pT250DZbfU1MQ5prOKpPR+LL6uWKK3KMwMCAS74QB3Um1uw==", - "dev": true, - "license": "MIT", - "dependencies": { - "browserslist": "^4.0.0", - "caniuse-lite": "^1.0.0", - "lodash.memoize": "^4.1.2", - "lodash.uniq": "^4.5.0" + "node": ">=10" + }, + "funding": { + "url": "https://github.com/sponsors/sindresorhus" } }, "node_modules/caniuse-lite": { - "version": "1.0.30001761", - "resolved": "https://registry.npmjs.org/caniuse-lite/-/caniuse-lite-1.0.30001761.tgz", - "integrity": "sha512-JF9ptu1vP2coz98+5051jZ4PwQgd2ni8A+gYSN7EA7dPKIMf0pDlSUxhdmVOaV3/fYK5uWBkgSXJaRLr4+3A6g==", + "version": "1.0.30001762", + "resolved": "https://registry.npmjs.org/caniuse-lite/-/caniuse-lite-1.0.30001762.tgz", + "integrity": "sha512-PxZwGNvH7Ak8WX5iXzoK1KPZttBXNPuaOvI2ZYU7NrlM+d9Ov+TUvlLOBNGzVXAntMSMMlJPd+jY6ovrVjSmUw==", "dev": true, "funding": [ { @@ -9084,104 +5591,26 @@ "url": "https://github.com/sponsors/wooorm" } }, - "node_modules/chardet": { - "version": "2.1.0", - "resolved": "https://registry.npmjs.org/chardet/-/chardet-2.1.0.tgz", - "integrity": "sha512-bNFETTG/pM5ryzQ9Ad0lJOTa6HWD/YsScAR3EnCPZRPlQh77JocYktSHOUHelyhm8IARL+o4c4F1bP5KVOjiRA==", - "license": "MIT" - }, - "node_modules/cheerio": { - "version": "1.0.0-rc.12", - "resolved": "https://registry.npmjs.org/cheerio/-/cheerio-1.0.0-rc.12.tgz", - "integrity": "sha512-VqR8m68vM46BNnuZ5NtnGBKIE/DfN0cRIzg9n40EIq9NOv90ayxLBXA8fXC5gquFRGJSTRqBq25Jt2ECLR431Q==", - "dev": true, - "license": "MIT", - "dependencies": { - "cheerio-select": "^2.1.0", - "dom-serializer": "^2.0.0", - "domhandler": "^5.0.3", - "domutils": "^3.0.1", - "htmlparser2": "^8.0.1", - "parse5": "^7.0.0", - "parse5-htmlparser2-tree-adapter": "^7.0.0" - }, - "engines": { - "node": ">= 6" - }, - "funding": { - "url": "https://github.com/cheeriojs/cheerio?sponsor=1" - } - }, - "node_modules/cheerio-select": { - "version": "2.1.0", - "resolved": "https://registry.npmjs.org/cheerio-select/-/cheerio-select-2.1.0.tgz", - "integrity": "sha512-9v9kG0LvzrlcungtnJtpGNxY+fzECQKhK4EGJX2vByejiMX84MFNQw4UxPJl3bFbTMw+Dfs37XaIkCwTZfLh4g==", - "dev": true, - "license": "BSD-2-Clause", - "dependencies": { - "boolbase": "^1.0.0", - "css-select": "^5.1.0", - "css-what": "^6.1.0", - "domelementtype": "^2.3.0", - "domhandler": "^5.0.3", - "domutils": "^3.0.1" - }, - "funding": { - "url": "https://github.com/sponsors/fb55" - } - }, "node_modules/chokidar": { - "version": "3.6.0", - "resolved": "https://registry.npmjs.org/chokidar/-/chokidar-3.6.0.tgz", - "integrity": "sha512-7VT13fmjotKpGipCW9JEQAusEPE+Ei8nl6/g4FBAmIm0GOOLMua9NDDo/DWp0ZAxCr3cPq5ZpBqmPAQgDda2Pw==", + "version": "4.0.3", + "resolved": "https://registry.npmjs.org/chokidar/-/chokidar-4.0.3.tgz", + "integrity": "sha512-Qgzu8kfBvo+cA4962jnP1KkS6Dop5NS6g7R5LFYJr4b8Ub94PPQXUksCw9PvXoeXPRRddRNC5C1JQUR2SMGtnA==", "dev": true, "license": "MIT", "dependencies": { - "anymatch": "~3.1.2", - "braces": "~3.0.2", - "glob-parent": "~5.1.2", - "is-binary-path": "~2.1.0", - "is-glob": "~4.0.1", - "normalize-path": "~3.0.0", - "readdirp": "~3.6.0" + "readdirp": "^4.0.1" }, "engines": { - "node": ">= 8.10.0" + "node": ">= 14.16.0" }, "funding": { "url": "https://paulmillr.com/funding/" - }, - "optionalDependencies": { - "fsevents": "~2.3.2" - } - }, - "node_modules/chokidar/node_modules/glob-parent": { - "version": "5.1.2", - "resolved": "https://registry.npmjs.org/glob-parent/-/glob-parent-5.1.2.tgz", - "integrity": "sha512-AOIgSQCepiJYwP3ARnGx+5VnTu2HBYdzbGP45eLw1vr3zB3vZLeyed1sC9hnbcOc9/SrMyM5RPQrkGz4aS9Zow==", - "dev": true, - "license": "ISC", - "dependencies": { - "is-glob": "^4.0.1" - }, - "engines": { - "node": ">= 6" - } - }, - "node_modules/chrome-trace-event": { - "version": "1.0.4", - "resolved": "https://registry.npmjs.org/chrome-trace-event/-/chrome-trace-event-1.0.4.tgz", - "integrity": "sha512-rNjApaLzuwaOTjCiT8lSDdGN1APCiqkChLMJxJPWLunPAt5fy8xgU9/jNOchV84wfIxrA0lRQB7oCT8jrn/wrQ==", - "dev": true, - "license": "MIT", - "engines": { - "node": ">=6.0" } }, "node_modules/ci-info": { - "version": "4.3.0", - "resolved": "https://registry.npmjs.org/ci-info/-/ci-info-4.3.0.tgz", - "integrity": "sha512-l+2bNRMiQgcfILUi33labAZYIWlH1kWDp+ecNo5iisRKrbm0xcRyCww71/YU0Fkw0mAFpz9bJayXPjey6vkmaQ==", + "version": "4.3.1", + "resolved": "https://registry.npmjs.org/ci-info/-/ci-info-4.3.1.tgz", + "integrity": "sha512-Wdy2Igu8OcBpI2pZePZ5oWjPC38tmDVx5WKUXKwlLYkA0ozo85sLsLvkBbBn/sZaSCMFOGZJ14fvW9t5/d7kdA==", "dev": true, "funding": [ { @@ -9195,25 +5624,12 @@ } }, "node_modules/cjs-module-lexer": { - "version": "2.1.0", - "resolved": "https://registry.npmjs.org/cjs-module-lexer/-/cjs-module-lexer-2.1.0.tgz", - "integrity": "sha512-UX0OwmYRYQQetfrLEZeewIFFI+wSTofC+pMBLNuH3RUuu/xzG1oz84UCEDOSoQlN3fZ4+AzmV50ZYvGqkMh9yA==", + "version": "2.2.0", + "resolved": "https://registry.npmjs.org/cjs-module-lexer/-/cjs-module-lexer-2.2.0.tgz", + "integrity": "sha512-4bHTS2YuzUvtoLjdy+98ykbNB5jS0+07EvFNXerqZQJ89F7DI6ET7OQo/HJuW6K0aVsKA9hj9/RVb2kQVOrPDQ==", "dev": true, "license": "MIT" }, - "node_modules/clean-css": { - "version": "5.3.3", - "resolved": "https://registry.npmjs.org/clean-css/-/clean-css-5.3.3.tgz", - "integrity": "sha512-D5J+kHaVb/wKSFcyyV75uCn8fiY4sV38XJoe4CUyGQ+mOU/fMVYUdH1hJC+CJQ5uY3EnW27SbJYS4X8BiLrAFg==", - "dev": true, - "license": "MIT", - "dependencies": { - "source-map": "~0.6.0" - }, - "engines": { - "node": ">= 10.0" - } - }, "node_modules/clean-regexp": { "version": "1.0.0", "resolved": "https://registry.npmjs.org/clean-regexp/-/clean-regexp-1.0.0.tgz", @@ -9237,16 +5653,6 @@ "node": ">=0.8.0" } }, - "node_modules/clean-stack": { - "version": "2.2.0", - "resolved": "https://registry.npmjs.org/clean-stack/-/clean-stack-2.2.0.tgz", - "integrity": "sha512-4diC9HaTE+KRAMWhDhrGOECgWZxoevMc5TlkObMqNSsVU62PYzXZ/SMTjzyGAFF1YusgxGcSWTEXBhp0CPwQ1A==", - "dev": true, - "license": "MIT", - "engines": { - "node": ">=6" - } - }, "node_modules/cli-boxes": { "version": "2.2.1", "resolved": "https://registry.npmjs.org/cli-boxes/-/cli-boxes-2.2.1.tgz", @@ -9260,15 +5666,19 @@ } }, "node_modules/cli-cursor": { - "version": "3.1.0", - "resolved": "https://registry.npmjs.org/cli-cursor/-/cli-cursor-3.1.0.tgz", - "integrity": "sha512-I/zHAwsKf9FqGoXM4WWRACob9+SNukZTd94DWF57E4toouRulbCxcUh6RKUEOQlYTHJnzkPMySvPNaaSLNfLZw==", + "version": "5.0.0", + "resolved": "https://registry.npmjs.org/cli-cursor/-/cli-cursor-5.0.0.tgz", + "integrity": "sha512-aCj4O5wKyszjMmDT4tZj93kxyydN/K5zPWSCe6/0AV/AA1pqe5ZBIw0a2ZfPQV7lL5/yb5HsUreJ6UFAF1tEQw==", + "dev": true, "license": "MIT", "dependencies": { - "restore-cursor": "^3.1.0" + "restore-cursor": "^5.0.0" }, "engines": { - "node": ">=8" + "node": ">=18" + }, + "funding": { + "url": "https://github.com/sponsors/sindresorhus" } }, "node_modules/cli-spinners": { @@ -9299,26 +5709,26 @@ } }, "node_modules/cli-truncate": { - "version": "4.0.0", - "resolved": "https://registry.npmjs.org/cli-truncate/-/cli-truncate-4.0.0.tgz", - "integrity": "sha512-nPdaFdQ0h/GEigbPClz11D0v/ZJEwxmeVZGeMo3Z5StPtUTkA9o1lD6QwoirYiSDzbcwn2XcjwmCp68W1IS4TA==", + "version": "5.1.1", + "resolved": "https://registry.npmjs.org/cli-truncate/-/cli-truncate-5.1.1.tgz", + "integrity": "sha512-SroPvNHxUnk+vIW/dOSfNqdy1sPEFkrTk6TUtqLCnBlo3N7TNYYkzzN7uSD6+jVjrdO4+p8nH7JzH6cIvUem6A==", "dev": true, "license": "MIT", "dependencies": { - "slice-ansi": "^5.0.0", - "string-width": "^7.0.0" + "slice-ansi": "^7.1.0", + "string-width": "^8.0.0" }, "engines": { - "node": ">=18" + "node": ">=20" }, "funding": { "url": "https://github.com/sponsors/sindresorhus" } }, "node_modules/cli-truncate/node_modules/ansi-regex": { - "version": "6.2.0", - "resolved": "https://registry.npmjs.org/ansi-regex/-/ansi-regex-6.2.0.tgz", - "integrity": "sha512-TKY5pyBkHyADOPYlRT9Lx6F544mPl0vS5Ew7BJ45hA08Q+t3GjbueLliBWN3sMICk6+y7HdyxSzC4bWS8baBdg==", + "version": "6.2.2", + "resolved": "https://registry.npmjs.org/ansi-regex/-/ansi-regex-6.2.2.tgz", + "integrity": "sha512-Bq3SmSpyFHaWjPk8If9yc6svM8c56dB5BAtW4Qbw5jHTwwXXcTLoRMkpDJp6VL0XzlWaCHTXrkFURMYmD0sLqg==", "dev": true, "license": "MIT", "engines": { @@ -9328,35 +5738,27 @@ "url": "https://github.com/chalk/ansi-regex?sponsor=1" } }, - "node_modules/cli-truncate/node_modules/emoji-regex": { - "version": "10.4.0", - "resolved": "https://registry.npmjs.org/emoji-regex/-/emoji-regex-10.4.0.tgz", - "integrity": "sha512-EC+0oUMY1Rqm4O6LLrgjtYDvcVYTy7chDnM4Q7030tP4Kwj3u/pR6gP9ygnp2CJMK5Gq+9Q2oqmrFJAz01DXjw==", - "dev": true, - "license": "MIT" - }, "node_modules/cli-truncate/node_modules/string-width": { - "version": "7.2.0", - "resolved": "https://registry.npmjs.org/string-width/-/string-width-7.2.0.tgz", - "integrity": "sha512-tsaTIkKW9b4N+AEj+SVA+WhJzV7/zMhcSu78mLKWSk7cXMOSHsBKFWUs0fWwq8QyK3MgJBQRX6Gbi4kYbdvGkQ==", + "version": "8.1.0", + "resolved": "https://registry.npmjs.org/string-width/-/string-width-8.1.0.tgz", + "integrity": "sha512-Kxl3KJGb/gxkaUMOjRsQ8IrXiGW75O4E3RPjFIINOVH8AMl2SQ/yWdTzWwF3FevIX9LcMAjJW+GRwAlAbTSXdg==", "dev": true, "license": "MIT", "dependencies": { - "emoji-regex": "^10.3.0", - "get-east-asian-width": "^1.0.0", + "get-east-asian-width": "^1.3.0", "strip-ansi": "^7.1.0" }, "engines": { - "node": ">=18" + "node": ">=20" }, "funding": { "url": "https://github.com/sponsors/sindresorhus" } }, "node_modules/cli-truncate/node_modules/strip-ansi": { - "version": "7.1.0", - "resolved": "https://registry.npmjs.org/strip-ansi/-/strip-ansi-7.1.0.tgz", - "integrity": "sha512-iq6eVVI64nQQTRYq2KtEg2d2uU7LElhTJwsH4YzIHZshxlgZms/wIc4VoDQTlG/IvVIrBKG06CrZnp0qv7hkcQ==", + "version": "7.1.2", + "resolved": "https://registry.npmjs.org/strip-ansi/-/strip-ansi-7.1.2.tgz", + "integrity": "sha512-gmBGslpoQJtgnMAvOVqGZpEz9dyoKTCzy2nfz/n8aIFhN/jCE/rCmcxabB6jOOHV+0WNnylOxaxBQPSvcWklhA==", "dev": true, "license": "MIT", "dependencies": { @@ -9369,15 +5771,6 @@ "url": "https://github.com/chalk/strip-ansi?sponsor=1" } }, - "node_modules/cli-width": { - "version": "3.0.0", - "resolved": "https://registry.npmjs.org/cli-width/-/cli-width-3.0.0.tgz", - "integrity": "sha512-FxqpkPPwu1HjuN93Omfm4h8uIanXofW0RxVEW3k5RKx+mJJYSthzNhp32Kzxxy3YAEZ/Dc/EWN1vZRY0+kOhbw==", - "license": "ISC", - "engines": { - "node": ">= 10" - } - }, "node_modules/cliui": { "version": "8.0.1", "resolved": "https://registry.npmjs.org/cliui/-/cliui-8.0.1.tgz", @@ -9394,29 +5787,15 @@ } }, "node_modules/clone": { - "version": "1.0.4", - "resolved": "https://registry.npmjs.org/clone/-/clone-1.0.4.tgz", - "integrity": "sha512-JQHZ2QMW6l3aH/j6xCqQThY/9OH4D/9ls34cgkUBiEeocRTU04tHfKPBsUK1PqZCUQM7GiA0IIXJSuXHI64Kbg==", + "version": "2.1.2", + "resolved": "https://registry.npmjs.org/clone/-/clone-2.1.2.tgz", + "integrity": "sha512-3Pe/CF1Nn94hyhIYpjtiLhdCoEoz0DqQ+988E9gmeEdQZlojxnOb74wctFyuwWQHzqyf9X7C7MG8juUpqBJT8w==", + "dev": true, "license": "MIT", "engines": { "node": ">=0.8" } }, - "node_modules/clone-deep": { - "version": "4.0.1", - "resolved": "https://registry.npmjs.org/clone-deep/-/clone-deep-4.0.1.tgz", - "integrity": "sha512-neHB9xuzh/wk0dIHweyAXv2aPGZIVk3pLMe+/RNzINf17fe0OG96QroktYAUm7SM1PBnzTabaLboqqxDyMU+SQ==", - "dev": true, - "license": "MIT", - "dependencies": { - "is-plain-object": "^2.0.4", - "kind-of": "^6.0.2", - "shallow-clone": "^3.0.0" - }, - "engines": { - "node": ">=6" - } - }, "node_modules/clsx": { "version": "2.1.1", "resolved": "https://registry.npmjs.org/clsx/-/clsx-2.1.1.tgz", @@ -9450,12 +5829,26 @@ } }, "node_modules/collect-v8-coverage": { - "version": "1.0.2", - "resolved": "https://registry.npmjs.org/collect-v8-coverage/-/collect-v8-coverage-1.0.2.tgz", - "integrity": "sha512-lHl4d5/ONEbLlJvaJNtsF/Lz+WvB07u2ycqTYbdrq7UypDXailES4valYb2eWiJFxZlVmpGekfqoxQhzyFdT4Q==", + "version": "1.0.3", + "resolved": "https://registry.npmjs.org/collect-v8-coverage/-/collect-v8-coverage-1.0.3.tgz", + "integrity": "sha512-1L5aqIkwPfiodaMgQunkF1zRhNqifHBmtbbbxcr6yVxxBnliw4TDOW6NxpO8DJLgJ16OT+Y4ztZqP6p/FtXnAw==", "dev": true, "license": "MIT" }, + "node_modules/color": { + "version": "4.2.3", + "resolved": "https://registry.npmjs.org/color/-/color-4.2.3.tgz", + "integrity": "sha512-1rXeuUUiGGrykh+CeBdu5Ie7OJwinCgQY0bc7GCRxy5xVHy+moaqkpL/jqQq0MtQOeYcrqEz4abc5f0KtU7W4A==", + "dev": true, + "license": "MIT", + "dependencies": { + "color-convert": "^2.0.1", + "color-string": "^1.9.0" + }, + "engines": { + "node": ">=12.5.0" + } + }, "node_modules/color-convert": { "version": "2.0.1", "resolved": "https://registry.npmjs.org/color-convert/-/color-convert-2.0.1.tgz", @@ -9474,12 +5867,16 @@ "integrity": "sha512-dOy+3AuW3a2wNbZHIuMZpTcgjGuLU/uBL/ubcZF9OXbDo8ff4O8yVp5Bf0efS8uEoYo5q4Fx7dY9OgQGXgAsQA==", "license": "MIT" }, - "node_modules/colord": { - "version": "2.9.3", - "resolved": "https://registry.npmjs.org/colord/-/colord-2.9.3.tgz", - "integrity": "sha512-jeC1axXpnb0/2nn/Y1LPuLdgXBLH7aDcHu4KEKfqw3CUhX7ZpfBSlPKyqXE6btIgEzfWtrX3/tyBCaCvXvMkOw==", + "node_modules/color-string": { + "version": "1.9.1", + "resolved": "https://registry.npmjs.org/color-string/-/color-string-1.9.1.tgz", + "integrity": "sha512-shrVawQFojnZv6xM40anx4CkoDP+fZsw/ZerEMsW/pyzsRbElpsL/DBVW7q3ExxwusdNXI3lXpuhEZkzs8p5Eg==", "dev": true, - "license": "MIT" + "license": "MIT", + "dependencies": { + "color-name": "^1.0.0", + "simple-swizzle": "^0.2.2" + } }, "node_modules/colorette": { "version": "2.0.20", @@ -9488,16 +5885,6 @@ "dev": true, "license": "MIT" }, - "node_modules/combine-promises": { - "version": "1.2.0", - "resolved": "https://registry.npmjs.org/combine-promises/-/combine-promises-1.2.0.tgz", - "integrity": "sha512-VcQB1ziGD0NXrhKxiwyNbCDmRzs/OShMs2GqW2DlU2A/Sd0nQxE1oWDAE5O0ygSx5mgQOn9eIFh7yKPgFRVkPQ==", - "dev": true, - "license": "MIT", - "engines": { - "node": ">=10" - } - }, "node_modules/comma-separated-tokens": { "version": "2.0.3", "resolved": "https://registry.npmjs.org/comma-separated-tokens/-/comma-separated-tokens-2.0.3.tgz", @@ -9510,18 +5897,18 @@ } }, "node_modules/commander": { - "version": "14.0.0", - "resolved": "https://registry.npmjs.org/commander/-/commander-14.0.0.tgz", - "integrity": "sha512-2uM9rYjPvyq39NwLRqaiLtWHyDC1FvryJDa2ATTVims5YAS4PupsEQsDvP14FqhFr0P49CYDugi59xaxJlTXRA==", + "version": "14.0.2", + "resolved": "https://registry.npmjs.org/commander/-/commander-14.0.2.tgz", + "integrity": "sha512-TywoWNNRbhoD0BXs1P3ZEScW8W5iKrnbithIl0YH+uCmBd0QpPOA8yc82DS3BIE5Ma6FnBVUsJ7wVUDz4dvOWQ==", "license": "MIT", "engines": { "node": ">=20" } }, - "node_modules/common-path-prefix": { - "version": "3.0.0", - "resolved": "https://registry.npmjs.org/common-path-prefix/-/common-path-prefix-3.0.0.tgz", - "integrity": "sha512-QE33hToZseCH3jS0qN96O/bSh3kaw/h+Tq7ngyY9eWDUnTlTNUyqfqvCXioLe5Na5jFsL78ra/wuBU4iuEgd4w==", + "node_modules/common-ancestor-path": { + "version": "1.0.1", + "resolved": "https://registry.npmjs.org/common-ancestor-path/-/common-ancestor-path-1.0.1.tgz", + "integrity": "sha512-L3sHRo1pXXEqX8VU28kfgUY+YGsk09hPqZiZmLacNib6XNTCM8ubYeT7ryXQw8asB1sKgcU5lkB7ONug08aB8w==", "dev": true, "license": "ISC" }, @@ -9542,117 +5929,6 @@ "node": ">= 14" } }, - "node_modules/compress-commons/node_modules/buffer": { - "version": "6.0.3", - "resolved": "https://registry.npmjs.org/buffer/-/buffer-6.0.3.tgz", - "integrity": "sha512-FTiCpNxtwiZZHEZbcbTIcZjERVICn9yq/pDFkTl95/AxzD1naBctN7YO68riM/gLSDY7sdrMby8hofADYuuqOA==", - "dev": true, - "funding": [ - { - "type": "github", - "url": "https://github.com/sponsors/feross" - }, - { - "type": "patreon", - "url": "https://www.patreon.com/feross" - }, - { - "type": "consulting", - "url": "https://feross.org/support" - } - ], - "license": "MIT", - "dependencies": { - "base64-js": "^1.3.1", - "ieee754": "^1.2.1" - } - }, - "node_modules/compress-commons/node_modules/readable-stream": { - "version": "4.7.0", - "resolved": "https://registry.npmjs.org/readable-stream/-/readable-stream-4.7.0.tgz", - "integrity": "sha512-oIGGmcpTLwPga8Bn6/Z75SVaH1z5dUut2ibSyAMVhmUggWpmDn2dapB0n7f8nwaSiRtepAsfJyfXIO5DCVAODg==", - "dev": true, - "license": "MIT", - "dependencies": { - "abort-controller": "^3.0.0", - "buffer": "^6.0.3", - "events": "^3.3.0", - "process": "^0.11.10", - "string_decoder": "^1.3.0" - }, - "engines": { - "node": "^12.22.0 || ^14.17.0 || >=16.0.0" - } - }, - "node_modules/compressible": { - "version": "2.0.18", - "resolved": "https://registry.npmjs.org/compressible/-/compressible-2.0.18.tgz", - "integrity": "sha512-AF3r7P5dWxL8MxyITRMlORQNaOA2IkAFaTr4k7BUumjPtRpGDTZpl0Pb1XCO6JeDCBdp126Cgs9sMxqSjgYyRg==", - "dev": true, - "license": "MIT", - "dependencies": { - "mime-db": ">= 1.43.0 < 2" - }, - "engines": { - "node": ">= 0.6" - } - }, - "node_modules/compressible/node_modules/mime-db": { - "version": "1.54.0", - "resolved": "https://registry.npmjs.org/mime-db/-/mime-db-1.54.0.tgz", - "integrity": "sha512-aU5EJuIN2WDemCcAp2vFBfp/m4EAhWJnUNSSw0ixs7/kXbd6Pg64EmwJkNdFhB8aWt1sH2CTXrLxo/iAGV3oPQ==", - "dev": true, - "license": "MIT", - "engines": { - "node": ">= 0.6" - } - }, - "node_modules/compression": { - "version": "1.8.1", - "resolved": "https://registry.npmjs.org/compression/-/compression-1.8.1.tgz", - "integrity": "sha512-9mAqGPHLakhCLeNyxPkK4xVo746zQ/czLH1Ky+vkitMnWfWZps8r0qXuwhwizagCRttsL4lfG4pIOvaWLpAP0w==", - "dev": true, - "license": "MIT", - "dependencies": { - "bytes": "3.1.2", - "compressible": "~2.0.18", - "debug": "2.6.9", - "negotiator": "~0.6.4", - "on-headers": "~1.1.0", - "safe-buffer": "5.2.1", - "vary": "~1.1.2" - }, - "engines": { - "node": ">= 0.8.0" - } - }, - "node_modules/compression/node_modules/bytes": { - "version": "3.1.2", - "resolved": "https://registry.npmjs.org/bytes/-/bytes-3.1.2.tgz", - "integrity": "sha512-/Nf7TyzTx6S3yRJObOAV7956r8cr2+Oj8AC5dt8wSP3BQAoeX58NoHyCU8P8zGkNXStjTSi6fzO6F0pBdcYbEg==", - "dev": true, - "license": "MIT", - "engines": { - "node": ">= 0.8" - } - }, - "node_modules/compression/node_modules/debug": { - "version": "2.6.9", - "resolved": "https://registry.npmjs.org/debug/-/debug-2.6.9.tgz", - "integrity": "sha512-bC7ElrdJaJnPbAP+1EotYvqZsb3ecl5wi6Bfi6BJTUcNowp6cvspg0jXznRTKDjm/E7AdgFBVeAPVMNcKGsHMA==", - "dev": true, - "license": "MIT", - "dependencies": { - "ms": "2.0.0" - } - }, - "node_modules/compression/node_modules/ms": { - "version": "2.0.0", - "resolved": "https://registry.npmjs.org/ms/-/ms-2.0.0.tgz", - "integrity": "sha512-Tpp60P6IUJDTuOq/5Z8cdskzJujfwqfOTkrwIwj7IRISpnkJnT6SyJ4PCPnGMoFjC9ddhal5KVIYtAt97ix05A==", - "dev": true, - "license": "MIT" - }, "node_modules/concat-map": { "version": "0.0.1", "resolved": "https://registry.npmjs.org/concat-map/-/concat-map-0.0.1.tgz", @@ -9660,74 +5936,6 @@ "dev": true, "license": "MIT" }, - "node_modules/config-chain": { - "version": "1.1.13", - "resolved": "https://registry.npmjs.org/config-chain/-/config-chain-1.1.13.tgz", - "integrity": "sha512-qj+f8APARXHrM0hraqXYb2/bOVSV4PvJQlNZ/DVj0QrmNM2q2euizkeuVckQ57J+W0mRH6Hvi+k50M4Jul2VRQ==", - "dev": true, - "license": "MIT", - "dependencies": { - "ini": "^1.3.4", - "proto-list": "~1.2.1" - } - }, - "node_modules/config-chain/node_modules/ini": { - "version": "1.3.8", - "resolved": "https://registry.npmjs.org/ini/-/ini-1.3.8.tgz", - "integrity": "sha512-JV/yugV2uzW5iMRSiZAyDtQd+nxtUnjeLt0acNdw98kKLrvuRVyB80tsREOE7yvGVgalhZ6RNXCmEHkUKBKxew==", - "dev": true, - "license": "ISC" - }, - "node_modules/configstore": { - "version": "6.0.0", - "resolved": "https://registry.npmjs.org/configstore/-/configstore-6.0.0.tgz", - "integrity": "sha512-cD31W1v3GqUlQvbBCGcXmd2Nj9SvLDOP1oQ0YFuLETufzSPaKp11rYBsSOm7rCsW3OnIRAFM3OxRhceaXNYHkA==", - "dev": true, - "license": "BSD-2-Clause", - "dependencies": { - "dot-prop": "^6.0.1", - "graceful-fs": "^4.2.6", - "unique-string": "^3.0.0", - "write-file-atomic": "^3.0.3", - "xdg-basedir": "^5.0.1" - }, - "engines": { - "node": ">=12" - }, - "funding": { - "url": "https://github.com/yeoman/configstore?sponsor=1" - } - }, - "node_modules/configstore/node_modules/signal-exit": { - "version": "3.0.7", - "resolved": "https://registry.npmjs.org/signal-exit/-/signal-exit-3.0.7.tgz", - "integrity": "sha512-wnD2ZE+l+SPC/uoS0vXeE9L1+0wuaMqKlfz9AMUo38JsyLSBWSFcHR1Rri62LZc12vLr1gb3jl7iwQhgwpAbGQ==", - "dev": true, - "license": "ISC" - }, - "node_modules/configstore/node_modules/write-file-atomic": { - "version": "3.0.3", - "resolved": "https://registry.npmjs.org/write-file-atomic/-/write-file-atomic-3.0.3.tgz", - "integrity": "sha512-AvHcyZ5JnSfq3ioSyjrBkH9yW4m7Ayk8/9My/DD9onKeu/94fwrMocemO2QAJFAlnnDN+ZDS+ZjAR5ua1/PV/Q==", - "dev": true, - "license": "ISC", - "dependencies": { - "imurmurhash": "^0.1.4", - "is-typedarray": "^1.0.0", - "signal-exit": "^3.0.2", - "typedarray-to-buffer": "^3.1.5" - } - }, - "node_modules/connect-history-api-fallback": { - "version": "2.0.0", - "resolved": "https://registry.npmjs.org/connect-history-api-fallback/-/connect-history-api-fallback-2.0.0.tgz", - "integrity": "sha512-U73+6lQFmfiNPrYbXqr6kZ1i1wiRqXnp2nhMsINseWXO8lDau0LGEffJ8kQi4EjLZympVgRdvqjAgiZ1tgzDDA==", - "dev": true, - "license": "MIT", - "engines": { - "node": ">=0.8" - } - }, "node_modules/consola": { "version": "2.15.3", "resolved": "https://registry.npmjs.org/consola/-/consola-2.15.3.tgz", @@ -9735,26 +5943,6 @@ "dev": true, "license": "MIT" }, - "node_modules/content-disposition": { - "version": "0.5.2", - "resolved": "https://registry.npmjs.org/content-disposition/-/content-disposition-0.5.2.tgz", - "integrity": "sha512-kRGRZw3bLlFISDBgwTSA1TMBFN6J6GWDeubmDE3AF+3+yXL8hTWv8r5rkLbqYXY4RjPk/EzHnClI3zQf1cFmHA==", - "dev": true, - "license": "MIT", - "engines": { - "node": ">= 0.6" - } - }, - "node_modules/content-type": { - "version": "1.0.5", - "resolved": "https://registry.npmjs.org/content-type/-/content-type-1.0.5.tgz", - "integrity": "sha512-nTjqfcBFEipKdXCv4YDQWCfmcLZKm81ldF0pAopTvyrFGVbcR6P/VAAd5G7N+0tTr8QqiU0tFadD6FK4NtJwOA==", - "dev": true, - "license": "MIT", - "engines": { - "node": ">= 0.6" - } - }, "node_modules/convert-source-map": { "version": "2.0.0", "resolved": "https://registry.npmjs.org/convert-source-map/-/convert-source-map-2.0.0.tgz", @@ -9763,128 +5951,40 @@ "license": "MIT" }, "node_modules/cookie": { - "version": "0.7.2", - "resolved": "https://registry.npmjs.org/cookie/-/cookie-0.7.2.tgz", - "integrity": "sha512-yki5XnKuf750l50uGTllt6kKILY4nQ1eNIQatoXEByZ5dWgnKqbnqmTrBE5B4N7lrMJKQ2ytWMiTO2o0v6Ew/w==", + "version": "1.1.1", + "resolved": "https://registry.npmjs.org/cookie/-/cookie-1.1.1.tgz", + "integrity": "sha512-ei8Aos7ja0weRpFzJnEA9UHJ/7XQmqglbRwnf2ATjcB9Wq874VKH9kfjjirM6UhU2/E5fFYadylyhFldcqSidQ==", "dev": true, "license": "MIT", "engines": { - "node": ">= 0.6" + "node": ">=18" + }, + "funding": { + "type": "opencollective", + "url": "https://opencollective.com/express" } }, - "node_modules/cookie-signature": { - "version": "1.0.7", - "resolved": "https://registry.npmjs.org/cookie-signature/-/cookie-signature-1.0.7.tgz", - "integrity": "sha512-NXdYc3dLr47pBkpUCHtKSwIOQXLVn8dZEuywboCOJY/osA0wFSLlSawr3KN8qXJEyX66FcONTH8EIlVuK0yyFA==", + "node_modules/cookie-es": { + "version": "1.2.2", + "resolved": "https://registry.npmjs.org/cookie-es/-/cookie-es-1.2.2.tgz", + "integrity": "sha512-+W7VmiVINB+ywl1HGXJXmrqkOhpKrIiVZV6tQuV54ZyQC7MMuBt81Vc336GMLoHBq5hV/F9eXgt5Mnx0Rha5Fg==", "dev": true, "license": "MIT" }, - "node_modules/copy-webpack-plugin": { - "version": "11.0.0", - "resolved": "https://registry.npmjs.org/copy-webpack-plugin/-/copy-webpack-plugin-11.0.0.tgz", - "integrity": "sha512-fX2MWpamkW0hZxMEg0+mYnA40LTosOSa5TqZ9GYIBzyJa9C3QUaMPSE2xAi/buNr8u89SfD9wHSQVBzrRa/SOQ==", - "dev": true, - "license": "MIT", - "dependencies": { - "fast-glob": "^3.2.11", - "glob-parent": "^6.0.1", - "globby": "^13.1.1", - "normalize-path": "^3.0.0", - "schema-utils": "^4.0.0", - "serialize-javascript": "^6.0.0" - }, - "engines": { - "node": ">= 14.15.0" - }, - "funding": { - "type": "opencollective", - "url": "https://opencollective.com/webpack" - }, - "peerDependencies": { - "webpack": "^5.1.0" - } - }, - "node_modules/copy-webpack-plugin/node_modules/globby": { - "version": "13.2.2", - "resolved": "https://registry.npmjs.org/globby/-/globby-13.2.2.tgz", - "integrity": "sha512-Y1zNGV+pzQdh7H39l9zgB4PJqjRNqydvdYCDG4HFXM4XuvSaQQlEc91IU1yALL8gUTDomgBAfz3XJdmUS+oo0w==", - "dev": true, - "license": "MIT", - "dependencies": { - "dir-glob": "^3.0.1", - "fast-glob": "^3.3.0", - "ignore": "^5.2.4", - "merge2": "^1.4.1", - "slash": "^4.0.0" - }, - "engines": { - "node": "^12.20.0 || ^14.13.1 || >=16.0.0" - }, - "funding": { - "url": "https://github.com/sponsors/sindresorhus" - } - }, - "node_modules/copy-webpack-plugin/node_modules/ignore": { - "version": "5.3.2", - "resolved": "https://registry.npmjs.org/ignore/-/ignore-5.3.2.tgz", - "integrity": "sha512-hsBTNUqQTDwkWtcdYI2i06Y/nUBEsNEDJKjWdigLvegy8kDuJAS8uRlpkkcQpyEXL0Z/pjDy5HBmMjRCJ2gq+g==", - "dev": true, - "license": "MIT", - "engines": { - "node": ">= 4" - } - }, - "node_modules/copy-webpack-plugin/node_modules/slash": { - "version": "4.0.0", - "resolved": "https://registry.npmjs.org/slash/-/slash-4.0.0.tgz", - "integrity": "sha512-3dOsAHXXUkQTpOYcoAxLIorMTp4gIQr5IW3iVb7A7lFIp0VHhnynm9izx6TssdrIcVIESAlVjtnO2K8bg+Coew==", - "dev": true, - "license": "MIT", - "engines": { - "node": ">=12" - }, - "funding": { - "url": "https://github.com/sponsors/sindresorhus" - } - }, - "node_modules/core-js": { - "version": "3.47.0", - "resolved": "https://registry.npmjs.org/core-js/-/core-js-3.47.0.tgz", - "integrity": "sha512-c3Q2VVkGAUyupsjRnaNX6u8Dq2vAdzm9iuPj5FW0fRxzlxgq9Q39MDq10IvmQSpLgHQNyQzQmOo6bgGHmH3NNg==", - "dev": true, - "hasInstallScript": true, - "license": "MIT", - "funding": { - "type": "opencollective", - "url": "https://opencollective.com/core-js" - } - }, "node_modules/core-js-compat": { - "version": "3.45.1", - "resolved": "https://registry.npmjs.org/core-js-compat/-/core-js-compat-3.45.1.tgz", - "integrity": "sha512-tqTt5T4PzsMIZ430XGviK4vzYSoeNJ6CXODi6c/voxOT6IZqBht5/EKaSNnYiEjjRYxjVz7DQIsOsY0XNi8PIA==", + "version": "3.47.0", + "resolved": "https://registry.npmjs.org/core-js-compat/-/core-js-compat-3.47.0.tgz", + "integrity": "sha512-IGfuznZ/n7Kp9+nypamBhvwdwLsW6KC8IOaURw2doAK5e98AG3acVLdh0woOnEqCfUtS+Vu882JE4k/DAm3ItQ==", "dev": true, "license": "MIT", "dependencies": { - "browserslist": "^4.25.3" + "browserslist": "^4.28.0" }, "funding": { "type": "opencollective", "url": "https://opencollective.com/core-js" } }, - "node_modules/core-js-pure": { - "version": "3.47.0", - "resolved": "https://registry.npmjs.org/core-js-pure/-/core-js-pure-3.47.0.tgz", - "integrity": "sha512-BcxeDbzUrRnXGYIVAGFtcGQVNpFcUhVjr6W7F8XktvQW2iJP9e66GP6xdKotCRFlrxBvNIBrhwKteRXqMV86Nw==", - "dev": true, - "hasInstallScript": true, - "license": "MIT", - "funding": { - "type": "opencollective", - "url": "https://opencollective.com/core-js" - } - }, "node_modules/core-util-is": { "version": "1.0.3", "resolved": "https://registry.npmjs.org/core-util-is/-/core-util-is-1.0.3.tgz", @@ -9892,33 +5992,6 @@ "dev": true, "license": "MIT" }, - "node_modules/cosmiconfig": { - "version": "8.3.6", - "resolved": "https://registry.npmjs.org/cosmiconfig/-/cosmiconfig-8.3.6.tgz", - "integrity": "sha512-kcZ6+W5QzcJ3P1Mt+83OUv/oHFqZHIx8DuxG6eZ5RGMERoLqp4BuGjhHLYGK+Kf5XVkQvqBSmAy/nGWN3qDgEA==", - "dev": true, - "license": "MIT", - "dependencies": { - "import-fresh": "^3.3.0", - "js-yaml": "^4.1.0", - "parse-json": "^5.2.0", - "path-type": "^4.0.0" - }, - "engines": { - "node": ">=14" - }, - "funding": { - "url": "https://github.com/sponsors/d-fischer" - }, - "peerDependencies": { - "typescript": ">=4.9.5" - }, - "peerDependenciesMeta": { - "typescript": { - "optional": true - } - } - }, "node_modules/crc-32": { "version": "1.2.2", "resolved": "https://registry.npmjs.org/crc-32/-/crc-32-1.2.2.tgz", @@ -9946,48 +6019,6 @@ "node": ">= 14" } }, - "node_modules/crc32-stream/node_modules/buffer": { - "version": "6.0.3", - "resolved": "https://registry.npmjs.org/buffer/-/buffer-6.0.3.tgz", - "integrity": "sha512-FTiCpNxtwiZZHEZbcbTIcZjERVICn9yq/pDFkTl95/AxzD1naBctN7YO68riM/gLSDY7sdrMby8hofADYuuqOA==", - "dev": true, - "funding": [ - { - "type": "github", - "url": "https://github.com/sponsors/feross" - }, - { - "type": "patreon", - "url": "https://www.patreon.com/feross" - }, - { - "type": "consulting", - "url": "https://feross.org/support" - } - ], - "license": "MIT", - "dependencies": { - "base64-js": "^1.3.1", - "ieee754": "^1.2.1" - } - }, - "node_modules/crc32-stream/node_modules/readable-stream": { - "version": "4.7.0", - "resolved": "https://registry.npmjs.org/readable-stream/-/readable-stream-4.7.0.tgz", - "integrity": "sha512-oIGGmcpTLwPga8Bn6/Z75SVaH1z5dUut2ibSyAMVhmUggWpmDn2dapB0n7f8nwaSiRtepAsfJyfXIO5DCVAODg==", - "dev": true, - "license": "MIT", - "dependencies": { - "abort-controller": "^3.0.0", - "buffer": "^6.0.3", - "events": "^3.3.0", - "process": "^0.11.10", - "string_decoder": "^1.3.0" - }, - "engines": { - "node": "^12.22.0 || ^14.17.0 || >=16.0.0" - } - }, "node_modules/cross-spawn": { "version": "7.0.6", "resolved": "https://registry.npmjs.org/cross-spawn/-/cross-spawn-7.0.6.tgz", @@ -10002,360 +6033,14 @@ "node": ">= 8" } }, - "node_modules/crypto-random-string": { - "version": "4.0.0", - "resolved": "https://registry.npmjs.org/crypto-random-string/-/crypto-random-string-4.0.0.tgz", - "integrity": "sha512-x8dy3RnvYdlUcPOjkEHqozhiwzKNSq7GcPuXFbnyMOCHxX8V3OgIg/pYuabl2sbUPfIJaeAQB7PMOK8DFIdoRA==", + "node_modules/crossws": { + "version": "0.3.5", + "resolved": "https://registry.npmjs.org/crossws/-/crossws-0.3.5.tgz", + "integrity": "sha512-ojKiDvcmByhwa8YYqbQI/hg7MEU0NC03+pSdEq4ZUnZR9xXpwk7E43SMNGkn+JxJGPFtNvQ48+vV2p+P1ml5PA==", "dev": true, "license": "MIT", "dependencies": { - "type-fest": "^1.0.1" - }, - "engines": { - "node": ">=12" - }, - "funding": { - "url": "https://github.com/sponsors/sindresorhus" - } - }, - "node_modules/crypto-random-string/node_modules/type-fest": { - "version": "1.4.0", - "resolved": "https://registry.npmjs.org/type-fest/-/type-fest-1.4.0.tgz", - "integrity": "sha512-yGSza74xk0UG8k+pLh5oeoYirvIiWo5t0/o3zHHAO2tRDiZcxWP7fywNlXhqb6/r6sWvwi+RsyQMWhVLe4BVuA==", - "dev": true, - "license": "(MIT OR CC0-1.0)", - "engines": { - "node": ">=10" - }, - "funding": { - "url": "https://github.com/sponsors/sindresorhus" - } - }, - "node_modules/css-blank-pseudo": { - "version": "7.0.1", - "resolved": "https://registry.npmjs.org/css-blank-pseudo/-/css-blank-pseudo-7.0.1.tgz", - "integrity": "sha512-jf+twWGDf6LDoXDUode+nc7ZlrqfaNphrBIBrcmeP3D8yw1uPaix1gCC8LUQUGQ6CycuK2opkbFFWFuq/a94ag==", - "dev": true, - "funding": [ - { - "type": "github", - "url": "https://github.com/sponsors/csstools" - }, - { - "type": "opencollective", - "url": "https://opencollective.com/csstools" - } - ], - "license": "MIT-0", - "dependencies": { - "postcss-selector-parser": "^7.0.0" - }, - "engines": { - "node": ">=18" - }, - "peerDependencies": { - "postcss": "^8.4" - } - }, - "node_modules/css-blank-pseudo/node_modules/postcss-selector-parser": { - "version": "7.1.1", - "resolved": "https://registry.npmjs.org/postcss-selector-parser/-/postcss-selector-parser-7.1.1.tgz", - "integrity": "sha512-orRsuYpJVw8LdAwqqLykBj9ecS5/cRHlI5+nvTo8LcCKmzDmqVORXtOIYEEQuL9D4BxtA1lm5isAqzQZCoQ6Eg==", - "dev": true, - "license": "MIT", - "dependencies": { - "cssesc": "^3.0.0", - "util-deprecate": "^1.0.2" - }, - "engines": { - "node": ">=4" - } - }, - "node_modules/css-declaration-sorter": { - "version": "7.3.0", - "resolved": "https://registry.npmjs.org/css-declaration-sorter/-/css-declaration-sorter-7.3.0.tgz", - "integrity": "sha512-LQF6N/3vkAMYF4xoHLJfG718HRJh34Z8BnNhd6bosOMIVjMlhuZK5++oZa3uYAgrI5+7x2o27gUqTR2U/KjUOQ==", - "dev": true, - "license": "ISC", - "engines": { - "node": "^14 || ^16 || >=18" - }, - "peerDependencies": { - "postcss": "^8.0.9" - } - }, - "node_modules/css-has-pseudo": { - "version": "7.0.3", - "resolved": "https://registry.npmjs.org/css-has-pseudo/-/css-has-pseudo-7.0.3.tgz", - "integrity": "sha512-oG+vKuGyqe/xvEMoxAQrhi7uY16deJR3i7wwhBerVrGQKSqUC5GiOVxTpM9F9B9hw0J+eKeOWLH7E9gZ1Dr5rA==", - "dev": true, - "funding": [ - { - "type": "github", - "url": "https://github.com/sponsors/csstools" - }, - { - "type": "opencollective", - "url": "https://opencollective.com/csstools" - } - ], - "license": "MIT-0", - "dependencies": { - "@csstools/selector-specificity": "^5.0.0", - "postcss-selector-parser": "^7.0.0", - "postcss-value-parser": "^4.2.0" - }, - "engines": { - "node": ">=18" - }, - "peerDependencies": { - "postcss": "^8.4" - } - }, - "node_modules/css-has-pseudo/node_modules/@csstools/selector-specificity": { - "version": "5.0.0", - "resolved": "https://registry.npmjs.org/@csstools/selector-specificity/-/selector-specificity-5.0.0.tgz", - "integrity": "sha512-PCqQV3c4CoVm3kdPhyeZ07VmBRdH2EpMFA/pd9OASpOEC3aXNGoqPDAZ80D0cLpMBxnmk0+yNhGsEx31hq7Gtw==", - "dev": true, - "funding": [ - { - "type": "github", - "url": "https://github.com/sponsors/csstools" - }, - { - "type": "opencollective", - "url": "https://opencollective.com/csstools" - } - ], - "license": "MIT-0", - "engines": { - "node": ">=18" - }, - "peerDependencies": { - "postcss-selector-parser": "^7.0.0" - } - }, - "node_modules/css-has-pseudo/node_modules/postcss-selector-parser": { - "version": "7.1.1", - "resolved": "https://registry.npmjs.org/postcss-selector-parser/-/postcss-selector-parser-7.1.1.tgz", - "integrity": "sha512-orRsuYpJVw8LdAwqqLykBj9ecS5/cRHlI5+nvTo8LcCKmzDmqVORXtOIYEEQuL9D4BxtA1lm5isAqzQZCoQ6Eg==", - "dev": true, - "license": "MIT", - "peer": true, - "dependencies": { - "cssesc": "^3.0.0", - "util-deprecate": "^1.0.2" - }, - "engines": { - "node": ">=4" - } - }, - "node_modules/css-loader": { - "version": "6.11.0", - "resolved": "https://registry.npmjs.org/css-loader/-/css-loader-6.11.0.tgz", - "integrity": "sha512-CTJ+AEQJjq5NzLga5pE39qdiSV56F8ywCIsqNIRF0r7BDgWsN25aazToqAFg7ZrtA/U016xudB3ffgweORxX7g==", - "dev": true, - "license": "MIT", - "dependencies": { - "icss-utils": "^5.1.0", - "postcss": "^8.4.33", - "postcss-modules-extract-imports": "^3.1.0", - "postcss-modules-local-by-default": "^4.0.5", - "postcss-modules-scope": "^3.2.0", - "postcss-modules-values": "^4.0.0", - "postcss-value-parser": "^4.2.0", - "semver": "^7.5.4" - }, - "engines": { - "node": ">= 12.13.0" - }, - "funding": { - "type": "opencollective", - "url": "https://opencollective.com/webpack" - }, - "peerDependencies": { - "@rspack/core": "0.x || 1.x", - "webpack": "^5.0.0" - }, - "peerDependenciesMeta": { - "@rspack/core": { - "optional": true - }, - "webpack": { - "optional": true - } - } - }, - "node_modules/css-minimizer-webpack-plugin": { - "version": "5.0.1", - "resolved": "https://registry.npmjs.org/css-minimizer-webpack-plugin/-/css-minimizer-webpack-plugin-5.0.1.tgz", - "integrity": "sha512-3caImjKFQkS+ws1TGcFn0V1HyDJFq1Euy589JlD6/3rV2kj+w7r5G9WDMgSHvpvXHNZ2calVypZWuEDQd9wfLg==", - "dev": true, - "license": "MIT", - "dependencies": { - "@jridgewell/trace-mapping": "^0.3.18", - "cssnano": "^6.0.1", - "jest-worker": "^29.4.3", - "postcss": "^8.4.24", - "schema-utils": "^4.0.1", - "serialize-javascript": "^6.0.1" - }, - "engines": { - "node": ">= 14.15.0" - }, - "funding": { - "type": "opencollective", - "url": "https://opencollective.com/webpack" - }, - "peerDependencies": { - "webpack": "^5.0.0" - }, - "peerDependenciesMeta": { - "@parcel/css": { - "optional": true - }, - "@swc/css": { - "optional": true - }, - "clean-css": { - "optional": true - }, - "csso": { - "optional": true - }, - "esbuild": { - "optional": true - }, - "lightningcss": { - "optional": true - } - } - }, - "node_modules/css-minimizer-webpack-plugin/node_modules/@jest/schemas": { - "version": "29.6.3", - "resolved": "https://registry.npmjs.org/@jest/schemas/-/schemas-29.6.3.tgz", - "integrity": "sha512-mo5j5X+jIZmJQveBKeS/clAueipV7KgiX1vMgCxam1RNYiqE1w62n0/tJJnHtjW8ZHcQco5gY85jA3mi0L+nSA==", - "dev": true, - "license": "MIT", - "dependencies": { - "@sinclair/typebox": "^0.27.8" - }, - "engines": { - "node": "^14.15.0 || ^16.10.0 || >=18.0.0" - } - }, - "node_modules/css-minimizer-webpack-plugin/node_modules/@jest/types": { - "version": "29.6.3", - "resolved": "https://registry.npmjs.org/@jest/types/-/types-29.6.3.tgz", - "integrity": "sha512-u3UPsIilWKOM3F9CXtrG8LEJmNxwoCQC/XVj4IKYXvvpx7QIi/Kg1LI5uDmDpKlac62NUtX7eLjRh+jVZcLOzw==", - "dev": true, - "license": "MIT", - "dependencies": { - "@jest/schemas": "^29.6.3", - "@types/istanbul-lib-coverage": "^2.0.0", - "@types/istanbul-reports": "^3.0.0", - "@types/node": "*", - "@types/yargs": "^17.0.8", - "chalk": "^4.0.0" - }, - "engines": { - "node": "^14.15.0 || ^16.10.0 || >=18.0.0" - } - }, - "node_modules/css-minimizer-webpack-plugin/node_modules/@sinclair/typebox": { - "version": "0.27.8", - "resolved": "https://registry.npmjs.org/@sinclair/typebox/-/typebox-0.27.8.tgz", - "integrity": "sha512-+Fj43pSMwJs4KRrH/938Uf+uAELIgVBmQzg/q1YG10djyfA3TnrU8N8XzqCh/okZdszqBQTZf96idMfE5lnwTA==", - "dev": true, - "license": "MIT" - }, - "node_modules/css-minimizer-webpack-plugin/node_modules/ci-info": { - "version": "3.9.0", - "resolved": "https://registry.npmjs.org/ci-info/-/ci-info-3.9.0.tgz", - "integrity": "sha512-NIxF55hv4nSqQswkAeiOi1r83xy8JldOFDTWiug55KBu9Jnblncd2U6ViHmYgHf01TPZS77NJBhBMKdWj9HQMQ==", - "dev": true, - "funding": [ - { - "type": "github", - "url": "https://github.com/sponsors/sibiraj-s" - } - ], - "license": "MIT", - "engines": { - "node": ">=8" - } - }, - "node_modules/css-minimizer-webpack-plugin/node_modules/jest-util": { - "version": "29.7.0", - "resolved": "https://registry.npmjs.org/jest-util/-/jest-util-29.7.0.tgz", - "integrity": "sha512-z6EbKajIpqGKU56y5KBUgy1dt1ihhQJgWzUlZHArA/+X2ad7Cb5iF+AK1EWVL/Bo7Rz9uurpqw6SiBCefUbCGA==", - "dev": true, - "license": "MIT", - "dependencies": { - "@jest/types": "^29.6.3", - "@types/node": "*", - "chalk": "^4.0.0", - "ci-info": "^3.2.0", - "graceful-fs": "^4.2.9", - "picomatch": "^2.2.3" - }, - "engines": { - "node": "^14.15.0 || ^16.10.0 || >=18.0.0" - } - }, - "node_modules/css-minimizer-webpack-plugin/node_modules/jest-worker": { - "version": "29.7.0", - "resolved": "https://registry.npmjs.org/jest-worker/-/jest-worker-29.7.0.tgz", - "integrity": "sha512-eIz2msL/EzL9UFTFFx7jBTkeZfku0yUAyZZZmJ93H2TYEiroIx2PQjEXcwYtYl8zXCxb+PAmA2hLIt/6ZEkPHw==", - "dev": true, - "license": "MIT", - "dependencies": { - "@types/node": "*", - "jest-util": "^29.7.0", - "merge-stream": "^2.0.0", - "supports-color": "^8.0.0" - }, - "engines": { - "node": "^14.15.0 || ^16.10.0 || >=18.0.0" - } - }, - "node_modules/css-minimizer-webpack-plugin/node_modules/supports-color": { - "version": "8.1.1", - "resolved": "https://registry.npmjs.org/supports-color/-/supports-color-8.1.1.tgz", - "integrity": "sha512-MpUEN2OodtUzxvKQl72cUF7RQ5EiHsGvSsVG0ia9c5RbWGL2CI4C7EpPS8UTBIplnlzZiNuV56w+FuNxy3ty2Q==", - "dev": true, - "license": "MIT", - "dependencies": { - "has-flag": "^4.0.0" - }, - "engines": { - "node": ">=10" - }, - "funding": { - "url": "https://github.com/chalk/supports-color?sponsor=1" - } - }, - "node_modules/css-prefers-color-scheme": { - "version": "10.0.0", - "resolved": "https://registry.npmjs.org/css-prefers-color-scheme/-/css-prefers-color-scheme-10.0.0.tgz", - "integrity": "sha512-VCtXZAWivRglTZditUfB4StnsWr6YVZ2PRtuxQLKTNRdtAf8tpzaVPE9zXIF3VaSc7O70iK/j1+NXxyQCqdPjQ==", - "dev": true, - "funding": [ - { - "type": "github", - "url": "https://github.com/sponsors/csstools" - }, - { - "type": "opencollective", - "url": "https://opencollective.com/csstools" - } - ], - "license": "MIT-0", - "engines": { - "node": ">=18" - }, - "peerDependencies": { - "postcss": "^8.4" + "uncrypto": "^0.1.3" } }, "node_modules/css-select": { @@ -10376,9 +6061,9 @@ } }, "node_modules/css-selector-parser": { - "version": "3.1.3", - "resolved": "https://registry.npmjs.org/css-selector-parser/-/css-selector-parser-3.1.3.tgz", - "integrity": "sha512-gJMigczVZqYAk0hPVzx/M4Hm1D9QOtqkdQk9005TNzDIUGzo5cnHEDiKUT7jGPximL/oYb+LIitcHFQ4aKupxg==", + "version": "3.3.0", + "resolved": "https://registry.npmjs.org/css-selector-parser/-/css-selector-parser-3.3.0.tgz", + "integrity": "sha512-Y2asgMGFqJKF4fq4xHDSlFYIkeVfRsm69lQC1q9kbEsH5XtnINTMrweLkjYMeaUgiXBy/uvKeO/a1JHTNnmB2g==", "funding": [ { "type": "github", @@ -10392,13 +6077,13 @@ "license": "MIT" }, "node_modules/css-tree": { - "version": "2.3.1", - "resolved": "https://registry.npmjs.org/css-tree/-/css-tree-2.3.1.tgz", - "integrity": "sha512-6Fv1DV/TYw//QF5IzQdqsNDjx/wc8TrMBZsqjL9eW01tWb7R7k/mq+/VXfJCl7SoD5emsJop9cOByJZfs8hYIw==", + "version": "3.1.0", + "resolved": "https://registry.npmjs.org/css-tree/-/css-tree-3.1.0.tgz", + "integrity": "sha512-0eW44TGN5SQXU1mWSkKwFstI/22X2bG1nYzZTYMAWjylYURhse752YgbE4Cx46AC+bAvI+/dYTPRk1LqSUnu6w==", "dev": true, "license": "MIT", "dependencies": { - "mdn-data": "2.0.30", + "mdn-data": "2.12.2", "source-map-js": "^1.0.1" }, "engines": { @@ -10418,23 +6103,6 @@ "url": "https://github.com/sponsors/fb55" } }, - "node_modules/cssdb": { - "version": "8.5.2", - "resolved": "https://registry.npmjs.org/cssdb/-/cssdb-8.5.2.tgz", - "integrity": "sha512-Pmoj9RmD8RIoIzA2EQWO4D4RMeDts0tgAH0VXdlNdxjuBGI3a9wMOIcUwaPNmD4r2qtIa06gqkIf7sECl+cBCg==", - "dev": true, - "funding": [ - { - "type": "opencollective", - "url": "https://opencollective.com/csstools" - }, - { - "type": "github", - "url": "https://github.com/sponsors/csstools" - } - ], - "license": "MIT-0" - }, "node_modules/cssesc": { "version": "3.0.0", "resolved": "https://registry.npmjs.org/cssesc/-/cssesc-3.0.0.tgz", @@ -10448,107 +6116,6 @@ "node": ">=4" } }, - "node_modules/cssnano": { - "version": "6.1.2", - "resolved": "https://registry.npmjs.org/cssnano/-/cssnano-6.1.2.tgz", - "integrity": "sha512-rYk5UeX7VAM/u0lNqewCdasdtPK81CgX8wJFLEIXHbV2oldWRgJAsZrdhRXkV1NJzA2g850KiFm9mMU2HxNxMA==", - "dev": true, - "license": "MIT", - "dependencies": { - "cssnano-preset-default": "^6.1.2", - "lilconfig": "^3.1.1" - }, - "engines": { - "node": "^14 || ^16 || >=18.0" - }, - "funding": { - "type": "opencollective", - "url": "https://opencollective.com/cssnano" - }, - "peerDependencies": { - "postcss": "^8.4.31" - } - }, - "node_modules/cssnano-preset-advanced": { - "version": "6.1.2", - "resolved": "https://registry.npmjs.org/cssnano-preset-advanced/-/cssnano-preset-advanced-6.1.2.tgz", - "integrity": "sha512-Nhao7eD8ph2DoHolEzQs5CfRpiEP0xa1HBdnFZ82kvqdmbwVBUr2r1QuQ4t1pi+D1ZpqpcO4T+wy/7RxzJ/WPQ==", - "dev": true, - "license": "MIT", - "dependencies": { - "autoprefixer": "^10.4.19", - "browserslist": "^4.23.0", - "cssnano-preset-default": "^6.1.2", - "postcss-discard-unused": "^6.0.5", - "postcss-merge-idents": "^6.0.3", - "postcss-reduce-idents": "^6.0.3", - "postcss-zindex": "^6.0.2" - }, - "engines": { - "node": "^14 || ^16 || >=18.0" - }, - "peerDependencies": { - "postcss": "^8.4.31" - } - }, - "node_modules/cssnano-preset-default": { - "version": "6.1.2", - "resolved": "https://registry.npmjs.org/cssnano-preset-default/-/cssnano-preset-default-6.1.2.tgz", - "integrity": "sha512-1C0C+eNaeN8OcHQa193aRgYexyJtU8XwbdieEjClw+J9d94E41LwT6ivKH0WT+fYwYWB0Zp3I3IZ7tI/BbUbrg==", - "dev": true, - "license": "MIT", - "dependencies": { - "browserslist": "^4.23.0", - "css-declaration-sorter": "^7.2.0", - "cssnano-utils": "^4.0.2", - "postcss-calc": "^9.0.1", - "postcss-colormin": "^6.1.0", - "postcss-convert-values": "^6.1.0", - "postcss-discard-comments": "^6.0.2", - "postcss-discard-duplicates": "^6.0.3", - "postcss-discard-empty": "^6.0.3", - "postcss-discard-overridden": "^6.0.2", - "postcss-merge-longhand": "^6.0.5", - "postcss-merge-rules": "^6.1.1", - "postcss-minify-font-values": "^6.1.0", - "postcss-minify-gradients": "^6.0.3", - "postcss-minify-params": "^6.1.0", - "postcss-minify-selectors": "^6.0.4", - "postcss-normalize-charset": "^6.0.2", - "postcss-normalize-display-values": "^6.0.2", - "postcss-normalize-positions": "^6.0.2", - "postcss-normalize-repeat-style": "^6.0.2", - "postcss-normalize-string": "^6.0.2", - "postcss-normalize-timing-functions": "^6.0.2", - "postcss-normalize-unicode": "^6.1.0", - "postcss-normalize-url": "^6.0.2", - "postcss-normalize-whitespace": "^6.0.2", - "postcss-ordered-values": "^6.0.2", - "postcss-reduce-initial": "^6.1.0", - "postcss-reduce-transforms": "^6.0.2", - "postcss-svgo": "^6.0.3", - "postcss-unique-selectors": "^6.0.4" - }, - "engines": { - "node": "^14 || ^16 || >=18.0" - }, - "peerDependencies": { - "postcss": "^8.4.31" - } - }, - "node_modules/cssnano-utils": { - "version": "4.0.2", - "resolved": "https://registry.npmjs.org/cssnano-utils/-/cssnano-utils-4.0.2.tgz", - "integrity": "sha512-ZR1jHg+wZ8o4c3zqf1SIUSTIvm/9mU343FMR6Obe/unskbvpGhZOo1J6d/r8D1pzkRQYuwbcH3hToOuoA2G7oQ==", - "dev": true, - "license": "MIT", - "engines": { - "node": "^14 || ^16 || >=18.0" - }, - "peerDependencies": { - "postcss": "^8.4.31" - } - }, "node_modules/csso": { "version": "5.0.5", "resolved": "https://registry.npmjs.org/csso/-/csso-5.0.5.tgz", @@ -10585,30 +6152,16 @@ "dev": true, "license": "CC0-1.0" }, - "node_modules/csstype": { - "version": "3.2.3", - "resolved": "https://registry.npmjs.org/csstype/-/csstype-3.2.3.tgz", - "integrity": "sha512-z1HGKcYy2xA8AGQfwrn0PAy+PB7X/GSj3UVJW9qKyn43xWa+gl5nXmU4qqLMRzWVLFC8KusUX8T/0kCiOYpAIQ==", - "dev": true, - "license": "MIT" - }, "node_modules/csv-parse": { "version": "6.1.0", "resolved": "https://registry.npmjs.org/csv-parse/-/csv-parse-6.1.0.tgz", "integrity": "sha512-CEE+jwpgLn+MmtCpVcPtiCZpVtB6Z2OKPTr34pycYYoL7sxdOkXDdQ4lRiw6ioC0q6BLqhc6cKweCVvral8yhw==", "license": "MIT" }, - "node_modules/debounce": { - "version": "1.2.1", - "resolved": "https://registry.npmjs.org/debounce/-/debounce-1.2.1.tgz", - "integrity": "sha512-XRRe6Glud4rd/ZGQfiV1ruXSfbvfJedlV9Y6zOlP+2K04vBYiJEte6stfFkCP03aMnY5tsipamumUjL14fofug==", - "dev": true, - "license": "MIT" - }, "node_modules/debug": { - "version": "4.4.1", - "resolved": "https://registry.npmjs.org/debug/-/debug-4.4.1.tgz", - "integrity": "sha512-KcKCqiftBJcZr++7ykoDIEwSa3XWowTfNPo92BYxjXiyYEVrUQh2aLyhxBCwww+heortUFxEJYcRzosstTEBYQ==", + "version": "4.4.3", + "resolved": "https://registry.npmjs.org/debug/-/debug-4.4.3.tgz", + "integrity": "sha512-RGwwWnwQvkVfavKVt22FGLw+xYSdzARwm0ru6DhTVA3umU5hZc28V3kO4stgYryrTlLpuvgI9GiijltAjNbcqA==", "license": "MIT", "dependencies": { "ms": "^2.1.3" @@ -10635,39 +6188,10 @@ "url": "https://github.com/sponsors/wooorm" } }, - "node_modules/decompress-response": { - "version": "6.0.0", - "resolved": "https://registry.npmjs.org/decompress-response/-/decompress-response-6.0.0.tgz", - "integrity": "sha512-aW35yZM6Bb/4oJlZncMH2LCoZtJXTRxES17vE3hoRiowU2kWHaJKFkSBDnDR+cm9J+9QhXmREyIfv0pji9ejCQ==", - "dev": true, - "license": "MIT", - "dependencies": { - "mimic-response": "^3.1.0" - }, - "engines": { - "node": ">=10" - }, - "funding": { - "url": "https://github.com/sponsors/sindresorhus" - } - }, - "node_modules/decompress-response/node_modules/mimic-response": { - "version": "3.1.0", - "resolved": "https://registry.npmjs.org/mimic-response/-/mimic-response-3.1.0.tgz", - "integrity": "sha512-z0yWI+4FDrrweS8Zmt4Ej5HdJmky15+L2e6Wgn3+iK5fWzb6T3fhNFq2+MeTRb064c6Wr4N/wv0DzQTjNzHNGQ==", - "dev": true, - "license": "MIT", - "engines": { - "node": ">=10" - }, - "funding": { - "url": "https://github.com/sponsors/sindresorhus" - } - }, "node_modules/dedent": { - "version": "1.6.0", - "resolved": "https://registry.npmjs.org/dedent/-/dedent-1.6.0.tgz", - "integrity": "sha512-F1Z+5UCFpmQUzJa11agbyPVMbpgT/qA3/SKyJ1jyBgm7dUcUEa8v9JwDkerSQXfakBwFljIxhOJqGkjUwZ9FSA==", + "version": "1.7.1", + "resolved": "https://registry.npmjs.org/dedent/-/dedent-1.7.1.tgz", + "integrity": "sha512-9JmrhGZpOlEgOLdQgSm0zxFaYoQon408V1v49aqTWuXENVlnCuY9JBZcXZiCsZQWDjTm5Qf/nIvAy77mXDAjEg==", "dev": true, "license": "MIT", "peerDependencies": { @@ -10679,16 +6203,6 @@ } } }, - "node_modules/deep-extend": { - "version": "0.6.0", - "resolved": "https://registry.npmjs.org/deep-extend/-/deep-extend-0.6.0.tgz", - "integrity": "sha512-LOHxIOaPYdHlJRtCQfDIVZtfw/ufM8+rVj649RIHzcm/vGwQRXFt6OPqIFWsm2XEMrNIEtWR64sY1LEKD2vAOA==", - "dev": true, - "license": "MIT", - "engines": { - "node": ">=4.0.0" - } - }, "node_modules/deep-is": { "version": "0.1.4", "resolved": "https://registry.npmjs.org/deep-is/-/deep-is-0.1.4.tgz", @@ -10706,36 +6220,6 @@ "node": ">=0.10.0" } }, - "node_modules/default-browser": { - "version": "5.4.0", - "resolved": "https://registry.npmjs.org/default-browser/-/default-browser-5.4.0.tgz", - "integrity": "sha512-XDuvSq38Hr1MdN47EDvYtx3U0MTqpCEn+F6ft8z2vYDzMrvQhVp0ui9oQdqW3MvK3vqUETglt1tVGgjLuJ5izg==", - "dev": true, - "license": "MIT", - "dependencies": { - "bundle-name": "^4.1.0", - "default-browser-id": "^5.0.0" - }, - "engines": { - "node": ">=18" - }, - "funding": { - "url": "https://github.com/sponsors/sindresorhus" - } - }, - "node_modules/default-browser-id": { - "version": "5.0.1", - "resolved": "https://registry.npmjs.org/default-browser-id/-/default-browser-id-5.0.1.tgz", - "integrity": "sha512-x1VCxdX4t+8wVfd1so/9w+vQ4vx7lKd2Qp5tDRutErwmR85OgmfX7RlLRMWafRMY7hbEiXIbudNrjOAPa/hL8Q==", - "dev": true, - "license": "MIT", - "engines": { - "node": ">=18" - }, - "funding": { - "url": "https://github.com/sponsors/sindresorhus" - } - }, "node_modules/defaults": { "version": "1.0.4", "resolved": "https://registry.npmjs.org/defaults/-/defaults-1.0.4.tgz", @@ -10748,71 +6232,21 @@ "url": "https://github.com/sponsors/sindresorhus" } }, - "node_modules/defer-to-connect": { - "version": "2.0.1", - "resolved": "https://registry.npmjs.org/defer-to-connect/-/defer-to-connect-2.0.1.tgz", - "integrity": "sha512-4tvttepXG1VaYGrRibk5EwJd1t4udunSOVMdLSAL6mId1ix438oPwPZMALY41FCijukO1L0twNcGsdzS7dHgDg==", - "dev": true, + "node_modules/defaults/node_modules/clone": { + "version": "1.0.4", + "resolved": "https://registry.npmjs.org/clone/-/clone-1.0.4.tgz", + "integrity": "sha512-JQHZ2QMW6l3aH/j6xCqQThY/9OH4D/9ls34cgkUBiEeocRTU04tHfKPBsUK1PqZCUQM7GiA0IIXJSuXHI64Kbg==", "license": "MIT", "engines": { - "node": ">=10" + "node": ">=0.8" } }, - "node_modules/define-data-property": { - "version": "1.1.4", - "resolved": "https://registry.npmjs.org/define-data-property/-/define-data-property-1.1.4.tgz", - "integrity": "sha512-rBMvIzlpA8v6E+SJZoo++HAYqsLrkg7MSfIinMPFhmkorw7X+dOXVJQs+QT69zGkzMyfDnIMN2Wid1+NbL3T+A==", + "node_modules/defu": { + "version": "6.1.4", + "resolved": "https://registry.npmjs.org/defu/-/defu-6.1.4.tgz", + "integrity": "sha512-mEQCMmwJu317oSz8CwdIOdwf3xMif1ttiM8LTufzc3g6kR+9Pe236twL8j3IYT1F7GfRgGcW6MWxzZjLIkuHIg==", "dev": true, - "license": "MIT", - "dependencies": { - "es-define-property": "^1.0.0", - "es-errors": "^1.3.0", - "gopd": "^1.0.1" - }, - "engines": { - "node": ">= 0.4" - }, - "funding": { - "url": "https://github.com/sponsors/ljharb" - } - }, - "node_modules/define-lazy-prop": { - "version": "2.0.0", - "resolved": "https://registry.npmjs.org/define-lazy-prop/-/define-lazy-prop-2.0.0.tgz", - "integrity": "sha512-Ds09qNh8yw3khSjiJjiUInaGX9xlqZDY7JVryGxdxV7NPeuqQfplOpQ66yJFZut3jLa5zOwkXw1g9EI2uKh4Og==", - "dev": true, - "license": "MIT", - "engines": { - "node": ">=8" - } - }, - "node_modules/define-properties": { - "version": "1.2.1", - "resolved": "https://registry.npmjs.org/define-properties/-/define-properties-1.2.1.tgz", - "integrity": "sha512-8QmQKqEASLd5nx0U1B1okLElbUuuttJ/AnYmRXbbbGDWh6uS208EjD4Xqq/I9wK7u0v6O08XhTWnt5XtEbR6Dg==", - "dev": true, - "license": "MIT", - "dependencies": { - "define-data-property": "^1.0.1", - "has-property-descriptors": "^1.0.0", - "object-keys": "^1.1.1" - }, - "engines": { - "node": ">= 0.4" - }, - "funding": { - "url": "https://github.com/sponsors/ljharb" - } - }, - "node_modules/depd": { - "version": "2.0.0", - "resolved": "https://registry.npmjs.org/depd/-/depd-2.0.0.tgz", - "integrity": "sha512-g7nH6P6dyDioJogAAGprGpCtVImJhpPk/roCzdb3fIh61/s/nPsfR6onyMwkCAR/OlC3yBC0lESvUoQEAssIrw==", - "dev": true, - "license": "MIT", - "engines": { - "node": ">= 0.8" - } + "license": "MIT" }, "node_modules/dequal": { "version": "2.0.3", @@ -10823,25 +6257,34 @@ "node": ">=6" } }, - "node_modules/destroy": { - "version": "1.2.0", - "resolved": "https://registry.npmjs.org/destroy/-/destroy-1.2.0.tgz", - "integrity": "sha512-2sJGJTaXIIaR1w4iJSNoN0hnMY7Gpc/n8D4qSCJw8QqFWXf7cuAgnEHxBpweaVcPevC2l3KpjYCx3NypQQgaJg==", + "node_modules/destr": { + "version": "2.0.5", + "resolved": "https://registry.npmjs.org/destr/-/destr-2.0.5.tgz", + "integrity": "sha512-ugFTXCtDZunbzasqBxrK93Ik/DRYsO6S/fedkWEMKqt04xZ4csmnmwGDBAb07QWNaGMAmnTIemsYZCksjATwsA==", "dev": true, - "license": "MIT", - "engines": { - "node": ">= 0.8", - "npm": "1.2.8000 || >= 1.4.16" - } + "license": "MIT" }, "node_modules/detect-indent": { - "version": "7.0.1", - "resolved": "https://registry.npmjs.org/detect-indent/-/detect-indent-7.0.1.tgz", - "integrity": "sha512-Mc7QhQ8s+cLrnUfU/Ji94vG/r8M26m8f++vyres4ZoojaRDpZ1eSIh/EpzLNwlWuvzSZ3UbDFspjFvTDXe6e/g==", + "version": "7.0.2", + "resolved": "https://registry.npmjs.org/detect-indent/-/detect-indent-7.0.2.tgz", + "integrity": "sha512-y+8xyqdGLL+6sh0tVeHcfP/QDd8gUgbasolJJpY7NgeQGSZ739bDtSiaiDgtoicy+mtYB81dKLxO9xRhCyIB3A==", "dev": true, "license": "MIT", "engines": { "node": ">=12.20" + }, + "funding": { + "url": "https://github.com/sponsors/sindresorhus" + } + }, + "node_modules/detect-libc": { + "version": "2.1.2", + "resolved": "https://registry.npmjs.org/detect-libc/-/detect-libc-2.1.2.tgz", + "integrity": "sha512-Btj2BOOO83o3WyH59e8MgXsxEQVcarkUOpEYrubB0urwnN10yQ364rsiByU11nZlqWYZm05i/of7io4mzihBtQ==", + "dev": true, + "license": "Apache-2.0", + "engines": { + "node": ">=8" } }, "node_modules/detect-newline": { @@ -10854,31 +6297,26 @@ "node": ">=8" } }, - "node_modules/detect-node": { - "version": "2.1.0", - "resolved": "https://registry.npmjs.org/detect-node/-/detect-node-2.1.0.tgz", - "integrity": "sha512-T0NIuQpnTvFDATNuHN5roPwSBG83rFsuO+MXXH9/3N1eFbn4wcPjttvjMLEPWJ0RGUYgQE7cGgS3tNxbqCGM7g==", - "dev": true, - "license": "MIT" - }, - "node_modules/detect-port": { - "version": "1.6.1", - "resolved": "https://registry.npmjs.org/detect-port/-/detect-port-1.6.1.tgz", - "integrity": "sha512-CmnVc+Hek2egPx1PeTFVta2W78xy2K/9Rkf6cC4T59S50tVnzKj+tnx5mmx5lwvCkujZ4uRrpRSuV+IVs3f90Q==", + "node_modules/deterministic-object-hash": { + "version": "2.0.2", + "resolved": "https://registry.npmjs.org/deterministic-object-hash/-/deterministic-object-hash-2.0.2.tgz", + "integrity": "sha512-KxektNH63SrbfUyDiwXqRb1rLwKt33AmMv+5Nhsw1kqZ13SJBRTgZHtGbE+hH3a1mVW1cz+4pqSWVPAtLVXTzQ==", "dev": true, "license": "MIT", "dependencies": { - "address": "^1.0.1", - "debug": "4" - }, - "bin": { - "detect": "bin/detect-port.js", - "detect-port": "bin/detect-port.js" + "base-64": "^1.0.0" }, "engines": { - "node": ">= 4.0.0" + "node": ">=18" } }, + "node_modules/devalue": { + "version": "5.6.1", + "resolved": "https://registry.npmjs.org/devalue/-/devalue-5.6.1.tgz", + "integrity": "sha512-jDwizj+IlEZBunHcOuuFVBnIMPAEHvTsJj0BcIp94xYguLRVBcXO853px/MyIJvbVzWdsGvrRweIUWJw8hBP7A==", + "dev": true, + "license": "MIT" + }, "node_modules/devlop": { "version": "1.1.0", "resolved": "https://registry.npmjs.org/devlop/-/devlop-1.1.0.tgz", @@ -10892,6 +6330,33 @@ "url": "https://github.com/sponsors/wooorm" } }, + "node_modules/dfa": { + "version": "1.2.0", + "resolved": "https://registry.npmjs.org/dfa/-/dfa-1.2.0.tgz", + "integrity": "sha512-ED3jP8saaweFTjeGX8HQPjeC1YYyZs98jGNZx6IiBvxW7JG5v492kamAQB3m2wop07CvU/RQmzcKr6bgcC5D/Q==", + "dev": true, + "license": "MIT" + }, + "node_modules/diff": { + "version": "5.2.0", + "resolved": "https://registry.npmjs.org/diff/-/diff-5.2.0.tgz", + "integrity": "sha512-uIFDxqpRZGZ6ThOk84hEfqWoHx2devRFvpTZcTHur85vImfaxUbTW9Ryh4CpCuDnToOP1CEtXKIgytHBPVff5A==", + "dev": true, + "license": "BSD-3-Clause", + "engines": { + "node": ">=0.3.1" + } + }, + "node_modules/diff-sequences": { + "version": "27.5.1", + "resolved": "https://registry.npmjs.org/diff-sequences/-/diff-sequences-27.5.1.tgz", + "integrity": "sha512-k1gCAXAsNgLwEL+Y8Wvl+M6oEFj5bgazfZULpS5CneoPPXRaCCW7dm+q21Ky2VEE5X+VeRDBVg1Pcvvsr4TtNQ==", + "dev": true, + "license": "MIT", + "engines": { + "node": "^10.13.0 || ^12.13.0 || ^14.15.0 || >=15.0.0" + } + }, "node_modules/dir-glob": { "version": "3.0.1", "resolved": "https://registry.npmjs.org/dir-glob/-/dir-glob-3.0.1.tgz", @@ -10905,29 +6370,37 @@ "node": ">=8" } }, - "node_modules/dns-packet": { - "version": "5.6.1", - "resolved": "https://registry.npmjs.org/dns-packet/-/dns-packet-5.6.1.tgz", - "integrity": "sha512-l4gcSouhcgIKRvyy99RNVOgxXiicE+2jZoNmaNmZ6JXiGajBOJAesk1OBlJuM5k2c+eudGdLxDqXuPCKIj6kpw==", + "node_modules/dir-glob/node_modules/path-type": { + "version": "4.0.0", + "resolved": "https://registry.npmjs.org/path-type/-/path-type-4.0.0.tgz", + "integrity": "sha512-gDKb8aZMDeD/tZWs9P6+q0J9Mwkdl6xMV8TjnGP3qJVJ06bdMgkbBlLU8IdfOsIsFz2BW1rNVT3XuNEl8zPAvw==", "dev": true, "license": "MIT", - "dependencies": { - "@leichtgewicht/ip-codec": "^2.0.1" - }, "engines": { - "node": ">=6" + "node": ">=8" } }, - "node_modules/dom-converter": { - "version": "0.2.0", - "resolved": "https://registry.npmjs.org/dom-converter/-/dom-converter-0.2.0.tgz", - "integrity": "sha512-gd3ypIPfOMr9h5jIKq8E3sHOTCjeirnl0WK5ZdS1AW0Odt0b1PaWaHdJ4Qk4klv+YB9aJBS7mESXjFoDQPu6DA==", + "node_modules/direction": { + "version": "2.0.1", + "resolved": "https://registry.npmjs.org/direction/-/direction-2.0.1.tgz", + "integrity": "sha512-9S6m9Sukh1cZNknO1CWAr2QAWsbKLafQiyM5gZ7VgXHeuaoUwffKN4q6NC4A/Mf9iiPlOXQEKW/Mv/mh9/3YFA==", "dev": true, "license": "MIT", - "dependencies": { - "utila": "~0.4" + "bin": { + "direction": "cli.js" + }, + "funding": { + "type": "github", + "url": "https://github.com/sponsors/wooorm" } }, + "node_modules/dlv": { + "version": "1.1.3", + "resolved": "https://registry.npmjs.org/dlv/-/dlv-1.1.3.tgz", + "integrity": "sha512-+HlytyjlPKnIG8XuRG8WvmBP8xs8P71y+SKKS6ZXWoEgLuePxtDoUEiH7WkdePWrQ5JBpE6aoVqfZfJUQkjXwA==", + "dev": true, + "license": "MIT" + }, "node_modules/dom-serializer": { "version": "2.0.0", "resolved": "https://registry.npmjs.org/dom-serializer/-/dom-serializer-2.0.0.tgz", @@ -10987,78 +6460,22 @@ "url": "https://github.com/fb55/domutils?sponsor=1" } }, - "node_modules/dot-case": { - "version": "3.0.4", - "resolved": "https://registry.npmjs.org/dot-case/-/dot-case-3.0.4.tgz", - "integrity": "sha512-Kv5nKlh6yRrdrGvxeJ2e5y2eRUpkUosIW4A2AS38zwSz27zu7ufDwQPi5Jhs3XAlGNetl3bmnGhQsMtkKJnj3w==", - "dev": true, - "license": "MIT", - "dependencies": { - "no-case": "^3.0.4", - "tslib": "^2.0.3" - } - }, - "node_modules/dot-prop": { - "version": "6.0.1", - "resolved": "https://registry.npmjs.org/dot-prop/-/dot-prop-6.0.1.tgz", - "integrity": "sha512-tE7ztYzXHIeyvc7N+hR3oi7FIbf/NIjVP9hmAt3yMXzrQ072/fpjGLx2GxNxGxUl5V73MEqYzioOMoVhGMJ5cA==", - "dev": true, - "license": "MIT", - "dependencies": { - "is-obj": "^2.0.0" - }, - "engines": { - "node": ">=10" - }, - "funding": { - "url": "https://github.com/sponsors/sindresorhus" - } - }, - "node_modules/dot-prop/node_modules/is-obj": { - "version": "2.0.0", - "resolved": "https://registry.npmjs.org/is-obj/-/is-obj-2.0.0.tgz", - "integrity": "sha512-drqDG3cbczxxEJRoOXcOjtdp1J/lyp1mNn0xaznRs8+muBhgQcrnbspox5X5fOw0HnMnbfDzvnEMEtqDEJEo8w==", + "node_modules/dset": { + "version": "3.1.4", + "resolved": "https://registry.npmjs.org/dset/-/dset-3.1.4.tgz", + "integrity": "sha512-2QF/g9/zTaPDc3BjNcVTGoBbXBgYfMTTceLaYcFJ/W9kggFUkhxD/hMEeuLKbugyef9SqAx8cpgwlIP/jinUTA==", "dev": true, "license": "MIT", "engines": { - "node": ">=8" + "node": ">=4" } }, - "node_modules/dunder-proto": { - "version": "1.0.1", - "resolved": "https://registry.npmjs.org/dunder-proto/-/dunder-proto-1.0.1.tgz", - "integrity": "sha512-KIN/nDJBQRcXw0MLVhZE9iQHmG68qAVIBg9CqmUYjmQIhgij9U5MFvrqkUL5FbtyyzZuOeOt0zdeRe4UY7ct+A==", - "dev": true, - "license": "MIT", - "dependencies": { - "call-bind-apply-helpers": "^1.0.1", - "es-errors": "^1.3.0", - "gopd": "^1.2.0" - }, - "engines": { - "node": ">= 0.4" - } - }, - "node_modules/duplexer": { - "version": "0.1.2", - "resolved": "https://registry.npmjs.org/duplexer/-/duplexer-0.1.2.tgz", - "integrity": "sha512-jtD6YG370ZCIi/9GTaJKQxWTZD045+4R4hTk/x1UyoqadyJ9x9CgSi1RlVDQF8U2sxLLSnFkCaMihqljHIWgMg==", - "dev": true, - "license": "MIT" - }, "node_modules/eastasianwidth": { "version": "0.2.0", "resolved": "https://registry.npmjs.org/eastasianwidth/-/eastasianwidth-0.2.0.tgz", "integrity": "sha512-I88TYZWc9XiYHRQ4/3c5rjjfgkjhLyW2luGIheGERbNQ6OY7yTybanSpDXZa8y7VUP9YmDcYa+eyq4ca7iLqWA==", "license": "MIT" }, - "node_modules/ee-first": { - "version": "1.1.1", - "resolved": "https://registry.npmjs.org/ee-first/-/ee-first-1.1.1.tgz", - "integrity": "sha512-WMwm9LhRUo+WUaRN+vRuETqG89IgZphVSNkdFgeb6sS/E4OrDIN7t48CAewSHXc6C8lefD8KKfr5vY61brQlow==", - "dev": true, - "license": "MIT" - }, "node_modules/electron-to-chromium": { "version": "1.5.267", "resolved": "https://registry.npmjs.org/electron-to-chromium/-/electron-to-chromium-1.5.267.tgz", @@ -11085,48 +6502,10 @@ "integrity": "sha512-MSjYzcWNOA0ewAHpz0MxpYFvwg6yjy1NG3xteoqz644VCo/RPgnr1/GGt+ic3iJTzQ8Eu3TdM14SawnVUmGE6A==", "license": "MIT" }, - "node_modules/emojilib": { - "version": "2.4.0", - "resolved": "https://registry.npmjs.org/emojilib/-/emojilib-2.4.0.tgz", - "integrity": "sha512-5U0rVMU5Y2n2+ykNLQqMoqklN9ICBT/KsvC1Gz6vqHbz2AXXGkG+Pm5rMWk/8Vjrr/mY9985Hi8DYzn1F09Nyw==", - "dev": true, - "license": "MIT" - }, - "node_modules/emojis-list": { - "version": "3.0.0", - "resolved": "https://registry.npmjs.org/emojis-list/-/emojis-list-3.0.0.tgz", - "integrity": "sha512-/kyM18EfinwXZbno9FyUGeFh87KC8HRQBQGildHZbEuRyWFOmv1U10o9BBp8XVZDVNNuQKyIGIu5ZYAAXJ0V2Q==", - "dev": true, - "license": "MIT", - "engines": { - "node": ">= 4" - } - }, - "node_modules/emoticon": { - "version": "4.1.0", - "resolved": "https://registry.npmjs.org/emoticon/-/emoticon-4.1.0.tgz", - "integrity": "sha512-VWZfnxqwNcc51hIy/sbOdEem6D+cVtpPzEEtVAFdaas30+1dgkyaOQ4sQ6Bp0tOMqWO1v+HQfYaoodOkdhK6SQ==", - "dev": true, - "license": "MIT", - "funding": { - "type": "github", - "url": "https://github.com/sponsors/wooorm" - } - }, - "node_modules/encodeurl": { - "version": "2.0.0", - "resolved": "https://registry.npmjs.org/encodeurl/-/encodeurl-2.0.0.tgz", - "integrity": "sha512-Q0n9HRi4m6JuGIV1eFlmvJB7ZEVxu93IrMyiMsGC0lrMJMWzRgx6WGquyfQgZVb31vhGgXnfmPNNXmxnOkRBrg==", - "dev": true, - "license": "MIT", - "engines": { - "node": ">= 0.8" - } - }, "node_modules/enhanced-resolve": { - "version": "5.18.3", - "resolved": "https://registry.npmjs.org/enhanced-resolve/-/enhanced-resolve-5.18.3.tgz", - "integrity": "sha512-d4lC8xfavMeBjzGr2vECC3fsGXziXZQyJxD868h2M/mBI3PwAuODxAkLkq5HYuvrPYcUtiLzsTo8U3PgX3Ocww==", + "version": "5.18.4", + "resolved": "https://registry.npmjs.org/enhanced-resolve/-/enhanced-resolve-5.18.4.tgz", + "integrity": "sha512-LgQMM4WXU3QI+SYgEc2liRgznaD5ojbmY3sb8LxyguVkIg5FxdpTkvk72te2R38/TGKxH634oLxXRGY6d7AP+Q==", "dev": true, "license": "MIT", "dependencies": { @@ -11164,55 +6543,22 @@ } }, "node_modules/error-ex": { - "version": "1.3.2", - "resolved": "https://registry.npmjs.org/error-ex/-/error-ex-1.3.2.tgz", - "integrity": "sha512-7dFHNmqeFSEt2ZBsCriorKnn3Z2pj+fd9kmI6QoWw4//DL+icEBfc0U7qJCisqrTsKTjw4fNFy2pW9OqStD84g==", + "version": "1.3.4", + "resolved": "https://registry.npmjs.org/error-ex/-/error-ex-1.3.4.tgz", + "integrity": "sha512-sqQamAnR14VgCr1A618A3sGrygcpK+HEbenA/HiEAkkUwcZIIB/tgWqHFxWgOyDh4nB4JCRimh79dR5Ywc9MDQ==", "dev": true, "license": "MIT", "dependencies": { "is-arrayish": "^0.2.1" } }, - "node_modules/es-define-property": { - "version": "1.0.1", - "resolved": "https://registry.npmjs.org/es-define-property/-/es-define-property-1.0.1.tgz", - "integrity": "sha512-e3nRfgfUZ4rNGL232gUgX06QNyyez04KdjFrF+LTRoOXmrOgFKDg4BCdsjW8EnT69eqdYGmRpJwiPVYNrCaW3g==", - "dev": true, - "license": "MIT", - "engines": { - "node": ">= 0.4" - } - }, - "node_modules/es-errors": { - "version": "1.3.0", - "resolved": "https://registry.npmjs.org/es-errors/-/es-errors-1.3.0.tgz", - "integrity": "sha512-Zf5H2Kxt2xjTvbJvP2ZWLEICxA6j+hAmMzIlypy4xcBg1vKVnx89Wy0GbS+kf5cwCVFFzdCFh2XSCFNULS6csw==", - "dev": true, - "license": "MIT", - "engines": { - "node": ">= 0.4" - } - }, "node_modules/es-module-lexer": { - "version": "2.0.0", - "resolved": "https://registry.npmjs.org/es-module-lexer/-/es-module-lexer-2.0.0.tgz", - "integrity": "sha512-5POEcUuZybH7IdmGsD8wlf0AI55wMecM9rVBTI/qEAy2c1kTOm3DjFYjrBdI2K3BaJjJYfYFeRtM0t9ssnRuxw==", + "version": "1.7.0", + "resolved": "https://registry.npmjs.org/es-module-lexer/-/es-module-lexer-1.7.0.tgz", + "integrity": "sha512-jEQoCwk8hyb2AZziIOLhDqpm5+2ww5uIE6lkO/6jcOCusfk6LhMHpXXfBLXTZ7Ydyt0j4VoUQv6uGNYbdW+kBA==", "dev": true, "license": "MIT" }, - "node_modules/es-object-atoms": { - "version": "1.1.1", - "resolved": "https://registry.npmjs.org/es-object-atoms/-/es-object-atoms-1.1.1.tgz", - "integrity": "sha512-FGgH2h8zKNim9ljj7dankFPcICIK9Cp5bm+c2gQSYePhpaG5+esrLODihIorn+Pe6FGJzWhXQotPv73jTaldXA==", - "dev": true, - "license": "MIT", - "dependencies": { - "es-errors": "^1.3.0" - }, - "engines": { - "node": ">= 0.4" - } - }, "node_modules/esast-util-from-estree": { "version": "2.0.0", "resolved": "https://registry.npmjs.org/esast-util-from-estree/-/esast-util-from-estree-2.0.0.tgz", @@ -11247,6 +6593,48 @@ "url": "https://opencollective.com/unified" } }, + "node_modules/esbuild": { + "version": "0.25.12", + "resolved": "https://registry.npmjs.org/esbuild/-/esbuild-0.25.12.tgz", + "integrity": "sha512-bbPBYYrtZbkt6Os6FiTLCTFxvq4tt3JKall1vRwshA3fdVztsLAatFaZobhkBC8/BrPetoa0oksYoKXoG4ryJg==", + "dev": true, + "hasInstallScript": true, + "license": "MIT", + "bin": { + "esbuild": "bin/esbuild" + }, + "engines": { + "node": ">=18" + }, + "optionalDependencies": { + "@esbuild/aix-ppc64": "0.25.12", + "@esbuild/android-arm": "0.25.12", + "@esbuild/android-arm64": "0.25.12", + "@esbuild/android-x64": "0.25.12", + "@esbuild/darwin-arm64": "0.25.12", + "@esbuild/darwin-x64": "0.25.12", + "@esbuild/freebsd-arm64": "0.25.12", + "@esbuild/freebsd-x64": "0.25.12", + "@esbuild/linux-arm": "0.25.12", + "@esbuild/linux-arm64": "0.25.12", + "@esbuild/linux-ia32": "0.25.12", + "@esbuild/linux-loong64": "0.25.12", + "@esbuild/linux-mips64el": "0.25.12", + "@esbuild/linux-ppc64": "0.25.12", + "@esbuild/linux-riscv64": "0.25.12", + "@esbuild/linux-s390x": "0.25.12", + "@esbuild/linux-x64": "0.25.12", + "@esbuild/netbsd-arm64": "0.25.12", + "@esbuild/netbsd-x64": "0.25.12", + "@esbuild/openbsd-arm64": "0.25.12", + "@esbuild/openbsd-x64": "0.25.12", + "@esbuild/openharmony-arm64": "0.25.12", + "@esbuild/sunos-x64": "0.25.12", + "@esbuild/win32-arm64": "0.25.12", + "@esbuild/win32-ia32": "0.25.12", + "@esbuild/win32-x64": "0.25.12" + } + }, "node_modules/escalade": { "version": "3.2.0", "resolved": "https://registry.npmjs.org/escalade/-/escalade-3.2.0.tgz", @@ -11257,26 +6645,6 @@ "node": ">=6" } }, - "node_modules/escape-goat": { - "version": "4.0.0", - "resolved": "https://registry.npmjs.org/escape-goat/-/escape-goat-4.0.0.tgz", - "integrity": "sha512-2Sd4ShcWxbx6OY1IHyla/CVNwvg7XwZVoXZHcSu9w9SReNP1EzzD5T8NWKIR38fIqEns9kDWKUQTXXAmlDrdPg==", - "dev": true, - "license": "MIT", - "engines": { - "node": ">=12" - }, - "funding": { - "url": "https://github.com/sponsors/sindresorhus" - } - }, - "node_modules/escape-html": { - "version": "1.0.3", - "resolved": "https://registry.npmjs.org/escape-html/-/escape-html-1.0.3.tgz", - "integrity": "sha512-NiSupZ4OeuGwr68lGIeym/ksIZMJodUGOSCZ/FSnTxcrekbvqrgdUxlJOMpijaKZVjAJrWrGs/6Jy8OMuyj9ow==", - "dev": true, - "license": "MIT" - }, "node_modules/escape-string-regexp": { "version": "4.0.0", "resolved": "https://registry.npmjs.org/escape-string-regexp/-/escape-string-regexp-4.0.0.tgz", @@ -11291,26 +6659,24 @@ } }, "node_modules/eslint": { - "version": "9.34.0", - "resolved": "https://registry.npmjs.org/eslint/-/eslint-9.34.0.tgz", - "integrity": "sha512-RNCHRX5EwdrESy3Jc9o8ie8Bog+PeYvvSR8sDGoZxNFTvZ4dlxUB3WzQ3bQMztFrSRODGrLLj8g6OFuGY/aiQg==", + "version": "9.39.2", + "resolved": "https://registry.npmjs.org/eslint/-/eslint-9.39.2.tgz", + "integrity": "sha512-LEyamqS7W5HB3ujJyvi0HQK/dtVINZvd5mAAp9eT5S/ujByGjiZLCzPcHVzuXbpJDJF/cxwHlfceVUDZ2lnSTw==", "dev": true, "license": "MIT", - "peer": true, "dependencies": { - "@eslint-community/eslint-utils": "^4.2.0", + "@eslint-community/eslint-utils": "^4.8.0", "@eslint-community/regexpp": "^4.12.1", - "@eslint/config-array": "^0.21.0", - "@eslint/config-helpers": "^0.3.1", - "@eslint/core": "^0.15.2", + "@eslint/config-array": "^0.21.1", + "@eslint/config-helpers": "^0.4.2", + "@eslint/core": "^0.17.0", "@eslint/eslintrc": "^3.3.1", - "@eslint/js": "9.34.0", - "@eslint/plugin-kit": "^0.3.5", + "@eslint/js": "9.39.2", + "@eslint/plugin-kit": "^0.4.1", "@humanfs/node": "^0.16.6", "@humanwhocodes/module-importer": "^1.0.1", "@humanwhocodes/retry": "^0.4.2", "@types/estree": "^1.0.6", - "@types/json-schema": "^7.0.15", "ajv": "^6.12.4", "chalk": "^4.0.0", "cross-spawn": "^7.0.6", @@ -11407,9 +6773,9 @@ } }, "node_modules/eslint-plugin-n": { - "version": "17.21.3", - "resolved": "https://registry.npmjs.org/eslint-plugin-n/-/eslint-plugin-n-17.21.3.tgz", - "integrity": "sha512-MtxYjDZhMQgsWRm/4xYLL0i2EhusWT7itDxlJ80l1NND2AL2Vi5Mvneqv/ikG9+zpran0VsVRXTEHrpLmUZRNw==", + "version": "17.23.1", + "resolved": "https://registry.npmjs.org/eslint-plugin-n/-/eslint-plugin-n-17.23.1.tgz", + "integrity": "sha512-68PealUpYoHOBh332JLLD9Sj7OQUDkFpmcfqt8R9sySfFSeuGJjMTJQvCRRB96zO3A/PELRLkPrzsHmzEFQQ5A==", "dev": true, "license": "MIT", "dependencies": { @@ -11492,10 +6858,37 @@ "eslint": ">=9.29.0" } }, + "node_modules/eslint-plugin-unicorn/node_modules/@eslint/core": { + "version": "0.15.2", + "resolved": "https://registry.npmjs.org/@eslint/core/-/core-0.15.2.tgz", + "integrity": "sha512-78Md3/Rrxh83gCxoUc0EiciuOHsIITzLy53m3d9UyiW8y9Dj2D29FeETqyKA+BRK76tnTp6RXWb3pCay8Oyomg==", + "dev": true, + "license": "Apache-2.0", + "dependencies": { + "@types/json-schema": "^7.0.15" + }, + "engines": { + "node": "^18.18.0 || ^20.9.0 || >=21.1.0" + } + }, + "node_modules/eslint-plugin-unicorn/node_modules/@eslint/plugin-kit": { + "version": "0.3.5", + "resolved": "https://registry.npmjs.org/@eslint/plugin-kit/-/plugin-kit-0.3.5.tgz", + "integrity": "sha512-Z5kJ+wU3oA7MMIqVR9tyZRtjYPr4OC004Q4Rw7pgOKUOKkJfZ3O24nz3WYfGRpMDNmcOi3TwQOmgm7B7Tpii0w==", + "dev": true, + "license": "Apache-2.0", + "dependencies": { + "@eslint/core": "^0.15.2", + "levn": "^0.4.1" + }, + "engines": { + "node": "^18.18.0 || ^20.9.0 || >=21.1.0" + } + }, "node_modules/eslint-plugin-unicorn/node_modules/globals": { - "version": "16.3.0", - "resolved": "https://registry.npmjs.org/globals/-/globals-16.3.0.tgz", - "integrity": "sha512-bqWEnJ1Nt3neqx2q5SFfGS8r/ahumIakg3HcwtNlrVlwXIeNumWn/c7Pn/wKzGhf6SaW6H6uWXLqC30STCMchQ==", + "version": "16.5.0", + "resolved": "https://registry.npmjs.org/globals/-/globals-16.5.0.tgz", + "integrity": "sha512-c/c15i26VrJ4IRt5Z89DnIzCGDn9EcebibhAOjw5ibqEHsE1wLUgkPn9RDmNcUKyU87GeaL633nyJ+pplFR2ZQ==", "dev": true, "license": "MIT", "engines": { @@ -11506,13 +6899,14 @@ } }, "node_modules/eslint-plugin-yml": { - "version": "1.18.0", - "resolved": "https://registry.npmjs.org/eslint-plugin-yml/-/eslint-plugin-yml-1.18.0.tgz", - "integrity": "sha512-9NtbhHRN2NJa/s3uHchO3qVVZw0vyOIvWlXWGaKCr/6l3Go62wsvJK5byiI6ZoYztDsow4GnS69BZD3GnqH3hA==", + "version": "1.19.1", + "resolved": "https://registry.npmjs.org/eslint-plugin-yml/-/eslint-plugin-yml-1.19.1.tgz", + "integrity": "sha512-bYkOxyEiXh9WxUhVYPELdSHxGG5pOjCSeJOVkfdIyj6tuiHDxrES2WAW1dBxn3iaZQey57XflwLtCYRcNPOiOg==", "dev": true, "license": "MIT", "dependencies": { "debug": "^4.3.2", + "diff-sequences": "^27.5.1", "escape-string-regexp": "4.0.0", "eslint-compat-utils": "^0.6.0", "natural-compare": "^1.4.0", @@ -11617,9 +7011,9 @@ } }, "node_modules/esquery": { - "version": "1.6.0", - "resolved": "https://registry.npmjs.org/esquery/-/esquery-1.6.0.tgz", - "integrity": "sha512-ca9pw9fomFcKPvFLXhBKUK90ZvGibiGOvRJNbjljY7s7uq/5YO4BOzcYtJqExdx99rF6aAcnRxHmcUHcz6sQsg==", + "version": "1.7.0", + "resolved": "https://registry.npmjs.org/esquery/-/esquery-1.7.0.tgz", + "integrity": "sha512-Ap6G0WQwcU/LHsvLwON1fAQX9Zp0A2Y6Y/cJBl9r/JbW90Zyg4/zbG6zzKa2OTALELarYHmKu0GhpM5EO+7T0g==", "dev": true, "license": "BSD-3-Clause", "dependencies": { @@ -11725,29 +7119,6 @@ "url": "https://opencollective.com/unified" } }, - "node_modules/estree-util-to-js/node_modules/source-map": { - "version": "0.7.6", - "resolved": "https://registry.npmjs.org/source-map/-/source-map-0.7.6.tgz", - "integrity": "sha512-i5uvt8C3ikiWeNZSVZNWcfZPItFQOsYTUAOkcUPGd8DqDy1uOUikjt5dG+uRlwyvR108Fb9DOd4GvXfT0N2/uQ==", - "dev": true, - "license": "BSD-3-Clause", - "engines": { - "node": ">= 12" - } - }, - "node_modules/estree-util-value-to-estree": { - "version": "3.5.0", - "resolved": "https://registry.npmjs.org/estree-util-value-to-estree/-/estree-util-value-to-estree-3.5.0.tgz", - "integrity": "sha512-aMV56R27Gv3QmfmF1MY12GWkGzzeAezAX+UplqHVASfjc9wNzI/X6hC0S9oxq61WT4aQesLGslWP9tKk6ghRZQ==", - "dev": true, - "license": "MIT", - "dependencies": { - "@types/estree": "^1.0.0" - }, - "funding": { - "url": "https://github.com/sponsors/remcohaszing" - } - }, "node_modules/estree-util-visit": { "version": "2.0.0", "resolved": "https://registry.npmjs.org/estree-util-visit/-/estree-util-visit-2.0.0.tgz", @@ -11783,42 +7154,6 @@ "node": ">=0.10.0" } }, - "node_modules/eta": { - "version": "2.2.0", - "resolved": "https://registry.npmjs.org/eta/-/eta-2.2.0.tgz", - "integrity": "sha512-UVQ72Rqjy/ZKQalzV5dCCJP80GrmPrMxh6NlNf+erV6ObL0ZFkhCstWRawS85z3smdr3d2wXPsZEY7rDPfGd2g==", - "dev": true, - "license": "MIT", - "engines": { - "node": ">=6.0.0" - }, - "funding": { - "url": "https://github.com/eta-dev/eta?sponsor=1" - } - }, - "node_modules/etag": { - "version": "1.8.1", - "resolved": "https://registry.npmjs.org/etag/-/etag-1.8.1.tgz", - "integrity": "sha512-aIL5Fx7mawVa300al2BnEE4iNvo1qETxLrPI/o05L7z6go7fCw1J6EQmbK4FmJ2AS7kgVF/KEZWufBfdClMcPg==", - "dev": true, - "license": "MIT", - "engines": { - "node": ">= 0.6" - } - }, - "node_modules/eval": { - "version": "0.1.8", - "resolved": "https://registry.npmjs.org/eval/-/eval-0.1.8.tgz", - "integrity": "sha512-EzV94NYKoO09GLXGjXj9JIlXijVck4ONSr5wiCWDvhsvj5jxSrzTmRU/9C1DyB6uToszLs8aifA6NQ7lEQdvFw==", - "dev": true, - "dependencies": { - "@types/node": "*", - "require-like": ">= 0.1.1" - }, - "engines": { - "node": ">= 0.8" - } - }, "node_modules/event-target-shim": { "version": "5.0.1", "resolved": "https://registry.npmjs.org/event-target-shim/-/event-target-shim-5.0.1.tgz", @@ -11856,16 +7191,6 @@ "bare-events": "^2.7.0" } }, - "node_modules/eventsource-parser": { - "version": "3.0.6", - "resolved": "https://registry.npmjs.org/eventsource-parser/-/eventsource-parser-3.0.6.tgz", - "integrity": "sha512-Vo1ab+QXPzZ4tCa8SwIHJFaSzy4R6SHf7BY79rFBDf0idraZWAkYrDjDj8uWaSm3S2TK+hJ7/t1CEmZ7jXw+pg==", - "dev": true, - "license": "MIT", - "engines": { - "node": ">=18.0.0" - } - }, "node_modules/execa": { "version": "5.1.1", "resolved": "https://registry.npmjs.org/execa/-/execa-5.1.1.tgz", @@ -11908,115 +7233,34 @@ } }, "node_modules/expect": { - "version": "30.0.5", - "resolved": "https://registry.npmjs.org/expect/-/expect-30.0.5.tgz", - "integrity": "sha512-P0te2pt+hHI5qLJkIR+iMvS+lYUZml8rKKsohVHAGY+uClp9XVbdyYNJOIjSRpHVp8s8YqxJCiHUkSYZGr8rtQ==", + "version": "30.2.0", + "resolved": "https://registry.npmjs.org/expect/-/expect-30.2.0.tgz", + "integrity": "sha512-u/feCi0GPsI+988gU2FLcsHyAHTU0MX1Wg68NhAnN7z/+C5wqG+CY8J53N9ioe8RXgaoz0nBR/TYMf3AycUuPw==", "dev": true, "license": "MIT", "dependencies": { - "@jest/expect-utils": "30.0.5", - "@jest/get-type": "30.0.1", - "jest-matcher-utils": "30.0.5", - "jest-message-util": "30.0.5", - "jest-mock": "30.0.5", - "jest-util": "30.0.5" + "@jest/expect-utils": "30.2.0", + "@jest/get-type": "30.1.0", + "jest-matcher-utils": "30.2.0", + "jest-message-util": "30.2.0", + "jest-mock": "30.2.0", + "jest-util": "30.2.0" }, "engines": { "node": "^18.14.0 || ^20.0.0 || ^22.0.0 || >=24.0.0" } }, - "node_modules/express": { - "version": "4.22.1", - "resolved": "https://registry.npmjs.org/express/-/express-4.22.1.tgz", - "integrity": "sha512-F2X8g9P1X7uCPZMA3MVf9wcTqlyNp7IhH5qPCI0izhaOIYXaW9L535tGA3qmjRzpH+bZczqq7hVKxTR4NWnu+g==", + "node_modules/expressive-code": { + "version": "0.41.5", + "resolved": "https://registry.npmjs.org/expressive-code/-/expressive-code-0.41.5.tgz", + "integrity": "sha512-iXl9BgDogQgzgE/WRSrcyU8upOcRZrXPMiu6tegEHML57YLQ65S0E3/sjAXmMZy0GXoPs60s9jbwoMo/mdEQOg==", "dev": true, "license": "MIT", "dependencies": { - "accepts": "~1.3.8", - "array-flatten": "1.1.1", - "body-parser": "~1.20.3", - "content-disposition": "~0.5.4", - "content-type": "~1.0.4", - "cookie": "~0.7.1", - "cookie-signature": "~1.0.6", - "debug": "2.6.9", - "depd": "2.0.0", - "encodeurl": "~2.0.0", - "escape-html": "~1.0.3", - "etag": "~1.8.1", - "finalhandler": "~1.3.1", - "fresh": "~0.5.2", - "http-errors": "~2.0.0", - "merge-descriptors": "1.0.3", - "methods": "~1.1.2", - "on-finished": "~2.4.1", - "parseurl": "~1.3.3", - "path-to-regexp": "~0.1.12", - "proxy-addr": "~2.0.7", - "qs": "~6.14.0", - "range-parser": "~1.2.1", - "safe-buffer": "5.2.1", - "send": "~0.19.0", - "serve-static": "~1.16.2", - "setprototypeof": "1.2.0", - "statuses": "~2.0.1", - "type-is": "~1.6.18", - "utils-merge": "1.0.1", - "vary": "~1.1.2" - }, - "engines": { - "node": ">= 0.10.0" - }, - "funding": { - "type": "opencollective", - "url": "https://opencollective.com/express" - } - }, - "node_modules/express/node_modules/content-disposition": { - "version": "0.5.4", - "resolved": "https://registry.npmjs.org/content-disposition/-/content-disposition-0.5.4.tgz", - "integrity": "sha512-FveZTNuGw04cxlAiWbzi6zTAL/lhehaWbTtgluJh4/E95DqMwTmha3KZN1aAWA8cFIhHzMZUvLevkw5Rqk+tSQ==", - "dev": true, - "license": "MIT", - "dependencies": { - "safe-buffer": "5.2.1" - }, - "engines": { - "node": ">= 0.6" - } - }, - "node_modules/express/node_modules/debug": { - "version": "2.6.9", - "resolved": "https://registry.npmjs.org/debug/-/debug-2.6.9.tgz", - "integrity": "sha512-bC7ElrdJaJnPbAP+1EotYvqZsb3ecl5wi6Bfi6BJTUcNowp6cvspg0jXznRTKDjm/E7AdgFBVeAPVMNcKGsHMA==", - "dev": true, - "license": "MIT", - "dependencies": { - "ms": "2.0.0" - } - }, - "node_modules/express/node_modules/ms": { - "version": "2.0.0", - "resolved": "https://registry.npmjs.org/ms/-/ms-2.0.0.tgz", - "integrity": "sha512-Tpp60P6IUJDTuOq/5Z8cdskzJujfwqfOTkrwIwj7IRISpnkJnT6SyJ4PCPnGMoFjC9ddhal5KVIYtAt97ix05A==", - "dev": true, - "license": "MIT" - }, - "node_modules/express/node_modules/path-to-regexp": { - "version": "0.1.12", - "resolved": "https://registry.npmjs.org/path-to-regexp/-/path-to-regexp-0.1.12.tgz", - "integrity": "sha512-RA1GjUVMnvYFxuqovrEqZoxxW5NUZqbwKtYz/Tt7nXerk0LbLblQmrsgdeOxV5SFHf0UDggjS/bSeOZwt1pmEQ==", - "dev": true, - "license": "MIT" - }, - "node_modules/express/node_modules/range-parser": { - "version": "1.2.1", - "resolved": "https://registry.npmjs.org/range-parser/-/range-parser-1.2.1.tgz", - "integrity": "sha512-Hrgsx+orqoygnmhFbKaHE6c296J+HTAQXoxEF6gNupROmmGJRoyzfG3ccAveqCBrwr/2yxQ5BVd/GTl5agOwSg==", - "dev": true, - "license": "MIT", - "engines": { - "node": ">= 0.6" + "@expressive-code/core": "^0.41.5", + "@expressive-code/plugin-frames": "^0.41.5", + "@expressive-code/plugin-shiki": "^0.41.5", + "@expressive-code/plugin-text-markers": "^0.41.5" } }, "node_modules/extend": { @@ -12025,19 +7269,6 @@ "integrity": "sha512-fjquC59cD7CyW6urNXK0FBufkZcoiGG80wTuPujX590cB5Ttln20E2UB4S/WARVqhXffZl2LNgS+gQdPIIim/g==", "license": "MIT" }, - "node_modules/extend-shallow": { - "version": "2.0.1", - "resolved": "https://registry.npmjs.org/extend-shallow/-/extend-shallow-2.0.1.tgz", - "integrity": "sha512-zCnTtlxNoAiDc3gqY2aYAWFx7XWWiasuF2K8Me5WbN8otHKTUKBwjPtNpRs/rbUZm7KxWAaNj7P1a/p52GbVug==", - "dev": true, - "license": "MIT", - "dependencies": { - "is-extendable": "^0.1.0" - }, - "engines": { - "node": ">=0.10.0" - } - }, "node_modules/fast-deep-equal": { "version": "3.1.3", "resolved": "https://registry.npmjs.org/fast-deep-equal/-/fast-deep-equal-3.1.3.tgz", @@ -12096,60 +7327,16 @@ "dev": true, "license": "MIT" }, - "node_modules/fast-uri": { - "version": "3.1.0", - "resolved": "https://registry.npmjs.org/fast-uri/-/fast-uri-3.1.0.tgz", - "integrity": "sha512-iPeeDKJSWf4IEOasVVrknXpaBV0IApz/gp7S2bb7Z4Lljbl2MGJRqInZiUrQwV16cpzw/D3S5j5Julj/gT52AA==", - "dev": true, - "funding": [ - { - "type": "github", - "url": "https://github.com/sponsors/fastify" - }, - { - "type": "opencollective", - "url": "https://opencollective.com/fastify" - } - ], - "license": "BSD-3-Clause" - }, "node_modules/fastq": { - "version": "1.19.1", - "resolved": "https://registry.npmjs.org/fastq/-/fastq-1.19.1.tgz", - "integrity": "sha512-GwLTyxkCXjXbxqIhTsMI2Nui8huMPtnxg7krajPJAjnEG/iiOS7i+zCtWGZR9G0NBKbXKh6X9m9UIsYX/N6vvQ==", + "version": "1.20.1", + "resolved": "https://registry.npmjs.org/fastq/-/fastq-1.20.1.tgz", + "integrity": "sha512-GGToxJ/w1x32s/D2EKND7kTil4n8OVk/9mycTc4VDza13lOvpUZTGX3mFSCtV9ksdGBVzvsyAVLM6mHFThxXxw==", "dev": true, "license": "ISC", "dependencies": { "reusify": "^1.0.4" } }, - "node_modules/fault": { - "version": "2.0.1", - "resolved": "https://registry.npmjs.org/fault/-/fault-2.0.1.tgz", - "integrity": "sha512-WtySTkS4OKev5JtpHXnib4Gxiurzh5NCGvWrFaZ34m6JehfTUhKZvn9njTfw48t6JumVQOmrKqpmGcdwxnhqBQ==", - "dev": true, - "license": "MIT", - "dependencies": { - "format": "^0.2.0" - }, - "funding": { - "type": "github", - "url": "https://github.com/sponsors/wooorm" - } - }, - "node_modules/faye-websocket": { - "version": "0.11.4", - "resolved": "https://registry.npmjs.org/faye-websocket/-/faye-websocket-0.11.4.tgz", - "integrity": "sha512-CzbClwlXAuiRQAlUyfqPgvPoNKTckTPGfwZV4ZdAhVcP2lh9KUxJg2b5GkE7XbjKQ3YJnQ9z6D9ntLAlB+tP8g==", - "dev": true, - "license": "Apache-2.0", - "dependencies": { - "websocket-driver": ">=0.5.1" - }, - "engines": { - "node": ">=0.8.0" - } - }, "node_modules/fb-watchman": { "version": "2.0.2", "resolved": "https://registry.npmjs.org/fb-watchman/-/fb-watchman-2.0.2.tgz", @@ -12160,53 +7347,37 @@ "bser": "2.1.1" } }, - "node_modules/feed": { - "version": "4.2.2", - "resolved": "https://registry.npmjs.org/feed/-/feed-4.2.2.tgz", - "integrity": "sha512-u5/sxGfiMfZNtJ3OvQpXcvotFpYkL0n9u9mM2vkui2nGo8b4wvDkJ8gAkYqbA8QpGyFCv3RK0Z+Iv+9veCS9bQ==", + "node_modules/fdir": { + "version": "6.5.0", + "resolved": "https://registry.npmjs.org/fdir/-/fdir-6.5.0.tgz", + "integrity": "sha512-tIbYtZbucOs0BRGqPJkshJUYdL+SDH7dVM8gjy+ERp3WAUjLEFJE+02kanyHtwjWOnwrKYBiwAmM0p4kLJAnXg==", "dev": true, "license": "MIT", - "dependencies": { - "xml-js": "^1.6.11" - }, "engines": { - "node": ">=0.4.0" + "node": ">=12.0.0" + }, + "peerDependencies": { + "picomatch": "^3 || ^4" + }, + "peerDependenciesMeta": { + "picomatch": { + "optional": true + } } }, "node_modules/figlet": { - "version": "1.8.0", - "resolved": "https://registry.npmjs.org/figlet/-/figlet-1.8.0.tgz", - "integrity": "sha512-chzvGjd+Sp7KUvPHZv6EXV5Ir3Q7kYNpCr4aHrRW79qFtTefmQZNny+W1pW9kf5zeE6dikku2W50W/wAH2xWgw==", + "version": "1.9.4", + "resolved": "https://registry.npmjs.org/figlet/-/figlet-1.9.4.tgz", + "integrity": "sha512-uN6QE+TrzTAHC1IWTyrc4FfGo2KH/82J8Jl1tyKB7+z5DBit/m3D++Iu5lg91qJMnQQ3vpJrj5gxcK/pk4R9tQ==", "license": "MIT", + "dependencies": { + "commander": "^14.0.0" + }, "bin": { "figlet": "bin/index.js" }, "engines": { - "node": ">= 0.4.0" - } - }, - "node_modules/figures": { - "version": "3.2.0", - "resolved": "https://registry.npmjs.org/figures/-/figures-3.2.0.tgz", - "integrity": "sha512-yaduQFRKLXYOGgEn6AZau90j3ggSOyiqXU0F9JZfeXYhNa+Jk4X+s45A2zg5jns87GAFa34BBm2kXw4XpNcbdg==", - "license": "MIT", - "dependencies": { - "escape-string-regexp": "^1.0.5" - }, - "engines": { - "node": ">=8" - }, - "funding": { - "url": "https://github.com/sponsors/sindresorhus" - } - }, - "node_modules/figures/node_modules/escape-string-regexp": { - "version": "1.0.5", - "resolved": "https://registry.npmjs.org/escape-string-regexp/-/escape-string-regexp-1.0.5.tgz", - "integrity": "sha512-vbRorB5FUQWvla16U8R/qgaFIya2qGzwDrNmCZuYKrbdSUMG6I1ZCGQRefkRVhuOkIGVne7BQ35DSfo1qvJqFg==", - "license": "MIT", - "engines": { - "node": ">=0.8.0" + "node": ">= 17.0.0" } }, "node_modules/file-entry-cache": { @@ -12222,46 +7393,6 @@ "node": ">=16.0.0" } }, - "node_modules/file-loader": { - "version": "6.2.0", - "resolved": "https://registry.npmjs.org/file-loader/-/file-loader-6.2.0.tgz", - "integrity": "sha512-qo3glqyTa61Ytg4u73GultjHGjdRyig3tG6lPtyX/jOEJvHif9uB0/OCI2Kif6ctF3caQTW2G5gym21oAsI4pw==", - "dev": true, - "license": "MIT", - "dependencies": { - "loader-utils": "^2.0.0", - "schema-utils": "^3.0.0" - }, - "engines": { - "node": ">= 10.13.0" - }, - "funding": { - "type": "opencollective", - "url": "https://opencollective.com/webpack" - }, - "peerDependencies": { - "webpack": "^4.0.0 || ^5.0.0" - } - }, - "node_modules/file-loader/node_modules/schema-utils": { - "version": "3.3.0", - "resolved": "https://registry.npmjs.org/schema-utils/-/schema-utils-3.3.0.tgz", - "integrity": "sha512-pN/yOAvcC+5rQ5nERGuwrjLlYvLTbCibnZ1I7B1LaiAz9BRBlE9GMgE/eqV30P7aJQUf7Ddimy/RsbYO/GrVGg==", - "dev": true, - "license": "MIT", - "dependencies": { - "@types/json-schema": "^7.0.8", - "ajv": "^6.12.5", - "ajv-keywords": "^3.5.2" - }, - "engines": { - "node": ">= 10.13.0" - }, - "funding": { - "type": "opencollective", - "url": "https://opencollective.com/webpack" - } - }, "node_modules/fill-range": { "version": "7.1.1", "resolved": "https://registry.npmjs.org/fill-range/-/fill-range-7.1.1.tgz", @@ -12275,163 +7406,6 @@ "node": ">=8" } }, - "node_modules/finalhandler": { - "version": "1.3.2", - "resolved": "https://registry.npmjs.org/finalhandler/-/finalhandler-1.3.2.tgz", - "integrity": "sha512-aA4RyPcd3badbdABGDuTXCMTtOneUCAYH/gxoYRTZlIJdF0YPWuGqiAsIrhNnnqdXGswYk6dGujem4w80UJFhg==", - "dev": true, - "license": "MIT", - "dependencies": { - "debug": "2.6.9", - "encodeurl": "~2.0.0", - "escape-html": "~1.0.3", - "on-finished": "~2.4.1", - "parseurl": "~1.3.3", - "statuses": "~2.0.2", - "unpipe": "~1.0.0" - }, - "engines": { - "node": ">= 0.8" - } - }, - "node_modules/finalhandler/node_modules/debug": { - "version": "2.6.9", - "resolved": "https://registry.npmjs.org/debug/-/debug-2.6.9.tgz", - "integrity": "sha512-bC7ElrdJaJnPbAP+1EotYvqZsb3ecl5wi6Bfi6BJTUcNowp6cvspg0jXznRTKDjm/E7AdgFBVeAPVMNcKGsHMA==", - "dev": true, - "license": "MIT", - "dependencies": { - "ms": "2.0.0" - } - }, - "node_modules/finalhandler/node_modules/ms": { - "version": "2.0.0", - "resolved": "https://registry.npmjs.org/ms/-/ms-2.0.0.tgz", - "integrity": "sha512-Tpp60P6IUJDTuOq/5Z8cdskzJujfwqfOTkrwIwj7IRISpnkJnT6SyJ4PCPnGMoFjC9ddhal5KVIYtAt97ix05A==", - "dev": true, - "license": "MIT" - }, - "node_modules/find-cache-dir": { - "version": "4.0.0", - "resolved": "https://registry.npmjs.org/find-cache-dir/-/find-cache-dir-4.0.0.tgz", - "integrity": "sha512-9ZonPT4ZAK4a+1pUPVPZJapbi7O5qbbJPdYw/NOQWZZbVLdDTYM3A4R9z/DpAM08IDaFGsvPgiGZ82WEwUDWjg==", - "dev": true, - "license": "MIT", - "dependencies": { - "common-path-prefix": "^3.0.0", - "pkg-dir": "^7.0.0" - }, - "engines": { - "node": ">=14.16" - }, - "funding": { - "url": "https://github.com/sponsors/sindresorhus" - } - }, - "node_modules/find-cache-dir/node_modules/find-up": { - "version": "6.3.0", - "resolved": "https://registry.npmjs.org/find-up/-/find-up-6.3.0.tgz", - "integrity": "sha512-v2ZsoEuVHYy8ZIlYqwPe/39Cy+cFDzp4dXPaxNvkEuouymu+2Jbz0PxpKarJHYJTmv2HWT3O382qY8l4jMWthw==", - "dev": true, - "license": "MIT", - "dependencies": { - "locate-path": "^7.1.0", - "path-exists": "^5.0.0" - }, - "engines": { - "node": "^12.20.0 || ^14.13.1 || >=16.0.0" - }, - "funding": { - "url": "https://github.com/sponsors/sindresorhus" - } - }, - "node_modules/find-cache-dir/node_modules/locate-path": { - "version": "7.2.0", - "resolved": "https://registry.npmjs.org/locate-path/-/locate-path-7.2.0.tgz", - "integrity": "sha512-gvVijfZvn7R+2qyPX8mAuKcFGDf6Nc61GdvGafQsHL0sBIxfKzA+usWn4GFC/bk+QdwPUD4kWFJLhElipq+0VA==", - "dev": true, - "license": "MIT", - "dependencies": { - "p-locate": "^6.0.0" - }, - "engines": { - "node": "^12.20.0 || ^14.13.1 || >=16.0.0" - }, - "funding": { - "url": "https://github.com/sponsors/sindresorhus" - } - }, - "node_modules/find-cache-dir/node_modules/p-limit": { - "version": "4.0.0", - "resolved": "https://registry.npmjs.org/p-limit/-/p-limit-4.0.0.tgz", - "integrity": "sha512-5b0R4txpzjPWVw/cXXUResoD4hb6U/x9BH08L7nw+GN1sezDzPdxeRvpc9c433fZhBan/wusjbCsqwqm4EIBIQ==", - "dev": true, - "license": "MIT", - "dependencies": { - "yocto-queue": "^1.0.0" - }, - "engines": { - "node": "^12.20.0 || ^14.13.1 || >=16.0.0" - }, - "funding": { - "url": "https://github.com/sponsors/sindresorhus" - } - }, - "node_modules/find-cache-dir/node_modules/p-locate": { - "version": "6.0.0", - "resolved": "https://registry.npmjs.org/p-locate/-/p-locate-6.0.0.tgz", - "integrity": "sha512-wPrq66Llhl7/4AGC6I+cqxT07LhXvWL08LNXz1fENOw0Ap4sRZZ/gZpTTJ5jpurzzzfS2W/Ge9BY3LgLjCShcw==", - "dev": true, - "license": "MIT", - "dependencies": { - "p-limit": "^4.0.0" - }, - "engines": { - "node": "^12.20.0 || ^14.13.1 || >=16.0.0" - }, - "funding": { - "url": "https://github.com/sponsors/sindresorhus" - } - }, - "node_modules/find-cache-dir/node_modules/path-exists": { - "version": "5.0.0", - "resolved": "https://registry.npmjs.org/path-exists/-/path-exists-5.0.0.tgz", - "integrity": "sha512-RjhtfwJOxzcFmNOi6ltcbcu4Iu+FL3zEj83dk4kAS+fVpTxXLO1b38RvJgT/0QwvV/L3aY9TAnyv0EOqW4GoMQ==", - "dev": true, - "license": "MIT", - "engines": { - "node": "^12.20.0 || ^14.13.1 || >=16.0.0" - } - }, - "node_modules/find-cache-dir/node_modules/pkg-dir": { - "version": "7.0.0", - "resolved": "https://registry.npmjs.org/pkg-dir/-/pkg-dir-7.0.0.tgz", - "integrity": "sha512-Ie9z/WINcxxLp27BKOCHGde4ITq9UklYKDzVo1nhk5sqGEXU3FpkwP5GM2voTGJkGd9B3Otl+Q4uwSOeSUtOBA==", - "dev": true, - "license": "MIT", - "dependencies": { - "find-up": "^6.3.0" - }, - "engines": { - "node": ">=14.16" - }, - "funding": { - "url": "https://github.com/sponsors/sindresorhus" - } - }, - "node_modules/find-cache-dir/node_modules/yocto-queue": { - "version": "1.2.2", - "resolved": "https://registry.npmjs.org/yocto-queue/-/yocto-queue-1.2.2.tgz", - "integrity": "sha512-4LCcse/U2MHZ63HAJVE+v71o7yOdIe4cZ70Wpf8D/IyjDKYQLV5GD46B+hSTjJsvV5PztjvHoU580EftxjDZFQ==", - "dev": true, - "license": "MIT", - "engines": { - "node": ">=12.20" - }, - "funding": { - "url": "https://github.com/sponsors/sindresorhus" - } - }, "node_modules/find-up": { "version": "5.0.0", "resolved": "https://registry.npmjs.org/find-up/-/find-up-5.0.0.tgz", @@ -12462,16 +7436,6 @@ "url": "https://github.com/sponsors/sindresorhus" } }, - "node_modules/flat": { - "version": "5.0.2", - "resolved": "https://registry.npmjs.org/flat/-/flat-5.0.2.tgz", - "integrity": "sha512-b6suED+5/3rTpUBdG1gupIl8MPFCAMA0QXwmljLhvCUKcUvdE4gWky9zpuGCcXHOsz4J9wPGNWq6OKpmIzz3hQ==", - "dev": true, - "license": "BSD-3-Clause", - "bin": { - "flat": "cli.js" - } - }, "node_modules/flat-cache": { "version": "4.0.1", "resolved": "https://registry.npmjs.org/flat-cache/-/flat-cache-4.0.1.tgz", @@ -12493,25 +7457,43 @@ "dev": true, "license": "ISC" }, - "node_modules/follow-redirects": { - "version": "1.15.11", - "resolved": "https://registry.npmjs.org/follow-redirects/-/follow-redirects-1.15.11.tgz", - "integrity": "sha512-deG2P0JfjrTxl50XGCDyfI97ZGVCxIpfKYmfyrQ54n5FO/0gfIES8C/Psl6kWVDolizcaaxZJnTS0QSMxvnsBQ==", + "node_modules/flattie": { + "version": "1.1.1", + "resolved": "https://registry.npmjs.org/flattie/-/flattie-1.1.1.tgz", + "integrity": "sha512-9UbaD6XdAL97+k/n+N7JwX46K/M6Zc6KcFYskrYL8wbBV/Uyk0CTAMY0VT+qiK5PM7AIc9aTWYtq65U7T+aCNQ==", "dev": true, - "funding": [ - { - "type": "individual", - "url": "https://github.com/sponsors/RubenVerborgh" - } - ], "license": "MIT", "engines": { - "node": ">=4.0" - }, - "peerDependenciesMeta": { - "debug": { - "optional": true - } + "node": ">=8" + } + }, + "node_modules/fontace": { + "version": "0.3.1", + "resolved": "https://registry.npmjs.org/fontace/-/fontace-0.3.1.tgz", + "integrity": "sha512-9f5g4feWT1jWT8+SbL85aLIRLIXUaDygaM2xPXRmzPYxrOMNok79Lr3FGJoKVNKibE0WCunNiEVG2mwuE+2qEg==", + "dev": true, + "license": "MIT", + "dependencies": { + "@types/fontkit": "^2.0.8", + "fontkit": "^2.0.4" + } + }, + "node_modules/fontkit": { + "version": "2.0.4", + "resolved": "https://registry.npmjs.org/fontkit/-/fontkit-2.0.4.tgz", + "integrity": "sha512-syetQadaUEDNdxdugga9CpEYVaQIxOwk7GlwZWWZ19//qW4zE5bknOKeMBDYAASwnpaSHKJITRLMF9m1fp3s6g==", + "dev": true, + "license": "MIT", + "dependencies": { + "@swc/helpers": "^0.5.12", + "brotli": "^1.3.2", + "clone": "^2.1.2", + "dfa": "^1.2.0", + "fast-deep-equal": "^3.1.3", + "restructure": "^3.0.0", + "tiny-inflate": "^1.0.3", + "unicode-properties": "^1.4.0", + "unicode-trie": "^2.0.0" } }, "node_modules/foreground-child": { @@ -12530,63 +7512,10 @@ "url": "https://github.com/sponsors/isaacs" } }, - "node_modules/form-data-encoder": { - "version": "2.1.4", - "resolved": "https://registry.npmjs.org/form-data-encoder/-/form-data-encoder-2.1.4.tgz", - "integrity": "sha512-yDYSgNMraqvnxiEXO4hi88+YZxaHC6QKzb5N84iRCTDeRO7ZALpir/lVmf/uXUhnwUr2O4HU8s/n6x+yNjQkHw==", - "dev": true, - "license": "MIT", - "engines": { - "node": ">= 14.17" - } - }, - "node_modules/format": { - "version": "0.2.2", - "resolved": "https://registry.npmjs.org/format/-/format-0.2.2.tgz", - "integrity": "sha512-wzsgA6WOq+09wrU1tsJ09udeR/YZRaeArL9e1wPbFg3GG2yDnC2ldKpxs4xunpFF9DgqCqOIra3bc1HWrJ37Ww==", - "dev": true, - "engines": { - "node": ">=0.4.x" - } - }, - "node_modules/forwarded": { - "version": "0.2.0", - "resolved": "https://registry.npmjs.org/forwarded/-/forwarded-0.2.0.tgz", - "integrity": "sha512-buRG0fpBtRHSTCOASe6hD258tEubFoRLb4ZNA6NxMVHNw2gOcwHo9wyablzMzOA5z9xA9L1KNjk/Nt6MT9aYow==", - "dev": true, - "license": "MIT", - "engines": { - "node": ">= 0.6" - } - }, - "node_modules/fraction.js": { - "version": "5.3.4", - "resolved": "https://registry.npmjs.org/fraction.js/-/fraction.js-5.3.4.tgz", - "integrity": "sha512-1X1NTtiJphryn/uLQz3whtY6jK3fTqoE3ohKs0tT+Ujr1W59oopxmoEh7Lu5p6vBaPbgoM0bzveAW4Qi5RyWDQ==", - "dev": true, - "license": "MIT", - "engines": { - "node": "*" - }, - "funding": { - "type": "github", - "url": "https://github.com/sponsors/rawify" - } - }, - "node_modules/fresh": { - "version": "0.5.2", - "resolved": "https://registry.npmjs.org/fresh/-/fresh-0.5.2.tgz", - "integrity": "sha512-zJ2mQYM18rEFOudeV4GShTGIQ7RbzA7ozbU9I/XBpm7kqgMywgmylMwXHxZJmkVoYkna9d2pVXVXPdYTP9ej8Q==", - "dev": true, - "license": "MIT", - "engines": { - "node": ">= 0.6" - } - }, "node_modules/fs-extra": { - "version": "11.3.1", - "resolved": "https://registry.npmjs.org/fs-extra/-/fs-extra-11.3.1.tgz", - "integrity": "sha512-eXvGGwZ5CL17ZSwHWd3bbgk7UUpF6IFHtP57NYYakPvHOs8GDgDe5KJI36jIJzDkJ6eJjuzRA8eBQb6SkKue0g==", + "version": "11.3.3", + "resolved": "https://registry.npmjs.org/fs-extra/-/fs-extra-11.3.3.tgz", + "integrity": "sha512-VWSRii4t0AFm6ixFFmLLx1t7wS1gh+ckoa84aOeapGum0h+EZd1EhEumSB+ZdDLnEPuucsVB9oB7cxJHap6Afg==", "license": "MIT", "dependencies": { "graceful-fs": "^4.2.0", @@ -12619,16 +7548,6 @@ "node": "^8.16.0 || ^10.6.0 || >=11.0.0" } }, - "node_modules/function-bind": { - "version": "1.1.2", - "resolved": "https://registry.npmjs.org/function-bind/-/function-bind-1.1.2.tgz", - "integrity": "sha512-7XHNxH7qX9xG5mIwxkhumTox/MIRNcOgDrxWsMt2pAr23WHp6MrRlN7FBSFpCpr+oVO0F744iUgR82nJMfG2SA==", - "dev": true, - "license": "MIT", - "funding": { - "url": "https://github.com/sponsors/ljharb" - } - }, "node_modules/gensync": { "version": "1.0.0-beta.2", "resolved": "https://registry.npmjs.org/gensync/-/gensync-1.0.0-beta.2.tgz", @@ -12650,9 +7569,9 @@ } }, "node_modules/get-east-asian-width": { - "version": "1.3.0", - "resolved": "https://registry.npmjs.org/get-east-asian-width/-/get-east-asian-width-1.3.0.tgz", - "integrity": "sha512-vpeMIQKxczTD/0s2CdEWHcb0eeJe6TFjxb+J5xgX7hScxqrGuyjmv4c1D4A/gelKfyox0gJJwIHF+fLjeaM8kQ==", + "version": "1.4.0", + "resolved": "https://registry.npmjs.org/get-east-asian-width/-/get-east-asian-width-1.4.0.tgz", + "integrity": "sha512-QZjmEOC+IT1uk6Rx0sX22V6uHWVwbdbxf1faPqJ1QhLdGgsRGCZoyaQBm/piRdJy/D2um6hM1UP7ZEeQ4EkP+Q==", "dev": true, "license": "MIT", "engines": { @@ -12662,38 +7581,6 @@ "url": "https://github.com/sponsors/sindresorhus" } }, - "node_modules/get-intrinsic": { - "version": "1.3.0", - "resolved": "https://registry.npmjs.org/get-intrinsic/-/get-intrinsic-1.3.0.tgz", - "integrity": "sha512-9fSjSaos/fRIVIp+xSJlE6lfwhES7LNtKaCBIamHsjr2na1BiABJPo0mOjjz8GJDURarmCPGqaiVg5mfjb98CQ==", - "dev": true, - "license": "MIT", - "dependencies": { - "call-bind-apply-helpers": "^1.0.2", - "es-define-property": "^1.0.1", - "es-errors": "^1.3.0", - "es-object-atoms": "^1.1.1", - "function-bind": "^1.1.2", - "get-proto": "^1.0.1", - "gopd": "^1.2.0", - "has-symbols": "^1.1.0", - "hasown": "^2.0.2", - "math-intrinsics": "^1.1.0" - }, - "engines": { - "node": ">= 0.4" - }, - "funding": { - "url": "https://github.com/sponsors/ljharb" - } - }, - "node_modules/get-own-enumerable-property-symbols": { - "version": "3.0.2", - "resolved": "https://registry.npmjs.org/get-own-enumerable-property-symbols/-/get-own-enumerable-property-symbols-3.0.2.tgz", - "integrity": "sha512-I0UBV/XOz1XkIJHEUDMZAbzCThU/H8DxmSfmdGcKPnVhu2VfFqr34jr9777IyaTYvxjedWhqVIilEDsCdP5G6g==", - "dev": true, - "license": "ISC" - }, "node_modules/get-package-type": { "version": "0.1.0", "resolved": "https://registry.npmjs.org/get-package-type/-/get-package-type-0.1.0.tgz", @@ -12704,20 +7591,6 @@ "node": ">=8.0.0" } }, - "node_modules/get-proto": { - "version": "1.0.1", - "resolved": "https://registry.npmjs.org/get-proto/-/get-proto-1.0.1.tgz", - "integrity": "sha512-sTSfBjoXBp89JvIKIefqw7U2CCebsc74kiY6awiGogKtoSGbgjYE/G/+l9sF3MWFPNc9IcoOC4ODfKHfxFmp0g==", - "dev": true, - "license": "MIT", - "dependencies": { - "dunder-proto": "^1.0.1", - "es-object-atoms": "^1.0.0" - }, - "engines": { - "node": ">= 0.4" - } - }, "node_modules/get-stream": { "version": "6.0.1", "resolved": "https://registry.npmjs.org/get-stream/-/get-stream-6.0.1.tgz", @@ -12732,9 +7605,9 @@ } }, "node_modules/get-tsconfig": { - "version": "4.10.1", - "resolved": "https://registry.npmjs.org/get-tsconfig/-/get-tsconfig-4.10.1.tgz", - "integrity": "sha512-auHyJ4AgMz7vgS8Hp3N6HXSmlMdUyhSUrfBF16w153rxtLIEOE+HGqaBppczZvnHLqQJfiHotCYpNhl0lUROFQ==", + "version": "4.13.0", + "resolved": "https://registry.npmjs.org/get-tsconfig/-/get-tsconfig-4.13.0.tgz", + "integrity": "sha512-1VKTZJCwBrvbd+Wn3AOgQP/2Av+TfTCOlE4AcRJE72W1ksZXbAx8PPBR9RzgTeSPzlPMHrbANMH3LbltH73wxQ==", "dev": true, "license": "MIT", "dependencies": { @@ -12755,9 +7628,9 @@ } }, "node_modules/github-slugger": { - "version": "1.5.0", - "resolved": "https://registry.npmjs.org/github-slugger/-/github-slugger-1.5.0.tgz", - "integrity": "sha512-wIh+gKBI9Nshz2o46B0B3f5k/W+WI9ZAv6y5Dn5WJ5SK1t0TnDimB4WE5rmTD05ZAIn8HALCZVmCsvj0w0v0lw==", + "version": "2.0.0", + "resolved": "https://registry.npmjs.org/github-slugger/-/github-slugger-2.0.0.tgz", + "integrity": "sha512-IaOQ9puYtjrkq7Y0Ygl9KDZnrf/aiUJYUpVf89y8kyaxbRG7Y1SrX/jaumrv81vc61+kiMempujsM3Yw7w5qcw==", "dev": true, "license": "ISC" }, @@ -12797,30 +7670,6 @@ "node": ">=10.13.0" } }, - "node_modules/glob-to-regex.js": { - "version": "1.2.0", - "resolved": "https://registry.npmjs.org/glob-to-regex.js/-/glob-to-regex.js-1.2.0.tgz", - "integrity": "sha512-QMwlOQKU/IzqMUOAZWubUOT8Qft+Y0KQWnX9nK3ch0CJg0tTp4TvGZsTfudYKv2NzoQSyPcnA6TYeIQ3jGichQ==", - "dev": true, - "license": "Apache-2.0", - "engines": { - "node": ">=10.0" - }, - "funding": { - "type": "github", - "url": "https://github.com/sponsors/streamich" - }, - "peerDependencies": { - "tslib": "2" - } - }, - "node_modules/glob-to-regexp": { - "version": "0.4.1", - "resolved": "https://registry.npmjs.org/glob-to-regexp/-/glob-to-regexp-0.4.1.tgz", - "integrity": "sha512-lkX1HJXwyMcprw/5YUZc2s7DrpAiHB21/V+E1rHUrVNokkvB6bqMzT0VfV6/86ZNabt1k14YOIaT7nDvOX3Iiw==", - "dev": true, - "license": "BSD-2-Clause" - }, "node_modules/glob/node_modules/minimatch": { "version": "10.1.1", "resolved": "https://registry.npmjs.org/minimatch/-/minimatch-10.1.1.tgz", @@ -12836,22 +7685,6 @@ "url": "https://github.com/sponsors/isaacs" } }, - "node_modules/global-dirs": { - "version": "3.0.1", - "resolved": "https://registry.npmjs.org/global-dirs/-/global-dirs-3.0.1.tgz", - "integrity": "sha512-NBcGGFbBA9s1VzD41QXDG+3++t9Mn5t1FpLdhESY6oKY4gYTFpX4wO3sqGUa0Srjtbfj3szX0RnemmrVRUdULA==", - "dev": true, - "license": "MIT", - "dependencies": { - "ini": "2.0.0" - }, - "engines": { - "node": ">=10" - }, - "funding": { - "url": "https://github.com/sponsors/sindresorhus" - } - }, "node_modules/globals": { "version": "14.0.0", "resolved": "https://registry.npmjs.org/globals/-/globals-14.0.0.tgz", @@ -12866,34 +7699,37 @@ } }, "node_modules/globby": { - "version": "11.1.0", - "resolved": "https://registry.npmjs.org/globby/-/globby-11.1.0.tgz", - "integrity": "sha512-jhIXaOzy1sb8IyocaruWSn1TjmnBVs8Ayhcy83rmxNJ8q2uWKCAj3CnJY+KpGSXCueAPc0i05kVvVKtP1t9S3g==", + "version": "15.0.0", + "resolved": "https://registry.npmjs.org/globby/-/globby-15.0.0.tgz", + "integrity": "sha512-oB4vkQGqlMl682wL1IlWd02tXCbquGWM4voPEI85QmNKCaw8zGTm1f1rubFgkg3Eli2PtKlFgrnmUqasbQWlkw==", "dev": true, "license": "MIT", "dependencies": { - "array-union": "^2.1.0", - "dir-glob": "^3.0.1", - "fast-glob": "^3.2.9", - "ignore": "^5.2.0", - "merge2": "^1.4.1", - "slash": "^3.0.0" + "@sindresorhus/merge-streams": "^4.0.0", + "fast-glob": "^3.3.3", + "ignore": "^7.0.5", + "path-type": "^6.0.0", + "slash": "^5.1.0", + "unicorn-magic": "^0.3.0" }, "engines": { - "node": ">=10" + "node": ">=20" }, "funding": { "url": "https://github.com/sponsors/sindresorhus" } }, - "node_modules/globby/node_modules/ignore": { - "version": "5.3.2", - "resolved": "https://registry.npmjs.org/ignore/-/ignore-5.3.2.tgz", - "integrity": "sha512-hsBTNUqQTDwkWtcdYI2i06Y/nUBEsNEDJKjWdigLvegy8kDuJAS8uRlpkkcQpyEXL0Z/pjDy5HBmMjRCJ2gq+g==", + "node_modules/globby/node_modules/slash": { + "version": "5.1.0", + "resolved": "https://registry.npmjs.org/slash/-/slash-5.1.0.tgz", + "integrity": "sha512-ZA6oR3T/pEyuqwMgAKT0/hAv8oAXckzbkmR0UkUosQ+Mc4RxGoJkRmwHgHufaenlyAgE1Mxgpdcrf75y6XcnDg==", "dev": true, "license": "MIT", "engines": { - "node": ">= 4" + "node": ">=14.16" + }, + "funding": { + "url": "https://github.com/sponsors/sindresorhus" } }, "node_modules/globrex": { @@ -12903,127 +7739,30 @@ "dev": true, "license": "MIT" }, - "node_modules/gopd": { - "version": "1.2.0", - "resolved": "https://registry.npmjs.org/gopd/-/gopd-1.2.0.tgz", - "integrity": "sha512-ZUKRh6/kUFoAiTAtTYPZJ3hw9wNxx+BIBOijnlG9PnrJsCcSjs1wyyD6vJpaYtgnzDrKYRSqf3OO6Rfa93xsRg==", - "dev": true, - "license": "MIT", - "engines": { - "node": ">= 0.4" - }, - "funding": { - "url": "https://github.com/sponsors/ljharb" - } - }, - "node_modules/got": { - "version": "12.6.1", - "resolved": "https://registry.npmjs.org/got/-/got-12.6.1.tgz", - "integrity": "sha512-mThBblvlAF1d4O5oqyvN+ZxLAYwIJK7bpMxgYqPD9okW0C3qm5FFn7k811QrcuEBwaogR3ngOFoCfs6mRv7teQ==", - "dev": true, - "license": "MIT", - "dependencies": { - "@sindresorhus/is": "^5.2.0", - "@szmarczak/http-timer": "^5.0.1", - "cacheable-lookup": "^7.0.0", - "cacheable-request": "^10.2.8", - "decompress-response": "^6.0.0", - "form-data-encoder": "^2.1.2", - "get-stream": "^6.0.1", - "http2-wrapper": "^2.1.10", - "lowercase-keys": "^3.0.0", - "p-cancelable": "^3.0.0", - "responselike": "^3.0.0" - }, - "engines": { - "node": ">=14.16" - }, - "funding": { - "url": "https://github.com/sindresorhus/got?sponsor=1" - } - }, - "node_modules/got/node_modules/@sindresorhus/is": { - "version": "5.6.0", - "resolved": "https://registry.npmjs.org/@sindresorhus/is/-/is-5.6.0.tgz", - "integrity": "sha512-TV7t8GKYaJWsn00tFDqBw8+Uqmr8A0fRU1tvTQhyZzGv0sJCGRQL3JGMI3ucuKo3XIZdUP+Lx7/gh2t3lewy7g==", - "dev": true, - "license": "MIT", - "engines": { - "node": ">=14.16" - }, - "funding": { - "url": "https://github.com/sindresorhus/is?sponsor=1" - } - }, "node_modules/graceful-fs": { "version": "4.2.11", "resolved": "https://registry.npmjs.org/graceful-fs/-/graceful-fs-4.2.11.tgz", "integrity": "sha512-RbJ5/jmFcNNCcDV5o9eTnBLJ/HszWV0P73bc+Ff4nS/rJj+YaS6IGyiOL0VoBYX+l1Wrl3k63h/KrH+nhJ0XvQ==", "license": "ISC" }, - "node_modules/gray-matter": { - "version": "4.0.3", - "resolved": "https://registry.npmjs.org/gray-matter/-/gray-matter-4.0.3.tgz", - "integrity": "sha512-5v6yZd4JK3eMI3FqqCouswVqwugaA9r4dNZB1wwcmrD02QkV5H0y7XBQW8QwQqEaZY1pM9aqORSORhJRdNK44Q==", + "node_modules/h3": { + "version": "1.15.4", + "resolved": "https://registry.npmjs.org/h3/-/h3-1.15.4.tgz", + "integrity": "sha512-z5cFQWDffyOe4vQ9xIqNfCZdV4p//vy6fBnr8Q1AWnVZ0teurKMG66rLj++TKwKPUP3u7iMUvrvKaEUiQw2QWQ==", "dev": true, "license": "MIT", "dependencies": { - "js-yaml": "^3.13.1", - "kind-of": "^6.0.2", - "section-matter": "^1.0.0", - "strip-bom-string": "^1.0.0" - }, - "engines": { - "node": ">=6.0" + "cookie-es": "^1.2.2", + "crossws": "^0.3.5", + "defu": "^6.1.4", + "destr": "^2.0.5", + "iron-webcrypto": "^1.2.1", + "node-mock-http": "^1.0.2", + "radix3": "^1.1.2", + "ufo": "^1.6.1", + "uncrypto": "^0.1.3" } }, - "node_modules/gray-matter/node_modules/argparse": { - "version": "1.0.10", - "resolved": "https://registry.npmjs.org/argparse/-/argparse-1.0.10.tgz", - "integrity": "sha512-o5Roy6tNG4SL/FOkCAN6RzjiakZS25RLYFrcMttJqbdd8BWrnA+fGz57iN5Pb06pvBGvl5gQ0B48dJlslXvoTg==", - "dev": true, - "license": "MIT", - "dependencies": { - "sprintf-js": "~1.0.2" - } - }, - "node_modules/gray-matter/node_modules/js-yaml": { - "version": "3.14.2", - "resolved": "https://registry.npmjs.org/js-yaml/-/js-yaml-3.14.2.tgz", - "integrity": "sha512-PMSmkqxr106Xa156c2M265Z+FTrPl+oxd/rgOQy2tijQeK5TxQ43psO1ZCwhVOSdnn+RzkzlRz/eY4BgJBYVpg==", - "dev": true, - "license": "MIT", - "dependencies": { - "argparse": "^1.0.7", - "esprima": "^4.0.0" - }, - "bin": { - "js-yaml": "bin/js-yaml.js" - } - }, - "node_modules/gzip-size": { - "version": "6.0.0", - "resolved": "https://registry.npmjs.org/gzip-size/-/gzip-size-6.0.0.tgz", - "integrity": "sha512-ax7ZYomf6jqPTQ4+XCpUGyXKHk5WweS+e05MBO4/y3WJ5RkmPXNKvX+bx1behVILVwr6JSQvZAku021CHPXG3Q==", - "dev": true, - "license": "MIT", - "dependencies": { - "duplexer": "^0.1.2" - }, - "engines": { - "node": ">=10" - }, - "funding": { - "url": "https://github.com/sponsors/sindresorhus" - } - }, - "node_modules/handle-thing": { - "version": "2.0.1", - "resolved": "https://registry.npmjs.org/handle-thing/-/handle-thing-2.0.1.tgz", - "integrity": "sha512-9Qn4yBxelxoh2Ow62nP+Ka/kMnOXRi8BXnRaUwezLNhqelnN49xKz4F/dPP8OYLxLxq6JDtZb2i9XznUQbNPTg==", - "dev": true, - "license": "MIT" - }, "node_modules/has-flag": { "version": "4.0.0", "resolved": "https://registry.npmjs.org/has-flag/-/has-flag-4.0.0.tgz", @@ -13033,56 +7772,58 @@ "node": ">=8" } }, - "node_modules/has-property-descriptors": { - "version": "1.0.2", - "resolved": "https://registry.npmjs.org/has-property-descriptors/-/has-property-descriptors-1.0.2.tgz", - "integrity": "sha512-55JNKuIW+vq4Ke1BjOTjM2YctQIvCT7GFzHwmfZPGo5wnrgkid0YQtnAleFSqumZm4az3n2BS+erby5ipJdgrg==", - "dev": true, - "license": "MIT", - "dependencies": { - "es-define-property": "^1.0.0" - }, - "funding": { - "url": "https://github.com/sponsors/ljharb" - } - }, - "node_modules/has-symbols": { - "version": "1.1.0", - "resolved": "https://registry.npmjs.org/has-symbols/-/has-symbols-1.1.0.tgz", - "integrity": "sha512-1cDNdwJ2Jaohmb3sg4OmKaMBwuC48sYni5HUw2DvsC8LjGTLK9h+eb1X6RyuOHe4hT0ULCW68iomhjUoKUqlPQ==", - "dev": true, - "license": "MIT", - "engines": { - "node": ">= 0.4" - }, - "funding": { - "url": "https://github.com/sponsors/ljharb" - } - }, - "node_modules/has-yarn": { + "node_modules/hast-util-embedded": { "version": "3.0.0", - "resolved": "https://registry.npmjs.org/has-yarn/-/has-yarn-3.0.0.tgz", - "integrity": "sha512-IrsVwUHhEULx3R8f/aA8AHuEzAorplsab/v8HBzEiIukwq5i/EC+xmOW+HfP1OaDP+2JkgT1yILHN2O3UFIbcA==", - "dev": true, - "license": "MIT", - "engines": { - "node": "^12.20.0 || ^14.13.1 || >=16.0.0" - }, - "funding": { - "url": "https://github.com/sponsors/sindresorhus" - } - }, - "node_modules/hasown": { - "version": "2.0.2", - "resolved": "https://registry.npmjs.org/hasown/-/hasown-2.0.2.tgz", - "integrity": "sha512-0hJU9SCPvmMzIBdZFqNPXWa6dqh7WdH0cII9y+CyS8rG3nL48Bclra9HmKhVVUHyPWNH5Y7xDwAB7bfgSjkUMQ==", + "resolved": "https://registry.npmjs.org/hast-util-embedded/-/hast-util-embedded-3.0.0.tgz", + "integrity": "sha512-naH8sld4Pe2ep03qqULEtvYr7EjrLK2QHY8KJR6RJkTUjPGObe1vnx585uzem2hGra+s1q08DZZpfgDVYRbaXA==", "dev": true, "license": "MIT", "dependencies": { - "function-bind": "^1.1.2" + "@types/hast": "^3.0.0", + "hast-util-is-element": "^3.0.0" }, - "engines": { - "node": ">= 0.4" + "funding": { + "type": "opencollective", + "url": "https://opencollective.com/unified" + } + }, + "node_modules/hast-util-format": { + "version": "1.1.0", + "resolved": "https://registry.npmjs.org/hast-util-format/-/hast-util-format-1.1.0.tgz", + "integrity": "sha512-yY1UDz6bC9rDvCWHpx12aIBGRG7krurX0p0Fm6pT547LwDIZZiNr8a+IHDogorAdreULSEzP82Nlv5SZkHZcjA==", + "dev": true, + "license": "MIT", + "dependencies": { + "@types/hast": "^3.0.0", + "hast-util-embedded": "^3.0.0", + "hast-util-minify-whitespace": "^1.0.0", + "hast-util-phrasing": "^3.0.0", + "hast-util-whitespace": "^3.0.0", + "html-whitespace-sensitive-tag-names": "^3.0.0", + "unist-util-visit-parents": "^6.0.0" + }, + "funding": { + "type": "opencollective", + "url": "https://opencollective.com/unified" + } + }, + "node_modules/hast-util-from-html": { + "version": "2.0.3", + "resolved": "https://registry.npmjs.org/hast-util-from-html/-/hast-util-from-html-2.0.3.tgz", + "integrity": "sha512-CUSRHXyKjzHov8yKsQjGOElXy/3EKpyX56ELnkHH34vDVw1N1XSQ1ZcAvTyAPtGqLTuKP/uxM+aLkSPqF/EtMw==", + "dev": true, + "license": "MIT", + "dependencies": { + "@types/hast": "^3.0.0", + "devlop": "^1.1.0", + "hast-util-from-parse5": "^8.0.0", + "parse5": "^7.0.0", + "vfile": "^6.0.0", + "vfile-message": "^4.0.0" + }, + "funding": { + "type": "opencollective", + "url": "https://opencollective.com/unified" } }, "node_modules/hast-util-from-parse5": { @@ -13106,6 +7847,66 @@ "url": "https://opencollective.com/unified" } }, + "node_modules/hast-util-has-property": { + "version": "3.0.0", + "resolved": "https://registry.npmjs.org/hast-util-has-property/-/hast-util-has-property-3.0.0.tgz", + "integrity": "sha512-MNilsvEKLFpV604hwfhVStK0usFY/QmM5zX16bo7EjnAEGofr5YyI37kzopBlZJkHD4t887i+q/C8/tr5Q94cA==", + "dev": true, + "license": "MIT", + "dependencies": { + "@types/hast": "^3.0.0" + }, + "funding": { + "type": "opencollective", + "url": "https://opencollective.com/unified" + } + }, + "node_modules/hast-util-is-body-ok-link": { + "version": "3.0.1", + "resolved": "https://registry.npmjs.org/hast-util-is-body-ok-link/-/hast-util-is-body-ok-link-3.0.1.tgz", + "integrity": "sha512-0qpnzOBLztXHbHQenVB8uNuxTnm/QBFUOmdOSsEn7GnBtyY07+ENTWVFBAnXd/zEgd9/SUG3lRY7hSIBWRgGpQ==", + "dev": true, + "license": "MIT", + "dependencies": { + "@types/hast": "^3.0.0" + }, + "funding": { + "type": "opencollective", + "url": "https://opencollective.com/unified" + } + }, + "node_modules/hast-util-is-element": { + "version": "3.0.0", + "resolved": "https://registry.npmjs.org/hast-util-is-element/-/hast-util-is-element-3.0.0.tgz", + "integrity": "sha512-Val9mnv2IWpLbNPqc/pUem+a7Ipj2aHacCwgNfTiK0vJKl0LF+4Ba4+v1oPHFpf3bLYmreq0/l3Gud9S5OH42g==", + "dev": true, + "license": "MIT", + "dependencies": { + "@types/hast": "^3.0.0" + }, + "funding": { + "type": "opencollective", + "url": "https://opencollective.com/unified" + } + }, + "node_modules/hast-util-minify-whitespace": { + "version": "1.0.1", + "resolved": "https://registry.npmjs.org/hast-util-minify-whitespace/-/hast-util-minify-whitespace-1.0.1.tgz", + "integrity": "sha512-L96fPOVpnclQE0xzdWb/D12VT5FabA7SnZOUMtL1DbXmYiHJMXZvFkIZfiMmTCNJHUeO2K9UYNXoVyfz+QHuOw==", + "dev": true, + "license": "MIT", + "dependencies": { + "@types/hast": "^3.0.0", + "hast-util-embedded": "^3.0.0", + "hast-util-is-element": "^3.0.0", + "hast-util-whitespace": "^3.0.0", + "unist-util-is": "^6.0.0" + }, + "funding": { + "type": "opencollective", + "url": "https://opencollective.com/unified" + } + }, "node_modules/hast-util-parse-selector": { "version": "4.0.0", "resolved": "https://registry.npmjs.org/hast-util-parse-selector/-/hast-util-parse-selector-4.0.0.tgz", @@ -13120,6 +7921,24 @@ "url": "https://opencollective.com/unified" } }, + "node_modules/hast-util-phrasing": { + "version": "3.0.1", + "resolved": "https://registry.npmjs.org/hast-util-phrasing/-/hast-util-phrasing-3.0.1.tgz", + "integrity": "sha512-6h60VfI3uBQUxHqTyMymMZnEbNl1XmEGtOxxKYL7stY2o601COo62AWAYBQR9lZbYXYSBoxag8UpPRXK+9fqSQ==", + "dev": true, + "license": "MIT", + "dependencies": { + "@types/hast": "^3.0.0", + "hast-util-embedded": "^3.0.0", + "hast-util-has-property": "^3.0.0", + "hast-util-is-body-ok-link": "^3.0.0", + "hast-util-is-element": "^3.0.0" + }, + "funding": { + "type": "opencollective", + "url": "https://opencollective.com/unified" + } + }, "node_modules/hast-util-raw": { "version": "9.1.0", "resolved": "https://registry.npmjs.org/hast-util-raw/-/hast-util-raw-9.1.0.tgz", @@ -13146,6 +7965,34 @@ "url": "https://opencollective.com/unified" } }, + "node_modules/hast-util-select": { + "version": "6.0.4", + "resolved": "https://registry.npmjs.org/hast-util-select/-/hast-util-select-6.0.4.tgz", + "integrity": "sha512-RqGS1ZgI0MwxLaKLDxjprynNzINEkRHY2i8ln4DDjgv9ZhcYVIHN9rlpiYsqtFwrgpYU361SyWDQcGNIBVu3lw==", + "dev": true, + "license": "MIT", + "dependencies": { + "@types/hast": "^3.0.0", + "@types/unist": "^3.0.0", + "bcp-47-match": "^2.0.0", + "comma-separated-tokens": "^2.0.0", + "css-selector-parser": "^3.0.0", + "devlop": "^1.0.0", + "direction": "^2.0.0", + "hast-util-has-property": "^3.0.0", + "hast-util-to-string": "^3.0.0", + "hast-util-whitespace": "^3.0.0", + "nth-check": "^2.0.0", + "property-information": "^7.0.0", + "space-separated-tokens": "^2.0.0", + "unist-util-visit": "^5.0.0", + "zwitch": "^2.0.0" + }, + "funding": { + "type": "opencollective", + "url": "https://opencollective.com/unified" + } + }, "node_modules/hast-util-to-estree": { "version": "3.1.3", "resolved": "https://registry.npmjs.org/hast-util-to-estree/-/hast-util-to-estree-3.1.3.tgz", @@ -13175,6 +8022,30 @@ "url": "https://opencollective.com/unified" } }, + "node_modules/hast-util-to-html": { + "version": "9.0.5", + "resolved": "https://registry.npmjs.org/hast-util-to-html/-/hast-util-to-html-9.0.5.tgz", + "integrity": "sha512-OguPdidb+fbHQSU4Q4ZiLKnzWo8Wwsf5bZfbvu7//a9oTYoqD/fWpe96NuHkoS9h0ccGOTe0C4NGXdtS0iObOw==", + "dev": true, + "license": "MIT", + "dependencies": { + "@types/hast": "^3.0.0", + "@types/unist": "^3.0.0", + "ccount": "^2.0.0", + "comma-separated-tokens": "^2.0.0", + "hast-util-whitespace": "^3.0.0", + "html-void-elements": "^3.0.0", + "mdast-util-to-hast": "^13.0.0", + "property-information": "^7.0.0", + "space-separated-tokens": "^2.0.0", + "stringify-entities": "^4.0.0", + "zwitch": "^2.0.4" + }, + "funding": { + "type": "opencollective", + "url": "https://opencollective.com/unified" + } + }, "node_modules/hast-util-to-jsx-runtime": { "version": "2.3.6", "resolved": "https://registry.npmjs.org/hast-util-to-jsx-runtime/-/hast-util-to-jsx-runtime-2.3.6.tgz", @@ -13223,6 +8094,37 @@ "url": "https://opencollective.com/unified" } }, + "node_modules/hast-util-to-string": { + "version": "3.0.1", + "resolved": "https://registry.npmjs.org/hast-util-to-string/-/hast-util-to-string-3.0.1.tgz", + "integrity": "sha512-XelQVTDWvqcl3axRfI0xSeoVKzyIFPwsAGSLIsKdJKQMXDYJS4WYrBNF/8J7RdhIcFI2BOHgAifggsvsxp/3+A==", + "dev": true, + "license": "MIT", + "dependencies": { + "@types/hast": "^3.0.0" + }, + "funding": { + "type": "opencollective", + "url": "https://opencollective.com/unified" + } + }, + "node_modules/hast-util-to-text": { + "version": "4.0.2", + "resolved": "https://registry.npmjs.org/hast-util-to-text/-/hast-util-to-text-4.0.2.tgz", + "integrity": "sha512-KK6y/BN8lbaq654j7JgBydev7wuNMcID54lkRav1P0CaE1e47P72AWWPiGKXTJU271ooYzcvTAn/Zt0REnvc7A==", + "dev": true, + "license": "MIT", + "dependencies": { + "@types/hast": "^3.0.0", + "@types/unist": "^3.0.0", + "hast-util-is-element": "^3.0.0", + "unist-util-find-after": "^5.0.0" + }, + "funding": { + "type": "opencollective", + "url": "https://opencollective.com/unified" + } + }, "node_modules/hast-util-whitespace": { "version": "3.0.0", "resolved": "https://registry.npmjs.org/hast-util-whitespace/-/hast-util-whitespace-3.0.0.tgz", @@ -13255,153 +8157,13 @@ "url": "https://opencollective.com/unified" } }, - "node_modules/he": { - "version": "1.2.0", - "resolved": "https://registry.npmjs.org/he/-/he-1.2.0.tgz", - "integrity": "sha512-F/1DnUGPopORZi0ni+CvrCgHQ5FyEAHRLSApuYWMmrbSwoN2Mn/7k+Gl38gJnR7yyDZk6WLXwiGod1JOWNDKGw==", - "dev": true, - "license": "MIT", - "bin": { - "he": "bin/he" - } - }, - "node_modules/history": { - "version": "4.10.1", - "resolved": "https://registry.npmjs.org/history/-/history-4.10.1.tgz", - "integrity": "sha512-36nwAD620w12kuzPAsyINPWJqlNbij+hpK1k9XRloDtym8mxzGYl2c17LnV6IAGB2Dmg4tEa7G7DlawS0+qjew==", - "dev": true, - "license": "MIT", - "dependencies": { - "@babel/runtime": "^7.1.2", - "loose-envify": "^1.2.0", - "resolve-pathname": "^3.0.0", - "tiny-invariant": "^1.0.2", - "tiny-warning": "^1.0.0", - "value-equal": "^1.0.1" - } - }, - "node_modules/hoist-non-react-statics": { - "version": "3.3.2", - "resolved": "https://registry.npmjs.org/hoist-non-react-statics/-/hoist-non-react-statics-3.3.2.tgz", - "integrity": "sha512-/gGivxi8JPKWNm/W0jSmzcMPpfpPLc3dY/6GxhX2hQ9iGj3aDfklV4ET7NjKpSinLpJ5vafa9iiGIEZg10SfBw==", - "dev": true, - "license": "BSD-3-Clause", - "dependencies": { - "react-is": "^16.7.0" - } - }, - "node_modules/hoist-non-react-statics/node_modules/react-is": { - "version": "16.13.1", - "resolved": "https://registry.npmjs.org/react-is/-/react-is-16.13.1.tgz", - "integrity": "sha512-24e6ynE2H+OKt4kqsOvNd8kBpV65zoxbA4BVsEOB3ARVWQki/DHzaUoC5KuON/BiccDaCCTZBuOcfZs70kR8bQ==", - "dev": true, - "license": "MIT" - }, - "node_modules/hpack.js": { - "version": "2.1.6", - "resolved": "https://registry.npmjs.org/hpack.js/-/hpack.js-2.1.6.tgz", - "integrity": "sha512-zJxVehUdMGIKsRaNt7apO2Gqp0BdqW5yaiGHXXmbpvxgBYVZnAql+BJb4RO5ad2MgpbZKn5G6nMnegrH1FcNYQ==", - "dev": true, - "license": "MIT", - "dependencies": { - "inherits": "^2.0.1", - "obuf": "^1.0.0", - "readable-stream": "^2.0.1", - "wbuf": "^1.1.0" - } - }, - "node_modules/hpack.js/node_modules/isarray": { - "version": "1.0.0", - "resolved": "https://registry.npmjs.org/isarray/-/isarray-1.0.0.tgz", - "integrity": "sha512-VLghIWNM6ELQzo7zwmcg0NmTVyWKYjvIeM83yjp0wRDTmUnrM678fQbcKBo6n2CJEF0szoG//ytg+TKla89ALQ==", - "dev": true, - "license": "MIT" - }, - "node_modules/hpack.js/node_modules/readable-stream": { - "version": "2.3.8", - "resolved": "https://registry.npmjs.org/readable-stream/-/readable-stream-2.3.8.tgz", - "integrity": "sha512-8p0AUk4XODgIewSi0l8Epjs+EVnWiK7NoDIEGU0HhE7+ZyY8D1IMY7odu5lRrFXGg71L15KG8QrPmum45RTtdA==", - "dev": true, - "license": "MIT", - "dependencies": { - "core-util-is": "~1.0.0", - "inherits": "~2.0.3", - "isarray": "~1.0.0", - "process-nextick-args": "~2.0.0", - "safe-buffer": "~5.1.1", - "string_decoder": "~1.1.1", - "util-deprecate": "~1.0.1" - } - }, - "node_modules/hpack.js/node_modules/safe-buffer": { - "version": "5.1.2", - "resolved": "https://registry.npmjs.org/safe-buffer/-/safe-buffer-5.1.2.tgz", - "integrity": "sha512-Gd2UZBJDkXlY7GbJxfsE8/nvKkUEU1G38c1siN6QP6a9PT9MmHB8GnpscSmMJSoF8LOIrt8ud/wPtojys4G6+g==", - "dev": true, - "license": "MIT" - }, - "node_modules/hpack.js/node_modules/string_decoder": { - "version": "1.1.1", - "resolved": "https://registry.npmjs.org/string_decoder/-/string_decoder-1.1.1.tgz", - "integrity": "sha512-n/ShnvDi6FHbbVfviro+WojiFzv+s8MPMHBczVePfUpDJLwoLT0ht1l4YwBCbi8pJAveEEdnkHyPyTP/mzRfwg==", - "dev": true, - "license": "MIT", - "dependencies": { - "safe-buffer": "~5.1.0" - } - }, "node_modules/html-escaper": { - "version": "2.0.2", - "resolved": "https://registry.npmjs.org/html-escaper/-/html-escaper-2.0.2.tgz", - "integrity": "sha512-H2iMtd0I4Mt5eYiapRdIDjp+XzelXQ0tFE4JS7YFwFevXXMmOp9myNrUvCg0D6ws8iqkRPBfKHgbwig1SmlLfg==", + "version": "3.0.3", + "resolved": "https://registry.npmjs.org/html-escaper/-/html-escaper-3.0.3.tgz", + "integrity": "sha512-RuMffC89BOWQoY0WKGpIhn5gX3iI54O6nRA0yC124NYVtzjmFWBIiFd8M0x+ZdX0P9R4lADg1mgP8C7PxGOWuQ==", "dev": true, "license": "MIT" }, - "node_modules/html-minifier-terser": { - "version": "7.2.0", - "resolved": "https://registry.npmjs.org/html-minifier-terser/-/html-minifier-terser-7.2.0.tgz", - "integrity": "sha512-tXgn3QfqPIpGl9o+K5tpcj3/MN4SfLtsx2GWwBC3SSd0tXQGyF3gsSqad8loJgKZGM3ZxbYDd5yhiBIdWpmvLA==", - "dev": true, - "license": "MIT", - "dependencies": { - "camel-case": "^4.1.2", - "clean-css": "~5.3.2", - "commander": "^10.0.0", - "entities": "^4.4.0", - "param-case": "^3.0.4", - "relateurl": "^0.2.7", - "terser": "^5.15.1" - }, - "bin": { - "html-minifier-terser": "cli.js" - }, - "engines": { - "node": "^14.13.1 || >=16.0.0" - } - }, - "node_modules/html-minifier-terser/node_modules/commander": { - "version": "10.0.1", - "resolved": "https://registry.npmjs.org/commander/-/commander-10.0.1.tgz", - "integrity": "sha512-y4Mg2tXshplEbSGzx7amzPwKKOCGuoSRP/CjEdwwk0FOGlUbq6lKuoyDZTNZkmxHdJtp54hdfY/JUrdL7Xfdug==", - "dev": true, - "license": "MIT", - "engines": { - "node": ">=14" - } - }, - "node_modules/html-tags": { - "version": "3.3.1", - "resolved": "https://registry.npmjs.org/html-tags/-/html-tags-3.3.1.tgz", - "integrity": "sha512-ztqyC3kLto0e9WbNp0aeP+M3kTt+nbaIveGmUxAtZa+8iFgKLUOD4YKM5j+f3QD89bra7UeumolZHKuOXnTmeQ==", - "dev": true, - "license": "MIT", - "engines": { - "node": ">=8" - }, - "funding": { - "url": "https://github.com/sponsors/sindresorhus" - } - }, "node_modules/html-void-elements": { "version": "3.0.0", "resolved": "https://registry.npmjs.org/html-void-elements/-/html-void-elements-3.0.0.tgz", @@ -13413,89 +8175,15 @@ "url": "https://github.com/sponsors/wooorm" } }, - "node_modules/html-webpack-plugin": { - "version": "5.6.5", - "resolved": "https://registry.npmjs.org/html-webpack-plugin/-/html-webpack-plugin-5.6.5.tgz", - "integrity": "sha512-4xynFbKNNk+WlzXeQQ+6YYsH2g7mpfPszQZUi3ovKlj+pDmngQ7vRXjrrmGROabmKwyQkcgcX5hqfOwHbFmK5g==", + "node_modules/html-whitespace-sensitive-tag-names": { + "version": "3.0.1", + "resolved": "https://registry.npmjs.org/html-whitespace-sensitive-tag-names/-/html-whitespace-sensitive-tag-names-3.0.1.tgz", + "integrity": "sha512-q+310vW8zmymYHALr1da4HyXUQ0zgiIwIicEfotYPWGN0OJVEN/58IJ3A4GBYcEq3LGAZqKb+ugvP0GNB9CEAA==", "dev": true, "license": "MIT", - "dependencies": { - "@types/html-minifier-terser": "^6.0.0", - "html-minifier-terser": "^6.0.2", - "lodash": "^4.17.21", - "pretty-error": "^4.0.0", - "tapable": "^2.0.0" - }, - "engines": { - "node": ">=10.13.0" - }, "funding": { "type": "opencollective", - "url": "https://opencollective.com/html-webpack-plugin" - }, - "peerDependencies": { - "@rspack/core": "0.x || 1.x", - "webpack": "^5.20.0" - }, - "peerDependenciesMeta": { - "@rspack/core": { - "optional": true - }, - "webpack": { - "optional": true - } - } - }, - "node_modules/html-webpack-plugin/node_modules/commander": { - "version": "8.3.0", - "resolved": "https://registry.npmjs.org/commander/-/commander-8.3.0.tgz", - "integrity": "sha512-OkTL9umf+He2DZkUq8f8J9of7yL6RJKI24dVITBmNfZBmri9zYZQrKkuXiKhyfPSu8tUhnVBB1iKXevvnlR4Ww==", - "dev": true, - "license": "MIT", - "engines": { - "node": ">= 12" - } - }, - "node_modules/html-webpack-plugin/node_modules/html-minifier-terser": { - "version": "6.1.0", - "resolved": "https://registry.npmjs.org/html-minifier-terser/-/html-minifier-terser-6.1.0.tgz", - "integrity": "sha512-YXxSlJBZTP7RS3tWnQw74ooKa6L9b9i9QYXY21eUEvhZ3u9XLfv6OnFsQq6RxkhHygsaUMvYsZRV5rU/OVNZxw==", - "dev": true, - "license": "MIT", - "dependencies": { - "camel-case": "^4.1.2", - "clean-css": "^5.2.2", - "commander": "^8.3.0", - "he": "^1.2.0", - "param-case": "^3.0.4", - "relateurl": "^0.2.7", - "terser": "^5.10.0" - }, - "bin": { - "html-minifier-terser": "cli.js" - }, - "engines": { - "node": ">=12" - } - }, - "node_modules/htmlparser2": { - "version": "8.0.2", - "resolved": "https://registry.npmjs.org/htmlparser2/-/htmlparser2-8.0.2.tgz", - "integrity": "sha512-GYdjWKDkbRLkZ5geuHs5NY1puJ+PXwP7+fHPRz06Eirsb9ugf6d8kkXav6ADhcODhFFPMIXyxkxSuMf3D6NCFA==", - "dev": true, - "funding": [ - "https://github.com/fb55/htmlparser2?sponsor=1", - { - "type": "github", - "url": "https://github.com/sponsors/fb55" - } - ], - "license": "MIT", - "dependencies": { - "domelementtype": "^2.3.0", - "domhandler": "^5.0.3", - "domutils": "^3.0.1", - "entities": "^4.4.0" + "url": "https://opencollective.com/unified" } }, "node_modules/http-cache-semantics": { @@ -13505,115 +8193,6 @@ "dev": true, "license": "BSD-2-Clause" }, - "node_modules/http-deceiver": { - "version": "1.2.7", - "resolved": "https://registry.npmjs.org/http-deceiver/-/http-deceiver-1.2.7.tgz", - "integrity": "sha512-LmpOGxTfbpgtGVxJrj5k7asXHCgNZp5nLfp+hWc8QQRqtb7fUy6kRY3BO1h9ddF6yIPYUARgxGOwB42DnxIaNw==", - "dev": true, - "license": "MIT" - }, - "node_modules/http-errors": { - "version": "2.0.1", - "resolved": "https://registry.npmjs.org/http-errors/-/http-errors-2.0.1.tgz", - "integrity": "sha512-4FbRdAX+bSdmo4AUFuS0WNiPz8NgFt+r8ThgNWmlrjQjt1Q7ZR9+zTlce2859x4KSXrwIsaeTqDoKQmtP8pLmQ==", - "dev": true, - "license": "MIT", - "dependencies": { - "depd": "~2.0.0", - "inherits": "~2.0.4", - "setprototypeof": "~1.2.0", - "statuses": "~2.0.2", - "toidentifier": "~1.0.1" - }, - "engines": { - "node": ">= 0.8" - }, - "funding": { - "type": "opencollective", - "url": "https://opencollective.com/express" - } - }, - "node_modules/http-parser-js": { - "version": "0.5.10", - "resolved": "https://registry.npmjs.org/http-parser-js/-/http-parser-js-0.5.10.tgz", - "integrity": "sha512-Pysuw9XpUq5dVc/2SMHpuTY01RFl8fttgcyunjL7eEMhGM3cI4eOmiCycJDVCo/7O7ClfQD3SaI6ftDzqOXYMA==", - "dev": true, - "license": "MIT" - }, - "node_modules/http-proxy": { - "version": "1.18.1", - "resolved": "https://registry.npmjs.org/http-proxy/-/http-proxy-1.18.1.tgz", - "integrity": "sha512-7mz/721AbnJwIVbnaSv1Cz3Am0ZLT/UBwkC92VlxhXv/k/BBQfM2fXElQNC27BVGr0uwUpplYPQM9LnaBMR5NQ==", - "dev": true, - "license": "MIT", - "dependencies": { - "eventemitter3": "^4.0.0", - "follow-redirects": "^1.0.0", - "requires-port": "^1.0.0" - }, - "engines": { - "node": ">=8.0.0" - } - }, - "node_modules/http-proxy-middleware": { - "version": "2.0.9", - "resolved": "https://registry.npmjs.org/http-proxy-middleware/-/http-proxy-middleware-2.0.9.tgz", - "integrity": "sha512-c1IyJYLYppU574+YI7R4QyX2ystMtVXZwIdzazUIPIJsHuWNd+mho2j+bKoHftndicGj9yh+xjd+l0yj7VeT1Q==", - "dev": true, - "license": "MIT", - "dependencies": { - "@types/http-proxy": "^1.17.8", - "http-proxy": "^1.18.1", - "is-glob": "^4.0.1", - "is-plain-obj": "^3.0.0", - "micromatch": "^4.0.2" - }, - "engines": { - "node": ">=12.0.0" - }, - "peerDependencies": { - "@types/express": "^4.17.13" - }, - "peerDependenciesMeta": { - "@types/express": { - "optional": true - } - } - }, - "node_modules/http-proxy-middleware/node_modules/is-plain-obj": { - "version": "3.0.0", - "resolved": "https://registry.npmjs.org/is-plain-obj/-/is-plain-obj-3.0.0.tgz", - "integrity": "sha512-gwsOE28k+23GP1B6vFl1oVh/WOzmawBrKwo5Ev6wMKzPkaXaCDIQKzLnvsA42DRlbVTWorkgTKIviAKCWkfUwA==", - "dev": true, - "license": "MIT", - "engines": { - "node": ">=10" - }, - "funding": { - "url": "https://github.com/sponsors/sindresorhus" - } - }, - "node_modules/http-proxy/node_modules/eventemitter3": { - "version": "4.0.7", - "resolved": "https://registry.npmjs.org/eventemitter3/-/eventemitter3-4.0.7.tgz", - "integrity": "sha512-8guHBZCwKnFhYdHr2ysuRWErTwhoN2X8XELRlrRwpmfeY2jjuUN4taQMsULKUVo1K4DvZl+0pgfyoysHxvmvEw==", - "dev": true, - "license": "MIT" - }, - "node_modules/http2-wrapper": { - "version": "2.2.1", - "resolved": "https://registry.npmjs.org/http2-wrapper/-/http2-wrapper-2.2.1.tgz", - "integrity": "sha512-V5nVw1PAOgfI3Lmeaj2Exmeg7fenjhRUgz1lPSezy1CuhPYbgQtbQj4jZfEAEMlaL+vupsvhjqCyjzob0yxsmQ==", - "dev": true, - "license": "MIT", - "dependencies": { - "quick-lru": "^5.1.1", - "resolve-alpn": "^1.2.0" - }, - "engines": { - "node": ">=10.19.0" - } - }, "node_modules/human-signals": { "version": "2.1.0", "resolved": "https://registry.npmjs.org/human-signals/-/human-signals-2.1.0.tgz", @@ -13640,39 +8219,28 @@ "url": "https://github.com/sponsors/typicode" } }, - "node_modules/hyperdyperid": { - "version": "1.2.0", - "resolved": "https://registry.npmjs.org/hyperdyperid/-/hyperdyperid-1.2.0.tgz", - "integrity": "sha512-Y93lCzHYgGWdrJ66yIktxiaGULYc6oGiABxhcO5AufBeOyoIdZF7bIfLaOrbM0iGIOXQQgxxRrFEnb+Y6w1n4A==", + "node_modules/i18next": { + "version": "23.16.8", + "resolved": "https://registry.npmjs.org/i18next/-/i18next-23.16.8.tgz", + "integrity": "sha512-06r/TitrM88Mg5FdUXAKL96dJMzgqLE5dv3ryBAra4KCwD9mJ4ndOTS95ZuymIGoE+2hzfdaMak2X11/es7ZWg==", "dev": true, - "license": "MIT", - "engines": { - "node": ">=10.18" - } - }, - "node_modules/iconv-lite": { - "version": "0.6.3", - "resolved": "https://registry.npmjs.org/iconv-lite/-/iconv-lite-0.6.3.tgz", - "integrity": "sha512-4fCk79wshMdzMp2rH06qWrJE4iolqLhCUH+OiuIgU++RB0+94NlDL81atO7GX55uUKueo0txHNtvEyI6D7WdMw==", + "funding": [ + { + "type": "individual", + "url": "https://locize.com" + }, + { + "type": "individual", + "url": "https://locize.com/i18next.html" + }, + { + "type": "individual", + "url": "https://www.i18next.com/how-to/faq#i18next-is-awesome.-how-can-i-support-the-project" + } + ], "license": "MIT", "dependencies": { - "safer-buffer": ">= 2.1.2 < 3.0.0" - }, - "engines": { - "node": ">=0.10.0" - } - }, - "node_modules/icss-utils": { - "version": "5.1.0", - "resolved": "https://registry.npmjs.org/icss-utils/-/icss-utils-5.1.0.tgz", - "integrity": "sha512-soFhflCVWLfRNOPU3iv5Z9VUdT44xFRbzjLsEzSr5AQmgqPMTHdU3PMT1Cf1ssx8fLNJDA1juftYl+PUcv3MqA==", - "dev": true, - "license": "ISC", - "engines": { - "node": "^10 || ^12 || >= 14" - }, - "peerDependencies": { - "postcss": "^8.1.0" + "@babel/runtime": "^7.23.2" } }, "node_modules/ieee754": { @@ -13704,19 +8272,6 @@ "node": ">= 4" } }, - "node_modules/image-size": { - "version": "2.0.2", - "resolved": "https://registry.npmjs.org/image-size/-/image-size-2.0.2.tgz", - "integrity": "sha512-IRqXKlaXwgSMAMtpNzZa1ZAe8m+Sa1770Dhk8VkSsP9LS+iHD62Zd8FQKs8fbPiagBE7BzoFX23cxFnwshpV6w==", - "dev": true, - "license": "MIT", - "bin": { - "image-size": "bin/image-size.js" - }, - "engines": { - "node": ">=16.x" - } - }, "node_modules/import-fresh": { "version": "3.3.1", "resolved": "https://registry.npmjs.org/import-fresh/-/import-fresh-3.3.1.tgz", @@ -13734,16 +8289,6 @@ "url": "https://github.com/sponsors/sindresorhus" } }, - "node_modules/import-lazy": { - "version": "4.0.0", - "resolved": "https://registry.npmjs.org/import-lazy/-/import-lazy-4.0.0.tgz", - "integrity": "sha512-rKtvo6a868b5Hu3heneU+L4yEQ4jYKLtjpnPeUdK7h0yzXGmyBTypknlkCvHFBqfX9YlorEiMM6Dnq/5atfHkw==", - "dev": true, - "license": "MIT", - "engines": { - "node": ">=8" - } - }, "node_modules/import-local": { "version": "3.2.0", "resolved": "https://registry.npmjs.org/import-local/-/import-local-3.2.0.tgz", @@ -13764,6 +8309,17 @@ "url": "https://github.com/sponsors/sindresorhus" } }, + "node_modules/import-meta-resolve": { + "version": "4.2.0", + "resolved": "https://registry.npmjs.org/import-meta-resolve/-/import-meta-resolve-4.2.0.tgz", + "integrity": "sha512-Iqv2fzaTQN28s/FwZAoFq0ZSs/7hMAHJVX+w8PZl3cY19Pxk6jFFalxQoIfW2826i/fDLXv8IiEZRIT0lDuWcg==", + "dev": true, + "license": "MIT", + "funding": { + "type": "github", + "url": "https://github.com/sponsors/wooorm" + } + }, "node_modules/imurmurhash": { "version": "0.1.4", "resolved": "https://registry.npmjs.org/imurmurhash/-/imurmurhash-0.1.4.tgz", @@ -13787,16 +8343,6 @@ "url": "https://github.com/sponsors/sindresorhus" } }, - "node_modules/infima": { - "version": "0.2.0-alpha.45", - "resolved": "https://registry.npmjs.org/infima/-/infima-0.2.0-alpha.45.tgz", - "integrity": "sha512-uyH0zfr1erU1OohLk0fT4Rrb94AOhguWNOcD9uGrSpRvNB+6gZXUoJX5J0NtvzBO10YZ9PgvA4NFgt+fYg8ojw==", - "dev": true, - "license": "MIT", - "engines": { - "node": ">=12" - } - }, "node_modules/inflight": { "version": "1.0.6", "resolved": "https://registry.npmjs.org/inflight/-/inflight-1.0.6.tgz", @@ -13832,64 +8378,14 @@ "dev": true, "license": "MIT" }, - "node_modules/inquirer": { - "version": "8.2.7", - "resolved": "https://registry.npmjs.org/inquirer/-/inquirer-8.2.7.tgz", - "integrity": "sha512-UjOaSel/iddGZJ5xP/Eixh6dY1XghiBw4XK13rCCIJcJfyhhoul/7KhLLUGtebEj6GDYM6Vnx/mVsjx2L/mFIA==", - "license": "MIT", - "dependencies": { - "@inquirer/external-editor": "^1.0.0", - "ansi-escapes": "^4.2.1", - "chalk": "^4.1.1", - "cli-cursor": "^3.1.0", - "cli-width": "^3.0.0", - "figures": "^3.0.0", - "lodash": "^4.17.21", - "mute-stream": "0.0.8", - "ora": "^5.4.1", - "run-async": "^2.4.0", - "rxjs": "^7.5.5", - "string-width": "^4.1.0", - "strip-ansi": "^6.0.0", - "through": "^2.3.6", - "wrap-ansi": "^6.0.1" - }, - "engines": { - "node": ">=12.0.0" - } - }, - "node_modules/inquirer/node_modules/wrap-ansi": { - "version": "6.2.0", - "resolved": "https://registry.npmjs.org/wrap-ansi/-/wrap-ansi-6.2.0.tgz", - "integrity": "sha512-r6lPcBGxZXlIcymEu7InxDMhdW0KDxpLgoFLcguasxCaJ/SOIZwINatK9KY/tf+ZrlywOKU0UDj3ATXUBfxJXA==", - "license": "MIT", - "dependencies": { - "ansi-styles": "^4.0.0", - "string-width": "^4.1.0", - "strip-ansi": "^6.0.0" - }, - "engines": { - "node": ">=8" - } - }, - "node_modules/invariant": { - "version": "2.2.4", - "resolved": "https://registry.npmjs.org/invariant/-/invariant-2.2.4.tgz", - "integrity": "sha512-phJfQVBuaJM5raOpJjSfkiD6BpbCE4Ns//LaXl6wGYtUBY83nWS6Rf9tXm2e8VaK60JEjYldbPif/A2B1C2gNA==", + "node_modules/iron-webcrypto": { + "version": "1.2.1", + "resolved": "https://registry.npmjs.org/iron-webcrypto/-/iron-webcrypto-1.2.1.tgz", + "integrity": "sha512-feOM6FaSr6rEABp/eDfVseKyTMDt+KGpeB35SkVn9Tyn0CqvVsY3EwI0v5i8nMHyJnzCIQf7nsy3p41TPkJZhg==", "dev": true, "license": "MIT", - "dependencies": { - "loose-envify": "^1.0.0" - } - }, - "node_modules/ipaddr.js": { - "version": "2.3.0", - "resolved": "https://registry.npmjs.org/ipaddr.js/-/ipaddr.js-2.3.0.tgz", - "integrity": "sha512-Zv/pA+ciVFbCSBBjGfaKUya/CcGmUHzTydLMaTwrUUEM2DIEO3iZvueGxmacvmN50fGpGVKeTXpb2LcYQxeVdg==", - "dev": true, - "license": "MIT", - "engines": { - "node": ">= 10" + "funding": { + "url": "https://github.com/sponsors/brc-dd" } }, "node_modules/is-alphabetical": { @@ -13925,19 +8421,6 @@ "dev": true, "license": "MIT" }, - "node_modules/is-binary-path": { - "version": "2.1.0", - "resolved": "https://registry.npmjs.org/is-binary-path/-/is-binary-path-2.1.0.tgz", - "integrity": "sha512-ZMERYes6pDydyuGidse7OsHxtbI7WVeUEozgR/g7rd0xUimYNlvZRE/K2MgZTjWy725IfelLeVcEM97mmtRGXw==", - "dev": true, - "license": "MIT", - "dependencies": { - "binary-extensions": "^2.0.0" - }, - "engines": { - "node": ">=8" - } - }, "node_modules/is-builtin-module": { "version": "5.0.0", "resolved": "https://registry.npmjs.org/is-builtin-module/-/is-builtin-module-5.0.0.tgz", @@ -13954,51 +8437,6 @@ "url": "https://github.com/sponsors/sindresorhus" } }, - "node_modules/is-ci": { - "version": "3.0.1", - "resolved": "https://registry.npmjs.org/is-ci/-/is-ci-3.0.1.tgz", - "integrity": "sha512-ZYvCgrefwqoQ6yTyYUbQu64HsITZ3NfKX1lzaEYdkTDcfKzzCI/wthRRYKkdjHKFVgNiXKAKm65Zo1pk2as/QQ==", - "dev": true, - "license": "MIT", - "dependencies": { - "ci-info": "^3.2.0" - }, - "bin": { - "is-ci": "bin.js" - } - }, - "node_modules/is-ci/node_modules/ci-info": { - "version": "3.9.0", - "resolved": "https://registry.npmjs.org/ci-info/-/ci-info-3.9.0.tgz", - "integrity": "sha512-NIxF55hv4nSqQswkAeiOi1r83xy8JldOFDTWiug55KBu9Jnblncd2U6ViHmYgHf01TPZS77NJBhBMKdWj9HQMQ==", - "dev": true, - "funding": [ - { - "type": "github", - "url": "https://github.com/sponsors/sibiraj-s" - } - ], - "license": "MIT", - "engines": { - "node": ">=8" - } - }, - "node_modules/is-core-module": { - "version": "2.16.1", - "resolved": "https://registry.npmjs.org/is-core-module/-/is-core-module-2.16.1.tgz", - "integrity": "sha512-UfoeMA6fIJ8wTYFEUjelnaGI67v6+N7qXJEvQuIGa99l4xsCruSYOVSQ0uPANn4dAzm8lkYPaKLrrijLq7x23w==", - "dev": true, - "license": "MIT", - "dependencies": { - "hasown": "^2.0.2" - }, - "engines": { - "node": ">= 0.4" - }, - "funding": { - "url": "https://github.com/sponsors/ljharb" - } - }, "node_modules/is-decimal": { "version": "2.0.1", "resolved": "https://registry.npmjs.org/is-decimal/-/is-decimal-2.0.1.tgz", @@ -14011,31 +8449,21 @@ } }, "node_modules/is-docker": { - "version": "2.2.1", - "resolved": "https://registry.npmjs.org/is-docker/-/is-docker-2.2.1.tgz", - "integrity": "sha512-F+i2BKsFrH66iaUFc0woD8sLy8getkwTwtOBjvs56Cx4CgJDeKQeqfz8wAYiSb8JOprWhHH5p77PbmYCvvUuXQ==", + "version": "3.0.0", + "resolved": "https://registry.npmjs.org/is-docker/-/is-docker-3.0.0.tgz", + "integrity": "sha512-eljcgEDlEns/7AXFosB5K/2nCM4P7FQPkGc/DWLy5rmFEWvZayGrik1d9/QIY5nJ4f9YsVvBkA6kJpHn9rISdQ==", "dev": true, "license": "MIT", "bin": { "is-docker": "cli.js" }, "engines": { - "node": ">=8" + "node": "^12.20.0 || ^14.13.1 || >=16.0.0" }, "funding": { "url": "https://github.com/sponsors/sindresorhus" } }, - "node_modules/is-extendable": { - "version": "0.1.1", - "resolved": "https://registry.npmjs.org/is-extendable/-/is-extendable-0.1.1.tgz", - "integrity": "sha512-5BMULNob1vgFX6EjQw5izWDxrecWK9AM72rugNr0TFldMOi0fj6Jk+zeKIt0xGj4cEfQIJth4w3OKWOJ4f+AFw==", - "dev": true, - "license": "MIT", - "engines": { - "node": ">=0.10.0" - } - }, "node_modules/is-extglob": { "version": "2.1.1", "resolved": "https://registry.npmjs.org/is-extglob/-/is-extglob-2.1.1.tgz", @@ -14047,13 +8475,16 @@ } }, "node_modules/is-fullwidth-code-point": { - "version": "4.0.0", - "resolved": "https://registry.npmjs.org/is-fullwidth-code-point/-/is-fullwidth-code-point-4.0.0.tgz", - "integrity": "sha512-O4L094N2/dZ7xqVdrXhh9r1KODPJpFms8B5sGdJLPy664AgvXsreZUyCQQNItZRDlYug4xStLjNp/sz3HvBowQ==", + "version": "5.1.0", + "resolved": "https://registry.npmjs.org/is-fullwidth-code-point/-/is-fullwidth-code-point-5.1.0.tgz", + "integrity": "sha512-5XHYaSyiqADb4RnZ1Bdad6cPp8Toise4TzEjcOYDHZkTCbKgiUl7WTUCpNWHuxmDt91wnsZBc9xinNzopv3JMQ==", "dev": true, "license": "MIT", + "dependencies": { + "get-east-asian-width": "^1.3.1" + }, "engines": { - "node": ">=12" + "node": ">=18" }, "funding": { "url": "https://github.com/sponsors/sindresorhus" @@ -14112,39 +8543,6 @@ "url": "https://github.com/sponsors/sindresorhus" } }, - "node_modules/is-inside-container/node_modules/is-docker": { - "version": "3.0.0", - "resolved": "https://registry.npmjs.org/is-docker/-/is-docker-3.0.0.tgz", - "integrity": "sha512-eljcgEDlEns/7AXFosB5K/2nCM4P7FQPkGc/DWLy5rmFEWvZayGrik1d9/QIY5nJ4f9YsVvBkA6kJpHn9rISdQ==", - "dev": true, - "license": "MIT", - "bin": { - "is-docker": "cli.js" - }, - "engines": { - "node": "^12.20.0 || ^14.13.1 || >=16.0.0" - }, - "funding": { - "url": "https://github.com/sponsors/sindresorhus" - } - }, - "node_modules/is-installed-globally": { - "version": "0.4.0", - "resolved": "https://registry.npmjs.org/is-installed-globally/-/is-installed-globally-0.4.0.tgz", - "integrity": "sha512-iwGqO3J21aaSkC7jWnHP/difazwS7SFeIqxv6wEtLU8Y5KlzFTjyqcSIT0d8s4+dDhKytsk9PJZ2BkS5eZwQRQ==", - "dev": true, - "license": "MIT", - "dependencies": { - "global-dirs": "^3.0.0", - "is-path-inside": "^3.0.2" - }, - "engines": { - "node": ">=10" - }, - "funding": { - "url": "https://github.com/sponsors/sindresorhus" - } - }, "node_modules/is-interactive": { "version": "1.0.0", "resolved": "https://registry.npmjs.org/is-interactive/-/is-interactive-1.0.0.tgz", @@ -14154,32 +8552,6 @@ "node": ">=8" } }, - "node_modules/is-network-error": { - "version": "1.3.0", - "resolved": "https://registry.npmjs.org/is-network-error/-/is-network-error-1.3.0.tgz", - "integrity": "sha512-6oIwpsgRfnDiyEDLMay/GqCl3HoAtH5+RUKW29gYkL0QA+ipzpDLA16yQs7/RHCSu+BwgbJaOUqa4A99qNVQVw==", - "dev": true, - "license": "MIT", - "engines": { - "node": ">=16" - }, - "funding": { - "url": "https://github.com/sponsors/sindresorhus" - } - }, - "node_modules/is-npm": { - "version": "6.1.0", - "resolved": "https://registry.npmjs.org/is-npm/-/is-npm-6.1.0.tgz", - "integrity": "sha512-O2z4/kNgyjhQwVR1Wpkbfc19JIhggF97NZNCpWTnjH7kVcZMUrnut9XSN7txI7VdyIYk5ZatOq3zvSuWpU8hoA==", - "dev": true, - "license": "MIT", - "engines": { - "node": "^12.20.0 || ^14.13.1 || >=16.0.0" - }, - "funding": { - "url": "https://github.com/sponsors/sindresorhus" - } - }, "node_modules/is-number": { "version": "7.0.0", "resolved": "https://registry.npmjs.org/is-number/-/is-number-7.0.0.tgz", @@ -14190,26 +8562,6 @@ "node": ">=0.12.0" } }, - "node_modules/is-obj": { - "version": "1.0.1", - "resolved": "https://registry.npmjs.org/is-obj/-/is-obj-1.0.1.tgz", - "integrity": "sha512-l4RyHgRqGN4Y3+9JHVrNqO+tN0rV5My76uW5/nuO4K1b6vw5G8d/cmFjP9tRfEsdhZNt0IFdZuK/c2Vr4Nb+Qg==", - "dev": true, - "license": "MIT", - "engines": { - "node": ">=0.10.0" - } - }, - "node_modules/is-path-inside": { - "version": "3.0.3", - "resolved": "https://registry.npmjs.org/is-path-inside/-/is-path-inside-3.0.3.tgz", - "integrity": "sha512-Fd4gABb+ycGAmKou8eMftCupSir5lRxqf4aD/vd0cD2qc4HL07OjCeuHMr8Ro4CoMaeCKDB0/ECBOVWjTwUvPQ==", - "dev": true, - "license": "MIT", - "engines": { - "node": ">=8" - } - }, "node_modules/is-plain-obj": { "version": "4.1.0", "resolved": "https://registry.npmjs.org/is-plain-obj/-/is-plain-obj-4.1.0.tgz", @@ -14222,29 +8574,6 @@ "url": "https://github.com/sponsors/sindresorhus" } }, - "node_modules/is-plain-object": { - "version": "2.0.4", - "resolved": "https://registry.npmjs.org/is-plain-object/-/is-plain-object-2.0.4.tgz", - "integrity": "sha512-h5PpgXkWitc38BBMYawTYMWJHFZJVnBquFE57xFpjB8pJFiF6gZ+bU+WyI/yqXiFR5mdLsgYNaPe8uao6Uv9Og==", - "dev": true, - "license": "MIT", - "dependencies": { - "isobject": "^3.0.1" - }, - "engines": { - "node": ">=0.10.0" - } - }, - "node_modules/is-regexp": { - "version": "1.0.0", - "resolved": "https://registry.npmjs.org/is-regexp/-/is-regexp-1.0.0.tgz", - "integrity": "sha512-7zjFAPO4/gwyQAAgRRmqeEeyIICSdmCqa3tsVHMdBzaXXRiqopZL4Cyghg/XulGWrtABTpbnYYzzIRffLkP4oA==", - "dev": true, - "license": "MIT", - "engines": { - "node": ">=0.10.0" - } - }, "node_modules/is-stream": { "version": "2.0.1", "resolved": "https://registry.npmjs.org/is-stream/-/is-stream-2.0.1.tgz", @@ -14258,13 +8587,6 @@ "url": "https://github.com/sponsors/sindresorhus" } }, - "node_modules/is-typedarray": { - "version": "1.0.0", - "resolved": "https://registry.npmjs.org/is-typedarray/-/is-typedarray-1.0.0.tgz", - "integrity": "sha512-cyA56iCMHAh5CdzjJIa4aohJyeO1YbwLi3Jc35MmRU6poroFjIGZzUzupGiRPOjgHg9TLu43xbpwXk523fMxKA==", - "dev": true, - "license": "MIT" - }, "node_modules/is-unicode-supported": { "version": "0.1.0", "resolved": "https://registry.npmjs.org/is-unicode-supported/-/is-unicode-supported-0.1.0.tgz", @@ -14278,32 +8600,25 @@ } }, "node_modules/is-wsl": { - "version": "2.2.0", - "resolved": "https://registry.npmjs.org/is-wsl/-/is-wsl-2.2.0.tgz", - "integrity": "sha512-fKzAra0rGJUUBwGBgNkHZuToZcn+TtXHpeCgmkMJMMYx1sQDYaCSyjJBSCa2nH1DGm7s3n1oBnohoVTBaN7Lww==", + "version": "3.1.0", + "resolved": "https://registry.npmjs.org/is-wsl/-/is-wsl-3.1.0.tgz", + "integrity": "sha512-UcVfVfaK4Sc4m7X3dUSoHoozQGBEFeDC+zVo06t98xe8CzHSZZBekNXH+tu0NalHolcJ/QAGqS46Hef7QXBIMw==", "dev": true, "license": "MIT", "dependencies": { - "is-docker": "^2.0.0" + "is-inside-container": "^1.0.0" }, "engines": { - "node": ">=8" - } - }, - "node_modules/is-yarn-global": { - "version": "0.4.1", - "resolved": "https://registry.npmjs.org/is-yarn-global/-/is-yarn-global-0.4.1.tgz", - "integrity": "sha512-/kppl+R+LO5VmhYSEWARUFjodS25D68gvj8W7z0I7OWhUla5xWu8KL6CtB2V0R6yqhnRgbcaREMr4EEM6htLPQ==", - "dev": true, - "license": "MIT", - "engines": { - "node": ">=12" + "node": ">=16" + }, + "funding": { + "url": "https://github.com/sponsors/sindresorhus" } }, "node_modules/isarray": { - "version": "0.0.1", - "resolved": "https://registry.npmjs.org/isarray/-/isarray-0.0.1.tgz", - "integrity": "sha512-D2S+3GLxWH+uhrNEcoh/fnmYeP8E8/zHl644d/jdA0g2uyXvy3sb0qxotE+ne0LtccHknQzWwZEzhak7oJ0COQ==", + "version": "1.0.0", + "resolved": "https://registry.npmjs.org/isarray/-/isarray-1.0.0.tgz", + "integrity": "sha512-VLghIWNM6ELQzo7zwmcg0NmTVyWKYjvIeM83yjp0wRDTmUnrM678fQbcKBo6n2CJEF0szoG//ytg+TKla89ALQ==", "dev": true, "license": "MIT" }, @@ -14313,16 +8628,6 @@ "integrity": "sha512-RHxMLp9lnKHGHRng9QFhRCMbYAcVpn69smSGcq3f36xjgVVWThj4qqLbTLlq7Ssj8B+fIQ1EuCEGI2lKsyQeIw==", "license": "ISC" }, - "node_modules/isobject": { - "version": "3.0.1", - "resolved": "https://registry.npmjs.org/isobject/-/isobject-3.0.1.tgz", - "integrity": "sha512-WhB9zCku7EGTj/HQQRz5aUQEUeoQZH2bWcltRErOpymJ4boYE6wL9Tbr23krRPSZ+C5zqNSrSw+Cc7sZZ4b7vg==", - "dev": true, - "license": "MIT", - "engines": { - "node": ">=0.10.0" - } - }, "node_modules/istanbul-lib-coverage": { "version": "3.2.2", "resolved": "https://registry.npmjs.org/istanbul-lib-coverage/-/istanbul-lib-coverage-3.2.2.tgz", @@ -14394,6 +8699,13 @@ "node": ">=8" } }, + "node_modules/istanbul-reports/node_modules/html-escaper": { + "version": "2.0.2", + "resolved": "https://registry.npmjs.org/html-escaper/-/html-escaper-2.0.2.tgz", + "integrity": "sha512-H2iMtd0I4Mt5eYiapRdIDjp+XzelXQ0tFE4JS7YFwFevXXMmOp9myNrUvCg0D6ws8iqkRPBfKHgbwig1SmlLfg==", + "dev": true, + "license": "MIT" + }, "node_modules/jackspeak": { "version": "4.1.1", "resolved": "https://registry.npmjs.org/jackspeak/-/jackspeak-4.1.1.tgz", @@ -14410,16 +8722,16 @@ } }, "node_modules/jest": { - "version": "30.0.5", - "resolved": "https://registry.npmjs.org/jest/-/jest-30.0.5.tgz", - "integrity": "sha512-y2mfcJywuTUkvLm2Lp1/pFX8kTgMO5yyQGq/Sk/n2mN7XWYp4JsCZ/QXW34M8YScgk8bPZlREH04f6blPnoHnQ==", + "version": "30.2.0", + "resolved": "https://registry.npmjs.org/jest/-/jest-30.2.0.tgz", + "integrity": "sha512-F26gjC0yWN8uAA5m5Ss8ZQf5nDHWGlN/xWZIh8S5SRbsEKBovwZhxGd6LJlbZYxBgCYOtreSUyb8hpXyGC5O4A==", "dev": true, "license": "MIT", "dependencies": { - "@jest/core": "30.0.5", - "@jest/types": "30.0.5", + "@jest/core": "30.2.0", + "@jest/types": "30.2.0", "import-local": "^3.2.0", - "jest-cli": "30.0.5" + "jest-cli": "30.2.0" }, "bin": { "jest": "bin/jest.js" @@ -14437,44 +8749,73 @@ } }, "node_modules/jest-changed-files": { - "version": "30.0.5", - "resolved": "https://registry.npmjs.org/jest-changed-files/-/jest-changed-files-30.0.5.tgz", - "integrity": "sha512-bGl2Ntdx0eAwXuGpdLdVYVr5YQHnSZlQ0y9HVDu565lCUAe9sj6JOtBbMmBBikGIegne9piDDIOeiLVoqTkz4A==", + "version": "30.2.0", + "resolved": "https://registry.npmjs.org/jest-changed-files/-/jest-changed-files-30.2.0.tgz", + "integrity": "sha512-L8lR1ChrRnSdfeOvTrwZMlnWV8G/LLjQ0nG9MBclwWZidA2N5FviRki0Bvh20WRMOX31/JYvzdqTJrk5oBdydQ==", "dev": true, "license": "MIT", "dependencies": { "execa": "^5.1.1", - "jest-util": "30.0.5", + "jest-util": "30.2.0", "p-limit": "^3.1.0" }, "engines": { "node": "^18.14.0 || ^20.0.0 || ^22.0.0 || >=24.0.0" } }, - "node_modules/jest-circus": { - "version": "30.0.5", - "resolved": "https://registry.npmjs.org/jest-circus/-/jest-circus-30.0.5.tgz", - "integrity": "sha512-h/sjXEs4GS+NFFfqBDYT7y5Msfxh04EwWLhQi0F8kuWpe+J/7tICSlswU8qvBqumR3kFgHbfu7vU6qruWWBPug==", + "node_modules/jest-changed-files/node_modules/p-limit": { + "version": "3.1.0", + "resolved": "https://registry.npmjs.org/p-limit/-/p-limit-3.1.0.tgz", + "integrity": "sha512-TYOanM3wGwNGsZN2cVTYPArw454xnXj5qmWF1bEoAc4+cU/ol7GVh7odevjp1FNHduHc3KZMcFduxU5Xc6uJRQ==", "dev": true, "license": "MIT", "dependencies": { - "@jest/environment": "30.0.5", - "@jest/expect": "30.0.5", - "@jest/test-result": "30.0.5", - "@jest/types": "30.0.5", + "yocto-queue": "^0.1.0" + }, + "engines": { + "node": ">=10" + }, + "funding": { + "url": "https://github.com/sponsors/sindresorhus" + } + }, + "node_modules/jest-changed-files/node_modules/yocto-queue": { + "version": "0.1.0", + "resolved": "https://registry.npmjs.org/yocto-queue/-/yocto-queue-0.1.0.tgz", + "integrity": "sha512-rVksvsnNCdJ/ohGc6xgPwyN8eheCxsiLM8mxuE/t/mOVqJewPuO1miLpTHQiRgTKCLexL4MeAFVagts7HmNZ2Q==", + "dev": true, + "license": "MIT", + "engines": { + "node": ">=10" + }, + "funding": { + "url": "https://github.com/sponsors/sindresorhus" + } + }, + "node_modules/jest-circus": { + "version": "30.2.0", + "resolved": "https://registry.npmjs.org/jest-circus/-/jest-circus-30.2.0.tgz", + "integrity": "sha512-Fh0096NC3ZkFx05EP2OXCxJAREVxj1BcW/i6EWqqymcgYKWjyyDpral3fMxVcHXg6oZM7iULer9wGRFvfpl+Tg==", + "dev": true, + "license": "MIT", + "dependencies": { + "@jest/environment": "30.2.0", + "@jest/expect": "30.2.0", + "@jest/test-result": "30.2.0", + "@jest/types": "30.2.0", "@types/node": "*", "chalk": "^4.1.2", "co": "^4.6.0", "dedent": "^1.6.0", "is-generator-fn": "^2.1.0", - "jest-each": "30.0.5", - "jest-matcher-utils": "30.0.5", - "jest-message-util": "30.0.5", - "jest-runtime": "30.0.5", - "jest-snapshot": "30.0.5", - "jest-util": "30.0.5", + "jest-each": "30.2.0", + "jest-matcher-utils": "30.2.0", + "jest-message-util": "30.2.0", + "jest-runtime": "30.2.0", + "jest-snapshot": "30.2.0", + "jest-util": "30.2.0", "p-limit": "^3.1.0", - "pretty-format": "30.0.5", + "pretty-format": "30.2.0", "pure-rand": "^7.0.0", "slash": "^3.0.0", "stack-utils": "^2.0.6" @@ -14483,22 +8824,51 @@ "node": "^18.14.0 || ^20.0.0 || ^22.0.0 || >=24.0.0" } }, - "node_modules/jest-cli": { - "version": "30.0.5", - "resolved": "https://registry.npmjs.org/jest-cli/-/jest-cli-30.0.5.tgz", - "integrity": "sha512-Sa45PGMkBZzF94HMrlX4kUyPOwUpdZasaliKN3mifvDmkhLYqLLg8HQTzn6gq7vJGahFYMQjXgyJWfYImKZzOw==", + "node_modules/jest-circus/node_modules/p-limit": { + "version": "3.1.0", + "resolved": "https://registry.npmjs.org/p-limit/-/p-limit-3.1.0.tgz", + "integrity": "sha512-TYOanM3wGwNGsZN2cVTYPArw454xnXj5qmWF1bEoAc4+cU/ol7GVh7odevjp1FNHduHc3KZMcFduxU5Xc6uJRQ==", "dev": true, "license": "MIT", "dependencies": { - "@jest/core": "30.0.5", - "@jest/test-result": "30.0.5", - "@jest/types": "30.0.5", + "yocto-queue": "^0.1.0" + }, + "engines": { + "node": ">=10" + }, + "funding": { + "url": "https://github.com/sponsors/sindresorhus" + } + }, + "node_modules/jest-circus/node_modules/yocto-queue": { + "version": "0.1.0", + "resolved": "https://registry.npmjs.org/yocto-queue/-/yocto-queue-0.1.0.tgz", + "integrity": "sha512-rVksvsnNCdJ/ohGc6xgPwyN8eheCxsiLM8mxuE/t/mOVqJewPuO1miLpTHQiRgTKCLexL4MeAFVagts7HmNZ2Q==", + "dev": true, + "license": "MIT", + "engines": { + "node": ">=10" + }, + "funding": { + "url": "https://github.com/sponsors/sindresorhus" + } + }, + "node_modules/jest-cli": { + "version": "30.2.0", + "resolved": "https://registry.npmjs.org/jest-cli/-/jest-cli-30.2.0.tgz", + "integrity": "sha512-Os9ukIvADX/A9sLt6Zse3+nmHtHaE6hqOsjQtNiugFTbKRHYIYtZXNGNK9NChseXy7djFPjndX1tL0sCTlfpAA==", + "dev": true, + "license": "MIT", + "dependencies": { + "@jest/core": "30.2.0", + "@jest/test-result": "30.2.0", + "@jest/types": "30.2.0", "chalk": "^4.1.2", "exit-x": "^0.2.2", "import-local": "^3.2.0", - "jest-config": "30.0.5", - "jest-util": "30.0.5", - "jest-validate": "30.0.5", + "jest-config": "30.2.0", + "jest-util": "30.2.0", + "jest-validate": "30.2.0", "yargs": "^17.7.2" }, "bin": { @@ -14517,34 +8887,34 @@ } }, "node_modules/jest-config": { - "version": "30.0.5", - "resolved": "https://registry.npmjs.org/jest-config/-/jest-config-30.0.5.tgz", - "integrity": "sha512-aIVh+JNOOpzUgzUnPn5FLtyVnqc3TQHVMupYtyeURSb//iLColiMIR8TxCIDKyx9ZgjKnXGucuW68hCxgbrwmA==", + "version": "30.2.0", + "resolved": "https://registry.npmjs.org/jest-config/-/jest-config-30.2.0.tgz", + "integrity": "sha512-g4WkyzFQVWHtu6uqGmQR4CQxz/CH3yDSlhzXMWzNjDx843gYjReZnMRanjRCq5XZFuQrGDxgUaiYWE8BRfVckA==", "dev": true, "license": "MIT", "dependencies": { "@babel/core": "^7.27.4", - "@jest/get-type": "30.0.1", + "@jest/get-type": "30.1.0", "@jest/pattern": "30.0.1", - "@jest/test-sequencer": "30.0.5", - "@jest/types": "30.0.5", - "babel-jest": "30.0.5", + "@jest/test-sequencer": "30.2.0", + "@jest/types": "30.2.0", + "babel-jest": "30.2.0", "chalk": "^4.1.2", "ci-info": "^4.2.0", "deepmerge": "^4.3.1", "glob": "^10.3.10", "graceful-fs": "^4.2.11", - "jest-circus": "30.0.5", - "jest-docblock": "30.0.1", - "jest-environment-node": "30.0.5", + "jest-circus": "30.2.0", + "jest-docblock": "30.2.0", + "jest-environment-node": "30.2.0", "jest-regex-util": "30.0.1", - "jest-resolve": "30.0.5", - "jest-runner": "30.0.5", - "jest-util": "30.0.5", - "jest-validate": "30.0.5", + "jest-resolve": "30.2.0", + "jest-runner": "30.2.0", + "jest-util": "30.2.0", + "jest-validate": "30.2.0", "micromatch": "^4.0.8", "parse-json": "^5.2.0", - "pretty-format": "30.0.5", + "pretty-format": "30.2.0", "slash": "^3.0.0", "strip-json-comments": "^3.1.1" }, @@ -14656,25 +9026,25 @@ } }, "node_modules/jest-diff": { - "version": "30.0.5", - "resolved": "https://registry.npmjs.org/jest-diff/-/jest-diff-30.0.5.tgz", - "integrity": "sha512-1UIqE9PoEKaHcIKvq2vbibrCog4Y8G0zmOxgQUVEiTqwR5hJVMCoDsN1vFvI5JvwD37hjueZ1C4l2FyGnfpE0A==", + "version": "30.2.0", + "resolved": "https://registry.npmjs.org/jest-diff/-/jest-diff-30.2.0.tgz", + "integrity": "sha512-dQHFo3Pt4/NLlG5z4PxZ/3yZTZ1C7s9hveiOj+GCN+uT109NC2QgsoVZsVOAvbJ3RgKkvyLGXZV9+piDpWbm6A==", "dev": true, "license": "MIT", "dependencies": { "@jest/diff-sequences": "30.0.1", - "@jest/get-type": "30.0.1", + "@jest/get-type": "30.1.0", "chalk": "^4.1.2", - "pretty-format": "30.0.5" + "pretty-format": "30.2.0" }, "engines": { "node": "^18.14.0 || ^20.0.0 || ^22.0.0 || >=24.0.0" } }, "node_modules/jest-docblock": { - "version": "30.0.1", - "resolved": "https://registry.npmjs.org/jest-docblock/-/jest-docblock-30.0.1.tgz", - "integrity": "sha512-/vF78qn3DYphAaIc3jy4gA7XSAz167n9Bm/wn/1XhTLW7tTBIzXtCJpb/vcmc73NIIeeohCbdL94JasyXUZsGA==", + "version": "30.2.0", + "resolved": "https://registry.npmjs.org/jest-docblock/-/jest-docblock-30.2.0.tgz", + "integrity": "sha512-tR/FFgZKS1CXluOQzZvNH3+0z9jXr3ldGSD8bhyuxvlVUwbeLOGynkunvlTMxchC5urrKndYiwCFC0DLVjpOCA==", "dev": true, "license": "MIT", "dependencies": { @@ -14685,56 +9055,56 @@ } }, "node_modules/jest-each": { - "version": "30.0.5", - "resolved": "https://registry.npmjs.org/jest-each/-/jest-each-30.0.5.tgz", - "integrity": "sha512-dKjRsx1uZ96TVyejD3/aAWcNKy6ajMaN531CwWIsrazIqIoXI9TnnpPlkrEYku/8rkS3dh2rbH+kMOyiEIv0xQ==", + "version": "30.2.0", + "resolved": "https://registry.npmjs.org/jest-each/-/jest-each-30.2.0.tgz", + "integrity": "sha512-lpWlJlM7bCUf1mfmuqTA8+j2lNURW9eNafOy99knBM01i5CQeY5UH1vZjgT9071nDJac1M4XsbyI44oNOdhlDQ==", "dev": true, "license": "MIT", "dependencies": { - "@jest/get-type": "30.0.1", - "@jest/types": "30.0.5", + "@jest/get-type": "30.1.0", + "@jest/types": "30.2.0", "chalk": "^4.1.2", - "jest-util": "30.0.5", - "pretty-format": "30.0.5" + "jest-util": "30.2.0", + "pretty-format": "30.2.0" }, "engines": { "node": "^18.14.0 || ^20.0.0 || ^22.0.0 || >=24.0.0" } }, "node_modules/jest-environment-node": { - "version": "30.0.5", - "resolved": "https://registry.npmjs.org/jest-environment-node/-/jest-environment-node-30.0.5.tgz", - "integrity": "sha512-ppYizXdLMSvciGsRsMEnv/5EFpvOdXBaXRBzFUDPWrsfmog4kYrOGWXarLllz6AXan6ZAA/kYokgDWuos1IKDA==", + "version": "30.2.0", + "resolved": "https://registry.npmjs.org/jest-environment-node/-/jest-environment-node-30.2.0.tgz", + "integrity": "sha512-ElU8v92QJ9UrYsKrxDIKCxu6PfNj4Hdcktcn0JX12zqNdqWHB0N+hwOnnBBXvjLd2vApZtuLUGs1QSY+MsXoNA==", "dev": true, "license": "MIT", "dependencies": { - "@jest/environment": "30.0.5", - "@jest/fake-timers": "30.0.5", - "@jest/types": "30.0.5", + "@jest/environment": "30.2.0", + "@jest/fake-timers": "30.2.0", + "@jest/types": "30.2.0", "@types/node": "*", - "jest-mock": "30.0.5", - "jest-util": "30.0.5", - "jest-validate": "30.0.5" + "jest-mock": "30.2.0", + "jest-util": "30.2.0", + "jest-validate": "30.2.0" }, "engines": { "node": "^18.14.0 || ^20.0.0 || ^22.0.0 || >=24.0.0" } }, "node_modules/jest-haste-map": { - "version": "30.0.5", - "resolved": "https://registry.npmjs.org/jest-haste-map/-/jest-haste-map-30.0.5.tgz", - "integrity": "sha512-dkmlWNlsTSR0nH3nRfW5BKbqHefLZv0/6LCccG0xFCTWcJu8TuEwG+5Cm75iBfjVoockmO6J35o5gxtFSn5xeg==", + "version": "30.2.0", + "resolved": "https://registry.npmjs.org/jest-haste-map/-/jest-haste-map-30.2.0.tgz", + "integrity": "sha512-sQA/jCb9kNt+neM0anSj6eZhLZUIhQgwDt7cPGjumgLM4rXsfb9kpnlacmvZz3Q5tb80nS+oG/if+NBKrHC+Xw==", "dev": true, "license": "MIT", "dependencies": { - "@jest/types": "30.0.5", + "@jest/types": "30.2.0", "@types/node": "*", "anymatch": "^3.1.3", "fb-watchman": "^2.0.2", "graceful-fs": "^4.2.11", "jest-regex-util": "30.0.1", - "jest-util": "30.0.5", - "jest-worker": "30.0.5", + "jest-util": "30.2.0", + "jest-worker": "30.2.0", "micromatch": "^4.0.8", "walker": "^1.0.8" }, @@ -14746,49 +9116,49 @@ } }, "node_modules/jest-leak-detector": { - "version": "30.0.5", - "resolved": "https://registry.npmjs.org/jest-leak-detector/-/jest-leak-detector-30.0.5.tgz", - "integrity": "sha512-3Uxr5uP8jmHMcsOtYMRB/zf1gXN3yUIc+iPorhNETG54gErFIiUhLvyY/OggYpSMOEYqsmRxmuU4ZOoX5jpRFg==", + "version": "30.2.0", + "resolved": "https://registry.npmjs.org/jest-leak-detector/-/jest-leak-detector-30.2.0.tgz", + "integrity": "sha512-M6jKAjyzjHG0SrQgwhgZGy9hFazcudwCNovY/9HPIicmNSBuockPSedAP9vlPK6ONFJ1zfyH/M2/YYJxOz5cdQ==", "dev": true, "license": "MIT", "dependencies": { - "@jest/get-type": "30.0.1", - "pretty-format": "30.0.5" + "@jest/get-type": "30.1.0", + "pretty-format": "30.2.0" }, "engines": { "node": "^18.14.0 || ^20.0.0 || ^22.0.0 || >=24.0.0" } }, "node_modules/jest-matcher-utils": { - "version": "30.0.5", - "resolved": "https://registry.npmjs.org/jest-matcher-utils/-/jest-matcher-utils-30.0.5.tgz", - "integrity": "sha512-uQgGWt7GOrRLP1P7IwNWwK1WAQbq+m//ZY0yXygyfWp0rJlksMSLQAA4wYQC3b6wl3zfnchyTx+k3HZ5aPtCbQ==", + "version": "30.2.0", + "resolved": "https://registry.npmjs.org/jest-matcher-utils/-/jest-matcher-utils-30.2.0.tgz", + "integrity": "sha512-dQ94Nq4dbzmUWkQ0ANAWS9tBRfqCrn0bV9AMYdOi/MHW726xn7eQmMeRTpX2ViC00bpNaWXq+7o4lIQ3AX13Hg==", "dev": true, "license": "MIT", "dependencies": { - "@jest/get-type": "30.0.1", + "@jest/get-type": "30.1.0", "chalk": "^4.1.2", - "jest-diff": "30.0.5", - "pretty-format": "30.0.5" + "jest-diff": "30.2.0", + "pretty-format": "30.2.0" }, "engines": { "node": "^18.14.0 || ^20.0.0 || ^22.0.0 || >=24.0.0" } }, "node_modules/jest-message-util": { - "version": "30.0.5", - "resolved": "https://registry.npmjs.org/jest-message-util/-/jest-message-util-30.0.5.tgz", - "integrity": "sha512-NAiDOhsK3V7RU0Aa/HnrQo+E4JlbarbmI3q6Pi4KcxicdtjV82gcIUrejOtczChtVQR4kddu1E1EJlW6EN9IyA==", + "version": "30.2.0", + "resolved": "https://registry.npmjs.org/jest-message-util/-/jest-message-util-30.2.0.tgz", + "integrity": "sha512-y4DKFLZ2y6DxTWD4cDe07RglV88ZiNEdlRfGtqahfbIjfsw1nMCPx49Uev4IA/hWn3sDKyAnSPwoYSsAEdcimw==", "dev": true, "license": "MIT", "dependencies": { "@babel/code-frame": "^7.27.1", - "@jest/types": "30.0.5", + "@jest/types": "30.2.0", "@types/stack-utils": "^2.0.3", "chalk": "^4.1.2", "graceful-fs": "^4.2.11", "micromatch": "^4.0.8", - "pretty-format": "30.0.5", + "pretty-format": "30.2.0", "slash": "^3.0.0", "stack-utils": "^2.0.6" }, @@ -14797,15 +9167,15 @@ } }, "node_modules/jest-mock": { - "version": "30.0.5", - "resolved": "https://registry.npmjs.org/jest-mock/-/jest-mock-30.0.5.tgz", - "integrity": "sha512-Od7TyasAAQX/6S+QCbN6vZoWOMwlTtzzGuxJku1GhGanAjz9y+QsQkpScDmETvdc9aSXyJ/Op4rhpMYBWW91wQ==", + "version": "30.2.0", + "resolved": "https://registry.npmjs.org/jest-mock/-/jest-mock-30.2.0.tgz", + "integrity": "sha512-JNNNl2rj4b5ICpmAcq+WbLH83XswjPbjH4T7yvGzfAGCPh1rw+xVNbtk+FnRslvt9lkCcdn9i1oAoKUuFsOxRw==", "dev": true, "license": "MIT", "dependencies": { - "@jest/types": "30.0.5", + "@jest/types": "30.2.0", "@types/node": "*", - "jest-util": "30.0.5" + "jest-util": "30.2.0" }, "engines": { "node": "^18.14.0 || ^20.0.0 || ^22.0.0 || >=24.0.0" @@ -14840,18 +9210,18 @@ } }, "node_modules/jest-resolve": { - "version": "30.0.5", - "resolved": "https://registry.npmjs.org/jest-resolve/-/jest-resolve-30.0.5.tgz", - "integrity": "sha512-d+DjBQ1tIhdz91B79mywH5yYu76bZuE96sSbxj8MkjWVx5WNdt1deEFRONVL4UkKLSrAbMkdhb24XN691yDRHg==", + "version": "30.2.0", + "resolved": "https://registry.npmjs.org/jest-resolve/-/jest-resolve-30.2.0.tgz", + "integrity": "sha512-TCrHSxPlx3tBY3hWNtRQKbtgLhsXa1WmbJEqBlTBrGafd5fiQFByy2GNCEoGR+Tns8d15GaL9cxEzKOO3GEb2A==", "dev": true, "license": "MIT", "dependencies": { "chalk": "^4.1.2", "graceful-fs": "^4.2.11", - "jest-haste-map": "30.0.5", + "jest-haste-map": "30.2.0", "jest-pnp-resolver": "^1.2.3", - "jest-util": "30.0.5", - "jest-validate": "30.0.5", + "jest-util": "30.2.0", + "jest-validate": "30.2.0", "slash": "^3.0.0", "unrs-resolver": "^1.7.11" }, @@ -14860,46 +9230,46 @@ } }, "node_modules/jest-resolve-dependencies": { - "version": "30.0.5", - "resolved": "https://registry.npmjs.org/jest-resolve-dependencies/-/jest-resolve-dependencies-30.0.5.tgz", - "integrity": "sha512-/xMvBR4MpwkrHW4ikZIWRttBBRZgWK4d6xt3xW1iRDSKt4tXzYkMkyPfBnSCgv96cpkrctfXs6gexeqMYqdEpw==", + "version": "30.2.0", + "resolved": "https://registry.npmjs.org/jest-resolve-dependencies/-/jest-resolve-dependencies-30.2.0.tgz", + "integrity": "sha512-xTOIGug/0RmIe3mmCqCT95yO0vj6JURrn1TKWlNbhiAefJRWINNPgwVkrVgt/YaerPzY3iItufd80v3lOrFJ2w==", "dev": true, "license": "MIT", "dependencies": { "jest-regex-util": "30.0.1", - "jest-snapshot": "30.0.5" + "jest-snapshot": "30.2.0" }, "engines": { "node": "^18.14.0 || ^20.0.0 || ^22.0.0 || >=24.0.0" } }, "node_modules/jest-runner": { - "version": "30.0.5", - "resolved": "https://registry.npmjs.org/jest-runner/-/jest-runner-30.0.5.tgz", - "integrity": "sha512-JcCOucZmgp+YuGgLAXHNy7ualBx4wYSgJVWrYMRBnb79j9PD0Jxh0EHvR5Cx/r0Ce+ZBC4hCdz2AzFFLl9hCiw==", + "version": "30.2.0", + "resolved": "https://registry.npmjs.org/jest-runner/-/jest-runner-30.2.0.tgz", + "integrity": "sha512-PqvZ2B2XEyPEbclp+gV6KO/F1FIFSbIwewRgmROCMBo/aZ6J1w8Qypoj2pEOcg3G2HzLlaP6VUtvwCI8dM3oqQ==", "dev": true, "license": "MIT", "dependencies": { - "@jest/console": "30.0.5", - "@jest/environment": "30.0.5", - "@jest/test-result": "30.0.5", - "@jest/transform": "30.0.5", - "@jest/types": "30.0.5", + "@jest/console": "30.2.0", + "@jest/environment": "30.2.0", + "@jest/test-result": "30.2.0", + "@jest/transform": "30.2.0", + "@jest/types": "30.2.0", "@types/node": "*", "chalk": "^4.1.2", "emittery": "^0.13.1", "exit-x": "^0.2.2", "graceful-fs": "^4.2.11", - "jest-docblock": "30.0.1", - "jest-environment-node": "30.0.5", - "jest-haste-map": "30.0.5", - "jest-leak-detector": "30.0.5", - "jest-message-util": "30.0.5", - "jest-resolve": "30.0.5", - "jest-runtime": "30.0.5", - "jest-util": "30.0.5", - "jest-watcher": "30.0.5", - "jest-worker": "30.0.5", + "jest-docblock": "30.2.0", + "jest-environment-node": "30.2.0", + "jest-haste-map": "30.2.0", + "jest-leak-detector": "30.2.0", + "jest-message-util": "30.2.0", + "jest-resolve": "30.2.0", + "jest-runtime": "30.2.0", + "jest-util": "30.2.0", + "jest-watcher": "30.2.0", + "jest-worker": "30.2.0", "p-limit": "^3.1.0", "source-map-support": "0.5.13" }, @@ -14907,33 +9277,62 @@ "node": "^18.14.0 || ^20.0.0 || ^22.0.0 || >=24.0.0" } }, - "node_modules/jest-runtime": { - "version": "30.0.5", - "resolved": "https://registry.npmjs.org/jest-runtime/-/jest-runtime-30.0.5.tgz", - "integrity": "sha512-7oySNDkqpe4xpX5PPiJTe5vEa+Ak/NnNz2bGYZrA1ftG3RL3EFlHaUkA1Cjx+R8IhK0Vg43RML5mJedGTPNz3A==", + "node_modules/jest-runner/node_modules/p-limit": { + "version": "3.1.0", + "resolved": "https://registry.npmjs.org/p-limit/-/p-limit-3.1.0.tgz", + "integrity": "sha512-TYOanM3wGwNGsZN2cVTYPArw454xnXj5qmWF1bEoAc4+cU/ol7GVh7odevjp1FNHduHc3KZMcFduxU5Xc6uJRQ==", "dev": true, "license": "MIT", "dependencies": { - "@jest/environment": "30.0.5", - "@jest/fake-timers": "30.0.5", - "@jest/globals": "30.0.5", + "yocto-queue": "^0.1.0" + }, + "engines": { + "node": ">=10" + }, + "funding": { + "url": "https://github.com/sponsors/sindresorhus" + } + }, + "node_modules/jest-runner/node_modules/yocto-queue": { + "version": "0.1.0", + "resolved": "https://registry.npmjs.org/yocto-queue/-/yocto-queue-0.1.0.tgz", + "integrity": "sha512-rVksvsnNCdJ/ohGc6xgPwyN8eheCxsiLM8mxuE/t/mOVqJewPuO1miLpTHQiRgTKCLexL4MeAFVagts7HmNZ2Q==", + "dev": true, + "license": "MIT", + "engines": { + "node": ">=10" + }, + "funding": { + "url": "https://github.com/sponsors/sindresorhus" + } + }, + "node_modules/jest-runtime": { + "version": "30.2.0", + "resolved": "https://registry.npmjs.org/jest-runtime/-/jest-runtime-30.2.0.tgz", + "integrity": "sha512-p1+GVX/PJqTucvsmERPMgCPvQJpFt4hFbM+VN3n8TMo47decMUcJbt+rgzwrEme0MQUA/R+1de2axftTHkKckg==", + "dev": true, + "license": "MIT", + "dependencies": { + "@jest/environment": "30.2.0", + "@jest/fake-timers": "30.2.0", + "@jest/globals": "30.2.0", "@jest/source-map": "30.0.1", - "@jest/test-result": "30.0.5", - "@jest/transform": "30.0.5", - "@jest/types": "30.0.5", + "@jest/test-result": "30.2.0", + "@jest/transform": "30.2.0", + "@jest/types": "30.2.0", "@types/node": "*", "chalk": "^4.1.2", "cjs-module-lexer": "^2.1.0", "collect-v8-coverage": "^1.0.2", "glob": "^10.3.10", "graceful-fs": "^4.2.11", - "jest-haste-map": "30.0.5", - "jest-message-util": "30.0.5", - "jest-mock": "30.0.5", + "jest-haste-map": "30.2.0", + "jest-message-util": "30.2.0", + "jest-mock": "30.2.0", "jest-regex-util": "30.0.1", - "jest-resolve": "30.0.5", - "jest-snapshot": "30.0.5", - "jest-util": "30.0.5", + "jest-resolve": "30.2.0", + "jest-snapshot": "30.2.0", + "jest-util": "30.2.0", "slash": "^3.0.0", "strip-bom": "^4.0.0" }, @@ -15029,9 +9428,9 @@ } }, "node_modules/jest-snapshot": { - "version": "30.0.5", - "resolved": "https://registry.npmjs.org/jest-snapshot/-/jest-snapshot-30.0.5.tgz", - "integrity": "sha512-T00dWU/Ek3LqTp4+DcW6PraVxjk28WY5Ua/s+3zUKSERZSNyxTqhDXCWKG5p2HAJ+crVQ3WJ2P9YVHpj1tkW+g==", + "version": "30.2.0", + "resolved": "https://registry.npmjs.org/jest-snapshot/-/jest-snapshot-30.2.0.tgz", + "integrity": "sha512-5WEtTy2jXPFypadKNpbNkZ72puZCa6UjSr/7djeecHWOu7iYhSXSnHScT8wBz3Rn8Ena5d5RYRcsyKIeqG1IyA==", "dev": true, "license": "MIT", "dependencies": { @@ -15040,20 +9439,20 @@ "@babel/plugin-syntax-jsx": "^7.27.1", "@babel/plugin-syntax-typescript": "^7.27.1", "@babel/types": "^7.27.3", - "@jest/expect-utils": "30.0.5", - "@jest/get-type": "30.0.1", - "@jest/snapshot-utils": "30.0.5", - "@jest/transform": "30.0.5", - "@jest/types": "30.0.5", - "babel-preset-current-node-syntax": "^1.1.0", + "@jest/expect-utils": "30.2.0", + "@jest/get-type": "30.1.0", + "@jest/snapshot-utils": "30.2.0", + "@jest/transform": "30.2.0", + "@jest/types": "30.2.0", + "babel-preset-current-node-syntax": "^1.2.0", "chalk": "^4.1.2", - "expect": "30.0.5", + "expect": "30.2.0", "graceful-fs": "^4.2.11", - "jest-diff": "30.0.5", - "jest-matcher-utils": "30.0.5", - "jest-message-util": "30.0.5", - "jest-util": "30.0.5", - "pretty-format": "30.0.5", + "jest-diff": "30.2.0", + "jest-matcher-utils": "30.2.0", + "jest-message-util": "30.2.0", + "jest-util": "30.2.0", + "pretty-format": "30.2.0", "semver": "^7.7.2", "synckit": "^0.11.8" }, @@ -15062,13 +9461,13 @@ } }, "node_modules/jest-util": { - "version": "30.0.5", - "resolved": "https://registry.npmjs.org/jest-util/-/jest-util-30.0.5.tgz", - "integrity": "sha512-pvyPWssDZR0FlfMxCBoc0tvM8iUEskaRFALUtGQYzVEAqisAztmy+R8LnU14KT4XA0H/a5HMVTXat1jLne010g==", + "version": "30.2.0", + "resolved": "https://registry.npmjs.org/jest-util/-/jest-util-30.2.0.tgz", + "integrity": "sha512-QKNsM0o3Xe6ISQU869e+DhG+4CK/48aHYdJZGlFQVTjnbvgpcKyxpzk29fGiO7i/J8VENZ+d2iGnSsvmuHywlA==", "dev": true, "license": "MIT", "dependencies": { - "@jest/types": "30.0.5", + "@jest/types": "30.2.0", "@types/node": "*", "chalk": "^4.1.2", "ci-info": "^4.2.0", @@ -15079,64 +9478,38 @@ "node": "^18.14.0 || ^20.0.0 || ^22.0.0 || >=24.0.0" } }, - "node_modules/jest-util/node_modules/picomatch": { - "version": "4.0.3", - "resolved": "https://registry.npmjs.org/picomatch/-/picomatch-4.0.3.tgz", - "integrity": "sha512-5gTmgEY/sqK6gFXLIsQNH19lWb4ebPDLA4SdLP7dsWkIXHWlG66oPuVvXSGFPppYZz8ZDZq0dYYrbHfBCVUb1Q==", - "dev": true, - "license": "MIT", - "engines": { - "node": ">=12" - }, - "funding": { - "url": "https://github.com/sponsors/jonschlinkert" - } - }, "node_modules/jest-validate": { - "version": "30.0.5", - "resolved": "https://registry.npmjs.org/jest-validate/-/jest-validate-30.0.5.tgz", - "integrity": "sha512-ouTm6VFHaS2boyl+k4u+Qip4TSH7Uld5tyD8psQ8abGgt2uYYB8VwVfAHWHjHc0NWmGGbwO5h0sCPOGHHevefw==", + "version": "30.2.0", + "resolved": "https://registry.npmjs.org/jest-validate/-/jest-validate-30.2.0.tgz", + "integrity": "sha512-FBGWi7dP2hpdi8nBoWxSsLvBFewKAg0+uSQwBaof4Y4DPgBabXgpSYC5/lR7VmnIlSpASmCi/ntRWPbv7089Pw==", "dev": true, "license": "MIT", "dependencies": { - "@jest/get-type": "30.0.1", - "@jest/types": "30.0.5", + "@jest/get-type": "30.1.0", + "@jest/types": "30.2.0", "camelcase": "^6.3.0", "chalk": "^4.1.2", "leven": "^3.1.0", - "pretty-format": "30.0.5" + "pretty-format": "30.2.0" }, "engines": { "node": "^18.14.0 || ^20.0.0 || ^22.0.0 || >=24.0.0" } }, - "node_modules/jest-validate/node_modules/camelcase": { - "version": "6.3.0", - "resolved": "https://registry.npmjs.org/camelcase/-/camelcase-6.3.0.tgz", - "integrity": "sha512-Gmy6FhYlCY7uOElZUSbxo2UCDH8owEk996gkbrpsgGtrJLM3J7jGxl9Ic7Qwwj4ivOE5AWZWRMecDdF7hqGjFA==", - "dev": true, - "license": "MIT", - "engines": { - "node": ">=10" - }, - "funding": { - "url": "https://github.com/sponsors/sindresorhus" - } - }, "node_modules/jest-watcher": { - "version": "30.0.5", - "resolved": "https://registry.npmjs.org/jest-watcher/-/jest-watcher-30.0.5.tgz", - "integrity": "sha512-z9slj/0vOwBDBjN3L4z4ZYaA+pG56d6p3kTUhFRYGvXbXMWhXmb/FIxREZCD06DYUwDKKnj2T80+Pb71CQ0KEg==", + "version": "30.2.0", + "resolved": "https://registry.npmjs.org/jest-watcher/-/jest-watcher-30.2.0.tgz", + "integrity": "sha512-PYxa28dxJ9g777pGm/7PrbnMeA0Jr7osHP9bS7eJy9DuAjMgdGtxgf0uKMyoIsTWAkIbUW5hSDdJ3urmgXBqxg==", "dev": true, "license": "MIT", "dependencies": { - "@jest/test-result": "30.0.5", - "@jest/types": "30.0.5", + "@jest/test-result": "30.2.0", + "@jest/types": "30.2.0", "@types/node": "*", "ansi-escapes": "^4.3.2", "chalk": "^4.1.2", "emittery": "^0.13.1", - "jest-util": "30.0.5", + "jest-util": "30.2.0", "string-length": "^4.0.2" }, "engines": { @@ -15144,15 +9517,15 @@ } }, "node_modules/jest-worker": { - "version": "30.0.5", - "resolved": "https://registry.npmjs.org/jest-worker/-/jest-worker-30.0.5.tgz", - "integrity": "sha512-ojRXsWzEP16NdUuBw/4H/zkZdHOa7MMYCk4E430l+8fELeLg/mqmMlRhjL7UNZvQrDmnovWZV4DxX03fZF48fQ==", + "version": "30.2.0", + "resolved": "https://registry.npmjs.org/jest-worker/-/jest-worker-30.2.0.tgz", + "integrity": "sha512-0Q4Uk8WF7BUwqXHuAjc23vmopWJw5WH7w2tqBoUOZpOjW/ZnR44GXXd1r82RvnmI2GZge3ivrYXk/BE2+VtW2g==", "dev": true, "license": "MIT", "dependencies": { "@types/node": "*", "@ungap/structured-clone": "^1.3.0", - "jest-util": "30.0.5", + "jest-util": "30.2.0", "merge-stream": "^2.0.0", "supports-color": "^8.1.1" }, @@ -15176,30 +9549,6 @@ "url": "https://github.com/chalk/supports-color?sponsor=1" } }, - "node_modules/jiti": { - "version": "1.21.7", - "resolved": "https://registry.npmjs.org/jiti/-/jiti-1.21.7.tgz", - "integrity": "sha512-/imKNG4EbWNrVjoNC/1H5/9GFy+tqjGBHCaSsN+P2RnPqjsLmv6UD3Ej+Kj8nBWaRAwyk7kK5ZUc+OEatnTR3A==", - "dev": true, - "license": "MIT", - "bin": { - "jiti": "bin/jiti.js" - } - }, - "node_modules/joi": { - "version": "17.13.3", - "resolved": "https://registry.npmjs.org/joi/-/joi-17.13.3.tgz", - "integrity": "sha512-otDA4ldcIx+ZXsKHWmp0YizCweVRZG96J10b0FevjfuncLO1oX59THoAmHkNubYJ+9gWsYsp5k8v4ib6oDv1fA==", - "dev": true, - "license": "BSD-3-Clause", - "dependencies": { - "@hapi/hoek": "^9.3.0", - "@hapi/topo": "^5.1.0", - "@sideway/address": "^4.1.5", - "@sideway/formula": "^3.0.1", - "@sideway/pinpoint": "^2.0.0" - } - }, "node_modules/js-tokens": { "version": "4.0.0", "resolved": "https://registry.npmjs.org/js-tokens/-/js-tokens-4.0.0.tgz", @@ -15246,13 +9595,6 @@ "dev": true, "license": "MIT" }, - "node_modules/json-schema": { - "version": "0.4.0", - "resolved": "https://registry.npmjs.org/json-schema/-/json-schema-0.4.0.tgz", - "integrity": "sha512-es94M3nTIfsEPisRafak+HDLfHXnKBhV3vU5eqPcS3flIWqcxJWgXHXiey3YrpaNsanY5ei1VoYEbOzijuq9BA==", - "dev": true, - "license": "(AFL-2.1 OR BSD-3-Clause)" - }, "node_modules/json-schema-traverse": { "version": "0.4.1", "resolved": "https://registry.npmjs.org/json-schema-traverse/-/json-schema-traverse-0.4.1.tgz", @@ -15300,9 +9642,9 @@ } }, "node_modules/katex": { - "version": "0.16.25", - "resolved": "https://registry.npmjs.org/katex/-/katex-0.16.25.tgz", - "integrity": "sha512-woHRUZ/iF23GBP1dkDQMh1QBad9dmr8/PAwNA54VrSOVYgI12MAcE14TqnDdQOdzyEonGzMepYnqBMYdsoAr8Q==", + "version": "0.16.27", + "resolved": "https://registry.npmjs.org/katex/-/katex-0.16.27.tgz", + "integrity": "sha512-aeQoDkuRWSqQN6nSvVCEFvfXdqo1OQiCmmW1kc9xSdjutPv7BGO7pqY9sQRJpMOGrEdfDgF2TfRXe5eUAD2Waw==", "dev": true, "funding": [ "https://opencollective.com/katex", @@ -15336,16 +9678,6 @@ "json-buffer": "3.0.1" } }, - "node_modules/kind-of": { - "version": "6.0.3", - "resolved": "https://registry.npmjs.org/kind-of/-/kind-of-6.0.3.tgz", - "integrity": "sha512-dcS1ul+9tmeD95T+x28/ehLgd9mENa3LsvDTtzm3vyBEO7RPptvAD+t44WVXaUjTBRcrpFeFlC8WCruUR456hw==", - "dev": true, - "license": "MIT", - "engines": { - "node": ">=0.10.0" - } - }, "node_modules/kleur": { "version": "3.0.3", "resolved": "https://registry.npmjs.org/kleur/-/kleur-3.0.3.tgz", @@ -15356,31 +9688,14 @@ "node": ">=6" } }, - "node_modules/latest-version": { - "version": "7.0.0", - "resolved": "https://registry.npmjs.org/latest-version/-/latest-version-7.0.0.tgz", - "integrity": "sha512-KvNT4XqAMzdcL6ka6Tl3i2lYeFDgXNCuIX+xNx6ZMVR1dFq+idXd9FLKNMOIx0t9mJ9/HudyX4oZWXZQ0UJHeg==", + "node_modules/klona": { + "version": "2.0.6", + "resolved": "https://registry.npmjs.org/klona/-/klona-2.0.6.tgz", + "integrity": "sha512-dhG34DXATL5hSxJbIexCft8FChFXtmskoZYnoPWjXQuebWYCNkVeV3KkGegCK9CP1oswI/vQibS2GY7Em/sJJA==", "dev": true, "license": "MIT", - "dependencies": { - "package-json": "^8.1.0" - }, "engines": { - "node": ">=14.16" - }, - "funding": { - "url": "https://github.com/sponsors/sindresorhus" - } - }, - "node_modules/launch-editor": { - "version": "2.12.0", - "resolved": "https://registry.npmjs.org/launch-editor/-/launch-editor-2.12.0.tgz", - "integrity": "sha512-giOHXoOtifjdHqUamwKq6c49GzBdLjvxrd2D+Q4V6uOHopJv7p9VJxikDsQ/CBXZbEITgUqSVHXLTG3VhPP1Dg==", - "dev": true, - "license": "MIT", - "dependencies": { - "picocolors": "^1.1.1", - "shell-quote": "^1.8.3" + "node": ">= 8" } }, "node_modules/lazystream": { @@ -15396,13 +9711,6 @@ "node": ">= 0.6.3" } }, - "node_modules/lazystream/node_modules/isarray": { - "version": "1.0.0", - "resolved": "https://registry.npmjs.org/isarray/-/isarray-1.0.0.tgz", - "integrity": "sha512-VLghIWNM6ELQzo7zwmcg0NmTVyWKYjvIeM83yjp0wRDTmUnrM678fQbcKBo6n2CJEF0szoG//ytg+TKla89ALQ==", - "dev": true, - "license": "MIT" - }, "node_modules/lazystream/node_modules/readable-stream": { "version": "2.3.8", "resolved": "https://registry.npmjs.org/readable-stream/-/readable-stream-2.3.8.tgz", @@ -15460,19 +9768,6 @@ "node": ">= 0.8.0" } }, - "node_modules/lilconfig": { - "version": "3.1.3", - "resolved": "https://registry.npmjs.org/lilconfig/-/lilconfig-3.1.3.tgz", - "integrity": "sha512-/vlFKAoH5Cgt3Ie+JLhRbwOsCQePABiU3tJ1egGvyQ+33R/vcwM2Zl2QR/LzjsBeItPt3oSVXapn+m4nQDvpzw==", - "dev": true, - "license": "MIT", - "engines": { - "node": ">=14" - }, - "funding": { - "url": "https://github.com/sponsors/antonk52" - } - }, "node_modules/lines-and-columns": { "version": "1.2.4", "resolved": "https://registry.npmjs.org/lines-and-columns/-/lines-and-columns-1.2.4.tgz", @@ -15491,19 +9786,16 @@ } }, "node_modules/lint-staged": { - "version": "16.1.5", - "resolved": "https://registry.npmjs.org/lint-staged/-/lint-staged-16.1.5.tgz", - "integrity": "sha512-uAeQQwByI6dfV7wpt/gVqg+jAPaSp8WwOA8kKC/dv1qw14oGpnpAisY65ibGHUGDUv0rYaZ8CAJZ/1U8hUvC2A==", + "version": "16.2.7", + "resolved": "https://registry.npmjs.org/lint-staged/-/lint-staged-16.2.7.tgz", + "integrity": "sha512-lDIj4RnYmK7/kXMya+qJsmkRFkGolciXjrsZ6PC25GdTfWOAWetR0ZbsNXRAj1EHHImRSalc+whZFg56F5DVow==", "dev": true, "license": "MIT", "dependencies": { - "chalk": "^5.5.0", - "commander": "^14.0.0", - "debug": "^4.4.1", - "lilconfig": "^3.1.3", - "listr2": "^9.0.1", + "commander": "^14.0.2", + "listr2": "^9.0.5", "micromatch": "^4.0.8", - "nano-spawn": "^1.0.2", + "nano-spawn": "^2.0.0", "pidtree": "^0.6.0", "string-argv": "^0.3.2", "yaml": "^2.8.1" @@ -15518,27 +9810,14 @@ "url": "https://opencollective.com/lint-staged" } }, - "node_modules/lint-staged/node_modules/chalk": { - "version": "5.6.0", - "resolved": "https://registry.npmjs.org/chalk/-/chalk-5.6.0.tgz", - "integrity": "sha512-46QrSQFyVSEyYAgQ22hQ+zDa60YHA4fBstHmtSApj1Y5vKtG27fWowW03jCk5KcbXEWPZUIR894aARCA/G1kfQ==", - "dev": true, - "license": "MIT", - "engines": { - "node": "^12.17.0 || ^14.13 || >=16.0.0" - }, - "funding": { - "url": "https://github.com/chalk/chalk?sponsor=1" - } - }, "node_modules/listr2": { - "version": "9.0.2", - "resolved": "https://registry.npmjs.org/listr2/-/listr2-9.0.2.tgz", - "integrity": "sha512-VVd7cS6W+vLJu2wmq4QmfVj14Iep7cz4r/OWNk36Aq5ZOY7G8/BfCrQFexcwB1OIxB3yERiePfE/REBjEFulag==", + "version": "9.0.5", + "resolved": "https://registry.npmjs.org/listr2/-/listr2-9.0.5.tgz", + "integrity": "sha512-ME4Fb83LgEgwNw96RKNvKV4VTLuXfoKudAmm2lP8Kk87KaMK0/Xrx/aAkMWmT8mDb+3MlFDspfbCs7adjRxA2g==", "dev": true, "license": "MIT", "dependencies": { - "cli-truncate": "^4.0.0", + "cli-truncate": "^5.0.0", "colorette": "^2.0.20", "eventemitter3": "^5.0.1", "log-update": "^6.1.0", @@ -15550,9 +9829,9 @@ } }, "node_modules/listr2/node_modules/ansi-regex": { - "version": "6.2.0", - "resolved": "https://registry.npmjs.org/ansi-regex/-/ansi-regex-6.2.0.tgz", - "integrity": "sha512-TKY5pyBkHyADOPYlRT9Lx6F544mPl0vS5Ew7BJ45hA08Q+t3GjbueLliBWN3sMICk6+y7HdyxSzC4bWS8baBdg==", + "version": "6.2.2", + "resolved": "https://registry.npmjs.org/ansi-regex/-/ansi-regex-6.2.2.tgz", + "integrity": "sha512-Bq3SmSpyFHaWjPk8If9yc6svM8c56dB5BAtW4Qbw5jHTwwXXcTLoRMkpDJp6VL0XzlWaCHTXrkFURMYmD0sLqg==", "dev": true, "license": "MIT", "engines": { @@ -15563,9 +9842,9 @@ } }, "node_modules/listr2/node_modules/ansi-styles": { - "version": "6.2.1", - "resolved": "https://registry.npmjs.org/ansi-styles/-/ansi-styles-6.2.1.tgz", - "integrity": "sha512-bN798gFfQX+viw3R7yrGWRqnrN2oRkEkUjjl4JNn4E8GxxbjtG3FbrEIIY3l8/hrwUwIeCZvi4QuOTP4MErVug==", + "version": "6.2.3", + "resolved": "https://registry.npmjs.org/ansi-styles/-/ansi-styles-6.2.3.tgz", + "integrity": "sha512-4Dj6M28JB+oAH8kFkTLUo+a2jwOFkuqb3yucU0CANcRRUbxS0cP0nZYCGjcc3BNXwRIsUVmDGgzawme7zvJHvg==", "dev": true, "license": "MIT", "engines": { @@ -15576,9 +9855,9 @@ } }, "node_modules/listr2/node_modules/emoji-regex": { - "version": "10.4.0", - "resolved": "https://registry.npmjs.org/emoji-regex/-/emoji-regex-10.4.0.tgz", - "integrity": "sha512-EC+0oUMY1Rqm4O6LLrgjtYDvcVYTy7chDnM4Q7030tP4Kwj3u/pR6gP9ygnp2CJMK5Gq+9Q2oqmrFJAz01DXjw==", + "version": "10.6.0", + "resolved": "https://registry.npmjs.org/emoji-regex/-/emoji-regex-10.6.0.tgz", + "integrity": "sha512-toUI84YS5YmxW219erniWD0CIVOo46xGKColeNQRgOzDorgBi1v4D71/OFzgD9GO2UGKIv1C3Sp8DAn0+j5w7A==", "dev": true, "license": "MIT" }, @@ -15601,9 +9880,9 @@ } }, "node_modules/listr2/node_modules/strip-ansi": { - "version": "7.1.0", - "resolved": "https://registry.npmjs.org/strip-ansi/-/strip-ansi-7.1.0.tgz", - "integrity": "sha512-iq6eVVI64nQQTRYq2KtEg2d2uU7LElhTJwsH4YzIHZshxlgZms/wIc4VoDQTlG/IvVIrBKG06CrZnp0qv7hkcQ==", + "version": "7.1.2", + "resolved": "https://registry.npmjs.org/strip-ansi/-/strip-ansi-7.1.2.tgz", + "integrity": "sha512-gmBGslpoQJtgnMAvOVqGZpEz9dyoKTCzy2nfz/n8aIFhN/jCE/rCmcxabB6jOOHV+0WNnylOxaxBQPSvcWklhA==", "dev": true, "license": "MIT", "dependencies": { @@ -15617,9 +9896,9 @@ } }, "node_modules/listr2/node_modules/wrap-ansi": { - "version": "9.0.0", - "resolved": "https://registry.npmjs.org/wrap-ansi/-/wrap-ansi-9.0.0.tgz", - "integrity": "sha512-G8ura3S+3Z2G+mkgNRq8dqaFZAuxfsxpBB8OCTGRTCtp+l/v9nbFNmCUP1BZMts3G1142MsZfn6eeUKrr4PD1Q==", + "version": "9.0.2", + "resolved": "https://registry.npmjs.org/wrap-ansi/-/wrap-ansi-9.0.2.tgz", + "integrity": "sha512-42AtmgqjV+X1VpdOfyTGOYRi0/zsoLqtXQckTmqTeybT+BDIbM/Guxo7x3pE2vtpr1ok6xRqM9OpBe+Jyoqyww==", "dev": true, "license": "MIT", "dependencies": { @@ -15634,35 +9913,6 @@ "url": "https://github.com/chalk/wrap-ansi?sponsor=1" } }, - "node_modules/loader-runner": { - "version": "4.3.1", - "resolved": "https://registry.npmjs.org/loader-runner/-/loader-runner-4.3.1.tgz", - "integrity": "sha512-IWqP2SCPhyVFTBtRcgMHdzlf9ul25NwaFx4wCEH/KjAXuuHY4yNjvPXsBokp8jCB936PyWRaPKUNh8NvylLp2Q==", - "dev": true, - "license": "MIT", - "engines": { - "node": ">=6.11.5" - }, - "funding": { - "type": "opencollective", - "url": "https://opencollective.com/webpack" - } - }, - "node_modules/loader-utils": { - "version": "2.0.4", - "resolved": "https://registry.npmjs.org/loader-utils/-/loader-utils-2.0.4.tgz", - "integrity": "sha512-xXqpXoINfFhgua9xiqD8fPFHgkoq1mmmpE92WlDbm9rNRd/EbRb+Gqf908T2DMfuHjjJlksiK2RbHVOdD/MqSw==", - "dev": true, - "license": "MIT", - "dependencies": { - "big.js": "^5.2.2", - "emojis-list": "^3.0.0", - "json5": "^2.1.2" - }, - "engines": { - "node": ">=8.9.0" - } - }, "node_modules/locate-path": { "version": "6.0.0", "resolved": "https://registry.npmjs.org/locate-path/-/locate-path-6.0.0.tgz", @@ -15683,12 +9933,6 @@ "version": "4.17.21", "resolved": "https://registry.npmjs.org/lodash/-/lodash-4.17.21.tgz", "integrity": "sha512-v2kDEe57lecTulaDIuNTPy3Ry4gLGJ6Z1O3vE1krgXZNrsQ+LFTGHVxVjcXPs17LhbZVGedAJv8XZ1tvj5FvSg==", - "license": "MIT" - }, - "node_modules/lodash.debounce": { - "version": "4.0.8", - "resolved": "https://registry.npmjs.org/lodash.debounce/-/lodash.debounce-4.0.8.tgz", - "integrity": "sha512-FT1yDzDYEoYWhnSGnpE/4Kj1fLZkDFyqRb7fNt6FdYOSxlUWAtp42Eh6Wb0rGIv/m9Bgo7x4GhQbm5Ys4SG5ow==", "dev": true, "license": "MIT" }, @@ -15698,13 +9942,6 @@ "integrity": "sha512-yv3cSQZmfpbIKo4Yo45B1taEvxjNvcpF1CEOc0Y6dEyvhPIfEJE3twDwPgWTPQubcSgXyBwBKG6wpQvWMDOf6Q==", "license": "MIT" }, - "node_modules/lodash.memoize": { - "version": "4.1.2", - "resolved": "https://registry.npmjs.org/lodash.memoize/-/lodash.memoize-4.1.2.tgz", - "integrity": "sha512-t7j+NzmgnQzTAYXcsHYLgimltOV1MXHtlOWf6GjL9Kj8GK5FInw5JotxvbOs+IvV1/Dzo04/fCGfLVs7aXb4Ag==", - "dev": true, - "license": "MIT" - }, "node_modules/lodash.merge": { "version": "4.6.2", "resolved": "https://registry.npmjs.org/lodash.merge/-/lodash.merge-4.6.2.tgz", @@ -15712,13 +9949,6 @@ "dev": true, "license": "MIT" }, - "node_modules/lodash.uniq": { - "version": "4.5.0", - "resolved": "https://registry.npmjs.org/lodash.uniq/-/lodash.uniq-4.5.0.tgz", - "integrity": "sha512-xfBaXQd9ryd9dlSDvnvI0lvxfLJlYAZzXomUYzLKtUeOQvOP5piqAWuGtrhWeqaXK9hhoM/iyJc5AV+XfsX3HQ==", - "dev": true, - "license": "MIT" - }, "node_modules/log-symbols": { "version": "4.1.0", "resolved": "https://registry.npmjs.org/log-symbols/-/log-symbols-4.1.0.tgz", @@ -15756,9 +9986,9 @@ } }, "node_modules/log-update/node_modules/ansi-escapes": { - "version": "7.0.0", - "resolved": "https://registry.npmjs.org/ansi-escapes/-/ansi-escapes-7.0.0.tgz", - "integrity": "sha512-GdYO7a61mR0fOlAsvC9/rIHf7L96sBc6dEWzeOu+KAea5bZyQRPIpojrVoI4AXGJS/ycu/fBTdLrUkA4ODrvjw==", + "version": "7.2.0", + "resolved": "https://registry.npmjs.org/ansi-escapes/-/ansi-escapes-7.2.0.tgz", + "integrity": "sha512-g6LhBsl+GBPRWGWsBtutpzBYuIIdBkLEvad5C/va/74Db018+5TZiyA26cZJAr3Rft5lprVqOIPxf5Vid6tqAw==", "dev": true, "license": "MIT", "dependencies": { @@ -15772,9 +10002,9 @@ } }, "node_modules/log-update/node_modules/ansi-regex": { - "version": "6.2.0", - "resolved": "https://registry.npmjs.org/ansi-regex/-/ansi-regex-6.2.0.tgz", - "integrity": "sha512-TKY5pyBkHyADOPYlRT9Lx6F544mPl0vS5Ew7BJ45hA08Q+t3GjbueLliBWN3sMICk6+y7HdyxSzC4bWS8baBdg==", + "version": "6.2.2", + "resolved": "https://registry.npmjs.org/ansi-regex/-/ansi-regex-6.2.2.tgz", + "integrity": "sha512-Bq3SmSpyFHaWjPk8If9yc6svM8c56dB5BAtW4Qbw5jHTwwXXcTLoRMkpDJp6VL0XzlWaCHTXrkFURMYmD0sLqg==", "dev": true, "license": "MIT", "engines": { @@ -15785,9 +10015,9 @@ } }, "node_modules/log-update/node_modules/ansi-styles": { - "version": "6.2.1", - "resolved": "https://registry.npmjs.org/ansi-styles/-/ansi-styles-6.2.1.tgz", - "integrity": "sha512-bN798gFfQX+viw3R7yrGWRqnrN2oRkEkUjjl4JNn4E8GxxbjtG3FbrEIIY3l8/hrwUwIeCZvi4QuOTP4MErVug==", + "version": "6.2.3", + "resolved": "https://registry.npmjs.org/ansi-styles/-/ansi-styles-6.2.3.tgz", + "integrity": "sha512-4Dj6M28JB+oAH8kFkTLUo+a2jwOFkuqb3yucU0CANcRRUbxS0cP0nZYCGjcc3BNXwRIsUVmDGgzawme7zvJHvg==", "dev": true, "license": "MIT", "engines": { @@ -15797,95 +10027,13 @@ "url": "https://github.com/chalk/ansi-styles?sponsor=1" } }, - "node_modules/log-update/node_modules/cli-cursor": { - "version": "5.0.0", - "resolved": "https://registry.npmjs.org/cli-cursor/-/cli-cursor-5.0.0.tgz", - "integrity": "sha512-aCj4O5wKyszjMmDT4tZj93kxyydN/K5zPWSCe6/0AV/AA1pqe5ZBIw0a2ZfPQV7lL5/yb5HsUreJ6UFAF1tEQw==", - "dev": true, - "license": "MIT", - "dependencies": { - "restore-cursor": "^5.0.0" - }, - "engines": { - "node": ">=18" - }, - "funding": { - "url": "https://github.com/sponsors/sindresorhus" - } - }, "node_modules/log-update/node_modules/emoji-regex": { - "version": "10.4.0", - "resolved": "https://registry.npmjs.org/emoji-regex/-/emoji-regex-10.4.0.tgz", - "integrity": "sha512-EC+0oUMY1Rqm4O6LLrgjtYDvcVYTy7chDnM4Q7030tP4Kwj3u/pR6gP9ygnp2CJMK5Gq+9Q2oqmrFJAz01DXjw==", + "version": "10.6.0", + "resolved": "https://registry.npmjs.org/emoji-regex/-/emoji-regex-10.6.0.tgz", + "integrity": "sha512-toUI84YS5YmxW219erniWD0CIVOo46xGKColeNQRgOzDorgBi1v4D71/OFzgD9GO2UGKIv1C3Sp8DAn0+j5w7A==", "dev": true, "license": "MIT" }, - "node_modules/log-update/node_modules/is-fullwidth-code-point": { - "version": "5.0.0", - "resolved": "https://registry.npmjs.org/is-fullwidth-code-point/-/is-fullwidth-code-point-5.0.0.tgz", - "integrity": "sha512-OVa3u9kkBbw7b8Xw5F9P+D/T9X+Z4+JruYVNapTjPYZYUznQ5YfWeFkOj606XYYW8yugTfC8Pj0hYqvi4ryAhA==", - "dev": true, - "license": "MIT", - "dependencies": { - "get-east-asian-width": "^1.0.0" - }, - "engines": { - "node": ">=18" - }, - "funding": { - "url": "https://github.com/sponsors/sindresorhus" - } - }, - "node_modules/log-update/node_modules/onetime": { - "version": "7.0.0", - "resolved": "https://registry.npmjs.org/onetime/-/onetime-7.0.0.tgz", - "integrity": "sha512-VXJjc87FScF88uafS3JllDgvAm+c/Slfz06lorj2uAY34rlUu0Nt+v8wreiImcrgAjjIHp1rXpTDlLOGw29WwQ==", - "dev": true, - "license": "MIT", - "dependencies": { - "mimic-function": "^5.0.0" - }, - "engines": { - "node": ">=18" - }, - "funding": { - "url": "https://github.com/sponsors/sindresorhus" - } - }, - "node_modules/log-update/node_modules/restore-cursor": { - "version": "5.1.0", - "resolved": "https://registry.npmjs.org/restore-cursor/-/restore-cursor-5.1.0.tgz", - "integrity": "sha512-oMA2dcrw6u0YfxJQXm342bFKX/E4sG9rbTzO9ptUcR/e8A33cHuvStiYOwH7fszkZlZ1z/ta9AAoPk2F4qIOHA==", - "dev": true, - "license": "MIT", - "dependencies": { - "onetime": "^7.0.0", - "signal-exit": "^4.1.0" - }, - "engines": { - "node": ">=18" - }, - "funding": { - "url": "https://github.com/sponsors/sindresorhus" - } - }, - "node_modules/log-update/node_modules/slice-ansi": { - "version": "7.1.0", - "resolved": "https://registry.npmjs.org/slice-ansi/-/slice-ansi-7.1.0.tgz", - "integrity": "sha512-bSiSngZ/jWeX93BqeIAbImyTbEihizcwNjFoRUIY/T1wWQsfsm2Vw1agPKylXvQTU7iASGdHhyqRlqQzfz+Htg==", - "dev": true, - "license": "MIT", - "dependencies": { - "ansi-styles": "^6.2.1", - "is-fullwidth-code-point": "^5.0.0" - }, - "engines": { - "node": ">=18" - }, - "funding": { - "url": "https://github.com/chalk/slice-ansi?sponsor=1" - } - }, "node_modules/log-update/node_modules/string-width": { "version": "7.2.0", "resolved": "https://registry.npmjs.org/string-width/-/string-width-7.2.0.tgz", @@ -15905,9 +10053,9 @@ } }, "node_modules/log-update/node_modules/strip-ansi": { - "version": "7.1.0", - "resolved": "https://registry.npmjs.org/strip-ansi/-/strip-ansi-7.1.0.tgz", - "integrity": "sha512-iq6eVVI64nQQTRYq2KtEg2d2uU7LElhTJwsH4YzIHZshxlgZms/wIc4VoDQTlG/IvVIrBKG06CrZnp0qv7hkcQ==", + "version": "7.1.2", + "resolved": "https://registry.npmjs.org/strip-ansi/-/strip-ansi-7.1.2.tgz", + "integrity": "sha512-gmBGslpoQJtgnMAvOVqGZpEz9dyoKTCzy2nfz/n8aIFhN/jCE/rCmcxabB6jOOHV+0WNnylOxaxBQPSvcWklhA==", "dev": true, "license": "MIT", "dependencies": { @@ -15921,9 +10069,9 @@ } }, "node_modules/log-update/node_modules/wrap-ansi": { - "version": "9.0.0", - "resolved": "https://registry.npmjs.org/wrap-ansi/-/wrap-ansi-9.0.0.tgz", - "integrity": "sha512-G8ura3S+3Z2G+mkgNRq8dqaFZAuxfsxpBB8OCTGRTCtp+l/v9nbFNmCUP1BZMts3G1142MsZfn6eeUKrr4PD1Q==", + "version": "9.0.2", + "resolved": "https://registry.npmjs.org/wrap-ansi/-/wrap-ansi-9.0.2.tgz", + "integrity": "sha512-42AtmgqjV+X1VpdOfyTGOYRi0/zsoLqtXQckTmqTeybT+BDIbM/Guxo7x3pE2vtpr1ok6xRqM9OpBe+Jyoqyww==", "dev": true, "license": "MIT", "dependencies": { @@ -15948,42 +10096,6 @@ "url": "https://github.com/sponsors/wooorm" } }, - "node_modules/loose-envify": { - "version": "1.4.0", - "resolved": "https://registry.npmjs.org/loose-envify/-/loose-envify-1.4.0.tgz", - "integrity": "sha512-lyuxPGr/Wfhrlem2CL/UcnUc1zcqKAImBDzukY7Y5F/yQiNdko6+fRLevlw1HgMySw7f611UIY408EtxRSoK3Q==", - "dev": true, - "license": "MIT", - "dependencies": { - "js-tokens": "^3.0.0 || ^4.0.0" - }, - "bin": { - "loose-envify": "cli.js" - } - }, - "node_modules/lower-case": { - "version": "2.0.2", - "resolved": "https://registry.npmjs.org/lower-case/-/lower-case-2.0.2.tgz", - "integrity": "sha512-7fm3l3NAF9WfN6W3JOmf5drwpVqX78JtoGJ3A6W0a6ZnldM41w2fV5D490psKFTpMds8TJse/eHLFFsNHHjHgg==", - "dev": true, - "license": "MIT", - "dependencies": { - "tslib": "^2.0.3" - } - }, - "node_modules/lowercase-keys": { - "version": "3.0.0", - "resolved": "https://registry.npmjs.org/lowercase-keys/-/lowercase-keys-3.0.0.tgz", - "integrity": "sha512-ozCC6gdQ+glXOQsveKD0YsDy8DSQFjDTz4zyzEHNV5+JP5D62LmfDZ6o1cycFx9ouG940M5dE8C8CTewdj2YWQ==", - "dev": true, - "license": "MIT", - "engines": { - "node": "^12.20.0 || ^14.13.1 || >=16.0.0" - }, - "funding": { - "url": "https://github.com/sponsors/sindresorhus" - } - }, "node_modules/lru-cache": { "version": "5.1.1", "resolved": "https://registry.npmjs.org/lru-cache/-/lru-cache-5.1.1.tgz", @@ -15994,6 +10106,28 @@ "yallist": "^3.0.2" } }, + "node_modules/magic-string": { + "version": "0.30.21", + "resolved": "https://registry.npmjs.org/magic-string/-/magic-string-0.30.21.tgz", + "integrity": "sha512-vd2F4YUyEXKGcLHoq+TEyCjxueSeHnFxyyjNp80yg0XV4vUhnDer/lvvlqM/arB5bXQN5K2/3oinyCRyx8T2CQ==", + "dev": true, + "license": "MIT", + "dependencies": { + "@jridgewell/sourcemap-codec": "^1.5.5" + } + }, + "node_modules/magicast": { + "version": "0.5.1", + "resolved": "https://registry.npmjs.org/magicast/-/magicast-0.5.1.tgz", + "integrity": "sha512-xrHS24IxaLrvuo613F719wvOIv9xPHFWQHuvGUBmPnCA/3MQxKI3b+r7n1jAoDHmsbC5bRhTZYR77invLAxVnw==", + "dev": true, + "license": "MIT", + "dependencies": { + "@babel/parser": "^7.28.5", + "@babel/types": "^7.28.5", + "source-map-js": "^1.2.1" + } + }, "node_modules/make-dir": { "version": "4.0.0", "resolved": "https://registry.npmjs.org/make-dir/-/make-dir-4.0.0.tgz", @@ -16123,74 +10257,20 @@ "markdownlint-cli2": ">=0.0.4" } }, - "node_modules/markdownlint-cli2/node_modules/globby": { - "version": "15.0.0", - "resolved": "https://registry.npmjs.org/globby/-/globby-15.0.0.tgz", - "integrity": "sha512-oB4vkQGqlMl682wL1IlWd02tXCbquGWM4voPEI85QmNKCaw8zGTm1f1rubFgkg3Eli2PtKlFgrnmUqasbQWlkw==", + "node_modules/mdast-util-definitions": { + "version": "6.0.0", + "resolved": "https://registry.npmjs.org/mdast-util-definitions/-/mdast-util-definitions-6.0.0.tgz", + "integrity": "sha512-scTllyX6pnYNZH/AIp/0ePz6s4cZtARxImwoPJ7kS42n+MnVsI4XbnG6d4ibehRIldYMWM2LD7ImQblVhUejVQ==", "dev": true, "license": "MIT", "dependencies": { - "@sindresorhus/merge-streams": "^4.0.0", - "fast-glob": "^3.3.3", - "ignore": "^7.0.5", - "path-type": "^6.0.0", - "slash": "^5.1.0", - "unicorn-magic": "^0.3.0" - }, - "engines": { - "node": ">=20" + "@types/mdast": "^4.0.0", + "@types/unist": "^3.0.0", + "unist-util-visit": "^5.0.0" }, "funding": { - "url": "https://github.com/sponsors/sindresorhus" - } - }, - "node_modules/markdownlint-cli2/node_modules/path-type": { - "version": "6.0.0", - "resolved": "https://registry.npmjs.org/path-type/-/path-type-6.0.0.tgz", - "integrity": "sha512-Vj7sf++t5pBD637NSfkxpHSMfWaeig5+DKWLhcqIYx6mWQz5hdJTGDVMQiJcw1ZYkhs7AazKDGpRVji1LJCZUQ==", - "dev": true, - "license": "MIT", - "engines": { - "node": ">=18" - }, - "funding": { - "url": "https://github.com/sponsors/sindresorhus" - } - }, - "node_modules/markdownlint-cli2/node_modules/slash": { - "version": "5.1.0", - "resolved": "https://registry.npmjs.org/slash/-/slash-5.1.0.tgz", - "integrity": "sha512-ZA6oR3T/pEyuqwMgAKT0/hAv8oAXckzbkmR0UkUosQ+Mc4RxGoJkRmwHgHufaenlyAgE1Mxgpdcrf75y6XcnDg==", - "dev": true, - "license": "MIT", - "engines": { - "node": ">=14.16" - }, - "funding": { - "url": "https://github.com/sponsors/sindresorhus" - } - }, - "node_modules/marked": { - "version": "16.4.2", - "resolved": "https://registry.npmjs.org/marked/-/marked-16.4.2.tgz", - "integrity": "sha512-TI3V8YYWvkVf3KJe1dRkpnjs68JUPyEa5vjKrp1XEEJUAOaQc+Qj+L1qWbPd0SJuAdQkFU0h73sXXqwDYxsiDA==", - "dev": true, - "license": "MIT", - "bin": { - "marked": "bin/marked.js" - }, - "engines": { - "node": ">= 20" - } - }, - "node_modules/math-intrinsics": { - "version": "1.1.0", - "resolved": "https://registry.npmjs.org/math-intrinsics/-/math-intrinsics-1.1.0.tgz", - "integrity": "sha512-/IXtbwEk5HTPyEwyKX6hGkYXxM9nbj64B+ilVJnC/R6B0pH5G4V3b0pVbL7DBj4tkhBAppbQUlf6F6Xl9LHu1g==", - "dev": true, - "license": "MIT", - "engines": { - "node": ">= 0.4" + "type": "opencollective", + "url": "https://opencollective.com/unified" } }, "node_modules/mdast-util-directive": { @@ -16269,38 +10349,6 @@ "url": "https://opencollective.com/unified" } }, - "node_modules/mdast-util-frontmatter": { - "version": "2.0.1", - "resolved": "https://registry.npmjs.org/mdast-util-frontmatter/-/mdast-util-frontmatter-2.0.1.tgz", - "integrity": "sha512-LRqI9+wdgC25P0URIJY9vwocIzCcksduHQ9OF2joxQoyTNVduwLAFUzjoopuRJbJAReaKrNQKAZKL3uCMugWJA==", - "dev": true, - "license": "MIT", - "dependencies": { - "@types/mdast": "^4.0.0", - "devlop": "^1.0.0", - "escape-string-regexp": "^5.0.0", - "mdast-util-from-markdown": "^2.0.0", - "mdast-util-to-markdown": "^2.0.0", - "micromark-extension-frontmatter": "^2.0.0" - }, - "funding": { - "type": "opencollective", - "url": "https://opencollective.com/unified" - } - }, - "node_modules/mdast-util-frontmatter/node_modules/escape-string-regexp": { - "version": "5.0.0", - "resolved": "https://registry.npmjs.org/escape-string-regexp/-/escape-string-regexp-5.0.0.tgz", - "integrity": "sha512-/veY75JbMK4j1yjvuUxuVsiS/hr/4iHs9FTT6cgTexxdE0Ly/glccBAkloH/DofkjRbZU3bnoj38mOmhkZ0lHw==", - "dev": true, - "license": "MIT", - "engines": { - "node": ">=12" - }, - "funding": { - "url": "https://github.com/sponsors/sindresorhus" - } - }, "node_modules/mdast-util-gfm": { "version": "3.1.0", "resolved": "https://registry.npmjs.org/mdast-util-gfm/-/mdast-util-gfm-3.1.0.tgz", @@ -16560,9 +10608,9 @@ } }, "node_modules/mdn-data": { - "version": "2.0.30", - "resolved": "https://registry.npmjs.org/mdn-data/-/mdn-data-2.0.30.tgz", - "integrity": "sha512-GaqWWShW4kv/G9IEucWScBx9G1/vsFZZJUO+tD26M8J8z3Kw5RDQjaoZe03YAClgeS/SWPOcb4nkFBTEi5DUEA==", + "version": "2.12.2", + "resolved": "https://registry.npmjs.org/mdn-data/-/mdn-data-2.12.2.tgz", + "integrity": "sha512-IEn+pegP1aManZuckezWCO+XZQDplx1366JoVhTpMpBB1sPey/SbveZQUosKiKiGYjg1wH4pMlNgXbCiYgihQA==", "dev": true, "license": "CC0-1.0" }, @@ -16573,45 +10621,6 @@ "dev": true, "license": "MIT" }, - "node_modules/media-typer": { - "version": "0.3.0", - "resolved": "https://registry.npmjs.org/media-typer/-/media-typer-0.3.0.tgz", - "integrity": "sha512-dq+qelQ9akHpcOl/gUVRTxVIOkAJ1wR3QAvb4RsVjS8oVoFjDGTc679wJYmUmknUF5HwMLOgb5O+a3KxfWapPQ==", - "dev": true, - "license": "MIT", - "engines": { - "node": ">= 0.6" - } - }, - "node_modules/memfs": { - "version": "4.51.1", - "resolved": "https://registry.npmjs.org/memfs/-/memfs-4.51.1.tgz", - "integrity": "sha512-Eyt3XrufitN2ZL9c/uIRMyDwXanLI88h/L3MoWqNY747ha3dMR9dWqp8cRT5ntjZ0U1TNuq4U91ZXK0sMBjYOQ==", - "dev": true, - "license": "Apache-2.0", - "dependencies": { - "@jsonjoy.com/json-pack": "^1.11.0", - "@jsonjoy.com/util": "^1.9.0", - "glob-to-regex.js": "^1.0.1", - "thingies": "^2.5.0", - "tree-dump": "^1.0.3", - "tslib": "^2.0.0" - }, - "funding": { - "type": "github", - "url": "https://github.com/sponsors/streamich" - } - }, - "node_modules/merge-descriptors": { - "version": "1.0.3", - "resolved": "https://registry.npmjs.org/merge-descriptors/-/merge-descriptors-1.0.3.tgz", - "integrity": "sha512-gaNvAS7TZ897/rVaZ0nMtAyxNyi/pdbjbAwUpFQpN70GqnVfOiXpeUUMKRBmzXaSQ8DdTX4/0ms62r2K+hE6mQ==", - "dev": true, - "license": "MIT", - "funding": { - "url": "https://github.com/sponsors/sindresorhus" - } - }, "node_modules/merge-stream": { "version": "2.0.0", "resolved": "https://registry.npmjs.org/merge-stream/-/merge-stream-2.0.0.tgz", @@ -16629,16 +10638,6 @@ "node": ">= 8" } }, - "node_modules/methods": { - "version": "1.1.2", - "resolved": "https://registry.npmjs.org/methods/-/methods-1.1.2.tgz", - "integrity": "sha512-iclAHeNqNm68zFtnZ0e+1L2yUIdvzNoauKU4WBA3VvH/vPFieF7qfRlwUZU+DA9P9bPXIS90ulxoUoCH23sV2w==", - "dev": true, - "license": "MIT", - "engines": { - "node": ">= 0.6" - } - }, "node_modules/micromark": { "version": "4.0.2", "resolved": "https://registry.npmjs.org/micromark/-/micromark-4.0.2.tgz", @@ -16728,23 +10727,6 @@ "url": "https://opencollective.com/unified" } }, - "node_modules/micromark-extension-frontmatter": { - "version": "2.0.0", - "resolved": "https://registry.npmjs.org/micromark-extension-frontmatter/-/micromark-extension-frontmatter-2.0.0.tgz", - "integrity": "sha512-C4AkuM3dA58cgZha7zVnuVxBhDsbttIMiytjgsM2XbHAB2faRVaHRle40558FBN+DJcrLNCoqG5mlrpdU4cRtg==", - "dev": true, - "license": "MIT", - "dependencies": { - "fault": "^2.0.0", - "micromark-util-character": "^2.0.0", - "micromark-util-symbol": "^2.0.0", - "micromark-util-types": "^2.0.0" - }, - "funding": { - "type": "opencollective", - "url": "https://opencollective.com/unified" - } - }, "node_modules/micromark-extension-gfm": { "version": "3.0.0", "resolved": "https://registry.npmjs.org/micromark-extension-gfm/-/micromark-extension-gfm-3.0.0.tgz", @@ -17441,40 +11423,17 @@ "node": ">=8.6" } }, - "node_modules/mime": { - "version": "1.6.0", - "resolved": "https://registry.npmjs.org/mime/-/mime-1.6.0.tgz", - "integrity": "sha512-x0Vn8spI+wuJ1O6S7gnbaQg8Pxh4NNHb7KSINmEWKiPE4RKOplvijn+NkmYmmRgP68mc70j2EbeTFRsrswaQeg==", + "node_modules/micromatch/node_modules/picomatch": { + "version": "2.3.1", + "resolved": "https://registry.npmjs.org/picomatch/-/picomatch-2.3.1.tgz", + "integrity": "sha512-JU3teHTNjmE2VCGFzuY8EXzCDVwEqB2a8fsIvwaStHhAWJEeVd1o1QD80CU6+ZdEXXSLbSsuLwJjkCBWqRQUVA==", "dev": true, "license": "MIT", - "bin": { - "mime": "cli.js" + "engines": { + "node": ">=8.6" }, - "engines": { - "node": ">=4" - } - }, - "node_modules/mime-db": { - "version": "1.33.0", - "resolved": "https://registry.npmjs.org/mime-db/-/mime-db-1.33.0.tgz", - "integrity": "sha512-BHJ/EKruNIqJf/QahvxwQZXKygOQ256myeN/Ew+THcAa5q+PjyTTMMeNQC4DZw5AwfvelsUrA6B67NKMqXDbzQ==", - "dev": true, - "license": "MIT", - "engines": { - "node": ">= 0.6" - } - }, - "node_modules/mime-types": { - "version": "2.1.18", - "resolved": "https://registry.npmjs.org/mime-types/-/mime-types-2.1.18.tgz", - "integrity": "sha512-lc/aahn+t4/SWV/qcmumYjymLsWfN3ELhpmVuUFjgsORruuZPVSwAQryq+HHGvO/SI2KVX26bx+En+zhM8g8hQ==", - "dev": true, - "license": "MIT", - "dependencies": { - "mime-db": "~1.33.0" - }, - "engines": { - "node": ">= 0.6" + "funding": { + "url": "https://github.com/sponsors/jonschlinkert" } }, "node_modules/mimic-fn": { @@ -17499,57 +11458,6 @@ "url": "https://github.com/sponsors/sindresorhus" } }, - "node_modules/mimic-response": { - "version": "4.0.0", - "resolved": "https://registry.npmjs.org/mimic-response/-/mimic-response-4.0.0.tgz", - "integrity": "sha512-e5ISH9xMYU0DzrT+jl8q2ze9D6eWBto+I8CNpe+VI+K2J/F/k3PdkdTdz4wvGVH4NTpo+NRYTVIuMQEMMcsLqg==", - "dev": true, - "license": "MIT", - "engines": { - "node": "^12.20.0 || ^14.13.1 || >=16.0.0" - }, - "funding": { - "url": "https://github.com/sponsors/sindresorhus" - } - }, - "node_modules/min-indent": { - "version": "1.0.1", - "resolved": "https://registry.npmjs.org/min-indent/-/min-indent-1.0.1.tgz", - "integrity": "sha512-I9jwMn07Sy/IwOj3zVkVik2JTvgpaykDZEigL6Rx6N9LbMywwUSMtxET+7lVoDLLd3O3IXwJwvuuns8UB/HeAg==", - "dev": true, - "license": "MIT", - "engines": { - "node": ">=4" - } - }, - "node_modules/mini-css-extract-plugin": { - "version": "2.9.4", - "resolved": "https://registry.npmjs.org/mini-css-extract-plugin/-/mini-css-extract-plugin-2.9.4.tgz", - "integrity": "sha512-ZWYT7ln73Hptxqxk2DxPU9MmapXRhxkJD6tkSR04dnQxm8BGu2hzgKLugK5yySD97u/8yy7Ma7E76k9ZdvtjkQ==", - "dev": true, - "license": "MIT", - "dependencies": { - "schema-utils": "^4.0.0", - "tapable": "^2.2.1" - }, - "engines": { - "node": ">= 12.13.0" - }, - "funding": { - "type": "opencollective", - "url": "https://opencollective.com/webpack" - }, - "peerDependencies": { - "webpack": "^5.0.0" - } - }, - "node_modules/minimalistic-assert": { - "version": "1.0.1", - "resolved": "https://registry.npmjs.org/minimalistic-assert/-/minimalistic-assert-1.0.1.tgz", - "integrity": "sha512-UtJcAD4yEaGtjPezWuO9wC4nwUnVH/8/Im3yEHQP4b67cXlD/Qr9hdITCU1xDbSEXg2XKNaP8jsReV7vQd00/A==", - "dev": true, - "license": "ISC" - }, "node_modules/minimatch": { "version": "3.1.2", "resolved": "https://registry.npmjs.org/minimatch/-/minimatch-3.1.2.tgz", @@ -17563,16 +11471,6 @@ "node": "*" } }, - "node_modules/minimist": { - "version": "1.2.8", - "resolved": "https://registry.npmjs.org/minimist/-/minimist-1.2.8.tgz", - "integrity": "sha512-2yyAR8qBkN3YuheJanUpWC5U3bb5osDywNB8RzDVlDwDHbocAJveqqj1u8+SVD7jkWT4yvsHCpWqqWqAxb0zCA==", - "dev": true, - "license": "MIT", - "funding": { - "url": "https://github.com/sponsors/ljharb" - } - }, "node_modules/minipass": { "version": "7.1.2", "resolved": "https://registry.npmjs.org/minipass/-/minipass-7.1.2.tgz", @@ -17598,30 +11496,10 @@ "integrity": "sha512-6FlzubTLZG3J2a/NVCAleEhjzq5oxgHyaCU9yYXvcLsvoVaHJq/s5xXI6/XXP6tz7R9xAOtHnSO/tXtF3WRTlA==", "license": "MIT" }, - "node_modules/multicast-dns": { - "version": "7.2.5", - "resolved": "https://registry.npmjs.org/multicast-dns/-/multicast-dns-7.2.5.tgz", - "integrity": "sha512-2eznPJP8z2BFLX50tf0LuODrpINqP1RVIm/CObbTcBRITQgmC/TjcREF1NeTBzIcR5XO/ukWo+YHOjBbFwIupg==", - "dev": true, - "license": "MIT", - "dependencies": { - "dns-packet": "^5.2.2", - "thunky": "^1.0.2" - }, - "bin": { - "multicast-dns": "cli.js" - } - }, - "node_modules/mute-stream": { - "version": "0.0.8", - "resolved": "https://registry.npmjs.org/mute-stream/-/mute-stream-0.0.8.tgz", - "integrity": "sha512-nnbWWOkoWyUsTjKrhgD0dcz22mdkSnpYqbEjIm2nhwhuxlSkpywJmBo8h0ZqJdkp73mb90SssHkN4rsRaBAfAA==", - "license": "ISC" - }, "node_modules/nano-spawn": { - "version": "1.0.2", - "resolved": "https://registry.npmjs.org/nano-spawn/-/nano-spawn-1.0.2.tgz", - "integrity": "sha512-21t+ozMQDAL/UGgQVBbZ/xXvNO10++ZPuTmKRO8k9V3AClVRht49ahtDjfY8l1q6nSHOrE5ASfthzH3ol6R/hg==", + "version": "2.0.0", + "resolved": "https://registry.npmjs.org/nano-spawn/-/nano-spawn-2.0.0.tgz", + "integrity": "sha512-tacvGzUY5o2D8CBh2rrwxyNojUsZNU2zjNTzKQrkgGJQTbGAfArVWXSKMBokBeeg6C7OLRGUEyoFlYbfeWQIqw==", "dev": true, "license": "MIT", "engines": { @@ -17651,9 +11529,9 @@ } }, "node_modules/napi-postinstall": { - "version": "0.3.3", - "resolved": "https://registry.npmjs.org/napi-postinstall/-/napi-postinstall-0.3.3.tgz", - "integrity": "sha512-uTp172LLXSxuSYHv/kou+f6KW3SMppU9ivthaVTXian9sOt3XM/zHYHpRZiLgQoxeWfYUnslNWQHF1+G71xcow==", + "version": "0.3.4", + "resolved": "https://registry.npmjs.org/napi-postinstall/-/napi-postinstall-0.3.4.tgz", + "integrity": "sha512-PHI5f1O0EP5xJ9gQmFGMS6IZcrVvTjpXjz7Na41gTE7eE2hK11lg04CECCYEEjdc17EV4DO+fkGEtt7TpTaTiQ==", "dev": true, "license": "MIT", "bin": { @@ -17730,60 +11608,37 @@ "node": ">=10" } }, - "node_modules/negotiator": { - "version": "0.6.4", - "resolved": "https://registry.npmjs.org/negotiator/-/negotiator-0.6.4.tgz", - "integrity": "sha512-myRT3DiWPHqho5PrJaIRyaMv2kgYf0mUVgBNOYMuCH5Ki1yEiQaf/ZJuQ62nvpc44wL5WDbTX7yGJi1Neevw8w==", + "node_modules/neotraverse": { + "version": "0.6.18", + "resolved": "https://registry.npmjs.org/neotraverse/-/neotraverse-0.6.18.tgz", + "integrity": "sha512-Z4SmBUweYa09+o6pG+eASabEpP6QkQ70yHj351pQoEXIs8uHbaU2DWVmzBANKgflPa47A50PtB2+NgRpQvr7vA==", "dev": true, "license": "MIT", "engines": { - "node": ">= 0.6" + "node": ">= 10" } }, - "node_modules/neo-async": { - "version": "2.6.2", - "resolved": "https://registry.npmjs.org/neo-async/-/neo-async-2.6.2.tgz", - "integrity": "sha512-Yd3UES5mWCSqR+qNT93S3UoYUkqAZ9lLg8a7g9rimsWmYGK8cVToA4/sF3RrshdyV3sAGMXVUmpMYOw+dLpOuw==", + "node_modules/nlcst-to-string": { + "version": "4.0.0", + "resolved": "https://registry.npmjs.org/nlcst-to-string/-/nlcst-to-string-4.0.0.tgz", + "integrity": "sha512-YKLBCcUYKAg0FNlOBT6aI91qFmSiFKiluk655WzPF+DDMA02qIyy8uiRqI8QXtcFpEvll12LpL5MXqEmAZ+dcA==", + "dev": true, + "license": "MIT", + "dependencies": { + "@types/nlcst": "^2.0.0" + }, + "funding": { + "type": "opencollective", + "url": "https://opencollective.com/unified" + } + }, + "node_modules/node-fetch-native": { + "version": "1.6.7", + "resolved": "https://registry.npmjs.org/node-fetch-native/-/node-fetch-native-1.6.7.tgz", + "integrity": "sha512-g9yhqoedzIUm0nTnTqAQvueMPVOuIY16bqgAJJC8XOOubYFNwz6IER9qs0Gq2Xd0+CecCKFjtdDTMA4u4xG06Q==", "dev": true, "license": "MIT" }, - "node_modules/no-case": { - "version": "3.0.4", - "resolved": "https://registry.npmjs.org/no-case/-/no-case-3.0.4.tgz", - "integrity": "sha512-fgAN3jGAh+RoxUGZHTSOLJIqUc2wmoBwGR4tbpNAKmmovFoWq0OdRkb0VkldReO2a2iBT/OEulG9XSUc10r3zg==", - "dev": true, - "license": "MIT", - "dependencies": { - "lower-case": "^2.0.2", - "tslib": "^2.0.3" - } - }, - "node_modules/node-emoji": { - "version": "2.2.0", - "resolved": "https://registry.npmjs.org/node-emoji/-/node-emoji-2.2.0.tgz", - "integrity": "sha512-Z3lTE9pLaJF47NyMhd4ww1yFTAP8YhYI8SleJiHzM46Fgpm5cnNzSl9XfzFNqbaz+VlJrIj3fXQ4DeN1Rjm6cw==", - "dev": true, - "license": "MIT", - "dependencies": { - "@sindresorhus/is": "^4.6.0", - "char-regex": "^1.0.2", - "emojilib": "^2.4.0", - "skin-tone": "^2.0.0" - }, - "engines": { - "node": ">=18" - } - }, - "node_modules/node-forge": { - "version": "1.3.3", - "resolved": "https://registry.npmjs.org/node-forge/-/node-forge-1.3.3.tgz", - "integrity": "sha512-rLvcdSyRCyouf6jcOIPe/BgwG/d7hKjzMKOas33/pHEr6gbq18IK9zV7DiPvzsz0oBJPme6qr6H6kGZuI9/DZg==", - "dev": true, - "license": "(BSD-3-Clause OR GPL-2.0)", - "engines": { - "node": ">= 6.13.0" - } - }, "node_modules/node-int64": { "version": "0.4.0", "resolved": "https://registry.npmjs.org/node-int64/-/node-int64-0.4.0.tgz", @@ -17791,6 +11646,13 @@ "dev": true, "license": "MIT" }, + "node_modules/node-mock-http": { + "version": "1.0.4", + "resolved": "https://registry.npmjs.org/node-mock-http/-/node-mock-http-1.0.4.tgz", + "integrity": "sha512-8DY+kFsDkNXy1sJglUfuODx1/opAGJGyrTuFqEoN90oRc2Vk0ZbD4K2qmKXBBEhZQzdKHIVfEJpDU8Ak2NJEvQ==", + "dev": true, + "license": "MIT" + }, "node_modules/node-releases": { "version": "2.0.27", "resolved": "https://registry.npmjs.org/node-releases/-/node-releases-2.0.27.tgz", @@ -17808,19 +11670,6 @@ "node": ">=0.10.0" } }, - "node_modules/normalize-url": { - "version": "8.1.0", - "resolved": "https://registry.npmjs.org/normalize-url/-/normalize-url-8.1.0.tgz", - "integrity": "sha512-X06Mfd/5aKsRHc0O0J5CUedwnPmnDtLF2+nq+KN9KSDlJHkPuh0JUviWjEWMe0SW/9TDdSLVPuk7L5gGTIA1/w==", - "dev": true, - "license": "MIT", - "engines": { - "node": ">=14.16" - }, - "funding": { - "url": "https://github.com/sponsors/sindresorhus" - } - }, "node_modules/npm-run-path": { "version": "4.0.1", "resolved": "https://registry.npmjs.org/npm-run-path/-/npm-run-path-4.0.1.tgz", @@ -17834,13 +11683,6 @@ "node": ">=8" } }, - "node_modules/nprogress": { - "version": "0.2.0", - "resolved": "https://registry.npmjs.org/nprogress/-/nprogress-0.2.0.tgz", - "integrity": "sha512-I19aIingLgR1fmhftnbWWO3dXc0hSxqHQHQb3H8m+K3TnEn/iSeTZZOyvKXWqQESMwuUVnatlCnZdLBZZt2VSA==", - "dev": true, - "license": "MIT" - }, "node_modules/nth-check": { "version": "2.1.1", "resolved": "https://registry.npmjs.org/nth-check/-/nth-check-2.1.1.tgz", @@ -17853,130 +11695,25 @@ "url": "https://github.com/fb55/nth-check?sponsor=1" } }, - "node_modules/null-loader": { - "version": "4.0.1", - "resolved": "https://registry.npmjs.org/null-loader/-/null-loader-4.0.1.tgz", - "integrity": "sha512-pxqVbi4U6N26lq+LmgIbB5XATP0VdZKOG25DhHi8btMmJJefGArFyDg1yc4U3hWCJbMqSrw0qyrz1UQX+qYXqg==", + "node_modules/ofetch": { + "version": "1.5.1", + "resolved": "https://registry.npmjs.org/ofetch/-/ofetch-1.5.1.tgz", + "integrity": "sha512-2W4oUZlVaqAPAil6FUg/difl6YhqhUR7x2eZY4bQCko22UXg3hptq9KLQdqFClV+Wu85UX7hNtdGTngi/1BxcA==", "dev": true, "license": "MIT", "dependencies": { - "loader-utils": "^2.0.0", - "schema-utils": "^3.0.0" - }, - "engines": { - "node": ">= 10.13.0" - }, - "funding": { - "type": "opencollective", - "url": "https://opencollective.com/webpack" - }, - "peerDependencies": { - "webpack": "^4.0.0 || ^5.0.0" + "destr": "^2.0.5", + "node-fetch-native": "^1.6.7", + "ufo": "^1.6.1" } }, - "node_modules/null-loader/node_modules/schema-utils": { - "version": "3.3.0", - "resolved": "https://registry.npmjs.org/schema-utils/-/schema-utils-3.3.0.tgz", - "integrity": "sha512-pN/yOAvcC+5rQ5nERGuwrjLlYvLTbCibnZ1I7B1LaiAz9BRBlE9GMgE/eqV30P7aJQUf7Ddimy/RsbYO/GrVGg==", - "dev": true, - "license": "MIT", - "dependencies": { - "@types/json-schema": "^7.0.8", - "ajv": "^6.12.5", - "ajv-keywords": "^3.5.2" - }, - "engines": { - "node": ">= 10.13.0" - }, - "funding": { - "type": "opencollective", - "url": "https://opencollective.com/webpack" - } - }, - "node_modules/object-assign": { - "version": "4.1.1", - "resolved": "https://registry.npmjs.org/object-assign/-/object-assign-4.1.1.tgz", - "integrity": "sha512-rJgTQnkUnH1sFw8yT6VSU3zD3sWmu6sZhIseY8VX+GRu3P6F7Fu+JNDoXfklElbLJSnc3FUQHVe4cU5hj+BcUg==", - "dev": true, - "license": "MIT", - "engines": { - "node": ">=0.10.0" - } - }, - "node_modules/object-inspect": { - "version": "1.13.4", - "resolved": "https://registry.npmjs.org/object-inspect/-/object-inspect-1.13.4.tgz", - "integrity": "sha512-W67iLl4J2EXEGTbfeHCffrjDfitvLANg0UlX3wFUUSTx92KXRFegMHUVgSqE+wvhAbi4WqjGg9czysTV2Epbew==", - "dev": true, - "license": "MIT", - "engines": { - "node": ">= 0.4" - }, - "funding": { - "url": "https://github.com/sponsors/ljharb" - } - }, - "node_modules/object-keys": { - "version": "1.1.1", - "resolved": "https://registry.npmjs.org/object-keys/-/object-keys-1.1.1.tgz", - "integrity": "sha512-NuAESUOUMrlIXOfHKzD6bpPu3tYt3xvjNdRIQ+FeT0lNb4K8WR70CaDxhuNguS2XG+GjkyMwOzsN5ZktImfhLA==", - "dev": true, - "license": "MIT", - "engines": { - "node": ">= 0.4" - } - }, - "node_modules/object.assign": { - "version": "4.1.7", - "resolved": "https://registry.npmjs.org/object.assign/-/object.assign-4.1.7.tgz", - "integrity": "sha512-nK28WOo+QIjBkDduTINE4JkF/UJJKyf2EJxvJKfblDpyg0Q+pkOHNTL0Qwy6NP6FhE/EnzV73BxxqcJaXY9anw==", - "dev": true, - "license": "MIT", - "dependencies": { - "call-bind": "^1.0.8", - "call-bound": "^1.0.3", - "define-properties": "^1.2.1", - "es-object-atoms": "^1.0.0", - "has-symbols": "^1.1.0", - "object-keys": "^1.1.1" - }, - "engines": { - "node": ">= 0.4" - }, - "funding": { - "url": "https://github.com/sponsors/ljharb" - } - }, - "node_modules/obuf": { - "version": "1.1.2", - "resolved": "https://registry.npmjs.org/obuf/-/obuf-1.1.2.tgz", - "integrity": "sha512-PX1wu0AmAdPqOL1mWhqmlOd8kOIZQwGZw6rh7uby9fTc5lhaOWFLX3I6R1hrF9k3zUY40e6igsLGkDXK92LJNg==", + "node_modules/ohash": { + "version": "2.0.11", + "resolved": "https://registry.npmjs.org/ohash/-/ohash-2.0.11.tgz", + "integrity": "sha512-RdR9FQrFwNBNXAr4GixM8YaRZRJ5PUWbKYbE5eOsrwAjJW0q2REGcf79oYPsLyskQCZG1PLN+S/K1V00joZAoQ==", "dev": true, "license": "MIT" }, - "node_modules/on-finished": { - "version": "2.4.1", - "resolved": "https://registry.npmjs.org/on-finished/-/on-finished-2.4.1.tgz", - "integrity": "sha512-oVlzkg3ENAhCk2zdv7IJwd/QUD4z2RxRwpkcGY8psCVcCYZNq4wYnVWALHM+brtuJjePWiYF/ClmuDr8Ch5+kg==", - "dev": true, - "license": "MIT", - "dependencies": { - "ee-first": "1.1.1" - }, - "engines": { - "node": ">= 0.8" - } - }, - "node_modules/on-headers": { - "version": "1.1.0", - "resolved": "https://registry.npmjs.org/on-headers/-/on-headers-1.1.0.tgz", - "integrity": "sha512-737ZY3yNnXy37FHkQxPzt4UZ2UWPWiCZWLvFZ4fu5cueciegX0zGPnrlY6bwRg4FdQOe9YU8MkmJwGhoMybl8A==", - "dev": true, - "license": "MIT", - "engines": { - "node": ">= 0.8" - } - }, "node_modules/once": { "version": "1.4.0", "resolved": "https://registry.npmjs.org/once/-/once-1.4.0.tgz", @@ -18002,32 +11739,23 @@ "url": "https://github.com/sponsors/sindresorhus" } }, - "node_modules/open": { - "version": "8.4.2", - "resolved": "https://registry.npmjs.org/open/-/open-8.4.2.tgz", - "integrity": "sha512-7x81NCL719oNbsq/3mh+hVrAWmFuEYUqrq/Iw3kUzH8ReypT9QQ0BLoJS7/G9k6N81XjW4qHWtjWwe/9eLy1EQ==", + "node_modules/oniguruma-parser": { + "version": "0.12.1", + "resolved": "https://registry.npmjs.org/oniguruma-parser/-/oniguruma-parser-0.12.1.tgz", + "integrity": "sha512-8Unqkvk1RYc6yq2WBYRj4hdnsAxVze8i7iPfQr8e4uSP3tRv0rpZcbGUDvxfQQcdwHt/e9PrMvGCsa8OqG9X3w==", + "dev": true, + "license": "MIT" + }, + "node_modules/oniguruma-to-es": { + "version": "4.3.4", + "resolved": "https://registry.npmjs.org/oniguruma-to-es/-/oniguruma-to-es-4.3.4.tgz", + "integrity": "sha512-3VhUGN3w2eYxnTzHn+ikMI+fp/96KoRSVK9/kMTcFqj1NRDh2IhQCKvYxDnWePKRXY/AqH+Fuiyb7VHSzBjHfA==", "dev": true, "license": "MIT", "dependencies": { - "define-lazy-prop": "^2.0.0", - "is-docker": "^2.1.1", - "is-wsl": "^2.2.0" - }, - "engines": { - "node": ">=12" - }, - "funding": { - "url": "https://github.com/sponsors/sindresorhus" - } - }, - "node_modules/opener": { - "version": "1.5.2", - "resolved": "https://registry.npmjs.org/opener/-/opener-1.5.2.tgz", - "integrity": "sha512-ur5UIdyw5Y7yEj9wLzhqXiy6GZ3Mwx0yGI+5sMn2r0N0v3cKJvUmFH5yPP+WXh9e0xfyzyJX95D8l088DNFj7A==", - "dev": true, - "license": "(WTFPL OR MIT)", - "bin": { - "opener": "bin/opener-bin.js" + "oniguruma-parser": "^0.12.1", + "regex": "^6.0.1", + "regex-recursion": "^6.0.2" } }, "node_modules/optionator": { @@ -18071,37 +11799,48 @@ "url": "https://github.com/sponsors/sindresorhus" } }, - "node_modules/p-cancelable": { - "version": "3.0.0", - "resolved": "https://registry.npmjs.org/p-cancelable/-/p-cancelable-3.0.0.tgz", - "integrity": "sha512-mlVgR3PGuzlo0MmTdk4cXqXWlwQDLnONTAg6sm62XkMJEiRxN3GL3SffkYvqwonbkJBcrI7Uvv5Zh9yjvn2iUw==", - "dev": true, + "node_modules/ora/node_modules/cli-cursor": { + "version": "3.1.0", + "resolved": "https://registry.npmjs.org/cli-cursor/-/cli-cursor-3.1.0.tgz", + "integrity": "sha512-I/zHAwsKf9FqGoXM4WWRACob9+SNukZTd94DWF57E4toouRulbCxcUh6RKUEOQlYTHJnzkPMySvPNaaSLNfLZw==", "license": "MIT", + "dependencies": { + "restore-cursor": "^3.1.0" + }, "engines": { - "node": ">=12.20" + "node": ">=8" } }, - "node_modules/p-finally": { - "version": "1.0.0", - "resolved": "https://registry.npmjs.org/p-finally/-/p-finally-1.0.0.tgz", - "integrity": "sha512-LICb2p9CB7FS+0eR1oqWnHhp0FljGLZCWBE9aix0Uye9W8LTQPwMTYVGWQWIw9RdQiDg4+epXQODwIYJtSJaow==", - "dev": true, + "node_modules/ora/node_modules/restore-cursor": { + "version": "3.1.0", + "resolved": "https://registry.npmjs.org/restore-cursor/-/restore-cursor-3.1.0.tgz", + "integrity": "sha512-l+sSefzHpj5qimhFSE5a8nufZYAM3sBSVMAPtYkmC+4EH2anSGaEMXSD0izRQbu9nfyQ9y5JrVmp7E8oZrUjvA==", "license": "MIT", + "dependencies": { + "onetime": "^5.1.0", + "signal-exit": "^3.0.2" + }, "engines": { - "node": ">=4" + "node": ">=8" } }, + "node_modules/ora/node_modules/signal-exit": { + "version": "3.0.7", + "resolved": "https://registry.npmjs.org/signal-exit/-/signal-exit-3.0.7.tgz", + "integrity": "sha512-wnD2ZE+l+SPC/uoS0vXeE9L1+0wuaMqKlfz9AMUo38JsyLSBWSFcHR1Rri62LZc12vLr1gb3jl7iwQhgwpAbGQ==", + "license": "ISC" + }, "node_modules/p-limit": { - "version": "3.1.0", - "resolved": "https://registry.npmjs.org/p-limit/-/p-limit-3.1.0.tgz", - "integrity": "sha512-TYOanM3wGwNGsZN2cVTYPArw454xnXj5qmWF1bEoAc4+cU/ol7GVh7odevjp1FNHduHc3KZMcFduxU5Xc6uJRQ==", + "version": "6.2.0", + "resolved": "https://registry.npmjs.org/p-limit/-/p-limit-6.2.0.tgz", + "integrity": "sha512-kuUqqHNUqoIWp/c467RI4X6mmyuojY5jGutNU0wVTmEOOfcuwLqyMVoAi9MKi2Ak+5i9+nhmrK4ufZE8069kHA==", "dev": true, "license": "MIT", "dependencies": { - "yocto-queue": "^0.1.0" + "yocto-queue": "^1.1.1" }, "engines": { - "node": ">=10" + "node": ">=18" }, "funding": { "url": "https://github.com/sponsors/sindresorhus" @@ -18123,14 +11862,14 @@ "url": "https://github.com/sponsors/sindresorhus" } }, - "node_modules/p-map": { - "version": "4.0.0", - "resolved": "https://registry.npmjs.org/p-map/-/p-map-4.0.0.tgz", - "integrity": "sha512-/bjOqmgETBYB5BoEeGVea8dmvHb2m9GLy1E9W43yeyfP6QQCZGFNa+XRceJEuDB6zqr+gKpIAmlLebMpykw/MQ==", + "node_modules/p-locate/node_modules/p-limit": { + "version": "3.1.0", + "resolved": "https://registry.npmjs.org/p-limit/-/p-limit-3.1.0.tgz", + "integrity": "sha512-TYOanM3wGwNGsZN2cVTYPArw454xnXj5qmWF1bEoAc4+cU/ol7GVh7odevjp1FNHduHc3KZMcFduxU5Xc6uJRQ==", "dev": true, "license": "MIT", "dependencies": { - "aggregate-error": "^3.0.0" + "yocto-queue": "^0.1.0" }, "engines": { "node": ">=10" @@ -18139,59 +11878,47 @@ "url": "https://github.com/sponsors/sindresorhus" } }, - "node_modules/p-queue": { - "version": "6.6.2", - "resolved": "https://registry.npmjs.org/p-queue/-/p-queue-6.6.2.tgz", - "integrity": "sha512-RwFpb72c/BhQLEXIZ5K2e+AhgNVmIejGlTgiB9MzZ0e93GRvqZ7uSi0dvRF7/XIXDeNkra2fNHBxTyPDGySpjQ==", + "node_modules/p-locate/node_modules/yocto-queue": { + "version": "0.1.0", + "resolved": "https://registry.npmjs.org/yocto-queue/-/yocto-queue-0.1.0.tgz", + "integrity": "sha512-rVksvsnNCdJ/ohGc6xgPwyN8eheCxsiLM8mxuE/t/mOVqJewPuO1miLpTHQiRgTKCLexL4MeAFVagts7HmNZ2Q==", "dev": true, "license": "MIT", - "dependencies": { - "eventemitter3": "^4.0.4", - "p-timeout": "^3.2.0" - }, "engines": { - "node": ">=8" + "node": ">=10" }, "funding": { "url": "https://github.com/sponsors/sindresorhus" } }, - "node_modules/p-queue/node_modules/eventemitter3": { - "version": "4.0.7", - "resolved": "https://registry.npmjs.org/eventemitter3/-/eventemitter3-4.0.7.tgz", - "integrity": "sha512-8guHBZCwKnFhYdHr2ysuRWErTwhoN2X8XELRlrRwpmfeY2jjuUN4taQMsULKUVo1K4DvZl+0pgfyoysHxvmvEw==", - "dev": true, - "license": "MIT" - }, - "node_modules/p-retry": { - "version": "6.2.1", - "resolved": "https://registry.npmjs.org/p-retry/-/p-retry-6.2.1.tgz", - "integrity": "sha512-hEt02O4hUct5wtwg4H4KcWgDdm+l1bOaEy/hWzd8xtXB9BqxTWBBhb+2ImAtH4Cv4rPjV76xN3Zumqk3k3AhhQ==", + "node_modules/p-queue": { + "version": "8.1.1", + "resolved": "https://registry.npmjs.org/p-queue/-/p-queue-8.1.1.tgz", + "integrity": "sha512-aNZ+VfjobsWryoiPnEApGGmf5WmNsCo9xu8dfaYamG5qaLP7ClhLN6NgsFe6SwJ2UbLEBK5dv9x8Mn5+RVhMWQ==", "dev": true, "license": "MIT", "dependencies": { - "@types/retry": "0.12.2", - "is-network-error": "^1.0.0", - "retry": "^0.13.1" + "eventemitter3": "^5.0.1", + "p-timeout": "^6.1.2" }, "engines": { - "node": ">=16.17" + "node": ">=18" }, "funding": { "url": "https://github.com/sponsors/sindresorhus" } }, "node_modules/p-timeout": { - "version": "3.2.0", - "resolved": "https://registry.npmjs.org/p-timeout/-/p-timeout-3.2.0.tgz", - "integrity": "sha512-rhIwUycgwwKcP9yTOOFK/AKsAopjjCakVqLHePO3CC6Mir1Z99xT+R63jZxAT5lFZLa2inS5h+ZS2GvR99/FBg==", + "version": "6.1.4", + "resolved": "https://registry.npmjs.org/p-timeout/-/p-timeout-6.1.4.tgz", + "integrity": "sha512-MyIV3ZA/PmyBN/ud8vV9XzwTrNtR4jFrObymZYnZqMmW0zA8Z17vnT0rBgFE/TlohB+YCHqXMgZzb3Csp49vqg==", "dev": true, "license": "MIT", - "dependencies": { - "p-finally": "^1.0.0" - }, "engines": { - "node": ">=8" + "node": ">=14.16" + }, + "funding": { + "url": "https://github.com/sponsors/sindresorhus" } }, "node_modules/p-try": { @@ -18204,42 +11931,44 @@ "node": ">=6" } }, - "node_modules/package-json": { - "version": "8.1.1", - "resolved": "https://registry.npmjs.org/package-json/-/package-json-8.1.1.tgz", - "integrity": "sha512-cbH9IAIJHNj9uXi196JVsRlt7cHKak6u/e6AkL/bkRelZ7rlL3X1YKxsZwa36xipOEKAsdtmaG6aAJoM1fx2zA==", - "dev": true, - "license": "MIT", - "dependencies": { - "got": "^12.1.0", - "registry-auth-token": "^5.0.1", - "registry-url": "^6.0.0", - "semver": "^7.3.7" - }, - "engines": { - "node": ">=14.16" - }, - "funding": { - "url": "https://github.com/sponsors/sindresorhus" - } - }, "node_modules/package-json-from-dist": { "version": "1.0.1", "resolved": "https://registry.npmjs.org/package-json-from-dist/-/package-json-from-dist-1.0.1.tgz", "integrity": "sha512-UEZIS3/by4OC8vL3P2dTXRETpebLI2NiI5vIrjaD/5UtrkFX/tNbwjTSRAGC/+7CAo2pIcBaRgWmcBBHcsaCIw==", "license": "BlueOak-1.0.0" }, - "node_modules/param-case": { - "version": "3.0.4", - "resolved": "https://registry.npmjs.org/param-case/-/param-case-3.0.4.tgz", - "integrity": "sha512-RXlj7zCYokReqWpOPH9oYivUzLYZ5vAPIfEmCTNViosC78F8F0H9y7T7gG2M39ymgutxF5gcFEsyZQSph9Bp3A==", + "node_modules/package-manager-detector": { + "version": "1.6.0", + "resolved": "https://registry.npmjs.org/package-manager-detector/-/package-manager-detector-1.6.0.tgz", + "integrity": "sha512-61A5ThoTiDG/C8s8UMZwSorAGwMJ0ERVGj2OjoW5pAalsNOg15+iQiPzrLJ4jhZ1HJzmC2PIHT2oEiH3R5fzNA==", + "dev": true, + "license": "MIT" + }, + "node_modules/pagefind": { + "version": "1.4.0", + "resolved": "https://registry.npmjs.org/pagefind/-/pagefind-1.4.0.tgz", + "integrity": "sha512-z2kY1mQlL4J8q5EIsQkLzQjilovKzfNVhX8De6oyE6uHpfFtyBaqUpcl/XzJC/4fjD8vBDyh1zolimIcVrCn9g==", "dev": true, "license": "MIT", - "dependencies": { - "dot-case": "^3.0.4", - "tslib": "^2.0.3" + "bin": { + "pagefind": "lib/runner/bin.cjs" + }, + "optionalDependencies": { + "@pagefind/darwin-arm64": "1.4.0", + "@pagefind/darwin-x64": "1.4.0", + "@pagefind/freebsd-x64": "1.4.0", + "@pagefind/linux-arm64": "1.4.0", + "@pagefind/linux-x64": "1.4.0", + "@pagefind/windows-x64": "1.4.0" } }, + "node_modules/pako": { + "version": "0.2.9", + "resolved": "https://registry.npmjs.org/pako/-/pako-0.2.9.tgz", + "integrity": "sha512-NUcwaKxUxWrZLpDG+z/xZaCgQITkA/Dv4V/T6bw7VON6l1Xz/VnrBqrYjZQ12TamKHzITTfOEIYUj48y2KXImA==", + "dev": true, + "license": "MIT" + }, "node_modules/parent-module": { "version": "1.0.1", "resolved": "https://registry.npmjs.org/parent-module/-/parent-module-1.0.1.tgz", @@ -18299,12 +12028,24 @@ "url": "https://github.com/sponsors/sindresorhus" } }, - "node_modules/parse-numeric-range": { - "version": "1.3.0", - "resolved": "https://registry.npmjs.org/parse-numeric-range/-/parse-numeric-range-1.3.0.tgz", - "integrity": "sha512-twN+njEipszzlMJd4ONUYgSfZPDxgHhT9Ahed5uTigpQn90FggW4SA/AIPq/6a149fTbE9qBEcSwE3FAEp6wQQ==", + "node_modules/parse-latin": { + "version": "7.0.0", + "resolved": "https://registry.npmjs.org/parse-latin/-/parse-latin-7.0.0.tgz", + "integrity": "sha512-mhHgobPPua5kZ98EF4HWiH167JWBfl4pvAIXXdbaVohtK7a6YBOy56kvhCqduqyo/f3yrHFWmqmiMg/BkBkYYQ==", "dev": true, - "license": "ISC" + "license": "MIT", + "dependencies": { + "@types/nlcst": "^2.0.0", + "@types/unist": "^3.0.0", + "nlcst-to-string": "^4.0.0", + "unist-util-modify-children": "^4.0.0", + "unist-util-visit-children": "^3.0.0", + "vfile": "^6.0.0" + }, + "funding": { + "type": "github", + "url": "https://github.com/sponsors/wooorm" + } }, "node_modules/parse5": { "version": "7.3.0", @@ -18319,20 +12060,6 @@ "url": "https://github.com/inikulin/parse5?sponsor=1" } }, - "node_modules/parse5-htmlparser2-tree-adapter": { - "version": "7.1.0", - "resolved": "https://registry.npmjs.org/parse5-htmlparser2-tree-adapter/-/parse5-htmlparser2-tree-adapter-7.1.0.tgz", - "integrity": "sha512-ruw5xyKs6lrpo9x9rCZqZZnIUntICjQAd0Wsmp396Ul9lN/h+ifgVV1x1gZHi8euej6wTfpqX8j+BFQxF0NS/g==", - "dev": true, - "license": "MIT", - "dependencies": { - "domhandler": "^5.0.3", - "parse5": "^7.0.0" - }, - "funding": { - "url": "https://github.com/inikulin/parse5?sponsor=1" - } - }, "node_modules/parse5/node_modules/entities": { "version": "6.0.1", "resolved": "https://registry.npmjs.org/entities/-/entities-6.0.1.tgz", @@ -18346,27 +12073,6 @@ "url": "https://github.com/fb55/entities?sponsor=1" } }, - "node_modules/parseurl": { - "version": "1.3.3", - "resolved": "https://registry.npmjs.org/parseurl/-/parseurl-1.3.3.tgz", - "integrity": "sha512-CiyeOxFT/JZyN5m0z9PfXw4SCBJ6Sygz1Dpl0wqjlhDEGGBP1GnsUVEL0p63hoG1fcj3fHynXi9NYO4nWOL+qQ==", - "dev": true, - "license": "MIT", - "engines": { - "node": ">= 0.8" - } - }, - "node_modules/pascal-case": { - "version": "3.1.2", - "resolved": "https://registry.npmjs.org/pascal-case/-/pascal-case-3.1.2.tgz", - "integrity": "sha512-uWlGT3YSnK9x3BQJaOdcZwrnV6hPpd8jFH1/ucpiLRPh/2zCVJKS19E4GvYHvaCcACn3foXZ0cLB9Wrx1KGe5g==", - "dev": true, - "license": "MIT", - "dependencies": { - "no-case": "^3.0.4", - "tslib": "^2.0.3" - } - }, "node_modules/path-exists": { "version": "4.0.0", "resolved": "https://registry.npmjs.org/path-exists/-/path-exists-4.0.0.tgz", @@ -18387,13 +12093,6 @@ "node": ">=0.10.0" } }, - "node_modules/path-is-inside": { - "version": "1.0.2", - "resolved": "https://registry.npmjs.org/path-is-inside/-/path-is-inside-1.0.2.tgz", - "integrity": "sha512-DUWJr3+ULp4zXmol/SZkFf3JGsS9/SIv+Y3Rt93/UjPpDpklB5f1er4O3POIbUuUJ3FXgqte2Q7SrU6zAqwk8w==", - "dev": true, - "license": "(WTFPL OR MIT)" - }, "node_modules/path-key": { "version": "3.1.1", "resolved": "https://registry.npmjs.org/path-key/-/path-key-3.1.1.tgz", @@ -18403,17 +12102,10 @@ "node": ">=8" } }, - "node_modules/path-parse": { - "version": "1.0.7", - "resolved": "https://registry.npmjs.org/path-parse/-/path-parse-1.0.7.tgz", - "integrity": "sha512-LDJzPVEEEPR+y48z93A0Ed0yXb8pAByGWo/k5YYdYgpY2/2EsOsksJrq7lOHxryrVOn1ejG6oAp8ahvOIQD8sw==", - "dev": true, - "license": "MIT" - }, "node_modules/path-scurry": { - "version": "2.0.0", - "resolved": "https://registry.npmjs.org/path-scurry/-/path-scurry-2.0.0.tgz", - "integrity": "sha512-ypGJsmGtdXUOeM5u93TyeIEfEhM6s+ljAhrk5vAvSx8uyY/02OvrZnA0YNGUrPXfpJMgI1ODd3nwz8Npx4O4cg==", + "version": "2.0.1", + "resolved": "https://registry.npmjs.org/path-scurry/-/path-scurry-2.0.1.tgz", + "integrity": "sha512-oWyT4gICAu+kaA7QWk/jvCHWarMKNs6pXOGWKDTr7cw4IGcUbW+PeTfbaQiLGheFRpjo6O9J0PmyMfQPjH71oA==", "license": "BlueOak-1.0.0", "dependencies": { "lru-cache": "^11.0.0", @@ -18427,34 +12119,34 @@ } }, "node_modules/path-scurry/node_modules/lru-cache": { - "version": "11.1.0", - "resolved": "https://registry.npmjs.org/lru-cache/-/lru-cache-11.1.0.tgz", - "integrity": "sha512-QIXZUBJUx+2zHUdQujWejBkcD9+cs94tLn0+YL8UrCh+D5sCXZ4c7LaEH48pNwRY3MLDgqUFyhlCyjJPf1WP0A==", - "license": "ISC", + "version": "11.2.4", + "resolved": "https://registry.npmjs.org/lru-cache/-/lru-cache-11.2.4.tgz", + "integrity": "sha512-B5Y16Jr9LB9dHVkh6ZevG+vAbOsNOYCX+sXvFWFu7B3Iz5mijW3zdbMyhsh8ANd2mSWBYdJgnqi+mL7/LrOPYg==", + "license": "BlueOak-1.0.0", "engines": { "node": "20 || >=22" } }, - "node_modules/path-to-regexp": { - "version": "1.9.0", - "resolved": "https://registry.npmjs.org/path-to-regexp/-/path-to-regexp-1.9.0.tgz", - "integrity": "sha512-xIp7/apCFJuUHdDLWe8O1HIkb0kQrOMb/0u6FXQjemHn/ii5LrIzU6bdECnsiTF/GjZkMEKg1xdiZwNqDYlZ6g==", - "dev": true, - "license": "MIT", - "dependencies": { - "isarray": "0.0.1" - } - }, "node_modules/path-type": { - "version": "4.0.0", - "resolved": "https://registry.npmjs.org/path-type/-/path-type-4.0.0.tgz", - "integrity": "sha512-gDKb8aZMDeD/tZWs9P6+q0J9Mwkdl6xMV8TjnGP3qJVJ06bdMgkbBlLU8IdfOsIsFz2BW1rNVT3XuNEl8zPAvw==", + "version": "6.0.0", + "resolved": "https://registry.npmjs.org/path-type/-/path-type-6.0.0.tgz", + "integrity": "sha512-Vj7sf++t5pBD637NSfkxpHSMfWaeig5+DKWLhcqIYx6mWQz5hdJTGDVMQiJcw1ZYkhs7AazKDGpRVji1LJCZUQ==", "dev": true, "license": "MIT", "engines": { - "node": ">=8" + "node": ">=18" + }, + "funding": { + "url": "https://github.com/sponsors/sindresorhus" } }, + "node_modules/piccolore": { + "version": "0.1.3", + "resolved": "https://registry.npmjs.org/piccolore/-/piccolore-0.1.3.tgz", + "integrity": "sha512-o8bTeDWjE086iwKrROaDf31K0qC/BENdm15/uH9usSC/uZjJOKb2YGiVHfLY4GhwsERiPI1jmwI2XrA7ACOxVw==", + "dev": true, + "license": "ISC" + }, "node_modules/picocolors": { "version": "1.1.1", "resolved": "https://registry.npmjs.org/picocolors/-/picocolors-1.1.1.tgz", @@ -18463,13 +12155,13 @@ "license": "ISC" }, "node_modules/picomatch": { - "version": "2.3.1", - "resolved": "https://registry.npmjs.org/picomatch/-/picomatch-2.3.1.tgz", - "integrity": "sha512-JU3teHTNjmE2VCGFzuY8EXzCDVwEqB2a8fsIvwaStHhAWJEeVd1o1QD80CU6+ZdEXXSLbSsuLwJjkCBWqRQUVA==", + "version": "4.0.3", + "resolved": "https://registry.npmjs.org/picomatch/-/picomatch-4.0.3.tgz", + "integrity": "sha512-5gTmgEY/sqK6gFXLIsQNH19lWb4ebPDLA4SdLP7dsWkIXHWlG66oPuVvXSGFPppYZz8ZDZq0dYYrbHfBCVUb1Q==", "dev": true, "license": "MIT", "engines": { - "node": ">=8.6" + "node": ">=12" }, "funding": { "url": "https://github.com/sponsors/jonschlinkert" @@ -18597,7 +12289,6 @@ } ], "license": "MIT", - "peer": true, "dependencies": { "nanoid": "^3.3.11", "picocolors": "^1.1.1", @@ -18607,1432 +12298,30 @@ "node": "^10 || ^12 || >=14" } }, - "node_modules/postcss-attribute-case-insensitive": { - "version": "7.0.1", - "resolved": "https://registry.npmjs.org/postcss-attribute-case-insensitive/-/postcss-attribute-case-insensitive-7.0.1.tgz", - "integrity": "sha512-Uai+SupNSqzlschRyNx3kbCTWgY/2hcwtHEI/ej2LJWc9JJ77qKgGptd8DHwY1mXtZ7Aoh4z4yxfwMBue9eNgw==", + "node_modules/postcss-nested": { + "version": "6.2.0", + "resolved": "https://registry.npmjs.org/postcss-nested/-/postcss-nested-6.2.0.tgz", + "integrity": "sha512-HQbt28KulC5AJzG+cZtj9kvKB93CFCdLvog1WFLf1D+xmMvPGlBstkpTEZfK5+AN9hfJocyBFCNiqyS48bpgzQ==", "dev": true, "funding": [ - { - "type": "github", - "url": "https://github.com/sponsors/csstools" - }, { "type": "opencollective", - "url": "https://opencollective.com/csstools" - } - ], - "license": "MIT", - "dependencies": { - "postcss-selector-parser": "^7.0.0" - }, - "engines": { - "node": ">=18" - }, - "peerDependencies": { - "postcss": "^8.4" - } - }, - "node_modules/postcss-attribute-case-insensitive/node_modules/postcss-selector-parser": { - "version": "7.1.1", - "resolved": "https://registry.npmjs.org/postcss-selector-parser/-/postcss-selector-parser-7.1.1.tgz", - "integrity": "sha512-orRsuYpJVw8LdAwqqLykBj9ecS5/cRHlI5+nvTo8LcCKmzDmqVORXtOIYEEQuL9D4BxtA1lm5isAqzQZCoQ6Eg==", - "dev": true, - "license": "MIT", - "dependencies": { - "cssesc": "^3.0.0", - "util-deprecate": "^1.0.2" - }, - "engines": { - "node": ">=4" - } - }, - "node_modules/postcss-calc": { - "version": "9.0.1", - "resolved": "https://registry.npmjs.org/postcss-calc/-/postcss-calc-9.0.1.tgz", - "integrity": "sha512-TipgjGyzP5QzEhsOZUaIkeO5mKeMFpebWzRogWG/ysonUlnHcq5aJe0jOjpfzUU8PeSaBQnrE8ehR0QA5vs8PQ==", - "dev": true, - "license": "MIT", - "dependencies": { - "postcss-selector-parser": "^6.0.11", - "postcss-value-parser": "^4.2.0" - }, - "engines": { - "node": "^14 || ^16 || >=18.0" - }, - "peerDependencies": { - "postcss": "^8.2.2" - } - }, - "node_modules/postcss-clamp": { - "version": "4.1.0", - "resolved": "https://registry.npmjs.org/postcss-clamp/-/postcss-clamp-4.1.0.tgz", - "integrity": "sha512-ry4b1Llo/9zz+PKC+030KUnPITTJAHeOwjfAyyB60eT0AorGLdzp52s31OsPRHRf8NchkgFoG2y6fCfn1IV1Ow==", - "dev": true, - "license": "MIT", - "dependencies": { - "postcss-value-parser": "^4.2.0" - }, - "engines": { - "node": ">=7.6.0" - }, - "peerDependencies": { - "postcss": "^8.4.6" - } - }, - "node_modules/postcss-color-functional-notation": { - "version": "7.0.12", - "resolved": "https://registry.npmjs.org/postcss-color-functional-notation/-/postcss-color-functional-notation-7.0.12.tgz", - "integrity": "sha512-TLCW9fN5kvO/u38/uesdpbx3e8AkTYhMvDZYa9JpmImWuTE99bDQ7GU7hdOADIZsiI9/zuxfAJxny/khknp1Zw==", - "dev": true, - "funding": [ + "url": "https://opencollective.com/postcss/" + }, { "type": "github", - "url": "https://github.com/sponsors/csstools" - }, - { - "type": "opencollective", - "url": "https://opencollective.com/csstools" - } - ], - "license": "MIT-0", - "dependencies": { - "@csstools/css-color-parser": "^3.1.0", - "@csstools/css-parser-algorithms": "^3.0.5", - "@csstools/css-tokenizer": "^3.0.4", - "@csstools/postcss-progressive-custom-properties": "^4.2.1", - "@csstools/utilities": "^2.0.0" - }, - "engines": { - "node": ">=18" - }, - "peerDependencies": { - "postcss": "^8.4" - } - }, - "node_modules/postcss-color-hex-alpha": { - "version": "10.0.0", - "resolved": "https://registry.npmjs.org/postcss-color-hex-alpha/-/postcss-color-hex-alpha-10.0.0.tgz", - "integrity": "sha512-1kervM2cnlgPs2a8Vt/Qbe5cQ++N7rkYo/2rz2BkqJZIHQwaVuJgQH38REHrAi4uM0b1fqxMkWYmese94iMp3w==", - "dev": true, - "funding": [ - { - "type": "github", - "url": "https://github.com/sponsors/csstools" - }, - { - "type": "opencollective", - "url": "https://opencollective.com/csstools" + "url": "https://github.com/sponsors/ai" } ], "license": "MIT", "dependencies": { - "@csstools/utilities": "^2.0.0", - "postcss-value-parser": "^4.2.0" + "postcss-selector-parser": "^6.1.1" }, "engines": { - "node": ">=18" + "node": ">=12.0" }, "peerDependencies": { - "postcss": "^8.4" - } - }, - "node_modules/postcss-color-rebeccapurple": { - "version": "10.0.0", - "resolved": "https://registry.npmjs.org/postcss-color-rebeccapurple/-/postcss-color-rebeccapurple-10.0.0.tgz", - "integrity": "sha512-JFta737jSP+hdAIEhk1Vs0q0YF5P8fFcj+09pweS8ktuGuZ8pPlykHsk6mPxZ8awDl4TrcxUqJo9l1IhVr/OjQ==", - "dev": true, - "funding": [ - { - "type": "github", - "url": "https://github.com/sponsors/csstools" - }, - { - "type": "opencollective", - "url": "https://opencollective.com/csstools" - } - ], - "license": "MIT-0", - "dependencies": { - "@csstools/utilities": "^2.0.0", - "postcss-value-parser": "^4.2.0" - }, - "engines": { - "node": ">=18" - }, - "peerDependencies": { - "postcss": "^8.4" - } - }, - "node_modules/postcss-colormin": { - "version": "6.1.0", - "resolved": "https://registry.npmjs.org/postcss-colormin/-/postcss-colormin-6.1.0.tgz", - "integrity": "sha512-x9yX7DOxeMAR+BgGVnNSAxmAj98NX/YxEMNFP+SDCEeNLb2r3i6Hh1ksMsnW8Ub5SLCpbescQqn9YEbE9554Sw==", - "dev": true, - "license": "MIT", - "dependencies": { - "browserslist": "^4.23.0", - "caniuse-api": "^3.0.0", - "colord": "^2.9.3", - "postcss-value-parser": "^4.2.0" - }, - "engines": { - "node": "^14 || ^16 || >=18.0" - }, - "peerDependencies": { - "postcss": "^8.4.31" - } - }, - "node_modules/postcss-convert-values": { - "version": "6.1.0", - "resolved": "https://registry.npmjs.org/postcss-convert-values/-/postcss-convert-values-6.1.0.tgz", - "integrity": "sha512-zx8IwP/ts9WvUM6NkVSkiU902QZL1bwPhaVaLynPtCsOTqp+ZKbNi+s6XJg3rfqpKGA/oc7Oxk5t8pOQJcwl/w==", - "dev": true, - "license": "MIT", - "dependencies": { - "browserslist": "^4.23.0", - "postcss-value-parser": "^4.2.0" - }, - "engines": { - "node": "^14 || ^16 || >=18.0" - }, - "peerDependencies": { - "postcss": "^8.4.31" - } - }, - "node_modules/postcss-custom-media": { - "version": "11.0.6", - "resolved": "https://registry.npmjs.org/postcss-custom-media/-/postcss-custom-media-11.0.6.tgz", - "integrity": "sha512-C4lD4b7mUIw+RZhtY7qUbf4eADmb7Ey8BFA2px9jUbwg7pjTZDl4KY4bvlUV+/vXQvzQRfiGEVJyAbtOsCMInw==", - "dev": true, - "funding": [ - { - "type": "github", - "url": "https://github.com/sponsors/csstools" - }, - { - "type": "opencollective", - "url": "https://opencollective.com/csstools" - } - ], - "license": "MIT", - "dependencies": { - "@csstools/cascade-layer-name-parser": "^2.0.5", - "@csstools/css-parser-algorithms": "^3.0.5", - "@csstools/css-tokenizer": "^3.0.4", - "@csstools/media-query-list-parser": "^4.0.3" - }, - "engines": { - "node": ">=18" - }, - "peerDependencies": { - "postcss": "^8.4" - } - }, - "node_modules/postcss-custom-properties": { - "version": "14.0.6", - "resolved": "https://registry.npmjs.org/postcss-custom-properties/-/postcss-custom-properties-14.0.6.tgz", - "integrity": "sha512-fTYSp3xuk4BUeVhxCSJdIPhDLpJfNakZKoiTDx7yRGCdlZrSJR7mWKVOBS4sBF+5poPQFMj2YdXx1VHItBGihQ==", - "dev": true, - "funding": [ - { - "type": "github", - "url": "https://github.com/sponsors/csstools" - }, - { - "type": "opencollective", - "url": "https://opencollective.com/csstools" - } - ], - "license": "MIT", - "dependencies": { - "@csstools/cascade-layer-name-parser": "^2.0.5", - "@csstools/css-parser-algorithms": "^3.0.5", - "@csstools/css-tokenizer": "^3.0.4", - "@csstools/utilities": "^2.0.0", - "postcss-value-parser": "^4.2.0" - }, - "engines": { - "node": ">=18" - }, - "peerDependencies": { - "postcss": "^8.4" - } - }, - "node_modules/postcss-custom-selectors": { - "version": "8.0.5", - "resolved": "https://registry.npmjs.org/postcss-custom-selectors/-/postcss-custom-selectors-8.0.5.tgz", - "integrity": "sha512-9PGmckHQswiB2usSO6XMSswO2yFWVoCAuih1yl9FVcwkscLjRKjwsjM3t+NIWpSU2Jx3eOiK2+t4vVTQaoCHHg==", - "dev": true, - "funding": [ - { - "type": "github", - "url": "https://github.com/sponsors/csstools" - }, - { - "type": "opencollective", - "url": "https://opencollective.com/csstools" - } - ], - "license": "MIT", - "dependencies": { - "@csstools/cascade-layer-name-parser": "^2.0.5", - "@csstools/css-parser-algorithms": "^3.0.5", - "@csstools/css-tokenizer": "^3.0.4", - "postcss-selector-parser": "^7.0.0" - }, - "engines": { - "node": ">=18" - }, - "peerDependencies": { - "postcss": "^8.4" - } - }, - "node_modules/postcss-custom-selectors/node_modules/postcss-selector-parser": { - "version": "7.1.1", - "resolved": "https://registry.npmjs.org/postcss-selector-parser/-/postcss-selector-parser-7.1.1.tgz", - "integrity": "sha512-orRsuYpJVw8LdAwqqLykBj9ecS5/cRHlI5+nvTo8LcCKmzDmqVORXtOIYEEQuL9D4BxtA1lm5isAqzQZCoQ6Eg==", - "dev": true, - "license": "MIT", - "dependencies": { - "cssesc": "^3.0.0", - "util-deprecate": "^1.0.2" - }, - "engines": { - "node": ">=4" - } - }, - "node_modules/postcss-dir-pseudo-class": { - "version": "9.0.1", - "resolved": "https://registry.npmjs.org/postcss-dir-pseudo-class/-/postcss-dir-pseudo-class-9.0.1.tgz", - "integrity": "sha512-tRBEK0MHYvcMUrAuYMEOa0zg9APqirBcgzi6P21OhxtJyJADo/SWBwY1CAwEohQ/6HDaa9jCjLRG7K3PVQYHEA==", - "dev": true, - "funding": [ - { - "type": "github", - "url": "https://github.com/sponsors/csstools" - }, - { - "type": "opencollective", - "url": "https://opencollective.com/csstools" - } - ], - "license": "MIT-0", - "dependencies": { - "postcss-selector-parser": "^7.0.0" - }, - "engines": { - "node": ">=18" - }, - "peerDependencies": { - "postcss": "^8.4" - } - }, - "node_modules/postcss-dir-pseudo-class/node_modules/postcss-selector-parser": { - "version": "7.1.1", - "resolved": "https://registry.npmjs.org/postcss-selector-parser/-/postcss-selector-parser-7.1.1.tgz", - "integrity": "sha512-orRsuYpJVw8LdAwqqLykBj9ecS5/cRHlI5+nvTo8LcCKmzDmqVORXtOIYEEQuL9D4BxtA1lm5isAqzQZCoQ6Eg==", - "dev": true, - "license": "MIT", - "dependencies": { - "cssesc": "^3.0.0", - "util-deprecate": "^1.0.2" - }, - "engines": { - "node": ">=4" - } - }, - "node_modules/postcss-discard-comments": { - "version": "6.0.2", - "resolved": "https://registry.npmjs.org/postcss-discard-comments/-/postcss-discard-comments-6.0.2.tgz", - "integrity": "sha512-65w/uIqhSBBfQmYnG92FO1mWZjJ4GL5b8atm5Yw2UgrwD7HiNiSSNwJor1eCFGzUgYnN/iIknhNRVqjrrpuglw==", - "dev": true, - "license": "MIT", - "engines": { - "node": "^14 || ^16 || >=18.0" - }, - "peerDependencies": { - "postcss": "^8.4.31" - } - }, - "node_modules/postcss-discard-duplicates": { - "version": "6.0.3", - "resolved": "https://registry.npmjs.org/postcss-discard-duplicates/-/postcss-discard-duplicates-6.0.3.tgz", - "integrity": "sha512-+JA0DCvc5XvFAxwx6f/e68gQu/7Z9ud584VLmcgto28eB8FqSFZwtrLwB5Kcp70eIoWP/HXqz4wpo8rD8gpsTw==", - "dev": true, - "license": "MIT", - "engines": { - "node": "^14 || ^16 || >=18.0" - }, - "peerDependencies": { - "postcss": "^8.4.31" - } - }, - "node_modules/postcss-discard-empty": { - "version": "6.0.3", - "resolved": "https://registry.npmjs.org/postcss-discard-empty/-/postcss-discard-empty-6.0.3.tgz", - "integrity": "sha512-znyno9cHKQsK6PtxL5D19Fj9uwSzC2mB74cpT66fhgOadEUPyXFkbgwm5tvc3bt3NAy8ltE5MrghxovZRVnOjQ==", - "dev": true, - "license": "MIT", - "engines": { - "node": "^14 || ^16 || >=18.0" - }, - "peerDependencies": { - "postcss": "^8.4.31" - } - }, - "node_modules/postcss-discard-overridden": { - "version": "6.0.2", - "resolved": "https://registry.npmjs.org/postcss-discard-overridden/-/postcss-discard-overridden-6.0.2.tgz", - "integrity": "sha512-j87xzI4LUggC5zND7KdjsI25APtyMuynXZSujByMaav2roV6OZX+8AaCUcZSWqckZpjAjRyFDdpqybgjFO0HJQ==", - "dev": true, - "license": "MIT", - "engines": { - "node": "^14 || ^16 || >=18.0" - }, - "peerDependencies": { - "postcss": "^8.4.31" - } - }, - "node_modules/postcss-discard-unused": { - "version": "6.0.5", - "resolved": "https://registry.npmjs.org/postcss-discard-unused/-/postcss-discard-unused-6.0.5.tgz", - "integrity": "sha512-wHalBlRHkaNnNwfC8z+ppX57VhvS+HWgjW508esjdaEYr3Mx7Gnn2xA4R/CKf5+Z9S5qsqC+Uzh4ueENWwCVUA==", - "dev": true, - "license": "MIT", - "dependencies": { - "postcss-selector-parser": "^6.0.16" - }, - "engines": { - "node": "^14 || ^16 || >=18.0" - }, - "peerDependencies": { - "postcss": "^8.4.31" - } - }, - "node_modules/postcss-double-position-gradients": { - "version": "6.0.4", - "resolved": "https://registry.npmjs.org/postcss-double-position-gradients/-/postcss-double-position-gradients-6.0.4.tgz", - "integrity": "sha512-m6IKmxo7FxSP5nF2l63QbCC3r+bWpFUWmZXZf096WxG0m7Vl1Q1+ruFOhpdDRmKrRS+S3Jtk+TVk/7z0+BVK6g==", - "dev": true, - "funding": [ - { - "type": "github", - "url": "https://github.com/sponsors/csstools" - }, - { - "type": "opencollective", - "url": "https://opencollective.com/csstools" - } - ], - "license": "MIT-0", - "dependencies": { - "@csstools/postcss-progressive-custom-properties": "^4.2.1", - "@csstools/utilities": "^2.0.0", - "postcss-value-parser": "^4.2.0" - }, - "engines": { - "node": ">=18" - }, - "peerDependencies": { - "postcss": "^8.4" - } - }, - "node_modules/postcss-focus-visible": { - "version": "10.0.1", - "resolved": "https://registry.npmjs.org/postcss-focus-visible/-/postcss-focus-visible-10.0.1.tgz", - "integrity": "sha512-U58wyjS/I1GZgjRok33aE8juW9qQgQUNwTSdxQGuShHzwuYdcklnvK/+qOWX1Q9kr7ysbraQ6ht6r+udansalA==", - "dev": true, - "funding": [ - { - "type": "github", - "url": "https://github.com/sponsors/csstools" - }, - { - "type": "opencollective", - "url": "https://opencollective.com/csstools" - } - ], - "license": "MIT-0", - "dependencies": { - "postcss-selector-parser": "^7.0.0" - }, - "engines": { - "node": ">=18" - }, - "peerDependencies": { - "postcss": "^8.4" - } - }, - "node_modules/postcss-focus-visible/node_modules/postcss-selector-parser": { - "version": "7.1.1", - "resolved": "https://registry.npmjs.org/postcss-selector-parser/-/postcss-selector-parser-7.1.1.tgz", - "integrity": "sha512-orRsuYpJVw8LdAwqqLykBj9ecS5/cRHlI5+nvTo8LcCKmzDmqVORXtOIYEEQuL9D4BxtA1lm5isAqzQZCoQ6Eg==", - "dev": true, - "license": "MIT", - "dependencies": { - "cssesc": "^3.0.0", - "util-deprecate": "^1.0.2" - }, - "engines": { - "node": ">=4" - } - }, - "node_modules/postcss-focus-within": { - "version": "9.0.1", - "resolved": "https://registry.npmjs.org/postcss-focus-within/-/postcss-focus-within-9.0.1.tgz", - "integrity": "sha512-fzNUyS1yOYa7mOjpci/bR+u+ESvdar6hk8XNK/TRR0fiGTp2QT5N+ducP0n3rfH/m9I7H/EQU6lsa2BrgxkEjw==", - "dev": true, - "funding": [ - { - "type": "github", - "url": "https://github.com/sponsors/csstools" - }, - { - "type": "opencollective", - "url": "https://opencollective.com/csstools" - } - ], - "license": "MIT-0", - "dependencies": { - "postcss-selector-parser": "^7.0.0" - }, - "engines": { - "node": ">=18" - }, - "peerDependencies": { - "postcss": "^8.4" - } - }, - "node_modules/postcss-focus-within/node_modules/postcss-selector-parser": { - "version": "7.1.1", - "resolved": "https://registry.npmjs.org/postcss-selector-parser/-/postcss-selector-parser-7.1.1.tgz", - "integrity": "sha512-orRsuYpJVw8LdAwqqLykBj9ecS5/cRHlI5+nvTo8LcCKmzDmqVORXtOIYEEQuL9D4BxtA1lm5isAqzQZCoQ6Eg==", - "dev": true, - "license": "MIT", - "dependencies": { - "cssesc": "^3.0.0", - "util-deprecate": "^1.0.2" - }, - "engines": { - "node": ">=4" - } - }, - "node_modules/postcss-font-variant": { - "version": "5.0.0", - "resolved": "https://registry.npmjs.org/postcss-font-variant/-/postcss-font-variant-5.0.0.tgz", - "integrity": "sha512-1fmkBaCALD72CK2a9i468mA/+tr9/1cBxRRMXOUaZqO43oWPR5imcyPjXwuv7PXbCid4ndlP5zWhidQVVa3hmA==", - "dev": true, - "license": "MIT", - "peerDependencies": { - "postcss": "^8.1.0" - } - }, - "node_modules/postcss-gap-properties": { - "version": "6.0.0", - "resolved": "https://registry.npmjs.org/postcss-gap-properties/-/postcss-gap-properties-6.0.0.tgz", - "integrity": "sha512-Om0WPjEwiM9Ru+VhfEDPZJAKWUd0mV1HmNXqp2C29z80aQ2uP9UVhLc7e3aYMIor/S5cVhoPgYQ7RtfeZpYTRw==", - "dev": true, - "funding": [ - { - "type": "github", - "url": "https://github.com/sponsors/csstools" - }, - { - "type": "opencollective", - "url": "https://opencollective.com/csstools" - } - ], - "license": "MIT-0", - "engines": { - "node": ">=18" - }, - "peerDependencies": { - "postcss": "^8.4" - } - }, - "node_modules/postcss-image-set-function": { - "version": "7.0.0", - "resolved": "https://registry.npmjs.org/postcss-image-set-function/-/postcss-image-set-function-7.0.0.tgz", - "integrity": "sha512-QL7W7QNlZuzOwBTeXEmbVckNt1FSmhQtbMRvGGqqU4Nf4xk6KUEQhAoWuMzwbSv5jxiRiSZ5Tv7eiDB9U87znA==", - "dev": true, - "funding": [ - { - "type": "github", - "url": "https://github.com/sponsors/csstools" - }, - { - "type": "opencollective", - "url": "https://opencollective.com/csstools" - } - ], - "license": "MIT-0", - "dependencies": { - "@csstools/utilities": "^2.0.0", - "postcss-value-parser": "^4.2.0" - }, - "engines": { - "node": ">=18" - }, - "peerDependencies": { - "postcss": "^8.4" - } - }, - "node_modules/postcss-lab-function": { - "version": "7.0.12", - "resolved": "https://registry.npmjs.org/postcss-lab-function/-/postcss-lab-function-7.0.12.tgz", - "integrity": "sha512-tUcyRk1ZTPec3OuKFsqtRzW2Go5lehW29XA21lZ65XmzQkz43VY2tyWEC202F7W3mILOjw0voOiuxRGTsN+J9w==", - "dev": true, - "funding": [ - { - "type": "github", - "url": "https://github.com/sponsors/csstools" - }, - { - "type": "opencollective", - "url": "https://opencollective.com/csstools" - } - ], - "license": "MIT-0", - "dependencies": { - "@csstools/css-color-parser": "^3.1.0", - "@csstools/css-parser-algorithms": "^3.0.5", - "@csstools/css-tokenizer": "^3.0.4", - "@csstools/postcss-progressive-custom-properties": "^4.2.1", - "@csstools/utilities": "^2.0.0" - }, - "engines": { - "node": ">=18" - }, - "peerDependencies": { - "postcss": "^8.4" - } - }, - "node_modules/postcss-loader": { - "version": "7.3.4", - "resolved": "https://registry.npmjs.org/postcss-loader/-/postcss-loader-7.3.4.tgz", - "integrity": "sha512-iW5WTTBSC5BfsBJ9daFMPVrLT36MrNiC6fqOZTTaHjBNX6Pfd5p+hSBqe/fEeNd7pc13QiAyGt7VdGMw4eRC4A==", - "dev": true, - "license": "MIT", - "dependencies": { - "cosmiconfig": "^8.3.5", - "jiti": "^1.20.0", - "semver": "^7.5.4" - }, - "engines": { - "node": ">= 14.15.0" - }, - "funding": { - "type": "opencollective", - "url": "https://opencollective.com/webpack" - }, - "peerDependencies": { - "postcss": "^7.0.0 || ^8.0.1", - "webpack": "^5.0.0" - } - }, - "node_modules/postcss-logical": { - "version": "8.1.0", - "resolved": "https://registry.npmjs.org/postcss-logical/-/postcss-logical-8.1.0.tgz", - "integrity": "sha512-pL1hXFQ2fEXNKiNiAgtfA005T9FBxky5zkX6s4GZM2D8RkVgRqz3f4g1JUoq925zXv495qk8UNldDwh8uGEDoA==", - "dev": true, - "funding": [ - { - "type": "github", - "url": "https://github.com/sponsors/csstools" - }, - { - "type": "opencollective", - "url": "https://opencollective.com/csstools" - } - ], - "license": "MIT-0", - "dependencies": { - "postcss-value-parser": "^4.2.0" - }, - "engines": { - "node": ">=18" - }, - "peerDependencies": { - "postcss": "^8.4" - } - }, - "node_modules/postcss-merge-idents": { - "version": "6.0.3", - "resolved": "https://registry.npmjs.org/postcss-merge-idents/-/postcss-merge-idents-6.0.3.tgz", - "integrity": "sha512-1oIoAsODUs6IHQZkLQGO15uGEbK3EAl5wi9SS8hs45VgsxQfMnxvt+L+zIr7ifZFIH14cfAeVe2uCTa+SPRa3g==", - "dev": true, - "license": "MIT", - "dependencies": { - "cssnano-utils": "^4.0.2", - "postcss-value-parser": "^4.2.0" - }, - "engines": { - "node": "^14 || ^16 || >=18.0" - }, - "peerDependencies": { - "postcss": "^8.4.31" - } - }, - "node_modules/postcss-merge-longhand": { - "version": "6.0.5", - "resolved": "https://registry.npmjs.org/postcss-merge-longhand/-/postcss-merge-longhand-6.0.5.tgz", - "integrity": "sha512-5LOiordeTfi64QhICp07nzzuTDjNSO8g5Ksdibt44d+uvIIAE1oZdRn8y/W5ZtYgRH/lnLDlvi9F8btZcVzu3w==", - "dev": true, - "license": "MIT", - "dependencies": { - "postcss-value-parser": "^4.2.0", - "stylehacks": "^6.1.1" - }, - "engines": { - "node": "^14 || ^16 || >=18.0" - }, - "peerDependencies": { - "postcss": "^8.4.31" - } - }, - "node_modules/postcss-merge-rules": { - "version": "6.1.1", - "resolved": "https://registry.npmjs.org/postcss-merge-rules/-/postcss-merge-rules-6.1.1.tgz", - "integrity": "sha512-KOdWF0gju31AQPZiD+2Ar9Qjowz1LTChSjFFbS+e2sFgc4uHOp3ZvVX4sNeTlk0w2O31ecFGgrFzhO0RSWbWwQ==", - "dev": true, - "license": "MIT", - "dependencies": { - "browserslist": "^4.23.0", - "caniuse-api": "^3.0.0", - "cssnano-utils": "^4.0.2", - "postcss-selector-parser": "^6.0.16" - }, - "engines": { - "node": "^14 || ^16 || >=18.0" - }, - "peerDependencies": { - "postcss": "^8.4.31" - } - }, - "node_modules/postcss-minify-font-values": { - "version": "6.1.0", - "resolved": "https://registry.npmjs.org/postcss-minify-font-values/-/postcss-minify-font-values-6.1.0.tgz", - "integrity": "sha512-gklfI/n+9rTh8nYaSJXlCo3nOKqMNkxuGpTn/Qm0gstL3ywTr9/WRKznE+oy6fvfolH6dF+QM4nCo8yPLdvGJg==", - "dev": true, - "license": "MIT", - "dependencies": { - "postcss-value-parser": "^4.2.0" - }, - "engines": { - "node": "^14 || ^16 || >=18.0" - }, - "peerDependencies": { - "postcss": "^8.4.31" - } - }, - "node_modules/postcss-minify-gradients": { - "version": "6.0.3", - "resolved": "https://registry.npmjs.org/postcss-minify-gradients/-/postcss-minify-gradients-6.0.3.tgz", - "integrity": "sha512-4KXAHrYlzF0Rr7uc4VrfwDJ2ajrtNEpNEuLxFgwkhFZ56/7gaE4Nr49nLsQDZyUe+ds+kEhf+YAUolJiYXF8+Q==", - "dev": true, - "license": "MIT", - "dependencies": { - "colord": "^2.9.3", - "cssnano-utils": "^4.0.2", - "postcss-value-parser": "^4.2.0" - }, - "engines": { - "node": "^14 || ^16 || >=18.0" - }, - "peerDependencies": { - "postcss": "^8.4.31" - } - }, - "node_modules/postcss-minify-params": { - "version": "6.1.0", - "resolved": "https://registry.npmjs.org/postcss-minify-params/-/postcss-minify-params-6.1.0.tgz", - "integrity": "sha512-bmSKnDtyyE8ujHQK0RQJDIKhQ20Jq1LYiez54WiaOoBtcSuflfK3Nm596LvbtlFcpipMjgClQGyGr7GAs+H1uA==", - "dev": true, - "license": "MIT", - "dependencies": { - "browserslist": "^4.23.0", - "cssnano-utils": "^4.0.2", - "postcss-value-parser": "^4.2.0" - }, - "engines": { - "node": "^14 || ^16 || >=18.0" - }, - "peerDependencies": { - "postcss": "^8.4.31" - } - }, - "node_modules/postcss-minify-selectors": { - "version": "6.0.4", - "resolved": "https://registry.npmjs.org/postcss-minify-selectors/-/postcss-minify-selectors-6.0.4.tgz", - "integrity": "sha512-L8dZSwNLgK7pjTto9PzWRoMbnLq5vsZSTu8+j1P/2GB8qdtGQfn+K1uSvFgYvgh83cbyxT5m43ZZhUMTJDSClQ==", - "dev": true, - "license": "MIT", - "dependencies": { - "postcss-selector-parser": "^6.0.16" - }, - "engines": { - "node": "^14 || ^16 || >=18.0" - }, - "peerDependencies": { - "postcss": "^8.4.31" - } - }, - "node_modules/postcss-modules-extract-imports": { - "version": "3.1.0", - "resolved": "https://registry.npmjs.org/postcss-modules-extract-imports/-/postcss-modules-extract-imports-3.1.0.tgz", - "integrity": "sha512-k3kNe0aNFQDAZGbin48pL2VNidTF0w4/eASDsxlyspobzU3wZQLOGj7L9gfRe0Jo9/4uud09DsjFNH7winGv8Q==", - "dev": true, - "license": "ISC", - "engines": { - "node": "^10 || ^12 || >= 14" - }, - "peerDependencies": { - "postcss": "^8.1.0" - } - }, - "node_modules/postcss-modules-local-by-default": { - "version": "4.2.0", - "resolved": "https://registry.npmjs.org/postcss-modules-local-by-default/-/postcss-modules-local-by-default-4.2.0.tgz", - "integrity": "sha512-5kcJm/zk+GJDSfw+V/42fJ5fhjL5YbFDl8nVdXkJPLLW+Vf9mTD5Xe0wqIaDnLuL2U6cDNpTr+UQ+v2HWIBhzw==", - "dev": true, - "license": "MIT", - "dependencies": { - "icss-utils": "^5.0.0", - "postcss-selector-parser": "^7.0.0", - "postcss-value-parser": "^4.1.0" - }, - "engines": { - "node": "^10 || ^12 || >= 14" - }, - "peerDependencies": { - "postcss": "^8.1.0" - } - }, - "node_modules/postcss-modules-local-by-default/node_modules/postcss-selector-parser": { - "version": "7.1.1", - "resolved": "https://registry.npmjs.org/postcss-selector-parser/-/postcss-selector-parser-7.1.1.tgz", - "integrity": "sha512-orRsuYpJVw8LdAwqqLykBj9ecS5/cRHlI5+nvTo8LcCKmzDmqVORXtOIYEEQuL9D4BxtA1lm5isAqzQZCoQ6Eg==", - "dev": true, - "license": "MIT", - "dependencies": { - "cssesc": "^3.0.0", - "util-deprecate": "^1.0.2" - }, - "engines": { - "node": ">=4" - } - }, - "node_modules/postcss-modules-scope": { - "version": "3.2.1", - "resolved": "https://registry.npmjs.org/postcss-modules-scope/-/postcss-modules-scope-3.2.1.tgz", - "integrity": "sha512-m9jZstCVaqGjTAuny8MdgE88scJnCiQSlSrOWcTQgM2t32UBe+MUmFSO5t7VMSfAf/FJKImAxBav8ooCHJXCJA==", - "dev": true, - "license": "ISC", - "dependencies": { - "postcss-selector-parser": "^7.0.0" - }, - "engines": { - "node": "^10 || ^12 || >= 14" - }, - "peerDependencies": { - "postcss": "^8.1.0" - } - }, - "node_modules/postcss-modules-scope/node_modules/postcss-selector-parser": { - "version": "7.1.1", - "resolved": "https://registry.npmjs.org/postcss-selector-parser/-/postcss-selector-parser-7.1.1.tgz", - "integrity": "sha512-orRsuYpJVw8LdAwqqLykBj9ecS5/cRHlI5+nvTo8LcCKmzDmqVORXtOIYEEQuL9D4BxtA1lm5isAqzQZCoQ6Eg==", - "dev": true, - "license": "MIT", - "dependencies": { - "cssesc": "^3.0.0", - "util-deprecate": "^1.0.2" - }, - "engines": { - "node": ">=4" - } - }, - "node_modules/postcss-modules-values": { - "version": "4.0.0", - "resolved": "https://registry.npmjs.org/postcss-modules-values/-/postcss-modules-values-4.0.0.tgz", - "integrity": "sha512-RDxHkAiEGI78gS2ofyvCsu7iycRv7oqw5xMWn9iMoR0N/7mf9D50ecQqUo5BZ9Zh2vH4bCUR/ktCqbB9m8vJjQ==", - "dev": true, - "license": "ISC", - "dependencies": { - "icss-utils": "^5.0.0" - }, - "engines": { - "node": "^10 || ^12 || >= 14" - }, - "peerDependencies": { - "postcss": "^8.1.0" - } - }, - "node_modules/postcss-nesting": { - "version": "13.0.2", - "resolved": "https://registry.npmjs.org/postcss-nesting/-/postcss-nesting-13.0.2.tgz", - "integrity": "sha512-1YCI290TX+VP0U/K/aFxzHzQWHWURL+CtHMSbex1lCdpXD1SoR2sYuxDu5aNI9lPoXpKTCggFZiDJbwylU0LEQ==", - "dev": true, - "funding": [ - { - "type": "github", - "url": "https://github.com/sponsors/csstools" - }, - { - "type": "opencollective", - "url": "https://opencollective.com/csstools" - } - ], - "license": "MIT-0", - "dependencies": { - "@csstools/selector-resolve-nested": "^3.1.0", - "@csstools/selector-specificity": "^5.0.0", - "postcss-selector-parser": "^7.0.0" - }, - "engines": { - "node": ">=18" - }, - "peerDependencies": { - "postcss": "^8.4" - } - }, - "node_modules/postcss-nesting/node_modules/@csstools/selector-resolve-nested": { - "version": "3.1.0", - "resolved": "https://registry.npmjs.org/@csstools/selector-resolve-nested/-/selector-resolve-nested-3.1.0.tgz", - "integrity": "sha512-mf1LEW0tJLKfWyvn5KdDrhpxHyuxpbNwTIwOYLIvsTffeyOf85j5oIzfG0yosxDgx/sswlqBnESYUcQH0vgZ0g==", - "dev": true, - "funding": [ - { - "type": "github", - "url": "https://github.com/sponsors/csstools" - }, - { - "type": "opencollective", - "url": "https://opencollective.com/csstools" - } - ], - "license": "MIT-0", - "engines": { - "node": ">=18" - }, - "peerDependencies": { - "postcss-selector-parser": "^7.0.0" - } - }, - "node_modules/postcss-nesting/node_modules/@csstools/selector-specificity": { - "version": "5.0.0", - "resolved": "https://registry.npmjs.org/@csstools/selector-specificity/-/selector-specificity-5.0.0.tgz", - "integrity": "sha512-PCqQV3c4CoVm3kdPhyeZ07VmBRdH2EpMFA/pd9OASpOEC3aXNGoqPDAZ80D0cLpMBxnmk0+yNhGsEx31hq7Gtw==", - "dev": true, - "funding": [ - { - "type": "github", - "url": "https://github.com/sponsors/csstools" - }, - { - "type": "opencollective", - "url": "https://opencollective.com/csstools" - } - ], - "license": "MIT-0", - "engines": { - "node": ">=18" - }, - "peerDependencies": { - "postcss-selector-parser": "^7.0.0" - } - }, - "node_modules/postcss-nesting/node_modules/postcss-selector-parser": { - "version": "7.1.1", - "resolved": "https://registry.npmjs.org/postcss-selector-parser/-/postcss-selector-parser-7.1.1.tgz", - "integrity": "sha512-orRsuYpJVw8LdAwqqLykBj9ecS5/cRHlI5+nvTo8LcCKmzDmqVORXtOIYEEQuL9D4BxtA1lm5isAqzQZCoQ6Eg==", - "dev": true, - "license": "MIT", - "peer": true, - "dependencies": { - "cssesc": "^3.0.0", - "util-deprecate": "^1.0.2" - }, - "engines": { - "node": ">=4" - } - }, - "node_modules/postcss-normalize-charset": { - "version": "6.0.2", - "resolved": "https://registry.npmjs.org/postcss-normalize-charset/-/postcss-normalize-charset-6.0.2.tgz", - "integrity": "sha512-a8N9czmdnrjPHa3DeFlwqst5eaL5W8jYu3EBbTTkI5FHkfMhFZh1EGbku6jhHhIzTA6tquI2P42NtZ59M/H/kQ==", - "dev": true, - "license": "MIT", - "engines": { - "node": "^14 || ^16 || >=18.0" - }, - "peerDependencies": { - "postcss": "^8.4.31" - } - }, - "node_modules/postcss-normalize-display-values": { - "version": "6.0.2", - "resolved": "https://registry.npmjs.org/postcss-normalize-display-values/-/postcss-normalize-display-values-6.0.2.tgz", - "integrity": "sha512-8H04Mxsb82ON/aAkPeq8kcBbAtI5Q2a64X/mnRRfPXBq7XeogoQvReqxEfc0B4WPq1KimjezNC8flUtC3Qz6jg==", - "dev": true, - "license": "MIT", - "dependencies": { - "postcss-value-parser": "^4.2.0" - }, - "engines": { - "node": "^14 || ^16 || >=18.0" - }, - "peerDependencies": { - "postcss": "^8.4.31" - } - }, - "node_modules/postcss-normalize-positions": { - "version": "6.0.2", - "resolved": "https://registry.npmjs.org/postcss-normalize-positions/-/postcss-normalize-positions-6.0.2.tgz", - "integrity": "sha512-/JFzI441OAB9O7VnLA+RtSNZvQ0NCFZDOtp6QPFo1iIyawyXg0YI3CYM9HBy1WvwCRHnPep/BvI1+dGPKoXx/Q==", - "dev": true, - "license": "MIT", - "dependencies": { - "postcss-value-parser": "^4.2.0" - }, - "engines": { - "node": "^14 || ^16 || >=18.0" - }, - "peerDependencies": { - "postcss": "^8.4.31" - } - }, - "node_modules/postcss-normalize-repeat-style": { - "version": "6.0.2", - "resolved": "https://registry.npmjs.org/postcss-normalize-repeat-style/-/postcss-normalize-repeat-style-6.0.2.tgz", - "integrity": "sha512-YdCgsfHkJ2jEXwR4RR3Tm/iOxSfdRt7jplS6XRh9Js9PyCR/aka/FCb6TuHT2U8gQubbm/mPmF6L7FY9d79VwQ==", - "dev": true, - "license": "MIT", - "dependencies": { - "postcss-value-parser": "^4.2.0" - }, - "engines": { - "node": "^14 || ^16 || >=18.0" - }, - "peerDependencies": { - "postcss": "^8.4.31" - } - }, - "node_modules/postcss-normalize-string": { - "version": "6.0.2", - "resolved": "https://registry.npmjs.org/postcss-normalize-string/-/postcss-normalize-string-6.0.2.tgz", - "integrity": "sha512-vQZIivlxlfqqMp4L9PZsFE4YUkWniziKjQWUtsxUiVsSSPelQydwS8Wwcuw0+83ZjPWNTl02oxlIvXsmmG+CiQ==", - "dev": true, - "license": "MIT", - "dependencies": { - "postcss-value-parser": "^4.2.0" - }, - "engines": { - "node": "^14 || ^16 || >=18.0" - }, - "peerDependencies": { - "postcss": "^8.4.31" - } - }, - "node_modules/postcss-normalize-timing-functions": { - "version": "6.0.2", - "resolved": "https://registry.npmjs.org/postcss-normalize-timing-functions/-/postcss-normalize-timing-functions-6.0.2.tgz", - "integrity": "sha512-a+YrtMox4TBtId/AEwbA03VcJgtyW4dGBizPl7e88cTFULYsprgHWTbfyjSLyHeBcK/Q9JhXkt2ZXiwaVHoMzA==", - "dev": true, - "license": "MIT", - "dependencies": { - "postcss-value-parser": "^4.2.0" - }, - "engines": { - "node": "^14 || ^16 || >=18.0" - }, - "peerDependencies": { - "postcss": "^8.4.31" - } - }, - "node_modules/postcss-normalize-unicode": { - "version": "6.1.0", - "resolved": "https://registry.npmjs.org/postcss-normalize-unicode/-/postcss-normalize-unicode-6.1.0.tgz", - "integrity": "sha512-QVC5TQHsVj33otj8/JD869Ndr5Xcc/+fwRh4HAsFsAeygQQXm+0PySrKbr/8tkDKzW+EVT3QkqZMfFrGiossDg==", - "dev": true, - "license": "MIT", - "dependencies": { - "browserslist": "^4.23.0", - "postcss-value-parser": "^4.2.0" - }, - "engines": { - "node": "^14 || ^16 || >=18.0" - }, - "peerDependencies": { - "postcss": "^8.4.31" - } - }, - "node_modules/postcss-normalize-url": { - "version": "6.0.2", - "resolved": "https://registry.npmjs.org/postcss-normalize-url/-/postcss-normalize-url-6.0.2.tgz", - "integrity": "sha512-kVNcWhCeKAzZ8B4pv/DnrU1wNh458zBNp8dh4y5hhxih5RZQ12QWMuQrDgPRw3LRl8mN9vOVfHl7uhvHYMoXsQ==", - "dev": true, - "license": "MIT", - "dependencies": { - "postcss-value-parser": "^4.2.0" - }, - "engines": { - "node": "^14 || ^16 || >=18.0" - }, - "peerDependencies": { - "postcss": "^8.4.31" - } - }, - "node_modules/postcss-normalize-whitespace": { - "version": "6.0.2", - "resolved": "https://registry.npmjs.org/postcss-normalize-whitespace/-/postcss-normalize-whitespace-6.0.2.tgz", - "integrity": "sha512-sXZ2Nj1icbJOKmdjXVT9pnyHQKiSAyuNQHSgRCUgThn2388Y9cGVDR+E9J9iAYbSbLHI+UUwLVl1Wzco/zgv0Q==", - "dev": true, - "license": "MIT", - "dependencies": { - "postcss-value-parser": "^4.2.0" - }, - "engines": { - "node": "^14 || ^16 || >=18.0" - }, - "peerDependencies": { - "postcss": "^8.4.31" - } - }, - "node_modules/postcss-opacity-percentage": { - "version": "3.0.0", - "resolved": "https://registry.npmjs.org/postcss-opacity-percentage/-/postcss-opacity-percentage-3.0.0.tgz", - "integrity": "sha512-K6HGVzyxUxd/VgZdX04DCtdwWJ4NGLG212US4/LA1TLAbHgmAsTWVR86o+gGIbFtnTkfOpb9sCRBx8K7HO66qQ==", - "dev": true, - "funding": [ - { - "type": "kofi", - "url": "https://ko-fi.com/mrcgrtz" - }, - { - "type": "liberapay", - "url": "https://liberapay.com/mrcgrtz" - } - ], - "license": "MIT", - "engines": { - "node": ">=18" - }, - "peerDependencies": { - "postcss": "^8.4" - } - }, - "node_modules/postcss-ordered-values": { - "version": "6.0.2", - "resolved": "https://registry.npmjs.org/postcss-ordered-values/-/postcss-ordered-values-6.0.2.tgz", - "integrity": "sha512-VRZSOB+JU32RsEAQrO94QPkClGPKJEL/Z9PCBImXMhIeK5KAYo6slP/hBYlLgrCjFxyqvn5VC81tycFEDBLG1Q==", - "dev": true, - "license": "MIT", - "dependencies": { - "cssnano-utils": "^4.0.2", - "postcss-value-parser": "^4.2.0" - }, - "engines": { - "node": "^14 || ^16 || >=18.0" - }, - "peerDependencies": { - "postcss": "^8.4.31" - } - }, - "node_modules/postcss-overflow-shorthand": { - "version": "6.0.0", - "resolved": "https://registry.npmjs.org/postcss-overflow-shorthand/-/postcss-overflow-shorthand-6.0.0.tgz", - "integrity": "sha512-BdDl/AbVkDjoTofzDQnwDdm/Ym6oS9KgmO7Gr+LHYjNWJ6ExORe4+3pcLQsLA9gIROMkiGVjjwZNoL/mpXHd5Q==", - "dev": true, - "funding": [ - { - "type": "github", - "url": "https://github.com/sponsors/csstools" - }, - { - "type": "opencollective", - "url": "https://opencollective.com/csstools" - } - ], - "license": "MIT-0", - "dependencies": { - "postcss-value-parser": "^4.2.0" - }, - "engines": { - "node": ">=18" - }, - "peerDependencies": { - "postcss": "^8.4" - } - }, - "node_modules/postcss-page-break": { - "version": "3.0.4", - "resolved": "https://registry.npmjs.org/postcss-page-break/-/postcss-page-break-3.0.4.tgz", - "integrity": "sha512-1JGu8oCjVXLa9q9rFTo4MbeeA5FMe00/9C7lN4va606Rdb+HkxXtXsmEDrIraQ11fGz/WvKWa8gMuCKkrXpTsQ==", - "dev": true, - "license": "MIT", - "peerDependencies": { - "postcss": "^8" - } - }, - "node_modules/postcss-place": { - "version": "10.0.0", - "resolved": "https://registry.npmjs.org/postcss-place/-/postcss-place-10.0.0.tgz", - "integrity": "sha512-5EBrMzat2pPAxQNWYavwAfoKfYcTADJ8AXGVPcUZ2UkNloUTWzJQExgrzrDkh3EKzmAx1evfTAzF9I8NGcc+qw==", - "dev": true, - "funding": [ - { - "type": "github", - "url": "https://github.com/sponsors/csstools" - }, - { - "type": "opencollective", - "url": "https://opencollective.com/csstools" - } - ], - "license": "MIT-0", - "dependencies": { - "postcss-value-parser": "^4.2.0" - }, - "engines": { - "node": ">=18" - }, - "peerDependencies": { - "postcss": "^8.4" - } - }, - "node_modules/postcss-preset-env": { - "version": "10.5.0", - "resolved": "https://registry.npmjs.org/postcss-preset-env/-/postcss-preset-env-10.5.0.tgz", - "integrity": "sha512-xgxFQPAPxeWmsgy8cR7GM1PGAL/smA5E9qU7K//D4vucS01es3M0fDujhDJn3kY8Ip7/vVYcecbe1yY+vBo3qQ==", - "dev": true, - "funding": [ - { - "type": "github", - "url": "https://github.com/sponsors/csstools" - }, - { - "type": "opencollective", - "url": "https://opencollective.com/csstools" - } - ], - "license": "MIT-0", - "dependencies": { - "@csstools/postcss-alpha-function": "^1.0.1", - "@csstools/postcss-cascade-layers": "^5.0.2", - "@csstools/postcss-color-function": "^4.0.12", - "@csstools/postcss-color-function-display-p3-linear": "^1.0.1", - "@csstools/postcss-color-mix-function": "^3.0.12", - "@csstools/postcss-color-mix-variadic-function-arguments": "^1.0.2", - "@csstools/postcss-content-alt-text": "^2.0.8", - "@csstools/postcss-contrast-color-function": "^2.0.12", - "@csstools/postcss-exponential-functions": "^2.0.9", - "@csstools/postcss-font-format-keywords": "^4.0.0", - "@csstools/postcss-gamut-mapping": "^2.0.11", - "@csstools/postcss-gradients-interpolation-method": "^5.0.12", - "@csstools/postcss-hwb-function": "^4.0.12", - "@csstools/postcss-ic-unit": "^4.0.4", - "@csstools/postcss-initial": "^2.0.1", - "@csstools/postcss-is-pseudo-class": "^5.0.3", - "@csstools/postcss-light-dark-function": "^2.0.11", - "@csstools/postcss-logical-float-and-clear": "^3.0.0", - "@csstools/postcss-logical-overflow": "^2.0.0", - "@csstools/postcss-logical-overscroll-behavior": "^2.0.0", - "@csstools/postcss-logical-resize": "^3.0.0", - "@csstools/postcss-logical-viewport-units": "^3.0.4", - "@csstools/postcss-media-minmax": "^2.0.9", - "@csstools/postcss-media-queries-aspect-ratio-number-values": "^3.0.5", - "@csstools/postcss-nested-calc": "^4.0.0", - "@csstools/postcss-normalize-display-values": "^4.0.0", - "@csstools/postcss-oklab-function": "^4.0.12", - "@csstools/postcss-position-area-property": "^1.0.0", - "@csstools/postcss-progressive-custom-properties": "^4.2.1", - "@csstools/postcss-random-function": "^2.0.1", - "@csstools/postcss-relative-color-syntax": "^3.0.12", - "@csstools/postcss-scope-pseudo-class": "^4.0.1", - "@csstools/postcss-sign-functions": "^1.1.4", - "@csstools/postcss-stepped-value-functions": "^4.0.9", - "@csstools/postcss-system-ui-font-family": "^1.0.0", - "@csstools/postcss-text-decoration-shorthand": "^4.0.3", - "@csstools/postcss-trigonometric-functions": "^4.0.9", - "@csstools/postcss-unset-value": "^4.0.0", - "autoprefixer": "^10.4.22", - "browserslist": "^4.28.0", - "css-blank-pseudo": "^7.0.1", - "css-has-pseudo": "^7.0.3", - "css-prefers-color-scheme": "^10.0.0", - "cssdb": "^8.5.2", - "postcss-attribute-case-insensitive": "^7.0.1", - "postcss-clamp": "^4.1.0", - "postcss-color-functional-notation": "^7.0.12", - "postcss-color-hex-alpha": "^10.0.0", - "postcss-color-rebeccapurple": "^10.0.0", - "postcss-custom-media": "^11.0.6", - "postcss-custom-properties": "^14.0.6", - "postcss-custom-selectors": "^8.0.5", - "postcss-dir-pseudo-class": "^9.0.1", - "postcss-double-position-gradients": "^6.0.4", - "postcss-focus-visible": "^10.0.1", - "postcss-focus-within": "^9.0.1", - "postcss-font-variant": "^5.0.0", - "postcss-gap-properties": "^6.0.0", - "postcss-image-set-function": "^7.0.0", - "postcss-lab-function": "^7.0.12", - "postcss-logical": "^8.1.0", - "postcss-nesting": "^13.0.2", - "postcss-opacity-percentage": "^3.0.0", - "postcss-overflow-shorthand": "^6.0.0", - "postcss-page-break": "^3.0.4", - "postcss-place": "^10.0.0", - "postcss-pseudo-class-any-link": "^10.0.1", - "postcss-replace-overflow-wrap": "^4.0.0", - "postcss-selector-not": "^8.0.1" - }, - "engines": { - "node": ">=18" - }, - "peerDependencies": { - "postcss": "^8.4" - } - }, - "node_modules/postcss-pseudo-class-any-link": { - "version": "10.0.1", - "resolved": "https://registry.npmjs.org/postcss-pseudo-class-any-link/-/postcss-pseudo-class-any-link-10.0.1.tgz", - "integrity": "sha512-3el9rXlBOqTFaMFkWDOkHUTQekFIYnaQY55Rsp8As8QQkpiSgIYEcF/6Ond93oHiDsGb4kad8zjt+NPlOC1H0Q==", - "dev": true, - "funding": [ - { - "type": "github", - "url": "https://github.com/sponsors/csstools" - }, - { - "type": "opencollective", - "url": "https://opencollective.com/csstools" - } - ], - "license": "MIT-0", - "dependencies": { - "postcss-selector-parser": "^7.0.0" - }, - "engines": { - "node": ">=18" - }, - "peerDependencies": { - "postcss": "^8.4" - } - }, - "node_modules/postcss-pseudo-class-any-link/node_modules/postcss-selector-parser": { - "version": "7.1.1", - "resolved": "https://registry.npmjs.org/postcss-selector-parser/-/postcss-selector-parser-7.1.1.tgz", - "integrity": "sha512-orRsuYpJVw8LdAwqqLykBj9ecS5/cRHlI5+nvTo8LcCKmzDmqVORXtOIYEEQuL9D4BxtA1lm5isAqzQZCoQ6Eg==", - "dev": true, - "license": "MIT", - "dependencies": { - "cssesc": "^3.0.0", - "util-deprecate": "^1.0.2" - }, - "engines": { - "node": ">=4" - } - }, - "node_modules/postcss-reduce-idents": { - "version": "6.0.3", - "resolved": "https://registry.npmjs.org/postcss-reduce-idents/-/postcss-reduce-idents-6.0.3.tgz", - "integrity": "sha512-G3yCqZDpsNPoQgbDUy3T0E6hqOQ5xigUtBQyrmq3tn2GxlyiL0yyl7H+T8ulQR6kOcHJ9t7/9H4/R2tv8tJbMA==", - "dev": true, - "license": "MIT", - "dependencies": { - "postcss-value-parser": "^4.2.0" - }, - "engines": { - "node": "^14 || ^16 || >=18.0" - }, - "peerDependencies": { - "postcss": "^8.4.31" - } - }, - "node_modules/postcss-reduce-initial": { - "version": "6.1.0", - "resolved": "https://registry.npmjs.org/postcss-reduce-initial/-/postcss-reduce-initial-6.1.0.tgz", - "integrity": "sha512-RarLgBK/CrL1qZags04oKbVbrrVK2wcxhvta3GCxrZO4zveibqbRPmm2VI8sSgCXwoUHEliRSbOfpR0b/VIoiw==", - "dev": true, - "license": "MIT", - "dependencies": { - "browserslist": "^4.23.0", - "caniuse-api": "^3.0.0" - }, - "engines": { - "node": "^14 || ^16 || >=18.0" - }, - "peerDependencies": { - "postcss": "^8.4.31" - } - }, - "node_modules/postcss-reduce-transforms": { - "version": "6.0.2", - "resolved": "https://registry.npmjs.org/postcss-reduce-transforms/-/postcss-reduce-transforms-6.0.2.tgz", - "integrity": "sha512-sB+Ya++3Xj1WaT9+5LOOdirAxP7dJZms3GRcYheSPi1PiTMigsxHAdkrbItHxwYHr4kt1zL7mmcHstgMYT+aiA==", - "dev": true, - "license": "MIT", - "dependencies": { - "postcss-value-parser": "^4.2.0" - }, - "engines": { - "node": "^14 || ^16 || >=18.0" - }, - "peerDependencies": { - "postcss": "^8.4.31" - } - }, - "node_modules/postcss-replace-overflow-wrap": { - "version": "4.0.0", - "resolved": "https://registry.npmjs.org/postcss-replace-overflow-wrap/-/postcss-replace-overflow-wrap-4.0.0.tgz", - "integrity": "sha512-KmF7SBPphT4gPPcKZc7aDkweHiKEEO8cla/GjcBK+ckKxiZslIu3C4GCRW3DNfL0o7yW7kMQu9xlZ1kXRXLXtw==", - "dev": true, - "license": "MIT", - "peerDependencies": { - "postcss": "^8.0.3" - } - }, - "node_modules/postcss-selector-not": { - "version": "8.0.1", - "resolved": "https://registry.npmjs.org/postcss-selector-not/-/postcss-selector-not-8.0.1.tgz", - "integrity": "sha512-kmVy/5PYVb2UOhy0+LqUYAhKj7DUGDpSWa5LZqlkWJaaAV+dxxsOG3+St0yNLu6vsKD7Dmqx+nWQt0iil89+WA==", - "dev": true, - "funding": [ - { - "type": "github", - "url": "https://github.com/sponsors/csstools" - }, - { - "type": "opencollective", - "url": "https://opencollective.com/csstools" - } - ], - "license": "MIT", - "dependencies": { - "postcss-selector-parser": "^7.0.0" - }, - "engines": { - "node": ">=18" - }, - "peerDependencies": { - "postcss": "^8.4" - } - }, - "node_modules/postcss-selector-not/node_modules/postcss-selector-parser": { - "version": "7.1.1", - "resolved": "https://registry.npmjs.org/postcss-selector-parser/-/postcss-selector-parser-7.1.1.tgz", - "integrity": "sha512-orRsuYpJVw8LdAwqqLykBj9ecS5/cRHlI5+nvTo8LcCKmzDmqVORXtOIYEEQuL9D4BxtA1lm5isAqzQZCoQ6Eg==", - "dev": true, - "license": "MIT", - "dependencies": { - "cssesc": "^3.0.0", - "util-deprecate": "^1.0.2" - }, - "engines": { - "node": ">=4" + "postcss": "^8.2.14" } }, "node_modules/postcss-selector-parser": { @@ -20049,75 +12338,6 @@ "node": ">=4" } }, - "node_modules/postcss-sort-media-queries": { - "version": "5.2.0", - "resolved": "https://registry.npmjs.org/postcss-sort-media-queries/-/postcss-sort-media-queries-5.2.0.tgz", - "integrity": "sha512-AZ5fDMLD8SldlAYlvi8NIqo0+Z8xnXU2ia0jxmuhxAU+Lqt9K+AlmLNJ/zWEnE9x+Zx3qL3+1K20ATgNOr3fAA==", - "dev": true, - "license": "MIT", - "dependencies": { - "sort-css-media-queries": "2.2.0" - }, - "engines": { - "node": ">=14.0.0" - }, - "peerDependencies": { - "postcss": "^8.4.23" - } - }, - "node_modules/postcss-svgo": { - "version": "6.0.3", - "resolved": "https://registry.npmjs.org/postcss-svgo/-/postcss-svgo-6.0.3.tgz", - "integrity": "sha512-dlrahRmxP22bX6iKEjOM+c8/1p+81asjKT+V5lrgOH944ryx/OHpclnIbGsKVd3uWOXFLYJwCVf0eEkJGvO96g==", - "dev": true, - "license": "MIT", - "dependencies": { - "postcss-value-parser": "^4.2.0", - "svgo": "^3.2.0" - }, - "engines": { - "node": "^14 || ^16 || >= 18" - }, - "peerDependencies": { - "postcss": "^8.4.31" - } - }, - "node_modules/postcss-unique-selectors": { - "version": "6.0.4", - "resolved": "https://registry.npmjs.org/postcss-unique-selectors/-/postcss-unique-selectors-6.0.4.tgz", - "integrity": "sha512-K38OCaIrO8+PzpArzkLKB42dSARtC2tmG6PvD4b1o1Q2E9Os8jzfWFfSy/rixsHwohtsDdFtAWGjFVFUdwYaMg==", - "dev": true, - "license": "MIT", - "dependencies": { - "postcss-selector-parser": "^6.0.16" - }, - "engines": { - "node": "^14 || ^16 || >=18.0" - }, - "peerDependencies": { - "postcss": "^8.4.31" - } - }, - "node_modules/postcss-value-parser": { - "version": "4.2.0", - "resolved": "https://registry.npmjs.org/postcss-value-parser/-/postcss-value-parser-4.2.0.tgz", - "integrity": "sha512-1NNCs6uurfkVbeXG4S8JFT9t19m45ICnif8zWLd5oPSZ50QnwMfK+H3jv408d4jw/7Bttv5axS5IiHoLaVNHeQ==", - "dev": true, - "license": "MIT" - }, - "node_modules/postcss-zindex": { - "version": "6.0.2", - "resolved": "https://registry.npmjs.org/postcss-zindex/-/postcss-zindex-6.0.2.tgz", - "integrity": "sha512-5BxW9l1evPB/4ZIc+2GobEBoKC+h8gPGCMi+jxsYvd2x0mjq7wazk6DrP71pStqxE9Foxh5TVnonbWpFZzXaYg==", - "dev": true, - "license": "MIT", - "engines": { - "node": "^14 || ^16 || >=18.0" - }, - "peerDependencies": { - "postcss": "^8.4.31" - } - }, "node_modules/prelude-ls": { "version": "1.2.1", "resolved": "https://registry.npmjs.org/prelude-ls/-/prelude-ls-1.2.1.tgz", @@ -20129,12 +12349,11 @@ } }, "node_modules/prettier": { - "version": "3.6.2", - "resolved": "https://registry.npmjs.org/prettier/-/prettier-3.6.2.tgz", - "integrity": "sha512-I7AIg5boAr5R0FFtJ6rCfD+LFsWHp81dolrFD8S79U9tb8Az2nGrJncnMSnys+bpQJfRUzqs9hnA81OAA3hCuQ==", + "version": "3.7.4", + "resolved": "https://registry.npmjs.org/prettier/-/prettier-3.7.4.tgz", + "integrity": "sha512-v6UNi1+3hSlVvv8fSaoUbggEM5VErKmmpGA7Pl3HF8V6uKY7rvClBOJlH6yNwQtfTueNkGVpOv/mtWL9L4bgRA==", "dev": true, "license": "MIT", - "peer": true, "bin": { "prettier": "bin/prettier.cjs" }, @@ -20146,13 +12365,13 @@ } }, "node_modules/prettier-plugin-packagejson": { - "version": "2.5.19", - "resolved": "https://registry.npmjs.org/prettier-plugin-packagejson/-/prettier-plugin-packagejson-2.5.19.tgz", - "integrity": "sha512-Qsqp4+jsZbKMpEGZB1UP1pxeAT8sCzne2IwnKkr+QhUe665EXUo3BAvTf1kAPCqyMv9kg3ZmO0+7eOni/C6Uag==", + "version": "2.5.20", + "resolved": "https://registry.npmjs.org/prettier-plugin-packagejson/-/prettier-plugin-packagejson-2.5.20.tgz", + "integrity": "sha512-G8cowPh+QmJJECTZlrPDKWkVVcwrFjF2rGcw546w3N8blLoc4szSs8UUPfFVxHUNLUjiru71Ah83g1lZkeK9Bw==", "dev": true, "license": "MIT", "dependencies": { - "sort-package-json": "3.4.0", + "sort-package-json": "3.5.0", "synckit": "0.11.11" }, "peerDependencies": { @@ -20164,21 +12383,10 @@ } } }, - "node_modules/pretty-error": { - "version": "4.0.0", - "resolved": "https://registry.npmjs.org/pretty-error/-/pretty-error-4.0.0.tgz", - "integrity": "sha512-AoJ5YMAcXKYxKhuJGdcvse+Voc6v1RgnsR3nWcYU7q4t6z0Q6T86sv5Zq8VIRbOWWFpvdGE83LtdSMNd+6Y0xw==", - "dev": true, - "license": "MIT", - "dependencies": { - "lodash": "^4.17.20", - "renderkid": "^3.0.0" - } - }, "node_modules/pretty-format": { - "version": "30.0.5", - "resolved": "https://registry.npmjs.org/pretty-format/-/pretty-format-30.0.5.tgz", - "integrity": "sha512-D1tKtYvByrBkFLe2wHJl2bwMJIiT8rW+XA+TiataH79/FszLQMrpGEvzUVkzPau7OCO0Qnrhpe87PqtOAIB8Yw==", + "version": "30.2.0", + "resolved": "https://registry.npmjs.org/pretty-format/-/pretty-format-30.2.0.tgz", + "integrity": "sha512-9uBdv/B4EefsuAL+pWqueZyZS2Ba+LxfFeQ9DN14HU4bN8bhaxKdkpjpB6fs9+pSjIBu+FXQHImEg8j/Lw0+vA==", "dev": true, "license": "MIT", "dependencies": { @@ -20203,30 +12411,6 @@ "url": "https://github.com/chalk/ansi-styles?sponsor=1" } }, - "node_modules/pretty-time": { - "version": "1.1.0", - "resolved": "https://registry.npmjs.org/pretty-time/-/pretty-time-1.1.0.tgz", - "integrity": "sha512-28iF6xPQrP8Oa6uxE6a1biz+lWeTOAPKggvjB8HAs6nVMKZwf5bG++632Dx614hIWgUPkgivRfG+a8uAXGTIbA==", - "dev": true, - "license": "MIT", - "engines": { - "node": ">=4" - } - }, - "node_modules/prism-react-renderer": { - "version": "2.4.1", - "resolved": "https://registry.npmjs.org/prism-react-renderer/-/prism-react-renderer-2.4.1.tgz", - "integrity": "sha512-ey8Ls/+Di31eqzUxC46h8MksNuGx/n0AAC8uKpwFau4RPDYLuE3EXTp8N8G2vX2N7UC/+IXeNUnlWBGGcAG+Ig==", - "dev": true, - "license": "MIT", - "dependencies": { - "@types/prismjs": "^1.26.0", - "clsx": "^2.0.0" - }, - "peerDependencies": { - "react": ">=16.0.0" - } - }, "node_modules/prismjs": { "version": "1.30.0", "resolved": "https://registry.npmjs.org/prismjs/-/prismjs-1.30.0.tgz", @@ -20268,25 +12452,6 @@ "node": ">= 6" } }, - "node_modules/prop-types": { - "version": "15.8.1", - "resolved": "https://registry.npmjs.org/prop-types/-/prop-types-15.8.1.tgz", - "integrity": "sha512-oj87CgZICdulUohogVAR7AjlC0327U4el4L6eAvOqCeudMDVU0NThNaV+b9Df4dXgSP1gXMTnPdhfe/2qDH5cg==", - "dev": true, - "license": "MIT", - "dependencies": { - "loose-envify": "^1.4.0", - "object-assign": "^4.1.1", - "react-is": "^16.13.1" - } - }, - "node_modules/prop-types/node_modules/react-is": { - "version": "16.13.1", - "resolved": "https://registry.npmjs.org/react-is/-/react-is-16.13.1.tgz", - "integrity": "sha512-24e6ynE2H+OKt4kqsOvNd8kBpV65zoxbA4BVsEOB3ARVWQki/DHzaUoC5KuON/BiccDaCCTZBuOcfZs70kR8bQ==", - "dev": true, - "license": "MIT" - }, "node_modules/property-information": { "version": "7.1.0", "resolved": "https://registry.npmjs.org/property-information/-/property-information-7.1.0.tgz", @@ -20298,37 +12463,6 @@ "url": "https://github.com/sponsors/wooorm" } }, - "node_modules/proto-list": { - "version": "1.2.4", - "resolved": "https://registry.npmjs.org/proto-list/-/proto-list-1.2.4.tgz", - "integrity": "sha512-vtK/94akxsTMhe0/cbfpR+syPuszcuwhqVjJq26CuNDgFGj682oRBXOP5MJpv2r7JtE8MsiepGIqvvOTBwn2vA==", - "dev": true, - "license": "ISC" - }, - "node_modules/proxy-addr": { - "version": "2.0.7", - "resolved": "https://registry.npmjs.org/proxy-addr/-/proxy-addr-2.0.7.tgz", - "integrity": "sha512-llQsMLSUDUPT44jdrU/O37qlnifitDP+ZwrmmZcoSKyLKvtZxpyV0n2/bD/N4tBAAZ/gJEdZU7KMraoK1+XYAg==", - "dev": true, - "license": "MIT", - "dependencies": { - "forwarded": "0.2.0", - "ipaddr.js": "1.9.1" - }, - "engines": { - "node": ">= 0.10" - } - }, - "node_modules/proxy-addr/node_modules/ipaddr.js": { - "version": "1.9.1", - "resolved": "https://registry.npmjs.org/ipaddr.js/-/ipaddr.js-1.9.1.tgz", - "integrity": "sha512-0KI/607xoxSToH7GjN1FfSbLoU0+btTicjsQSWQlh/hZykN8KpmMf7uYwPW3R+akZ6R/w18ZlXSHBYXiYUPO3g==", - "dev": true, - "license": "MIT", - "engines": { - "node": ">= 0.10" - } - }, "node_modules/punycode": { "version": "2.3.1", "resolved": "https://registry.npmjs.org/punycode/-/punycode-2.3.1.tgz", @@ -20349,22 +12483,6 @@ "node": ">=6" } }, - "node_modules/pupa": { - "version": "3.3.0", - "resolved": "https://registry.npmjs.org/pupa/-/pupa-3.3.0.tgz", - "integrity": "sha512-LjgDO2zPtoXP2wJpDjZrGdojii1uqO0cnwKoIoUzkfS98HDmbeiGmYiXo3lXeFlq2xvne1QFQhwYXSUCLKtEuA==", - "dev": true, - "license": "MIT", - "dependencies": { - "escape-goat": "^4.0.0" - }, - "engines": { - "node": ">=12.20" - }, - "funding": { - "url": "https://github.com/sponsors/sindresorhus" - } - }, "node_modules/pure-rand": { "version": "7.0.1", "resolved": "https://registry.npmjs.org/pure-rand/-/pure-rand-7.0.1.tgz", @@ -20382,22 +12500,6 @@ ], "license": "MIT" }, - "node_modules/qs": { - "version": "6.14.0", - "resolved": "https://registry.npmjs.org/qs/-/qs-6.14.0.tgz", - "integrity": "sha512-YWWTjgABSKcvs/nWBi9PycY/JiPJqOD4JA6o9Sej2AtvSGarXxKC3OQSk4pAarbdQlKAh5D4FCQkJNkW+GAn3w==", - "dev": true, - "license": "BSD-3-Clause", - "dependencies": { - "side-channel": "^1.1.0" - }, - "engines": { - "node": ">=0.6" - }, - "funding": { - "url": "https://github.com/sponsors/ljharb" - } - }, "node_modules/queue-microtask": { "version": "1.2.3", "resolved": "https://registry.npmjs.org/queue-microtask/-/queue-microtask-1.2.3.tgz", @@ -20419,166 +12521,13 @@ ], "license": "MIT" }, - "node_modules/quick-lru": { - "version": "5.1.1", - "resolved": "https://registry.npmjs.org/quick-lru/-/quick-lru-5.1.1.tgz", - "integrity": "sha512-WuyALRjWPDGtt/wzJiadO5AXY+8hZ80hVpe6MyivgraREW751X3SbhRvG3eLKOYN+8VEvqLcf3wdnt44Z4S4SA==", - "dev": true, - "license": "MIT", - "engines": { - "node": ">=10" - }, - "funding": { - "url": "https://github.com/sponsors/sindresorhus" - } - }, - "node_modules/randombytes": { - "version": "2.1.0", - "resolved": "https://registry.npmjs.org/randombytes/-/randombytes-2.1.0.tgz", - "integrity": "sha512-vYl3iOX+4CKUWuxGi9Ukhie6fsqXqS9FE2Zaic4tNFD2N2QQaXOMFbuKK4QmDHC0JO6B1Zp41J0LpT0oR68amQ==", - "dev": true, - "license": "MIT", - "dependencies": { - "safe-buffer": "^5.1.0" - } - }, - "node_modules/range-parser": { - "version": "1.2.0", - "resolved": "https://registry.npmjs.org/range-parser/-/range-parser-1.2.0.tgz", - "integrity": "sha512-kA5WQoNVo4t9lNx2kQNFCxKeBl5IbbSNBl1M/tLkw9WCn+hxNBAW5Qh8gdhs63CJnhjJ2zQWFoqPJP2sK1AV5A==", - "dev": true, - "license": "MIT", - "engines": { - "node": ">= 0.6" - } - }, - "node_modules/raw-body": { - "version": "2.5.3", - "resolved": "https://registry.npmjs.org/raw-body/-/raw-body-2.5.3.tgz", - "integrity": "sha512-s4VSOf6yN0rvbRZGxs8Om5CWj6seneMwK3oDb4lWDH0UPhWcxwOWw5+qk24bxq87szX1ydrwylIOp2uG1ojUpA==", - "dev": true, - "license": "MIT", - "dependencies": { - "bytes": "~3.1.2", - "http-errors": "~2.0.1", - "iconv-lite": "~0.4.24", - "unpipe": "~1.0.0" - }, - "engines": { - "node": ">= 0.8" - } - }, - "node_modules/raw-body/node_modules/bytes": { - "version": "3.1.2", - "resolved": "https://registry.npmjs.org/bytes/-/bytes-3.1.2.tgz", - "integrity": "sha512-/Nf7TyzTx6S3yRJObOAV7956r8cr2+Oj8AC5dt8wSP3BQAoeX58NoHyCU8P8zGkNXStjTSi6fzO6F0pBdcYbEg==", - "dev": true, - "license": "MIT", - "engines": { - "node": ">= 0.8" - } - }, - "node_modules/raw-body/node_modules/iconv-lite": { - "version": "0.4.24", - "resolved": "https://registry.npmjs.org/iconv-lite/-/iconv-lite-0.4.24.tgz", - "integrity": "sha512-v3MXnZAcvnywkTUEZomIActle7RXXeedOR31wwl7VlyoXO4Qi9arvSenNQWne1TcRwhCL1HwLI21bEqdpj8/rA==", - "dev": true, - "license": "MIT", - "dependencies": { - "safer-buffer": ">= 2.1.2 < 3" - }, - "engines": { - "node": ">=0.10.0" - } - }, - "node_modules/rc": { - "version": "1.2.8", - "resolved": "https://registry.npmjs.org/rc/-/rc-1.2.8.tgz", - "integrity": "sha512-y3bGgqKj3QBdxLbLkomlohkvsA8gdAiUQlSBJnBhfn+BPxg4bc62d8TcBW15wavDfgexCgccckhcZvywyQYPOw==", - "dev": true, - "license": "(BSD-2-Clause OR MIT OR Apache-2.0)", - "dependencies": { - "deep-extend": "^0.6.0", - "ini": "~1.3.0", - "minimist": "^1.2.0", - "strip-json-comments": "~2.0.1" - }, - "bin": { - "rc": "cli.js" - } - }, - "node_modules/rc/node_modules/ini": { - "version": "1.3.8", - "resolved": "https://registry.npmjs.org/ini/-/ini-1.3.8.tgz", - "integrity": "sha512-JV/yugV2uzW5iMRSiZAyDtQd+nxtUnjeLt0acNdw98kKLrvuRVyB80tsREOE7yvGVgalhZ6RNXCmEHkUKBKxew==", - "dev": true, - "license": "ISC" - }, - "node_modules/rc/node_modules/strip-json-comments": { - "version": "2.0.1", - "resolved": "https://registry.npmjs.org/strip-json-comments/-/strip-json-comments-2.0.1.tgz", - "integrity": "sha512-4gB8na07fecVVkOI6Rs4e7T6NOTki5EmL7TUduTs6bu3EdnSycntVJ4re8kgZA+wx9IueI2Y11bfbgwtzuE0KQ==", - "dev": true, - "license": "MIT", - "engines": { - "node": ">=0.10.0" - } - }, - "node_modules/react": { - "version": "18.3.1", - "resolved": "https://registry.npmjs.org/react/-/react-18.3.1.tgz", - "integrity": "sha512-wS+hAgJShR0KhEvPJArfuPVN1+Hz1t0Y6n5jLrGQbkb4urgPE/0Rve+1kMB1v/oWgHgm4WIcV+i7F2pTVj+2iQ==", - "dev": true, - "license": "MIT", - "peer": true, - "dependencies": { - "loose-envify": "^1.1.0" - }, - "engines": { - "node": ">=0.10.0" - } - }, - "node_modules/react-dom": { - "version": "18.3.1", - "resolved": "https://registry.npmjs.org/react-dom/-/react-dom-18.3.1.tgz", - "integrity": "sha512-5m4nQKp+rZRb09LNH59GM4BxTh9251/ylbKIbpe7TpGxfJ+9kv6BLkLBXIjjspbgbnIBNqlI23tRnTWT0snUIw==", - "dev": true, - "license": "MIT", - "peer": true, - "dependencies": { - "loose-envify": "^1.1.0", - "scheduler": "^0.23.2" - }, - "peerDependencies": { - "react": "^18.3.1" - } - }, - "node_modules/react-fast-compare": { - "version": "3.2.2", - "resolved": "https://registry.npmjs.org/react-fast-compare/-/react-fast-compare-3.2.2.tgz", - "integrity": "sha512-nsO+KSNgo1SbJqJEYRE9ERzo7YtYbou/OqjSQKxV7jcKox7+usiUVZOAC+XnDOABXggQTno0Y1CpVnuWEc1boQ==", + "node_modules/radix3": { + "version": "1.1.2", + "resolved": "https://registry.npmjs.org/radix3/-/radix3-1.1.2.tgz", + "integrity": "sha512-b484I/7b8rDEdSDKckSSBA8knMpcdsXudlE/LNL639wFoHKwLbEkQFZHWEYwDC0wa0FKUcCY+GAF73Z7wxNVFA==", "dev": true, "license": "MIT" }, - "node_modules/react-helmet-async": { - "name": "@slorber/react-helmet-async", - "version": "1.3.0", - "resolved": "https://registry.npmjs.org/@slorber/react-helmet-async/-/react-helmet-async-1.3.0.tgz", - "integrity": "sha512-e9/OK8VhwUSc67diWI8Rb3I0YgI9/SBQtnhe9aEuK6MhZm7ntZZimXgwXnd8W96YTmSOb9M4d8LwhRZyhWr/1A==", - "dev": true, - "license": "Apache-2.0", - "dependencies": { - "@babel/runtime": "^7.12.5", - "invariant": "^2.2.4", - "prop-types": "^15.7.2", - "react-fast-compare": "^3.2.0", - "shallowequal": "^1.1.0" - }, - "peerDependencies": { - "react": "^16.6.0 || ^17.0.0 || ^18.0.0 || ^19.0.0", - "react-dom": "^16.6.0 || ^17.0.0 || ^18.0.0 || ^19.0.0" - } - }, "node_modules/react-is": { "version": "18.3.1", "resolved": "https://registry.npmjs.org/react-is/-/react-is-18.3.1.tgz", @@ -20586,125 +12535,46 @@ "dev": true, "license": "MIT" }, - "node_modules/react-json-view-lite": { - "version": "2.5.0", - "resolved": "https://registry.npmjs.org/react-json-view-lite/-/react-json-view-lite-2.5.0.tgz", - "integrity": "sha512-tk7o7QG9oYyELWHL8xiMQ8x4WzjCzbWNyig3uexmkLb54r8jO0yH3WCWx8UZS0c49eSA4QUmG5caiRJ8fAn58g==", - "dev": true, - "license": "MIT", - "engines": { - "node": ">=18" - }, - "peerDependencies": { - "react": "^18.0.0 || ^19.0.0" - } - }, - "node_modules/react-loadable": { - "name": "@docusaurus/react-loadable", - "version": "6.0.0", - "resolved": "https://registry.npmjs.org/@docusaurus/react-loadable/-/react-loadable-6.0.0.tgz", - "integrity": "sha512-YMMxTUQV/QFSnbgrP3tjDzLHRg7vsbMn8e9HAa8o/1iXoiomo48b7sk/kkmWEuWNDPJVlKSJRB6Y2fHqdJk+SQ==", - "dev": true, - "license": "MIT", - "peer": true, - "dependencies": { - "@types/react": "*" - }, - "peerDependencies": { - "react": "*" - } - }, - "node_modules/react-loadable-ssr-addon-v5-slorber": { - "version": "1.0.1", - "resolved": "https://registry.npmjs.org/react-loadable-ssr-addon-v5-slorber/-/react-loadable-ssr-addon-v5-slorber-1.0.1.tgz", - "integrity": "sha512-lq3Lyw1lGku8zUEJPDxsNm1AfYHBrO9Y1+olAYwpUJ2IGFBskM0DMKok97A6LWUpHm+o7IvQBOWu9MLenp9Z+A==", - "dev": true, - "license": "MIT", - "dependencies": { - "@babel/runtime": "^7.10.3" - }, - "engines": { - "node": ">=10.13.0" - }, - "peerDependencies": { - "react-loadable": "*", - "webpack": ">=4.41.1 || 5.x" - } - }, - "node_modules/react-router": { - "version": "5.3.4", - "resolved": "https://registry.npmjs.org/react-router/-/react-router-5.3.4.tgz", - "integrity": "sha512-Ys9K+ppnJah3QuaRiLxk+jDWOR1MekYQrlytiXxC1RyfbdsZkS5pvKAzCCr031xHixZwpnsYNT5xysdFHQaYsA==", - "dev": true, - "license": "MIT", - "peer": true, - "dependencies": { - "@babel/runtime": "^7.12.13", - "history": "^4.9.0", - "hoist-non-react-statics": "^3.1.0", - "loose-envify": "^1.3.1", - "path-to-regexp": "^1.7.0", - "prop-types": "^15.6.2", - "react-is": "^16.6.0", - "tiny-invariant": "^1.0.2", - "tiny-warning": "^1.0.0" - }, - "peerDependencies": { - "react": ">=15" - } - }, - "node_modules/react-router-config": { - "version": "5.1.1", - "resolved": "https://registry.npmjs.org/react-router-config/-/react-router-config-5.1.1.tgz", - "integrity": "sha512-DuanZjaD8mQp1ppHjgnnUnyOlqYXZVjnov/JzFhjLEwd3Z4dYjMSnqrEzzGThH47vpCOqPPwJM2FtthLeJ8Pbg==", - "dev": true, - "license": "MIT", - "dependencies": { - "@babel/runtime": "^7.1.2" - }, - "peerDependencies": { - "react": ">=15", - "react-router": ">=5" - } - }, - "node_modules/react-router-dom": { - "version": "5.3.4", - "resolved": "https://registry.npmjs.org/react-router-dom/-/react-router-dom-5.3.4.tgz", - "integrity": "sha512-m4EqFMHv/Ih4kpcBCONHbkT68KoAeHN4p3lAGoNryfHi0dMy0kCzEZakiKRsvg5wHZ/JLrLW8o8KomWiz/qbYQ==", - "dev": true, - "license": "MIT", - "dependencies": { - "@babel/runtime": "^7.12.13", - "history": "^4.9.0", - "loose-envify": "^1.3.1", - "prop-types": "^15.6.2", - "react-router": "5.3.4", - "tiny-invariant": "^1.0.2", - "tiny-warning": "^1.0.0" - }, - "peerDependencies": { - "react": ">=15" - } - }, - "node_modules/react-router/node_modules/react-is": { - "version": "16.13.1", - "resolved": "https://registry.npmjs.org/react-is/-/react-is-16.13.1.tgz", - "integrity": "sha512-24e6ynE2H+OKt4kqsOvNd8kBpV65zoxbA4BVsEOB3ARVWQki/DHzaUoC5KuON/BiccDaCCTZBuOcfZs70kR8bQ==", - "dev": true, - "license": "MIT" - }, "node_modules/readable-stream": { - "version": "3.6.2", - "resolved": "https://registry.npmjs.org/readable-stream/-/readable-stream-3.6.2.tgz", - "integrity": "sha512-9u/sniCrY3D5WdsERHzHE4G2YCXqoG5FTHUiCC4SIbr6XcLZBY05ya9EKjYek9O5xOAwjGq+1JdGBAS7Q9ScoA==", + "version": "4.7.0", + "resolved": "https://registry.npmjs.org/readable-stream/-/readable-stream-4.7.0.tgz", + "integrity": "sha512-oIGGmcpTLwPga8Bn6/Z75SVaH1z5dUut2ibSyAMVhmUggWpmDn2dapB0n7f8nwaSiRtepAsfJyfXIO5DCVAODg==", + "dev": true, "license": "MIT", "dependencies": { - "inherits": "^2.0.3", - "string_decoder": "^1.1.1", - "util-deprecate": "^1.0.1" + "abort-controller": "^3.0.0", + "buffer": "^6.0.3", + "events": "^3.3.0", + "process": "^0.11.10", + "string_decoder": "^1.3.0" }, "engines": { - "node": ">= 6" + "node": "^12.22.0 || ^14.17.0 || >=16.0.0" + } + }, + "node_modules/readable-stream/node_modules/buffer": { + "version": "6.0.3", + "resolved": "https://registry.npmjs.org/buffer/-/buffer-6.0.3.tgz", + "integrity": "sha512-FTiCpNxtwiZZHEZbcbTIcZjERVICn9yq/pDFkTl95/AxzD1naBctN7YO68riM/gLSDY7sdrMby8hofADYuuqOA==", + "dev": true, + "funding": [ + { + "type": "github", + "url": "https://github.com/sponsors/feross" + }, + { + "type": "patreon", + "url": "https://www.patreon.com/feross" + }, + { + "type": "consulting", + "url": "https://feross.org/support" + } + ], + "license": "MIT", + "dependencies": { + "base64-js": "^1.3.1", + "ieee754": "^1.2.1" } }, "node_modules/readdir-glob": { @@ -20741,16 +12611,17 @@ } }, "node_modules/readdirp": { - "version": "3.6.0", - "resolved": "https://registry.npmjs.org/readdirp/-/readdirp-3.6.0.tgz", - "integrity": "sha512-hOS089on8RduqdbhvQ5Z37A0ESjsqz6qnRcffsMU3495FuTdqSm+7bhJ29JvIOsBDEEnan5DPu9t3To9VRlMzA==", + "version": "4.1.2", + "resolved": "https://registry.npmjs.org/readdirp/-/readdirp-4.1.2.tgz", + "integrity": "sha512-GDhwkLfywWL2s6vEjyhri+eXmfH6j1L7JE27WhqLeYzoh/A3DBaYGEj2H/HFZCn/kMfim73FXxEJTw06WtxQwg==", "dev": true, "license": "MIT", - "dependencies": { - "picomatch": "^2.2.1" - }, "engines": { - "node": ">=8.10.0" + "node": ">= 14.18.0" + }, + "funding": { + "type": "individual", + "url": "https://paulmillr.com/funding/" } }, "node_modules/recma-build-jsx": { @@ -20824,26 +12695,33 @@ "url": "https://opencollective.com/unified" } }, - "node_modules/regenerate": { - "version": "1.4.2", - "resolved": "https://registry.npmjs.org/regenerate/-/regenerate-1.4.2.tgz", - "integrity": "sha512-zrceR/XhGYU/d/opr2EKO7aRHUeiBI8qjtfHqADTwZd6Szfy16la6kqD0MIUs5z5hx6AaKa+PixpPrR289+I0A==", - "dev": true, - "license": "MIT" - }, - "node_modules/regenerate-unicode-properties": { - "version": "10.2.2", - "resolved": "https://registry.npmjs.org/regenerate-unicode-properties/-/regenerate-unicode-properties-10.2.2.tgz", - "integrity": "sha512-m03P+zhBeQd1RGnYxrGyDAPpWX/epKirLrp8e3qevZdVkKtnCrjjWczIbYc8+xd6vcTStVlqfycTx1KR4LOr0g==", + "node_modules/regex": { + "version": "6.1.0", + "resolved": "https://registry.npmjs.org/regex/-/regex-6.1.0.tgz", + "integrity": "sha512-6VwtthbV4o/7+OaAF9I5L5V3llLEsoPyq9P1JVXkedTP33c7MfCG0/5NOPcSJn0TzXcG9YUrR0gQSWioew3LDg==", "dev": true, "license": "MIT", "dependencies": { - "regenerate": "^1.4.2" - }, - "engines": { - "node": ">=4" + "regex-utilities": "^2.3.0" } }, + "node_modules/regex-recursion": { + "version": "6.0.2", + "resolved": "https://registry.npmjs.org/regex-recursion/-/regex-recursion-6.0.2.tgz", + "integrity": "sha512-0YCaSCq2VRIebiaUviZNs0cBz1kg5kVS2UKUfNIx8YVs1cN3AV7NTctO5FOKBA+UT2BPJIWZauYHPqJODG50cg==", + "dev": true, + "license": "MIT", + "dependencies": { + "regex-utilities": "^2.3.0" + } + }, + "node_modules/regex-utilities": { + "version": "2.3.0", + "resolved": "https://registry.npmjs.org/regex-utilities/-/regex-utilities-2.3.0.tgz", + "integrity": "sha512-8VhliFJAWRaUiVvREIiW2NXXTmHs4vMNnSzuJVhscgmGav3g9VDxLrQndI3dZZVVdp0ZO/5v0xmX516/7M9cng==", + "dev": true, + "license": "MIT" + }, "node_modules/regexp-tree": { "version": "0.1.27", "resolved": "https://registry.npmjs.org/regexp-tree/-/regexp-tree-0.1.27.tgz", @@ -20854,73 +12732,6 @@ "regexp-tree": "bin/regexp-tree" } }, - "node_modules/regexpu-core": { - "version": "6.4.0", - "resolved": "https://registry.npmjs.org/regexpu-core/-/regexpu-core-6.4.0.tgz", - "integrity": "sha512-0ghuzq67LI9bLXpOX/ISfve/Mq33a4aFRzoQYhnnok1JOFpmE/A2TBGkNVenOGEeSBCjIiWcc6MVOG5HEQv0sA==", - "dev": true, - "license": "MIT", - "dependencies": { - "regenerate": "^1.4.2", - "regenerate-unicode-properties": "^10.2.2", - "regjsgen": "^0.8.0", - "regjsparser": "^0.13.0", - "unicode-match-property-ecmascript": "^2.0.0", - "unicode-match-property-value-ecmascript": "^2.2.1" - }, - "engines": { - "node": ">=4" - } - }, - "node_modules/regexpu-core/node_modules/regjsparser": { - "version": "0.13.0", - "resolved": "https://registry.npmjs.org/regjsparser/-/regjsparser-0.13.0.tgz", - "integrity": "sha512-NZQZdC5wOE/H3UT28fVGL+ikOZcEzfMGk/c3iN9UGxzWHMa1op7274oyiUVrAG4B2EuFhus8SvkaYnhvW92p9Q==", - "dev": true, - "license": "BSD-2-Clause", - "dependencies": { - "jsesc": "~3.1.0" - }, - "bin": { - "regjsparser": "bin/parser" - } - }, - "node_modules/registry-auth-token": { - "version": "5.1.0", - "resolved": "https://registry.npmjs.org/registry-auth-token/-/registry-auth-token-5.1.0.tgz", - "integrity": "sha512-GdekYuwLXLxMuFTwAPg5UKGLW/UXzQrZvH/Zj791BQif5T05T0RsaLfHc9q3ZOKi7n+BoprPD9mJ0O0k4xzUlw==", - "dev": true, - "license": "MIT", - "dependencies": { - "@pnpm/npm-conf": "^2.1.0" - }, - "engines": { - "node": ">=14" - } - }, - "node_modules/registry-url": { - "version": "6.0.1", - "resolved": "https://registry.npmjs.org/registry-url/-/registry-url-6.0.1.tgz", - "integrity": "sha512-+crtS5QjFRqFCoQmvGduwYWEBng99ZvmFvF+cUJkGYF1L1BfU8C6Zp9T7f5vPAwyLkUExpvK+ANVZmGU49qi4Q==", - "dev": true, - "license": "MIT", - "dependencies": { - "rc": "1.2.8" - }, - "engines": { - "node": ">=12" - }, - "funding": { - "url": "https://github.com/sponsors/sindresorhus" - } - }, - "node_modules/regjsgen": { - "version": "0.8.0", - "resolved": "https://registry.npmjs.org/regjsgen/-/regjsgen-0.8.0.tgz", - "integrity": "sha512-RvwtGe3d7LvWiDQXeQw8p5asZUmfU1G/l6WbUXeHta7Y2PEIvBTwH6E2EfmYUK8pxcxEdEmaomqyp0vZZ7C+3Q==", - "dev": true, - "license": "MIT" - }, "node_modules/regjsparser": { "version": "0.12.0", "resolved": "https://registry.npmjs.org/regjsparser/-/regjsparser-0.12.0.tgz", @@ -20947,6 +12758,64 @@ "node": ">=6" } }, + "node_modules/rehype": { + "version": "13.0.2", + "resolved": "https://registry.npmjs.org/rehype/-/rehype-13.0.2.tgz", + "integrity": "sha512-j31mdaRFrwFRUIlxGeuPXXKWQxet52RBQRvCmzl5eCefn/KGbomK5GMHNMsOJf55fgo3qw5tST5neDuarDYR2A==", + "dev": true, + "license": "MIT", + "dependencies": { + "@types/hast": "^3.0.0", + "rehype-parse": "^9.0.0", + "rehype-stringify": "^10.0.0", + "unified": "^11.0.0" + }, + "funding": { + "type": "opencollective", + "url": "https://opencollective.com/unified" + } + }, + "node_modules/rehype-expressive-code": { + "version": "0.41.5", + "resolved": "https://registry.npmjs.org/rehype-expressive-code/-/rehype-expressive-code-0.41.5.tgz", + "integrity": "sha512-SzKJyu7heDpkt+XE/AqeWsYMSMocE/5mpJXD6CMgstqJHSE9bxGNcLp3zL9Wne3M5iBsS4GJyOD2syV77kRveA==", + "dev": true, + "license": "MIT", + "dependencies": { + "expressive-code": "^0.41.5" + } + }, + "node_modules/rehype-format": { + "version": "5.0.1", + "resolved": "https://registry.npmjs.org/rehype-format/-/rehype-format-5.0.1.tgz", + "integrity": "sha512-zvmVru9uB0josBVpr946OR8ui7nJEdzZobwLOOqHb/OOD88W0Vk2SqLwoVOj0fM6IPCCO6TaV9CvQvJMWwukFQ==", + "dev": true, + "license": "MIT", + "dependencies": { + "@types/hast": "^3.0.0", + "hast-util-format": "^1.0.0" + }, + "funding": { + "type": "opencollective", + "url": "https://opencollective.com/unified" + } + }, + "node_modules/rehype-parse": { + "version": "9.0.1", + "resolved": "https://registry.npmjs.org/rehype-parse/-/rehype-parse-9.0.1.tgz", + "integrity": "sha512-ksCzCD0Fgfh7trPDxr2rSylbwq9iYDkSn8TCDmEJ49ljEUBxDVCzCHv7QNzZOfODanX4+bWQ4WZqLCRWYLfhag==", + "dev": true, + "license": "MIT", + "dependencies": { + "@types/hast": "^3.0.0", + "hast-util-from-html": "^2.0.0", + "unified": "^11.0.0" + }, + "funding": { + "type": "opencollective", + "url": "https://opencollective.com/unified" + } + }, "node_modules/rehype-raw": { "version": "7.0.0", "resolved": "https://registry.npmjs.org/rehype-raw/-/rehype-raw-7.0.0.tgz", @@ -20979,14 +12848,20 @@ "url": "https://opencollective.com/unified" } }, - "node_modules/relateurl": { - "version": "0.2.7", - "resolved": "https://registry.npmjs.org/relateurl/-/relateurl-0.2.7.tgz", - "integrity": "sha512-G08Dxvm4iDN3MLM0EsP62EDV9IuhXPR6blNz6Utcp7zyV3tr4HVNINt6MpaRWbxoOHT3Q7YN2P+jaHX8vUbgog==", + "node_modules/rehype-stringify": { + "version": "10.0.1", + "resolved": "https://registry.npmjs.org/rehype-stringify/-/rehype-stringify-10.0.1.tgz", + "integrity": "sha512-k9ecfXHmIPuFVI61B9DeLPN0qFHfawM6RsuX48hoqlaKSF61RskNjSm1lI8PhBEM0MRdLxVVm4WmTqJQccH9mA==", "dev": true, "license": "MIT", - "engines": { - "node": ">= 0.10" + "dependencies": { + "@types/hast": "^3.0.0", + "hast-util-to-html": "^9.0.0", + "unified": "^11.0.0" + }, + "funding": { + "type": "opencollective", + "url": "https://opencollective.com/unified" } }, "node_modules/remark-directive": { @@ -21026,40 +12901,6 @@ "url": "https://opencollective.com/unified" } }, - "node_modules/remark-emoji": { - "version": "4.0.1", - "resolved": "https://registry.npmjs.org/remark-emoji/-/remark-emoji-4.0.1.tgz", - "integrity": "sha512-fHdvsTR1dHkWKev9eNyhTo4EFwbUvJ8ka9SgeWkMPYFX4WoI7ViVBms3PjlQYgw5TLvNQso3GUB/b/8t3yo+dg==", - "dev": true, - "license": "MIT", - "dependencies": { - "@types/mdast": "^4.0.2", - "emoticon": "^4.0.1", - "mdast-util-find-and-replace": "^3.0.1", - "node-emoji": "^2.1.0", - "unified": "^11.0.4" - }, - "engines": { - "node": "^12.20.0 || ^14.13.1 || >=16.0.0" - } - }, - "node_modules/remark-frontmatter": { - "version": "5.0.0", - "resolved": "https://registry.npmjs.org/remark-frontmatter/-/remark-frontmatter-5.0.0.tgz", - "integrity": "sha512-XTFYvNASMe5iPN0719nPrdItC9aU0ssC4v14mH1BCi1u0n1gAocqcujWUrByftZTbLhRtiKRyjYTSIOcr69UVQ==", - "dev": true, - "license": "MIT", - "dependencies": { - "@types/mdast": "^4.0.0", - "mdast-util-frontmatter": "^2.0.0", - "micromark-extension-frontmatter": "^2.0.0", - "unified": "^11.0.0" - }, - "funding": { - "type": "opencollective", - "url": "https://opencollective.com/unified" - } - }, "node_modules/remark-gfm": { "version": "4.0.1", "resolved": "https://registry.npmjs.org/remark-gfm/-/remark-gfm-4.0.1.tgz", @@ -21128,6 +12969,22 @@ "url": "https://opencollective.com/unified" } }, + "node_modules/remark-smartypants": { + "version": "3.0.2", + "resolved": "https://registry.npmjs.org/remark-smartypants/-/remark-smartypants-3.0.2.tgz", + "integrity": "sha512-ILTWeOriIluwEvPjv67v7Blgrcx+LZOkAUVtKI3putuhlZm84FnqDORNXPPm+HY3NdZOMhyDwZ1E+eZB/Df5dA==", + "dev": true, + "license": "MIT", + "dependencies": { + "retext": "^9.0.0", + "retext-smartypants": "^6.0.0", + "unified": "^11.0.4", + "unist-util-visit": "^5.0.0" + }, + "engines": { + "node": ">=16.0.0" + } + }, "node_modules/remark-stringify": { "version": "11.0.0", "resolved": "https://registry.npmjs.org/remark-stringify/-/remark-stringify-11.0.0.tgz", @@ -21143,123 +13000,6 @@ "url": "https://opencollective.com/unified" } }, - "node_modules/renderkid": { - "version": "3.0.0", - "resolved": "https://registry.npmjs.org/renderkid/-/renderkid-3.0.0.tgz", - "integrity": "sha512-q/7VIQA8lmM1hF+jn+sFSPWGlMkSAeNYcPLmDQx2zzuiDfaLrOmumR8iaUKlenFgh0XRPIUeSPlH3A+AW3Z5pg==", - "dev": true, - "license": "MIT", - "dependencies": { - "css-select": "^4.1.3", - "dom-converter": "^0.2.0", - "htmlparser2": "^6.1.0", - "lodash": "^4.17.21", - "strip-ansi": "^6.0.1" - } - }, - "node_modules/renderkid/node_modules/css-select": { - "version": "4.3.0", - "resolved": "https://registry.npmjs.org/css-select/-/css-select-4.3.0.tgz", - "integrity": "sha512-wPpOYtnsVontu2mODhA19JrqWxNsfdatRKd64kmpRbQgh1KtItko5sTnEpPdpSaJszTOhEMlF/RPz28qj4HqhQ==", - "dev": true, - "license": "BSD-2-Clause", - "dependencies": { - "boolbase": "^1.0.0", - "css-what": "^6.0.1", - "domhandler": "^4.3.1", - "domutils": "^2.8.0", - "nth-check": "^2.0.1" - }, - "funding": { - "url": "https://github.com/sponsors/fb55" - } - }, - "node_modules/renderkid/node_modules/dom-serializer": { - "version": "1.4.1", - "resolved": "https://registry.npmjs.org/dom-serializer/-/dom-serializer-1.4.1.tgz", - "integrity": "sha512-VHwB3KfrcOOkelEG2ZOfxqLZdfkil8PtJi4P8N2MMXucZq2yLp75ClViUlOVwyoHEDjYU433Aq+5zWP61+RGag==", - "dev": true, - "license": "MIT", - "dependencies": { - "domelementtype": "^2.0.1", - "domhandler": "^4.2.0", - "entities": "^2.0.0" - }, - "funding": { - "url": "https://github.com/cheeriojs/dom-serializer?sponsor=1" - } - }, - "node_modules/renderkid/node_modules/domhandler": { - "version": "4.3.1", - "resolved": "https://registry.npmjs.org/domhandler/-/domhandler-4.3.1.tgz", - "integrity": "sha512-GrwoxYN+uWlzO8uhUXRl0P+kHE4GtVPfYzVLcUxPL7KNdHKj66vvlhiweIHqYYXWlw+T8iLMp42Lm67ghw4WMQ==", - "dev": true, - "license": "BSD-2-Clause", - "dependencies": { - "domelementtype": "^2.2.0" - }, - "engines": { - "node": ">= 4" - }, - "funding": { - "url": "https://github.com/fb55/domhandler?sponsor=1" - } - }, - "node_modules/renderkid/node_modules/domutils": { - "version": "2.8.0", - "resolved": "https://registry.npmjs.org/domutils/-/domutils-2.8.0.tgz", - "integrity": "sha512-w96Cjofp72M5IIhpjgobBimYEfoPjx1Vx0BSX9P30WBdZW2WIKU0T1Bd0kz2eNZ9ikjKgHbEyKx8BB6H1L3h3A==", - "dev": true, - "license": "BSD-2-Clause", - "dependencies": { - "dom-serializer": "^1.0.1", - "domelementtype": "^2.2.0", - "domhandler": "^4.2.0" - }, - "funding": { - "url": "https://github.com/fb55/domutils?sponsor=1" - } - }, - "node_modules/renderkid/node_modules/entities": { - "version": "2.2.0", - "resolved": "https://registry.npmjs.org/entities/-/entities-2.2.0.tgz", - "integrity": "sha512-p92if5Nz619I0w+akJrLZH0MX0Pb5DX39XOwQTtXSdQQOaYH03S1uIQp4mhOZtAXrxq4ViO67YTiLBo2638o9A==", - "dev": true, - "license": "BSD-2-Clause", - "funding": { - "url": "https://github.com/fb55/entities?sponsor=1" - } - }, - "node_modules/renderkid/node_modules/htmlparser2": { - "version": "6.1.0", - "resolved": "https://registry.npmjs.org/htmlparser2/-/htmlparser2-6.1.0.tgz", - "integrity": "sha512-gyyPk6rgonLFEDGoeRgQNaEUvdJ4ktTmmUh/h2t7s+M8oPpIPxgNACWa+6ESR57kXstwqPiCut0V8NRpcwgU7A==", - "dev": true, - "funding": [ - "https://github.com/fb55/htmlparser2?sponsor=1", - { - "type": "github", - "url": "https://github.com/sponsors/fb55" - } - ], - "license": "MIT", - "dependencies": { - "domelementtype": "^2.0.1", - "domhandler": "^4.0.0", - "domutils": "^2.5.2", - "entities": "^2.0.0" - } - }, - "node_modules/repeat-string": { - "version": "1.6.1", - "resolved": "https://registry.npmjs.org/repeat-string/-/repeat-string-1.6.1.tgz", - "integrity": "sha512-PV0dzCYDNfRi1jCDbJzpW7jNNDRuCOG/jI5ctQcGKt/clZD+YcPS3yIlWuTJMmESC8aevCFmWJy5wjAFgNqN6w==", - "dev": true, - "license": "MIT", - "engines": { - "node": ">=0.10" - } - }, "node_modules/require-directory": { "version": "2.1.1", "resolved": "https://registry.npmjs.org/require-directory/-/require-directory-2.1.1.tgz", @@ -21270,60 +13010,6 @@ "node": ">=0.10.0" } }, - "node_modules/require-from-string": { - "version": "2.0.2", - "resolved": "https://registry.npmjs.org/require-from-string/-/require-from-string-2.0.2.tgz", - "integrity": "sha512-Xf0nWe6RseziFMu+Ap9biiUbmplq6S9/p+7w7YXP/JBHhrUDDUhwa+vANyubuqfZWTveU//DYVGsDG7RKL/vEw==", - "dev": true, - "license": "MIT", - "engines": { - "node": ">=0.10.0" - } - }, - "node_modules/require-like": { - "version": "0.1.2", - "resolved": "https://registry.npmjs.org/require-like/-/require-like-0.1.2.tgz", - "integrity": "sha512-oyrU88skkMtDdauHDuKVrgR+zuItqr6/c//FXzvmxRGMexSDc6hNvJInGW3LL46n+8b50RykrvwSUIIQH2LQ5A==", - "dev": true, - "engines": { - "node": "*" - } - }, - "node_modules/requires-port": { - "version": "1.0.0", - "resolved": "https://registry.npmjs.org/requires-port/-/requires-port-1.0.0.tgz", - "integrity": "sha512-KigOCHcocU3XODJxsu8i/j8T9tzT4adHiecwORRQ0ZZFcp7ahwXuRU1m+yuO90C5ZUyGeGfocHDI14M3L3yDAQ==", - "dev": true, - "license": "MIT" - }, - "node_modules/resolve": { - "version": "1.22.11", - "resolved": "https://registry.npmjs.org/resolve/-/resolve-1.22.11.tgz", - "integrity": "sha512-RfqAvLnMl313r7c9oclB1HhUEAezcpLjz95wFH4LVuhk9JF/r22qmVP9AMmOU4vMX7Q8pN8jwNg/CSpdFnMjTQ==", - "dev": true, - "license": "MIT", - "dependencies": { - "is-core-module": "^2.16.1", - "path-parse": "^1.0.7", - "supports-preserve-symlinks-flag": "^1.0.0" - }, - "bin": { - "resolve": "bin/resolve" - }, - "engines": { - "node": ">= 0.4" - }, - "funding": { - "url": "https://github.com/sponsors/ljharb" - } - }, - "node_modules/resolve-alpn": { - "version": "1.2.1", - "resolved": "https://registry.npmjs.org/resolve-alpn/-/resolve-alpn-1.2.1.tgz", - "integrity": "sha512-0a1F4l73/ZFZOakJnQ3FvkJ2+gSTQWz/r2KE5OdDY0TxPm5h4GkqkWWfM47T7HsbnOtcJVEF4epCVy6u7Q3K+g==", - "dev": true, - "license": "MIT" - }, "node_modules/resolve-cwd": { "version": "3.0.0", "resolved": "https://registry.npmjs.org/resolve-cwd/-/resolve-cwd-3.0.0.tgz", @@ -21357,13 +13043,6 @@ "node": ">=4" } }, - "node_modules/resolve-pathname": { - "version": "3.0.0", - "resolved": "https://registry.npmjs.org/resolve-pathname/-/resolve-pathname-3.0.0.tgz", - "integrity": "sha512-C7rARubxI8bXFNB/hqcp/4iUeIXJhJZvFPFPiSPRnhU5UPxzMFIl+2E6yY6c4k9giDJAhtV+enfA+G89N6Csng==", - "dev": true, - "license": "MIT" - }, "node_modules/resolve-pkg-maps": { "version": "1.0.0", "resolved": "https://registry.npmjs.org/resolve-pkg-maps/-/resolve-pkg-maps-1.0.0.tgz", @@ -21374,49 +13053,109 @@ "url": "https://github.com/privatenumber/resolve-pkg-maps?sponsor=1" } }, - "node_modules/responselike": { - "version": "3.0.0", - "resolved": "https://registry.npmjs.org/responselike/-/responselike-3.0.0.tgz", - "integrity": "sha512-40yHxbNcl2+rzXvZuVkrYohathsSJlMTXKryG5y8uciHv1+xDLHQpgjG64JUO9nrEq2jGLH6IZ8BcZyw3wrweg==", + "node_modules/restore-cursor": { + "version": "5.1.0", + "resolved": "https://registry.npmjs.org/restore-cursor/-/restore-cursor-5.1.0.tgz", + "integrity": "sha512-oMA2dcrw6u0YfxJQXm342bFKX/E4sG9rbTzO9ptUcR/e8A33cHuvStiYOwH7fszkZlZ1z/ta9AAoPk2F4qIOHA==", "dev": true, "license": "MIT", "dependencies": { - "lowercase-keys": "^3.0.0" + "onetime": "^7.0.0", + "signal-exit": "^4.1.0" }, "engines": { - "node": ">=14.16" + "node": ">=18" }, "funding": { "url": "https://github.com/sponsors/sindresorhus" } }, - "node_modules/restore-cursor": { - "version": "3.1.0", - "resolved": "https://registry.npmjs.org/restore-cursor/-/restore-cursor-3.1.0.tgz", - "integrity": "sha512-l+sSefzHpj5qimhFSE5a8nufZYAM3sBSVMAPtYkmC+4EH2anSGaEMXSD0izRQbu9nfyQ9y5JrVmp7E8oZrUjvA==", - "license": "MIT", - "dependencies": { - "onetime": "^5.1.0", - "signal-exit": "^3.0.2" - }, - "engines": { - "node": ">=8" - } - }, - "node_modules/restore-cursor/node_modules/signal-exit": { - "version": "3.0.7", - "resolved": "https://registry.npmjs.org/signal-exit/-/signal-exit-3.0.7.tgz", - "integrity": "sha512-wnD2ZE+l+SPC/uoS0vXeE9L1+0wuaMqKlfz9AMUo38JsyLSBWSFcHR1Rri62LZc12vLr1gb3jl7iwQhgwpAbGQ==", - "license": "ISC" - }, - "node_modules/retry": { - "version": "0.13.1", - "resolved": "https://registry.npmjs.org/retry/-/retry-0.13.1.tgz", - "integrity": "sha512-XQBQ3I8W1Cge0Seh+6gjj03LbmRFWuoszgK9ooCpwYIrhhoO80pfq4cUkU5DkknwfOfFteRwlZ56PYOGYyFWdg==", + "node_modules/restore-cursor/node_modules/onetime": { + "version": "7.0.0", + "resolved": "https://registry.npmjs.org/onetime/-/onetime-7.0.0.tgz", + "integrity": "sha512-VXJjc87FScF88uafS3JllDgvAm+c/Slfz06lorj2uAY34rlUu0Nt+v8wreiImcrgAjjIHp1rXpTDlLOGw29WwQ==", "dev": true, "license": "MIT", + "dependencies": { + "mimic-function": "^5.0.0" + }, "engines": { - "node": ">= 4" + "node": ">=18" + }, + "funding": { + "url": "https://github.com/sponsors/sindresorhus" + } + }, + "node_modules/restructure": { + "version": "3.0.2", + "resolved": "https://registry.npmjs.org/restructure/-/restructure-3.0.2.tgz", + "integrity": "sha512-gSfoiOEA0VPE6Tukkrr7I0RBdE0s7H1eFCDBk05l1KIQT1UIKNc5JZy6jdyW6eYH3aR3g5b3PuL77rq0hvwtAw==", + "dev": true, + "license": "MIT" + }, + "node_modules/retext": { + "version": "9.0.0", + "resolved": "https://registry.npmjs.org/retext/-/retext-9.0.0.tgz", + "integrity": "sha512-sbMDcpHCNjvlheSgMfEcVrZko3cDzdbe1x/e7G66dFp0Ff7Mldvi2uv6JkJQzdRcvLYE8CA8Oe8siQx8ZOgTcA==", + "dev": true, + "license": "MIT", + "dependencies": { + "@types/nlcst": "^2.0.0", + "retext-latin": "^4.0.0", + "retext-stringify": "^4.0.0", + "unified": "^11.0.0" + }, + "funding": { + "type": "opencollective", + "url": "https://opencollective.com/unified" + } + }, + "node_modules/retext-latin": { + "version": "4.0.0", + "resolved": "https://registry.npmjs.org/retext-latin/-/retext-latin-4.0.0.tgz", + "integrity": "sha512-hv9woG7Fy0M9IlRQloq/N6atV82NxLGveq+3H2WOi79dtIYWN8OaxogDm77f8YnVXJL2VD3bbqowu5E3EMhBYA==", + "dev": true, + "license": "MIT", + "dependencies": { + "@types/nlcst": "^2.0.0", + "parse-latin": "^7.0.0", + "unified": "^11.0.0" + }, + "funding": { + "type": "opencollective", + "url": "https://opencollective.com/unified" + } + }, + "node_modules/retext-smartypants": { + "version": "6.2.0", + "resolved": "https://registry.npmjs.org/retext-smartypants/-/retext-smartypants-6.2.0.tgz", + "integrity": "sha512-kk0jOU7+zGv//kfjXEBjdIryL1Acl4i9XNkHxtM7Tm5lFiCog576fjNC9hjoR7LTKQ0DsPWy09JummSsH1uqfQ==", + "dev": true, + "license": "MIT", + "dependencies": { + "@types/nlcst": "^2.0.0", + "nlcst-to-string": "^4.0.0", + "unist-util-visit": "^5.0.0" + }, + "funding": { + "type": "opencollective", + "url": "https://opencollective.com/unified" + } + }, + "node_modules/retext-stringify": { + "version": "4.0.0", + "resolved": "https://registry.npmjs.org/retext-stringify/-/retext-stringify-4.0.0.tgz", + "integrity": "sha512-rtfN/0o8kL1e+78+uxPTqu1Klt0yPzKuQ2BfWwwfgIUSayyzxpM1PJzkKt4V8803uB9qSy32MvI7Xep9khTpiA==", + "dev": true, + "license": "MIT", + "dependencies": { + "@types/nlcst": "^2.0.0", + "nlcst-to-string": "^4.0.0", + "unified": "^11.0.0" + }, + "funding": { + "type": "opencollective", + "url": "https://opencollective.com/unified" } }, "node_modules/reusify": { @@ -21437,45 +13176,46 @@ "dev": true, "license": "MIT" }, - "node_modules/rtlcss": { - "version": "4.3.0", - "resolved": "https://registry.npmjs.org/rtlcss/-/rtlcss-4.3.0.tgz", - "integrity": "sha512-FI+pHEn7Wc4NqKXMXFM+VAYKEj/mRIcW4h24YVwVtyjI+EqGrLc2Hx/Ny0lrZ21cBWU2goLy36eqMcNj3AQJig==", + "node_modules/rollup": { + "version": "4.54.0", + "resolved": "https://registry.npmjs.org/rollup/-/rollup-4.54.0.tgz", + "integrity": "sha512-3nk8Y3a9Ea8szgKhinMlGMhGMw89mqule3KWczxhIzqudyHdCIOHw8WJlj/r329fACjKLEh13ZSk7oE22kyeIw==", "dev": true, "license": "MIT", "dependencies": { - "escalade": "^3.1.1", - "picocolors": "^1.0.0", - "postcss": "^8.4.21", - "strip-json-comments": "^3.1.1" + "@types/estree": "1.0.8" }, "bin": { - "rtlcss": "bin/rtlcss.js" + "rollup": "dist/bin/rollup" }, "engines": { - "node": ">=12.0.0" - } - }, - "node_modules/run-applescript": { - "version": "7.1.0", - "resolved": "https://registry.npmjs.org/run-applescript/-/run-applescript-7.1.0.tgz", - "integrity": "sha512-DPe5pVFaAsinSaV6QjQ6gdiedWDcRCbUuiQfQa2wmWV7+xC9bGulGI8+TdRmoFkAPaBXk8CrAbnlY2ISniJ47Q==", - "dev": true, - "license": "MIT", - "engines": { - "node": ">=18" + "node": ">=18.0.0", + "npm": ">=8.0.0" }, - "funding": { - "url": "https://github.com/sponsors/sindresorhus" - } - }, - "node_modules/run-async": { - "version": "2.4.1", - "resolved": "https://registry.npmjs.org/run-async/-/run-async-2.4.1.tgz", - "integrity": "sha512-tvVnVv01b8c1RrA6Ep7JkStj85Guv/YrMcwqYQnwjsAS2cTmmPGBBjAjpCW7RrSodNSoE2/qg9O4bceNvUuDgQ==", - "license": "MIT", - "engines": { - "node": ">=0.12.0" + "optionalDependencies": { + "@rollup/rollup-android-arm-eabi": "4.54.0", + "@rollup/rollup-android-arm64": "4.54.0", + "@rollup/rollup-darwin-arm64": "4.54.0", + "@rollup/rollup-darwin-x64": "4.54.0", + "@rollup/rollup-freebsd-arm64": "4.54.0", + "@rollup/rollup-freebsd-x64": "4.54.0", + "@rollup/rollup-linux-arm-gnueabihf": "4.54.0", + "@rollup/rollup-linux-arm-musleabihf": "4.54.0", + "@rollup/rollup-linux-arm64-gnu": "4.54.0", + "@rollup/rollup-linux-arm64-musl": "4.54.0", + "@rollup/rollup-linux-loong64-gnu": "4.54.0", + "@rollup/rollup-linux-ppc64-gnu": "4.54.0", + "@rollup/rollup-linux-riscv64-gnu": "4.54.0", + "@rollup/rollup-linux-riscv64-musl": "4.54.0", + "@rollup/rollup-linux-s390x-gnu": "4.54.0", + "@rollup/rollup-linux-x64-gnu": "4.54.0", + "@rollup/rollup-linux-x64-musl": "4.54.0", + "@rollup/rollup-openharmony-arm64": "4.54.0", + "@rollup/rollup-win32-arm64-msvc": "4.54.0", + "@rollup/rollup-win32-ia32-msvc": "4.54.0", + "@rollup/rollup-win32-x64-gnu": "4.54.0", + "@rollup/rollup-win32-x64-msvc": "4.54.0", + "fsevents": "~2.3.2" } }, "node_modules/run-parallel": { @@ -21502,15 +13242,6 @@ "queue-microtask": "^1.2.2" } }, - "node_modules/rxjs": { - "version": "7.8.2", - "resolved": "https://registry.npmjs.org/rxjs/-/rxjs-7.8.2.tgz", - "integrity": "sha512-dhKf903U/PQZY6boNNtAGdWbG85WAbjT/1xYoZIC7FAY0yWapOBQVsVrDl58W86//e1VpMNBtRV4MaXfdMySFA==", - "license": "Apache-2.0", - "dependencies": { - "tslib": "^2.1.0" - } - }, "node_modules/safe-buffer": { "version": "5.2.1", "resolved": "https://registry.npmjs.org/safe-buffer/-/safe-buffer-5.2.1.tgz", @@ -21531,114 +13262,11 @@ ], "license": "MIT" }, - "node_modules/safer-buffer": { - "version": "2.1.2", - "resolved": "https://registry.npmjs.org/safer-buffer/-/safer-buffer-2.1.2.tgz", - "integrity": "sha512-YZo3K82SD7Riyi0E1EQPojLz7kpepnSQI9IyPbHHg1XXXevb5dJI7tpyN2ADxGcQbHG7vcyRHk0cbwqcQriUtg==", - "license": "MIT" - }, "node_modules/sax": { - "version": "1.4.1", - "resolved": "https://registry.npmjs.org/sax/-/sax-1.4.1.tgz", - "integrity": "sha512-+aWOz7yVScEGoKNd4PA10LZ8sk0A/z5+nXQG5giUO5rprX9jgYsTdov9qCchZiPIZezbZH+jRut8nPodFAX4Jg==", - "license": "ISC" - }, - "node_modules/scheduler": { - "version": "0.23.2", - "resolved": "https://registry.npmjs.org/scheduler/-/scheduler-0.23.2.tgz", - "integrity": "sha512-UOShsPwz7NrMUqhR6t0hWjFduvOzbtv7toDH1/hIrfRNIDBnnBWd0CwJTGvTpngVlmwGCdP9/Zl/tVrDqcuYzQ==", - "dev": true, - "license": "MIT", - "dependencies": { - "loose-envify": "^1.1.0" - } - }, - "node_modules/schema-dts": { - "version": "1.1.5", - "resolved": "https://registry.npmjs.org/schema-dts/-/schema-dts-1.1.5.tgz", - "integrity": "sha512-RJr9EaCmsLzBX2NDiO5Z3ux2BVosNZN5jo0gWgsyKvxKIUL5R3swNvoorulAeL9kLB0iTSX7V6aokhla2m7xbg==", - "dev": true, - "license": "Apache-2.0" - }, - "node_modules/schema-utils": { - "version": "4.3.3", - "resolved": "https://registry.npmjs.org/schema-utils/-/schema-utils-4.3.3.tgz", - "integrity": "sha512-eflK8wEtyOE6+hsaRVPxvUKYCpRgzLqDTb8krvAsRIwOGlHoSgYLgBXoubGgLd2fT41/OUYdb48v4k4WWHQurA==", - "dev": true, - "license": "MIT", - "dependencies": { - "@types/json-schema": "^7.0.9", - "ajv": "^8.9.0", - "ajv-formats": "^2.1.1", - "ajv-keywords": "^5.1.0" - }, - "engines": { - "node": ">= 10.13.0" - }, - "funding": { - "type": "opencollective", - "url": "https://opencollective.com/webpack" - } - }, - "node_modules/schema-utils/node_modules/ajv": { - "version": "8.17.1", - "resolved": "https://registry.npmjs.org/ajv/-/ajv-8.17.1.tgz", - "integrity": "sha512-B/gBuNg5SiMTrPkC+A2+cW0RszwxYmn6VYxB/inlBStS5nx6xHIt/ehKRhIMhqusl7a8LjQoZnjCs5vhwxOQ1g==", - "dev": true, - "license": "MIT", - "peer": true, - "dependencies": { - "fast-deep-equal": "^3.1.3", - "fast-uri": "^3.0.1", - "json-schema-traverse": "^1.0.0", - "require-from-string": "^2.0.2" - }, - "funding": { - "type": "github", - "url": "https://github.com/sponsors/epoberezkin" - } - }, - "node_modules/schema-utils/node_modules/ajv-keywords": { - "version": "5.1.0", - "resolved": "https://registry.npmjs.org/ajv-keywords/-/ajv-keywords-5.1.0.tgz", - "integrity": "sha512-YCS/JNFAUyr5vAuhk1DWm1CBxRHW9LbJ2ozWeemrIqpbsqKjHVxYPyi5GC0rjZIT5JxJ3virVTS8wk4i/Z+krw==", - "dev": true, - "license": "MIT", - "dependencies": { - "fast-deep-equal": "^3.1.3" - }, - "peerDependencies": { - "ajv": "^8.8.2" - } - }, - "node_modules/schema-utils/node_modules/json-schema-traverse": { - "version": "1.0.0", - "resolved": "https://registry.npmjs.org/json-schema-traverse/-/json-schema-traverse-1.0.0.tgz", - "integrity": "sha512-NM8/P9n3XjXhIZn1lLhkFaACTOURQXjWhV4BA/RnOv8xvgqtqpAX9IO4mRQxSx1Rlo4tqzeqb0sOlruaOy3dug==", - "dev": true, - "license": "MIT" - }, - "node_modules/search-insights": { - "version": "2.17.3", - "resolved": "https://registry.npmjs.org/search-insights/-/search-insights-2.17.3.tgz", - "integrity": "sha512-RQPdCYTa8A68uM2jwxoY842xDhvx3E5LFL1LxvxCNMev4o5mLuokczhzjAgGwUZBAmOKZknArSxLKmXtIi2AxQ==", - "dev": true, - "license": "MIT", - "peer": true - }, - "node_modules/section-matter": { - "version": "1.0.0", - "resolved": "https://registry.npmjs.org/section-matter/-/section-matter-1.0.0.tgz", - "integrity": "sha512-vfD3pmTzGpufjScBh50YHKzEu2lxBWhVEHsNGoEXmCmn2hKGfeNLYMzCJpe8cD7gqX7TJluOVpBkAequ6dgMmA==", - "dev": true, - "license": "MIT", - "dependencies": { - "extend-shallow": "^2.0.1", - "kind-of": "^6.0.0" - }, - "engines": { - "node": ">=4" - } + "version": "1.4.3", + "resolved": "https://registry.npmjs.org/sax/-/sax-1.4.3.tgz", + "integrity": "sha512-yqYn1JhPczigF94DMS+shiDMjDowYO6y9+wB/4WgO0Y19jWYk0lQ4tuG5KI7kj4FTp1wxPj5IFfcrz/s1c3jjQ==", + "license": "BlueOak-1.0.0" }, "node_modules/secure-keys": { "version": "1.0.0", @@ -21647,31 +13275,10 @@ "dev": true, "license": "MIT" }, - "node_modules/select-hose": { - "version": "2.0.0", - "resolved": "https://registry.npmjs.org/select-hose/-/select-hose-2.0.0.tgz", - "integrity": "sha512-mEugaLK+YfkijB4fx0e6kImuJdCIt2LxCRcbEYPqRGCs4F2ogyfZU5IAZRdjCP8JPq2AtdNoC/Dux63d9Kiryg==", - "dev": true, - "license": "MIT" - }, - "node_modules/selfsigned": { - "version": "2.4.1", - "resolved": "https://registry.npmjs.org/selfsigned/-/selfsigned-2.4.1.tgz", - "integrity": "sha512-th5B4L2U+eGLq1TVh7zNRGBapioSORUeymIydxgFpwww9d2qyKvtuPU2jJuHvYAwwqi2Y596QBL3eEqcPEYL8Q==", - "dev": true, - "license": "MIT", - "dependencies": { - "@types/node-forge": "^1.3.0", - "node-forge": "^1" - }, - "engines": { - "node": ">=10" - } - }, "node_modules/semver": { - "version": "7.7.2", - "resolved": "https://registry.npmjs.org/semver/-/semver-7.7.2.tgz", - "integrity": "sha512-RF0Fw+rO5AMf9MAyaRXI4AV0Ulj5lMHqVxxdSgiVbixSCXoEmmX/jk0CuJw4+3SqroYO9VoUh+HcuJivvtJemA==", + "version": "7.7.3", + "resolved": "https://registry.npmjs.org/semver/-/semver-7.7.3.tgz", + "integrity": "sha512-SdsKMrI9TdgjdweUSR9MweHA4EJ8YxHn8DFaDisvhVlUOe4BF1tLD7GAj0lIqWVl+dPb/rExr0Btby5loQm20Q==", "license": "ISC", "bin": { "semver": "bin/semver.js" @@ -21680,254 +13287,46 @@ "node": ">=10" } }, - "node_modules/semver-diff": { - "version": "4.0.0", - "resolved": "https://registry.npmjs.org/semver-diff/-/semver-diff-4.0.0.tgz", - "integrity": "sha512-0Ju4+6A8iOnpL/Thra7dZsSlOHYAHIeMxfhWQRI1/VLcT3WDBZKKtQt/QkBOsiIN9ZpuvHE6cGZ0x4glCMmfiA==", + "node_modules/sharp": { + "version": "0.33.5", + "resolved": "https://registry.npmjs.org/sharp/-/sharp-0.33.5.tgz", + "integrity": "sha512-haPVm1EkS9pgvHrQ/F3Xy+hgcuMV0Wm9vfIBSiwZ05k+xgb0PkBQpGsAA/oWdDobNaZTH5ppvHtzCFbnSEwHVw==", "dev": true, - "license": "MIT", + "hasInstallScript": true, + "license": "Apache-2.0", "dependencies": { - "semver": "^7.3.5" + "color": "^4.2.3", + "detect-libc": "^2.0.3", + "semver": "^7.6.3" }, "engines": { - "node": ">=12" + "node": "^18.17.0 || ^20.3.0 || >=21.0.0" }, "funding": { - "url": "https://github.com/sponsors/sindresorhus" - } - }, - "node_modules/send": { - "version": "0.19.2", - "resolved": "https://registry.npmjs.org/send/-/send-0.19.2.tgz", - "integrity": "sha512-VMbMxbDeehAxpOtWJXlcUS5E8iXh6QmN+BkRX1GARS3wRaXEEgzCcB10gTQazO42tpNIya8xIyNx8fll1OFPrg==", - "dev": true, - "license": "MIT", - "dependencies": { - "debug": "2.6.9", - "depd": "2.0.0", - "destroy": "1.2.0", - "encodeurl": "~2.0.0", - "escape-html": "~1.0.3", - "etag": "~1.8.1", - "fresh": "~0.5.2", - "http-errors": "~2.0.1", - "mime": "1.6.0", - "ms": "2.1.3", - "on-finished": "~2.4.1", - "range-parser": "~1.2.1", - "statuses": "~2.0.2" + "url": "https://opencollective.com/libvips" }, - "engines": { - "node": ">= 0.8.0" + "optionalDependencies": { + "@img/sharp-darwin-arm64": "0.33.5", + "@img/sharp-darwin-x64": "0.33.5", + "@img/sharp-libvips-darwin-arm64": "1.0.4", + "@img/sharp-libvips-darwin-x64": "1.0.4", + "@img/sharp-libvips-linux-arm": "1.0.5", + "@img/sharp-libvips-linux-arm64": "1.0.4", + "@img/sharp-libvips-linux-s390x": "1.0.4", + "@img/sharp-libvips-linux-x64": "1.0.4", + "@img/sharp-libvips-linuxmusl-arm64": "1.0.4", + "@img/sharp-libvips-linuxmusl-x64": "1.0.4", + "@img/sharp-linux-arm": "0.33.5", + "@img/sharp-linux-arm64": "0.33.5", + "@img/sharp-linux-s390x": "0.33.5", + "@img/sharp-linux-x64": "0.33.5", + "@img/sharp-linuxmusl-arm64": "0.33.5", + "@img/sharp-linuxmusl-x64": "0.33.5", + "@img/sharp-wasm32": "0.33.5", + "@img/sharp-win32-ia32": "0.33.5", + "@img/sharp-win32-x64": "0.33.5" } }, - "node_modules/send/node_modules/debug": { - "version": "2.6.9", - "resolved": "https://registry.npmjs.org/debug/-/debug-2.6.9.tgz", - "integrity": "sha512-bC7ElrdJaJnPbAP+1EotYvqZsb3ecl5wi6Bfi6BJTUcNowp6cvspg0jXznRTKDjm/E7AdgFBVeAPVMNcKGsHMA==", - "dev": true, - "license": "MIT", - "dependencies": { - "ms": "2.0.0" - } - }, - "node_modules/send/node_modules/debug/node_modules/ms": { - "version": "2.0.0", - "resolved": "https://registry.npmjs.org/ms/-/ms-2.0.0.tgz", - "integrity": "sha512-Tpp60P6IUJDTuOq/5Z8cdskzJujfwqfOTkrwIwj7IRISpnkJnT6SyJ4PCPnGMoFjC9ddhal5KVIYtAt97ix05A==", - "dev": true, - "license": "MIT" - }, - "node_modules/send/node_modules/range-parser": { - "version": "1.2.1", - "resolved": "https://registry.npmjs.org/range-parser/-/range-parser-1.2.1.tgz", - "integrity": "sha512-Hrgsx+orqoygnmhFbKaHE6c296J+HTAQXoxEF6gNupROmmGJRoyzfG3ccAveqCBrwr/2yxQ5BVd/GTl5agOwSg==", - "dev": true, - "license": "MIT", - "engines": { - "node": ">= 0.6" - } - }, - "node_modules/serialize-javascript": { - "version": "6.0.2", - "resolved": "https://registry.npmjs.org/serialize-javascript/-/serialize-javascript-6.0.2.tgz", - "integrity": "sha512-Saa1xPByTTq2gdeFZYLLo+RFE35NHZkAbqZeWNd3BpzppeVisAqpDjcp8dyf6uIvEqJRd46jemmyA4iFIeVk8g==", - "dev": true, - "license": "BSD-3-Clause", - "dependencies": { - "randombytes": "^2.1.0" - } - }, - "node_modules/serve-handler": { - "version": "6.1.6", - "resolved": "https://registry.npmjs.org/serve-handler/-/serve-handler-6.1.6.tgz", - "integrity": "sha512-x5RL9Y2p5+Sh3D38Fh9i/iQ5ZK+e4xuXRd/pGbM4D13tgo/MGwbttUk8emytcr1YYzBYs+apnUngBDFYfpjPuQ==", - "dev": true, - "license": "MIT", - "dependencies": { - "bytes": "3.0.0", - "content-disposition": "0.5.2", - "mime-types": "2.1.18", - "minimatch": "3.1.2", - "path-is-inside": "1.0.2", - "path-to-regexp": "3.3.0", - "range-parser": "1.2.0" - } - }, - "node_modules/serve-handler/node_modules/path-to-regexp": { - "version": "3.3.0", - "resolved": "https://registry.npmjs.org/path-to-regexp/-/path-to-regexp-3.3.0.tgz", - "integrity": "sha512-qyCH421YQPS2WFDxDjftfc1ZR5WKQzVzqsp4n9M2kQhVOo/ByahFoUNJfl58kOcEGfQ//7weFTDhm+ss8Ecxgw==", - "dev": true, - "license": "MIT" - }, - "node_modules/serve-index": { - "version": "1.9.1", - "resolved": "https://registry.npmjs.org/serve-index/-/serve-index-1.9.1.tgz", - "integrity": "sha512-pXHfKNP4qujrtteMrSBb0rc8HJ9Ms/GrXwcUtUtD5s4ewDJI8bT3Cz2zTVRMKtri49pLx2e0Ya8ziP5Ya2pZZw==", - "dev": true, - "license": "MIT", - "dependencies": { - "accepts": "~1.3.4", - "batch": "0.6.1", - "debug": "2.6.9", - "escape-html": "~1.0.3", - "http-errors": "~1.6.2", - "mime-types": "~2.1.17", - "parseurl": "~1.3.2" - }, - "engines": { - "node": ">= 0.8.0" - } - }, - "node_modules/serve-index/node_modules/debug": { - "version": "2.6.9", - "resolved": "https://registry.npmjs.org/debug/-/debug-2.6.9.tgz", - "integrity": "sha512-bC7ElrdJaJnPbAP+1EotYvqZsb3ecl5wi6Bfi6BJTUcNowp6cvspg0jXznRTKDjm/E7AdgFBVeAPVMNcKGsHMA==", - "dev": true, - "license": "MIT", - "dependencies": { - "ms": "2.0.0" - } - }, - "node_modules/serve-index/node_modules/depd": { - "version": "1.1.2", - "resolved": "https://registry.npmjs.org/depd/-/depd-1.1.2.tgz", - "integrity": "sha512-7emPTl6Dpo6JRXOXjLRxck+FlLRX5847cLKEn00PLAgc3g2hTZZgr+e4c2v6QpSmLeFP3n5yUo7ft6avBK/5jQ==", - "dev": true, - "license": "MIT", - "engines": { - "node": ">= 0.6" - } - }, - "node_modules/serve-index/node_modules/http-errors": { - "version": "1.6.3", - "resolved": "https://registry.npmjs.org/http-errors/-/http-errors-1.6.3.tgz", - "integrity": "sha512-lks+lVC8dgGyh97jxvxeYTWQFvh4uw4yC12gVl63Cg30sjPX4wuGcdkICVXDAESr6OJGjqGA8Iz5mkeN6zlD7A==", - "dev": true, - "license": "MIT", - "dependencies": { - "depd": "~1.1.2", - "inherits": "2.0.3", - "setprototypeof": "1.1.0", - "statuses": ">= 1.4.0 < 2" - }, - "engines": { - "node": ">= 0.6" - } - }, - "node_modules/serve-index/node_modules/inherits": { - "version": "2.0.3", - "resolved": "https://registry.npmjs.org/inherits/-/inherits-2.0.3.tgz", - "integrity": "sha512-x00IRNXNy63jwGkJmzPigoySHbaqpNuzKbBOmzK+g2OdZpQ9w+sxCN+VSB3ja7IAge2OP2qpfxTjeNcyjmW1uw==", - "dev": true, - "license": "ISC" - }, - "node_modules/serve-index/node_modules/ms": { - "version": "2.0.0", - "resolved": "https://registry.npmjs.org/ms/-/ms-2.0.0.tgz", - "integrity": "sha512-Tpp60P6IUJDTuOq/5Z8cdskzJujfwqfOTkrwIwj7IRISpnkJnT6SyJ4PCPnGMoFjC9ddhal5KVIYtAt97ix05A==", - "dev": true, - "license": "MIT" - }, - "node_modules/serve-index/node_modules/setprototypeof": { - "version": "1.1.0", - "resolved": "https://registry.npmjs.org/setprototypeof/-/setprototypeof-1.1.0.tgz", - "integrity": "sha512-BvE/TwpZX4FXExxOxZyRGQQv651MSwmWKZGqvmPcRIjDqWub67kTKuIMx43cZZrS/cBBzwBcNDWoFxt2XEFIpQ==", - "dev": true, - "license": "ISC" - }, - "node_modules/serve-index/node_modules/statuses": { - "version": "1.5.0", - "resolved": "https://registry.npmjs.org/statuses/-/statuses-1.5.0.tgz", - "integrity": "sha512-OpZ3zP+jT1PI7I8nemJX4AKmAX070ZkYPVWV/AaKTJl+tXCTGyVdC1a4SL8RUQYEwk/f34ZX8UTykN68FwrqAA==", - "dev": true, - "license": "MIT", - "engines": { - "node": ">= 0.6" - } - }, - "node_modules/serve-static": { - "version": "1.16.3", - "resolved": "https://registry.npmjs.org/serve-static/-/serve-static-1.16.3.tgz", - "integrity": "sha512-x0RTqQel6g5SY7Lg6ZreMmsOzncHFU7nhnRWkKgWuMTu5NN0DR5oruckMqRvacAN9d5w6ARnRBXl9xhDCgfMeA==", - "dev": true, - "license": "MIT", - "dependencies": { - "encodeurl": "~2.0.0", - "escape-html": "~1.0.3", - "parseurl": "~1.3.3", - "send": "~0.19.1" - }, - "engines": { - "node": ">= 0.8.0" - } - }, - "node_modules/set-function-length": { - "version": "1.2.2", - "resolved": "https://registry.npmjs.org/set-function-length/-/set-function-length-1.2.2.tgz", - "integrity": "sha512-pgRc4hJ4/sNjWCSS9AmnS40x3bNMDTknHgL5UaMBTMyJnU90EgWh1Rz+MC9eFu4BuN/UwZjKQuY/1v3rM7HMfg==", - "dev": true, - "license": "MIT", - "dependencies": { - "define-data-property": "^1.1.4", - "es-errors": "^1.3.0", - "function-bind": "^1.1.2", - "get-intrinsic": "^1.2.4", - "gopd": "^1.0.1", - "has-property-descriptors": "^1.0.2" - }, - "engines": { - "node": ">= 0.4" - } - }, - "node_modules/setprototypeof": { - "version": "1.2.0", - "resolved": "https://registry.npmjs.org/setprototypeof/-/setprototypeof-1.2.0.tgz", - "integrity": "sha512-E5LDX7Wrp85Kil5bhZv46j8jOeboKq5JMmYM3gVGdGH8xFpPWXUMsNrlODCrkoxMEeNi/XZIwuRvY4XNwYMJpw==", - "dev": true, - "license": "ISC" - }, - "node_modules/shallow-clone": { - "version": "3.0.1", - "resolved": "https://registry.npmjs.org/shallow-clone/-/shallow-clone-3.0.1.tgz", - "integrity": "sha512-/6KqX+GVUdqPuPPd2LxDDxzX6CAbjJehAAOKlNpqqUpAqPM6HeL8f+o3a+JsyGjn2lv0WY8UsTgUJjU9Ok55NA==", - "dev": true, - "license": "MIT", - "dependencies": { - "kind-of": "^6.0.2" - }, - "engines": { - "node": ">=8" - } - }, - "node_modules/shallowequal": { - "version": "1.1.0", - "resolved": "https://registry.npmjs.org/shallowequal/-/shallowequal-1.1.0.tgz", - "integrity": "sha512-y0m1JoUZSlPAjXVtPPW70aZWfIL/dSP7AFkRnniLCrK/8MDKog3TySTBmckD+RObVxH0v4Tox67+F14PdED2oQ==", - "dev": true, - "license": "MIT" - }, "node_modules/shebang-command": { "version": "2.0.0", "resolved": "https://registry.npmjs.org/shebang-command/-/shebang-command-2.0.0.tgz", @@ -21949,93 +13348,21 @@ "node": ">=8" } }, - "node_modules/shell-quote": { - "version": "1.8.3", - "resolved": "https://registry.npmjs.org/shell-quote/-/shell-quote-1.8.3.tgz", - "integrity": "sha512-ObmnIF4hXNg1BqhnHmgbDETF8dLPCggZWBjkQfhZpbszZnYur5DUljTcCHii5LC3J5E0yeO/1LIMyH+UvHQgyw==", - "dev": true, - "license": "MIT", - "engines": { - "node": ">= 0.4" - }, - "funding": { - "url": "https://github.com/sponsors/ljharb" - } - }, - "node_modules/side-channel": { - "version": "1.1.0", - "resolved": "https://registry.npmjs.org/side-channel/-/side-channel-1.1.0.tgz", - "integrity": "sha512-ZX99e6tRweoUXqR+VBrslhda51Nh5MTQwou5tnUDgbtyM0dBgmhEDtWGP/xbKn6hqfPRHujUNwz5fy/wbbhnpw==", + "node_modules/shiki": { + "version": "3.20.0", + "resolved": "https://registry.npmjs.org/shiki/-/shiki-3.20.0.tgz", + "integrity": "sha512-kgCOlsnyWb+p0WU+01RjkCH+eBVsjL1jOwUYWv0YDWkM2/A46+LDKVs5yZCUXjJG6bj4ndFoAg5iLIIue6dulg==", "dev": true, "license": "MIT", "dependencies": { - "es-errors": "^1.3.0", - "object-inspect": "^1.13.3", - "side-channel-list": "^1.0.0", - "side-channel-map": "^1.0.1", - "side-channel-weakmap": "^1.0.2" - }, - "engines": { - "node": ">= 0.4" - }, - "funding": { - "url": "https://github.com/sponsors/ljharb" - } - }, - "node_modules/side-channel-list": { - "version": "1.0.0", - "resolved": "https://registry.npmjs.org/side-channel-list/-/side-channel-list-1.0.0.tgz", - "integrity": "sha512-FCLHtRD/gnpCiCHEiJLOwdmFP+wzCmDEkc9y7NsYxeF4u7Btsn1ZuwgwJGxImImHicJArLP4R0yX4c2KCrMrTA==", - "dev": true, - "license": "MIT", - "dependencies": { - "es-errors": "^1.3.0", - "object-inspect": "^1.13.3" - }, - "engines": { - "node": ">= 0.4" - }, - "funding": { - "url": "https://github.com/sponsors/ljharb" - } - }, - "node_modules/side-channel-map": { - "version": "1.0.1", - "resolved": "https://registry.npmjs.org/side-channel-map/-/side-channel-map-1.0.1.tgz", - "integrity": "sha512-VCjCNfgMsby3tTdo02nbjtM/ewra6jPHmpThenkTYh8pG9ucZ/1P8So4u4FGBek/BjpOVsDCMoLA/iuBKIFXRA==", - "dev": true, - "license": "MIT", - "dependencies": { - "call-bound": "^1.0.2", - "es-errors": "^1.3.0", - "get-intrinsic": "^1.2.5", - "object-inspect": "^1.13.3" - }, - "engines": { - "node": ">= 0.4" - }, - "funding": { - "url": "https://github.com/sponsors/ljharb" - } - }, - "node_modules/side-channel-weakmap": { - "version": "1.0.2", - "resolved": "https://registry.npmjs.org/side-channel-weakmap/-/side-channel-weakmap-1.0.2.tgz", - "integrity": "sha512-WPS/HvHQTYnHisLo9McqBHOJk2FkHO/tlpvldyrnem4aeQp4hai3gythswg6p01oSoTl58rcpiFAjF2br2Ak2A==", - "dev": true, - "license": "MIT", - "dependencies": { - "call-bound": "^1.0.2", - "es-errors": "^1.3.0", - "get-intrinsic": "^1.2.5", - "object-inspect": "^1.13.3", - "side-channel-map": "^1.0.1" - }, - "engines": { - "node": ">= 0.4" - }, - "funding": { - "url": "https://github.com/sponsors/ljharb" + "@shikijs/core": "3.20.0", + "@shikijs/engine-javascript": "3.20.0", + "@shikijs/engine-oniguruma": "3.20.0", + "@shikijs/langs": "3.20.0", + "@shikijs/themes": "3.20.0", + "@shikijs/types": "3.20.0", + "@shikijs/vscode-textmate": "^10.0.2", + "@types/hast": "^3.0.4" } }, "node_modules/signal-exit": { @@ -22050,21 +13377,23 @@ "url": "https://github.com/sponsors/isaacs" } }, - "node_modules/sirv": { - "version": "2.0.4", - "resolved": "https://registry.npmjs.org/sirv/-/sirv-2.0.4.tgz", - "integrity": "sha512-94Bdh3cC2PKrbgSOUqTiGPWVZeSiXfKOVZNJniWoqrWrRkB1CJzBU3NEbiTsPcYy1lDsANA/THzS+9WBiy5nfQ==", + "node_modules/simple-swizzle": { + "version": "0.2.4", + "resolved": "https://registry.npmjs.org/simple-swizzle/-/simple-swizzle-0.2.4.tgz", + "integrity": "sha512-nAu1WFPQSMNr2Zn9PGSZK9AGn4t/y97lEm+MXTtUDwfP0ksAIX4nO+6ruD9Jwut4C49SB1Ws+fbXsm/yScWOHw==", "dev": true, "license": "MIT", "dependencies": { - "@polka/url": "^1.0.0-next.24", - "mrmime": "^2.0.0", - "totalist": "^3.0.0" - }, - "engines": { - "node": ">= 10" + "is-arrayish": "^0.3.1" } }, + "node_modules/simple-swizzle/node_modules/is-arrayish": { + "version": "0.3.4", + "resolved": "https://registry.npmjs.org/is-arrayish/-/is-arrayish-0.3.4.tgz", + "integrity": "sha512-m6UrgzFVUYawGBh1dUsWR5M2Clqic9RVXC/9f8ceNlv2IcO9j9J/z8UoCLPqtsPBFNzEpfR3xftohbfqDx8EQA==", + "dev": true, + "license": "MIT" + }, "node_modules/sisteransi": { "version": "1.0.5", "resolved": "https://registry.npmjs.org/sisteransi/-/sisteransi-1.0.5.tgz", @@ -22073,23 +13402,23 @@ "license": "MIT" }, "node_modules/sitemap": { - "version": "7.1.2", - "resolved": "https://registry.npmjs.org/sitemap/-/sitemap-7.1.2.tgz", - "integrity": "sha512-ARCqzHJ0p4gWt+j7NlU5eDlIO9+Rkr/JhPFZKKQ1l5GCus7rJH4UdrlVAh0xC/gDS/Qir2UMxqYNHtsKr2rpCw==", + "version": "8.0.2", + "resolved": "https://registry.npmjs.org/sitemap/-/sitemap-8.0.2.tgz", + "integrity": "sha512-LwktpJcyZDoa0IL6KT++lQ53pbSrx2c9ge41/SeLTyqy2XUNA6uR4+P9u5IVo5lPeL2arAcOKn1aZAxoYbCKlQ==", "dev": true, "license": "MIT", "dependencies": { "@types/node": "^17.0.5", "@types/sax": "^1.2.1", "arg": "^5.0.0", - "sax": "^1.2.4" + "sax": "^1.4.1" }, "bin": { "sitemap": "dist/cli.js" }, "engines": { - "node": ">=12.0.0", - "npm": ">=5.6.0" + "node": ">=14.0.0", + "npm": ">=6.0.0" } }, "node_modules/sitemap/node_modules/@types/node": { @@ -22099,19 +13428,6 @@ "dev": true, "license": "MIT" }, - "node_modules/skin-tone": { - "version": "2.0.0", - "resolved": "https://registry.npmjs.org/skin-tone/-/skin-tone-2.0.0.tgz", - "integrity": "sha512-kUMbT1oBJCpgrnKoSr0o6wPtvRWT9W9UKvGLwfJYO2WuahZRHOpEyL1ckyMGgMWh0UdpmaoFqKKD29WTomNEGA==", - "dev": true, - "license": "MIT", - "dependencies": { - "unicode-emoji-modifier-base": "^1.0.0" - }, - "engines": { - "node": ">=8" - } - }, "node_modules/slash": { "version": "3.0.0", "resolved": "https://registry.npmjs.org/slash/-/slash-3.0.0.tgz", @@ -22123,26 +13439,26 @@ } }, "node_modules/slice-ansi": { - "version": "5.0.0", - "resolved": "https://registry.npmjs.org/slice-ansi/-/slice-ansi-5.0.0.tgz", - "integrity": "sha512-FC+lgizVPfie0kkhqUScwRu1O/lF6NOgJmlCgK+/LYxDCTk8sGelYaHDhFcDN+Sn3Cv+3VSa4Byeo+IMCzpMgQ==", + "version": "7.1.2", + "resolved": "https://registry.npmjs.org/slice-ansi/-/slice-ansi-7.1.2.tgz", + "integrity": "sha512-iOBWFgUX7caIZiuutICxVgX1SdxwAVFFKwt1EvMYYec/NWO5meOJ6K5uQxhrYBdQJne4KxiqZc+KptFOWFSI9w==", "dev": true, "license": "MIT", "dependencies": { - "ansi-styles": "^6.0.0", - "is-fullwidth-code-point": "^4.0.0" + "ansi-styles": "^6.2.1", + "is-fullwidth-code-point": "^5.0.0" }, "engines": { - "node": ">=12" + "node": ">=18" }, "funding": { "url": "https://github.com/chalk/slice-ansi?sponsor=1" } }, "node_modules/slice-ansi/node_modules/ansi-styles": { - "version": "6.2.1", - "resolved": "https://registry.npmjs.org/ansi-styles/-/ansi-styles-6.2.1.tgz", - "integrity": "sha512-bN798gFfQX+viw3R7yrGWRqnrN2oRkEkUjjl4JNn4E8GxxbjtG3FbrEIIY3l8/hrwUwIeCZvi4QuOTP4MErVug==", + "version": "6.2.3", + "resolved": "https://registry.npmjs.org/ansi-styles/-/ansi-styles-6.2.3.tgz", + "integrity": "sha512-4Dj6M28JB+oAH8kFkTLUo+a2jwOFkuqb3yucU0CANcRRUbxS0cP0nZYCGjcc3BNXwRIsUVmDGgzawme7zvJHvg==", "dev": true, "license": "MIT", "engines": { @@ -22152,50 +13468,30 @@ "url": "https://github.com/chalk/ansi-styles?sponsor=1" } }, - "node_modules/snake-case": { - "version": "3.0.4", - "resolved": "https://registry.npmjs.org/snake-case/-/snake-case-3.0.4.tgz", - "integrity": "sha512-LAOh4z89bGQvl9pFfNF8V146i7o7/CqFPbqzYgP+yYzDIDeS9HaNFtXABamRW+AQzEVODcvE79ljJ+8a9YSdMg==", + "node_modules/smol-toml": { + "version": "1.6.0", + "resolved": "https://registry.npmjs.org/smol-toml/-/smol-toml-1.6.0.tgz", + "integrity": "sha512-4zemZi0HvTnYwLfrpk/CF9LOd9Lt87kAt50GnqhMpyF9U3poDAP2+iukq2bZsO/ufegbYehBkqINbsWxj4l4cw==", "dev": true, - "license": "MIT", - "dependencies": { - "dot-case": "^3.0.4", - "tslib": "^2.0.3" - } - }, - "node_modules/sockjs": { - "version": "0.3.24", - "resolved": "https://registry.npmjs.org/sockjs/-/sockjs-0.3.24.tgz", - "integrity": "sha512-GJgLTZ7vYb/JtPSSZ10hsOYIvEYsjbNU+zPdIHcUaWVNUEPivzxku31865sSSud0Da0W4lEeOPlmw93zLQchuQ==", - "dev": true, - "license": "MIT", - "dependencies": { - "faye-websocket": "^0.11.3", - "uuid": "^8.3.2", - "websocket-driver": "^0.7.4" - } - }, - "node_modules/sort-css-media-queries": { - "version": "2.2.0", - "resolved": "https://registry.npmjs.org/sort-css-media-queries/-/sort-css-media-queries-2.2.0.tgz", - "integrity": "sha512-0xtkGhWCC9MGt/EzgnvbbbKhqWjl1+/rncmhTh5qCpbYguXh6S/qwePfv/JQ8jePXXmqingylxoC49pCkSPIbA==", - "dev": true, - "license": "MIT", + "license": "BSD-3-Clause", "engines": { - "node": ">= 6.3.0" + "node": ">= 18" + }, + "funding": { + "url": "https://github.com/sponsors/cyyynthia" } }, "node_modules/sort-object-keys": { - "version": "1.1.3", - "resolved": "https://registry.npmjs.org/sort-object-keys/-/sort-object-keys-1.1.3.tgz", - "integrity": "sha512-855pvK+VkU7PaKYPc+Jjnmt4EzejQHyhhF33q31qG8x7maDzkeFhAAThdCYay11CISO+qAMwjOBP+fPZe0IPyg==", + "version": "2.0.1", + "resolved": "https://registry.npmjs.org/sort-object-keys/-/sort-object-keys-2.0.1.tgz", + "integrity": "sha512-R89fO+z3x7hiKPXX5P0qim+ge6Y60AjtlW+QQpRozrrNcR1lw9Pkpm5MLB56HoNvdcLHL4wbpq16OcvGpEDJIg==", "dev": true, "license": "MIT" }, "node_modules/sort-package-json": { - "version": "3.4.0", - "resolved": "https://registry.npmjs.org/sort-package-json/-/sort-package-json-3.4.0.tgz", - "integrity": "sha512-97oFRRMM2/Js4oEA9LJhjyMlde+2ewpZQf53pgue27UkbEXfHJnDzHlUxQ/DWUkzqmp7DFwJp8D+wi/TYeQhpA==", + "version": "3.5.0", + "resolved": "https://registry.npmjs.org/sort-package-json/-/sort-package-json-3.5.0.tgz", + "integrity": "sha512-moY4UtptUuP5sPuu9H9dp8xHNel7eP5/Kz/7+90jTvC0IOiPH2LigtRM/aSFSxreaWoToHUVUpEV4a2tAs2oKQ==", "dev": true, "license": "MIT", "dependencies": { @@ -22204,7 +13500,7 @@ "git-hooks-list": "^4.0.0", "is-plain-obj": "^4.1.0", "semver": "^7.7.1", - "sort-object-keys": "^1.1.3", + "sort-object-keys": "^2.0.0", "tinyglobby": "^0.2.12" }, "bin": { @@ -22228,13 +13524,13 @@ } }, "node_modules/source-map": { - "version": "0.6.1", - "resolved": "https://registry.npmjs.org/source-map/-/source-map-0.6.1.tgz", - "integrity": "sha512-UjgapumWlbMhkBgzT7Ykc5YXUT46F0iKu8SGXq0bcwP5dz/h0Plj6enJqjz1Zbq2l5WaqYnrVbwWOWMyF3F47g==", + "version": "0.7.6", + "resolved": "https://registry.npmjs.org/source-map/-/source-map-0.7.6.tgz", + "integrity": "sha512-i5uvt8C3ikiWeNZSVZNWcfZPItFQOsYTUAOkcUPGd8DqDy1uOUikjt5dG+uRlwyvR108Fb9DOd4GvXfT0N2/uQ==", "dev": true, "license": "BSD-3-Clause", "engines": { - "node": ">=0.10.0" + "node": ">= 12" } }, "node_modules/source-map-js": { @@ -22258,6 +13554,16 @@ "source-map": "^0.6.0" } }, + "node_modules/source-map-support/node_modules/source-map": { + "version": "0.6.1", + "resolved": "https://registry.npmjs.org/source-map/-/source-map-0.6.1.tgz", + "integrity": "sha512-UjgapumWlbMhkBgzT7Ykc5YXUT46F0iKu8SGXq0bcwP5dz/h0Plj6enJqjz1Zbq2l5WaqYnrVbwWOWMyF3F47g==", + "dev": true, + "license": "BSD-3-Clause", + "engines": { + "node": ">=0.10.0" + } + }, "node_modules/space-separated-tokens": { "version": "2.0.2", "resolved": "https://registry.npmjs.org/space-separated-tokens/-/space-separated-tokens-2.0.2.tgz", @@ -22269,38 +13575,6 @@ "url": "https://github.com/sponsors/wooorm" } }, - "node_modules/spdy": { - "version": "4.0.2", - "resolved": "https://registry.npmjs.org/spdy/-/spdy-4.0.2.tgz", - "integrity": "sha512-r46gZQZQV+Kl9oItvl1JZZqJKGr+oEkB08A6BzkiR7593/7IbtuncXHd2YoYeTsG4157ZssMu9KYvUHLcjcDoA==", - "dev": true, - "license": "MIT", - "dependencies": { - "debug": "^4.1.0", - "handle-thing": "^2.0.0", - "http-deceiver": "^1.2.7", - "select-hose": "^2.0.0", - "spdy-transport": "^3.0.0" - }, - "engines": { - "node": ">=6.0.0" - } - }, - "node_modules/spdy-transport": { - "version": "3.0.0", - "resolved": "https://registry.npmjs.org/spdy-transport/-/spdy-transport-3.0.0.tgz", - "integrity": "sha512-hsLVFE5SjA6TCisWeJXFKniGGOpBgMLmerfO2aCyCU5s7nJ/rpAepqmFifv/GCbSbueEeAJJnmSQ2rKC/g8Fcw==", - "dev": true, - "license": "MIT", - "dependencies": { - "debug": "^4.1.0", - "detect-node": "^2.0.4", - "hpack.js": "^2.1.6", - "obuf": "^1.1.2", - "readable-stream": "^3.0.6", - "wbuf": "^1.7.3" - } - }, "node_modules/sprintf-js": { "version": "1.0.3", "resolved": "https://registry.npmjs.org/sprintf-js/-/sprintf-js-1.0.3.tgz", @@ -22308,19 +13582,6 @@ "dev": true, "license": "BSD-3-Clause" }, - "node_modules/srcset": { - "version": "4.0.0", - "resolved": "https://registry.npmjs.org/srcset/-/srcset-4.0.0.tgz", - "integrity": "sha512-wvLeHgcVHKO8Sc/H/5lkGreJQVeYMm9rlmt8PuR1xE31rIuXhuzznUUqAt8MqLhB3MqJdFzlNAfpcWnxiFUcPw==", - "dev": true, - "license": "MIT", - "engines": { - "node": ">=12" - }, - "funding": { - "url": "https://github.com/sponsors/sindresorhus" - } - }, "node_modules/stack-utils": { "version": "2.0.6", "resolved": "https://registry.npmjs.org/stack-utils/-/stack-utils-2.0.6.tgz", @@ -22344,20 +13605,10 @@ "node": ">=8" } }, - "node_modules/statuses": { - "version": "2.0.2", - "resolved": "https://registry.npmjs.org/statuses/-/statuses-2.0.2.tgz", - "integrity": "sha512-DvEy55V3DB7uknRo+4iOGT5fP1slR8wQohVdknigZPMpMstaKJQWhwiYBACJE3Ul2pTnATihhBYnRhZQHGBiRw==", - "dev": true, - "license": "MIT", - "engines": { - "node": ">= 0.8" - } - }, - "node_modules/std-env": { - "version": "3.10.0", - "resolved": "https://registry.npmjs.org/std-env/-/std-env-3.10.0.tgz", - "integrity": "sha512-5GS12FdOZNliM5mAOxFRg7Ir0pWz8MdpYm6AY6VPkGpbA7ZzmbzNcBJQ0GPvvyWgcY7QAhCgf9Uy89I03faLkg==", + "node_modules/stream-replace-string": { + "version": "2.0.0", + "resolved": "https://registry.npmjs.org/stream-replace-string/-/stream-replace-string-2.0.0.tgz", + "integrity": "sha512-TlnjJ1C0QrmxRNrON00JvaFFlNh5TTG00APw23j74ET7gkQpTASi6/L2fuiav8pzK715HXtUeClpBTw2NPSn6w==", "dev": true, "license": "MIT" }, @@ -22468,21 +13719,6 @@ "url": "https://github.com/sponsors/wooorm" } }, - "node_modules/stringify-object": { - "version": "3.3.0", - "resolved": "https://registry.npmjs.org/stringify-object/-/stringify-object-3.3.0.tgz", - "integrity": "sha512-rHqiFh1elqCQ9WPLIC8I0Q/g/wj5J1eMkyoiD6eoQApWHP0FtlK7rqnhmabL5VUY9JQCcqwwvlOaSuutekgyrw==", - "dev": true, - "license": "BSD-2-Clause", - "dependencies": { - "get-own-enumerable-property-symbols": "^3.0.0", - "is-obj": "^1.0.1", - "is-regexp": "^1.0.0" - }, - "engines": { - "node": ">=4" - } - }, "node_modules/strip-ansi": { "version": "6.0.1", "resolved": "https://registry.npmjs.org/strip-ansi/-/strip-ansi-6.0.1.tgz", @@ -22518,16 +13754,6 @@ "node": ">=8" } }, - "node_modules/strip-bom-string": { - "version": "1.0.0", - "resolved": "https://registry.npmjs.org/strip-bom-string/-/strip-bom-string-1.0.0.tgz", - "integrity": "sha512-uCC2VHvQRYu+lMh4My/sFNmF2klFymLX1wHJeXnbEJERpV/ZsVuonzerjfrGpIGF7LBVa1O7i9kjiWvJiFck8g==", - "dev": true, - "license": "MIT", - "engines": { - "node": ">=0.10.0" - } - }, "node_modules/strip-final-newline": { "version": "2.0.0", "resolved": "https://registry.npmjs.org/strip-final-newline/-/strip-final-newline-2.0.0.tgz", @@ -22539,14 +13765,11 @@ } }, "node_modules/strip-indent": { - "version": "4.0.0", - "resolved": "https://registry.npmjs.org/strip-indent/-/strip-indent-4.0.0.tgz", - "integrity": "sha512-mnVSV2l+Zv6BLpSD/8V87CW/y9EmmbYzGCIavsnsI6/nwn26DwffM/yztm30Z/I2DY9wdS3vXVCMnHDgZaVNoA==", + "version": "4.1.1", + "resolved": "https://registry.npmjs.org/strip-indent/-/strip-indent-4.1.1.tgz", + "integrity": "sha512-SlyRoSkdh1dYP0PzclLE7r0M9sgbFKKMFXpFRUMNuKhQSbC6VQIGzq3E0qsfvGJaUFJPGv6Ws1NZ/haTAjfbMA==", "dev": true, "license": "MIT", - "dependencies": { - "min-indent": "^1.0.1" - }, "engines": { "node": ">=12" }, @@ -22587,23 +13810,6 @@ "inline-style-parser": "0.2.7" } }, - "node_modules/stylehacks": { - "version": "6.1.1", - "resolved": "https://registry.npmjs.org/stylehacks/-/stylehacks-6.1.1.tgz", - "integrity": "sha512-gSTTEQ670cJNoaeIp9KX6lZmm8LJ3jPB5yJmX8Zq/wQxOsAFXV3qjWzHas3YYk1qesuVIyYWWUpZ0vSE/dTSGg==", - "dev": true, - "license": "MIT", - "dependencies": { - "browserslist": "^4.23.0", - "postcss-selector-parser": "^6.0.16" - }, - "engines": { - "node": "^14 || ^16 || >=18.0" - }, - "peerDependencies": { - "postcss": "^8.4.31" - } - }, "node_modules/supports-color": { "version": "7.2.0", "resolved": "https://registry.npmjs.org/supports-color/-/supports-color-7.2.0.tgz", @@ -22616,46 +13822,26 @@ "node": ">=8" } }, - "node_modules/supports-preserve-symlinks-flag": { - "version": "1.0.0", - "resolved": "https://registry.npmjs.org/supports-preserve-symlinks-flag/-/supports-preserve-symlinks-flag-1.0.0.tgz", - "integrity": "sha512-ot0WnXS9fgdkgIcePe6RHNk1WA8+muPa6cSjeR3V8K27q9BB1rTE3R1p7Hv0z1ZyAc8s6Vvv8DIyWf681MAt0w==", - "dev": true, - "license": "MIT", - "engines": { - "node": ">= 0.4" - }, - "funding": { - "url": "https://github.com/sponsors/ljharb" - } - }, - "node_modules/svg-parser": { - "version": "2.0.4", - "resolved": "https://registry.npmjs.org/svg-parser/-/svg-parser-2.0.4.tgz", - "integrity": "sha512-e4hG1hRwoOdRb37cIMSgzNsxyzKfayW6VOflrwvR+/bzrkyxY/31WkbgnQpgtrNp1SdpJvpUAGTa/ZoiPNDuRQ==", - "dev": true, - "license": "MIT" - }, "node_modules/svgo": { - "version": "3.3.2", - "resolved": "https://registry.npmjs.org/svgo/-/svgo-3.3.2.tgz", - "integrity": "sha512-OoohrmuUlBs8B8o6MB2Aevn+pRIH9zDALSR+6hhqVfa6fRwG/Qw9VUMSMW9VNg2CFc/MTIfabtdOVl9ODIJjpw==", + "version": "4.0.0", + "resolved": "https://registry.npmjs.org/svgo/-/svgo-4.0.0.tgz", + "integrity": "sha512-VvrHQ+9uniE+Mvx3+C9IEe/lWasXCU0nXMY2kZeLrHNICuRiC8uMPyM14UEaMOFA5mhyQqEkB02VoQ16n3DLaw==", "dev": true, "license": "MIT", "dependencies": { - "@trysound/sax": "0.2.0", - "commander": "^7.2.0", + "commander": "^11.1.0", "css-select": "^5.1.0", - "css-tree": "^2.3.1", + "css-tree": "^3.0.1", "css-what": "^6.1.0", "csso": "^5.0.5", - "picocolors": "^1.0.0" + "picocolors": "^1.1.1", + "sax": "^1.4.1" }, "bin": { - "svgo": "bin/svgo" + "svgo": "bin/svgo.js" }, "engines": { - "node": ">=14.0.0" + "node": ">=16" }, "funding": { "type": "opencollective", @@ -22663,27 +13849,13 @@ } }, "node_modules/svgo/node_modules/commander": { - "version": "7.2.0", - "resolved": "https://registry.npmjs.org/commander/-/commander-7.2.0.tgz", - "integrity": "sha512-QrWXB+ZQSVPmIWIhtEO9H+gwHaMGYiF5ChvoJ+K9ZGHG/sVsa6yiesAD1GC/x46sET00Xlwo1u49RVVVzvcSkw==", + "version": "11.1.0", + "resolved": "https://registry.npmjs.org/commander/-/commander-11.1.0.tgz", + "integrity": "sha512-yPVavfyCcRhmorC7rWlkHn15b4wDVgVmBA7kV4QVBsF7kv/9TKJAbAXVTxvTnwP8HHKjRCJDClKbciiYS7p0DQ==", "dev": true, "license": "MIT", "engines": { - "node": ">= 10" - } - }, - "node_modules/swr": { - "version": "2.3.8", - "resolved": "https://registry.npmjs.org/swr/-/swr-2.3.8.tgz", - "integrity": "sha512-gaCPRVoMq8WGDcWj9p4YWzCMPHzE0WNl6W8ADIx9c3JBEIdMkJGMzW+uzXvxHMltwcYACr9jP+32H8/hgwMR7w==", - "dev": true, - "license": "MIT", - "dependencies": { - "dequal": "^2.0.3", - "use-sync-external-store": "^1.6.0" - }, - "peerDependencies": { - "react": "^16.11.0 || ^17.0.0 || ^18.0.0 || ^19.0.0" + "node": ">=16" } }, "node_modules/synckit": { @@ -22728,156 +13900,103 @@ "streamx": "^2.15.0" } }, - "node_modules/tar-stream/node_modules/b4a": { - "version": "1.7.3", - "resolved": "https://registry.npmjs.org/b4a/-/b4a-1.7.3.tgz", - "integrity": "sha512-5Q2mfq2WfGuFp3uS//0s6baOJLMoVduPYVeNmDYxu5OUA1/cBfvr2RIS7vi62LdNj/urk1hfmj867I3qt6uZ7Q==", - "dev": true, - "license": "Apache-2.0", - "peerDependencies": { - "react-native-b4a": "*" - }, - "peerDependenciesMeta": { - "react-native-b4a": { - "optional": true - } - } - }, - "node_modules/terser": { - "version": "5.44.1", - "resolved": "https://registry.npmjs.org/terser/-/terser-5.44.1.tgz", - "integrity": "sha512-t/R3R/n0MSwnnazuPpPNVO60LX0SKL45pyl9YlvxIdkH0Of7D5qM2EVe+yASRIlY5pZ73nclYJfNANGWPwFDZw==", - "dev": true, - "license": "BSD-2-Clause", - "dependencies": { - "@jridgewell/source-map": "^0.3.3", - "acorn": "^8.15.0", - "commander": "^2.20.0", - "source-map-support": "~0.5.20" - }, - "bin": { - "terser": "bin/terser" - }, - "engines": { - "node": ">=10" - } - }, - "node_modules/terser-webpack-plugin": { - "version": "5.3.16", - "resolved": "https://registry.npmjs.org/terser-webpack-plugin/-/terser-webpack-plugin-5.3.16.tgz", - "integrity": "sha512-h9oBFCWrq78NyWWVcSwZarJkZ01c2AyGrzs1crmHZO3QUg9D61Wu4NPjBy69n7JqylFF5y+CsUZYmYEIZ3mR+Q==", - "dev": true, - "license": "MIT", - "dependencies": { - "@jridgewell/trace-mapping": "^0.3.25", - "jest-worker": "^27.4.5", - "schema-utils": "^4.3.0", - "serialize-javascript": "^6.0.2", - "terser": "^5.31.1" - }, - "engines": { - "node": ">= 10.13.0" - }, - "funding": { - "type": "opencollective", - "url": "https://opencollective.com/webpack" - }, - "peerDependencies": { - "webpack": "^5.1.0" - }, - "peerDependenciesMeta": { - "@swc/core": { - "optional": true - }, - "esbuild": { - "optional": true - }, - "uglify-js": { - "optional": true - } - } - }, - "node_modules/terser-webpack-plugin/node_modules/jest-worker": { - "version": "27.5.1", - "resolved": "https://registry.npmjs.org/jest-worker/-/jest-worker-27.5.1.tgz", - "integrity": "sha512-7vuh85V5cdDofPyxn58nrPjBktZo0u9x1g8WtjQol+jZDaE+fhN+cIvTj11GndBnMnyfrUOG1sZQxCdjKh+DKg==", - "dev": true, - "license": "MIT", - "dependencies": { - "@types/node": "*", - "merge-stream": "^2.0.0", - "supports-color": "^8.0.0" - }, - "engines": { - "node": ">= 10.13.0" - } - }, - "node_modules/terser-webpack-plugin/node_modules/supports-color": { - "version": "8.1.1", - "resolved": "https://registry.npmjs.org/supports-color/-/supports-color-8.1.1.tgz", - "integrity": "sha512-MpUEN2OodtUzxvKQl72cUF7RQ5EiHsGvSsVG0ia9c5RbWGL2CI4C7EpPS8UTBIplnlzZiNuV56w+FuNxy3ty2Q==", - "dev": true, - "license": "MIT", - "dependencies": { - "has-flag": "^4.0.0" - }, - "engines": { - "node": ">=10" - }, - "funding": { - "url": "https://github.com/chalk/supports-color?sponsor=1" - } - }, - "node_modules/terser/node_modules/commander": { - "version": "2.20.3", - "resolved": "https://registry.npmjs.org/commander/-/commander-2.20.3.tgz", - "integrity": "sha512-GpVkmM8vF2vQUkj2LvZmD35JxeJOLCwJ9cUkugyk2nuhbv3+mJvpLYYt+0+USMxE+oj+ey/lJEnhZw75x/OMcQ==", - "dev": true, - "license": "MIT" - }, - "node_modules/terser/node_modules/source-map-support": { - "version": "0.5.21", - "resolved": "https://registry.npmjs.org/source-map-support/-/source-map-support-0.5.21.tgz", - "integrity": "sha512-uBHU3L3czsIyYXKX88fdrGovxdSCoTGDRZ6SYXtSRxLZUzHg5P/66Ht6uoUlHu9EZod+inXhKo3qQgwXUT/y1w==", - "dev": true, - "license": "MIT", - "dependencies": { - "buffer-from": "^1.0.0", - "source-map": "^0.6.0" - } - }, "node_modules/test-exclude": { - "version": "6.0.0", - "resolved": "https://registry.npmjs.org/test-exclude/-/test-exclude-6.0.0.tgz", - "integrity": "sha512-cAGWPIyOHU6zlmg88jwm7VRyXnMN7iV68OGAbYDk/Mh/xC/pzVPlQtY6ngoIH/5/tciuhGfvESU8GrHrcxD56w==", + "version": "7.0.1", + "resolved": "https://registry.npmjs.org/test-exclude/-/test-exclude-7.0.1.tgz", + "integrity": "sha512-pFYqmTw68LXVjeWJMST4+borgQP2AyMNbg1BpZh9LbyhUeNkeaPF9gzfPGUAnSMV3qPYdWUwDIjjCLiSDOl7vg==", "dev": true, "license": "ISC", "dependencies": { "@istanbuljs/schema": "^0.1.2", - "glob": "^7.1.4", - "minimatch": "^3.0.4" + "glob": "^10.4.1", + "minimatch": "^9.0.4" }, "engines": { - "node": ">=8" + "node": ">=18" + } + }, + "node_modules/test-exclude/node_modules/brace-expansion": { + "version": "2.0.2", + "resolved": "https://registry.npmjs.org/brace-expansion/-/brace-expansion-2.0.2.tgz", + "integrity": "sha512-Jt0vHyM+jmUBqojB7E1NIYadt0vI0Qxjxd2TErW94wDz+E2LAm5vKMXXwg6ZZBTHPuUlDgQHKXvjGBdfcF1ZDQ==", + "dev": true, + "license": "MIT", + "dependencies": { + "balanced-match": "^1.0.0" } }, "node_modules/test-exclude/node_modules/glob": { - "version": "7.2.3", - "resolved": "https://registry.npmjs.org/glob/-/glob-7.2.3.tgz", - "integrity": "sha512-nFR0zLpU2YCaRxwoCJvL6UvCH2JFyFVIvwTLsIf21AuHlMskA1hhTdk+LlYJtOlYt9v6dvszD2BGRqBL+iQK9Q==", - "deprecated": "Glob versions prior to v9 are no longer supported", + "version": "10.5.0", + "resolved": "https://registry.npmjs.org/glob/-/glob-10.5.0.tgz", + "integrity": "sha512-DfXN8DfhJ7NH3Oe7cFmu3NCu1wKbkReJ8TorzSAFbSKrlNaQSKfIzqYqVY8zlbs2NLBbWpRiU52GX2PbaBVNkg==", "dev": true, "license": "ISC", "dependencies": { - "fs.realpath": "^1.0.0", - "inflight": "^1.0.4", - "inherits": "2", - "minimatch": "^3.1.1", - "once": "^1.3.0", - "path-is-absolute": "^1.0.0" + "foreground-child": "^3.1.0", + "jackspeak": "^3.1.2", + "minimatch": "^9.0.4", + "minipass": "^7.1.2", + "package-json-from-dist": "^1.0.0", + "path-scurry": "^1.11.1" + }, + "bin": { + "glob": "dist/esm/bin.mjs" + }, + "funding": { + "url": "https://github.com/sponsors/isaacs" + } + }, + "node_modules/test-exclude/node_modules/jackspeak": { + "version": "3.4.3", + "resolved": "https://registry.npmjs.org/jackspeak/-/jackspeak-3.4.3.tgz", + "integrity": "sha512-OGlZQpz2yfahA/Rd1Y8Cd9SIEsqvXkLVoSw/cgwhnhFMDbsQFeZYoJJ7bIZBS9BcamUW96asq/npPWugM+RQBw==", + "dev": true, + "license": "BlueOak-1.0.0", + "dependencies": { + "@isaacs/cliui": "^8.0.2" + }, + "funding": { + "url": "https://github.com/sponsors/isaacs" + }, + "optionalDependencies": { + "@pkgjs/parseargs": "^0.11.0" + } + }, + "node_modules/test-exclude/node_modules/lru-cache": { + "version": "10.4.3", + "resolved": "https://registry.npmjs.org/lru-cache/-/lru-cache-10.4.3.tgz", + "integrity": "sha512-JNAzZcXrCt42VGLuYz0zfAzDfAvJWW6AfYlDBQyDV5DClI2m5sAmK+OIO7s59XfsRsWHp02jAJrRadPRGTt6SQ==", + "dev": true, + "license": "ISC" + }, + "node_modules/test-exclude/node_modules/minimatch": { + "version": "9.0.5", + "resolved": "https://registry.npmjs.org/minimatch/-/minimatch-9.0.5.tgz", + "integrity": "sha512-G6T0ZX48xgozx7587koeX9Ys2NYy6Gmv//P89sEte9V9whIapMNF4idKxnW2QtCcLiTWlb/wfCabAtAFWhhBow==", + "dev": true, + "license": "ISC", + "dependencies": { + "brace-expansion": "^2.0.1" }, "engines": { - "node": "*" + "node": ">=16 || 14 >=14.17" + }, + "funding": { + "url": "https://github.com/sponsors/isaacs" + } + }, + "node_modules/test-exclude/node_modules/path-scurry": { + "version": "1.11.1", + "resolved": "https://registry.npmjs.org/path-scurry/-/path-scurry-1.11.1.tgz", + "integrity": "sha512-Xa4Nw17FS9ApQFJ9umLiJS4orGjm7ZzwUrwamcGQuHSzDyth9boKDaycYdDcZDuqYATXw4HFXgaqWTctW/v1HA==", + "dev": true, + "license": "BlueOak-1.0.0", + "dependencies": { + "lru-cache": "^10.2.0", + "minipass": "^5.0.0 || ^6.0.2 || ^7.0.0" + }, + "engines": { + "node": ">=16 || 14 >=14.18" }, "funding": { "url": "https://github.com/sponsors/isaacs" @@ -22893,87 +14012,32 @@ "b4a": "^1.6.4" } }, - "node_modules/text-decoder/node_modules/b4a": { - "version": "1.7.3", - "resolved": "https://registry.npmjs.org/b4a/-/b4a-1.7.3.tgz", - "integrity": "sha512-5Q2mfq2WfGuFp3uS//0s6baOJLMoVduPYVeNmDYxu5OUA1/cBfvr2RIS7vi62LdNj/urk1hfmj867I3qt6uZ7Q==", + "node_modules/tiny-inflate": { + "version": "1.0.3", + "resolved": "https://registry.npmjs.org/tiny-inflate/-/tiny-inflate-1.0.3.tgz", + "integrity": "sha512-pkY1fj1cKHb2seWDy0B16HeWyczlJA9/WW3u3c4z/NiWDsO3DOU5D7nhTLE9CF0yXv/QZFY7sEJmj24dK+Rrqw==", "dev": true, - "license": "Apache-2.0", - "peerDependencies": { - "react-native-b4a": "*" - }, - "peerDependenciesMeta": { - "react-native-b4a": { - "optional": true - } - } + "license": "MIT" }, - "node_modules/thingies": { - "version": "2.5.0", - "resolved": "https://registry.npmjs.org/thingies/-/thingies-2.5.0.tgz", - "integrity": "sha512-s+2Bwztg6PhWUD7XMfeYm5qliDdSiZm7M7n8KjTkIsm3l/2lgVRc2/Gx/v+ZX8lT4FMA+i8aQvhcWylldc+ZNw==", - "dev": true, - "license": "MIT", - "engines": { - "node": ">=10.18" - }, - "funding": { - "type": "github", - "url": "https://github.com/sponsors/streamich" - }, - "peerDependencies": { - "tslib": "^2" - } - }, - "node_modules/throttleit": { - "version": "2.1.0", - "resolved": "https://registry.npmjs.org/throttleit/-/throttleit-2.1.0.tgz", - "integrity": "sha512-nt6AMGKW1p/70DF/hGBdJB57B8Tspmbp5gfJ8ilhLnt7kkr2ye7hzD6NVG8GGErk2HWF34igrL2CXmNIkzKqKw==", + "node_modules/tinyexec": { + "version": "1.0.2", + "resolved": "https://registry.npmjs.org/tinyexec/-/tinyexec-1.0.2.tgz", + "integrity": "sha512-W/KYk+NFhkmsYpuHq5JykngiOCnxeVL8v8dFnqxSD8qEEdRfXk1SDM6JzNqcERbcGYj9tMrDQBYV9cjgnunFIg==", "dev": true, "license": "MIT", "engines": { "node": ">=18" - }, - "funding": { - "url": "https://github.com/sponsors/sindresorhus" } }, - "node_modules/through": { - "version": "2.3.8", - "resolved": "https://registry.npmjs.org/through/-/through-2.3.8.tgz", - "integrity": "sha512-w89qg7PI8wAdvX60bMDP+bFoD5Dvhm9oLheFp5O4a2QF0cSBGsBX4qZmadPMvVqlLJBBci+WqGGOAPvcDeNSVg==", - "license": "MIT" - }, - "node_modules/thunky": { - "version": "1.1.0", - "resolved": "https://registry.npmjs.org/thunky/-/thunky-1.1.0.tgz", - "integrity": "sha512-eHY7nBftgThBqOyHGVN+l8gF0BucP09fMo0oO/Lb0w1OF80dJv+lDVpXG60WMQvkcxAkNybKsrEIE3ZtKGmPrA==", - "dev": true, - "license": "MIT" - }, - "node_modules/tiny-invariant": { - "version": "1.3.3", - "resolved": "https://registry.npmjs.org/tiny-invariant/-/tiny-invariant-1.3.3.tgz", - "integrity": "sha512-+FbBPE1o9QAYvviau/qC5SE3caw21q3xkvWKBtja5vgqOWIHHJ3ioaq1VPfn/Szqctz2bU/oYeKd9/z5BL+PVg==", - "dev": true, - "license": "MIT" - }, - "node_modules/tiny-warning": { - "version": "1.0.3", - "resolved": "https://registry.npmjs.org/tiny-warning/-/tiny-warning-1.0.3.tgz", - "integrity": "sha512-lBN9zLN/oAf68o3zNXYrdCt1kP8WsiGW8Oo2ka41b2IM5JL/S1CTyX1rW0mb/zSuJun0ZUrDxx4sqvYS2FWzPA==", - "dev": true, - "license": "MIT" - }, "node_modules/tinyglobby": { - "version": "0.2.14", - "resolved": "https://registry.npmjs.org/tinyglobby/-/tinyglobby-0.2.14.tgz", - "integrity": "sha512-tX5e7OM1HnYr2+a2C/4V0htOcSQcoSTH9KgJnVvNm5zm/cyEWKJ7j7YutsH9CxMdtOkkLFy2AHrMci9IM8IPZQ==", + "version": "0.2.15", + "resolved": "https://registry.npmjs.org/tinyglobby/-/tinyglobby-0.2.15.tgz", + "integrity": "sha512-j2Zq4NyQYG5XMST4cbs02Ak8iJUdxRM0XI5QyxXuZOzKOINmWurp3smXu3y5wDcJrptwpSjgXHzIQxR0omXljQ==", "dev": true, "license": "MIT", "dependencies": { - "fdir": "^6.4.4", - "picomatch": "^4.0.2" + "fdir": "^6.5.0", + "picomatch": "^4.0.3" }, "engines": { "node": ">=12.0.0" @@ -22982,48 +14046,6 @@ "url": "https://github.com/sponsors/SuperchupuDev" } }, - "node_modules/tinyglobby/node_modules/fdir": { - "version": "6.5.0", - "resolved": "https://registry.npmjs.org/fdir/-/fdir-6.5.0.tgz", - "integrity": "sha512-tIbYtZbucOs0BRGqPJkshJUYdL+SDH7dVM8gjy+ERp3WAUjLEFJE+02kanyHtwjWOnwrKYBiwAmM0p4kLJAnXg==", - "dev": true, - "license": "MIT", - "engines": { - "node": ">=12.0.0" - }, - "peerDependencies": { - "picomatch": "^3 || ^4" - }, - "peerDependenciesMeta": { - "picomatch": { - "optional": true - } - } - }, - "node_modules/tinyglobby/node_modules/picomatch": { - "version": "4.0.3", - "resolved": "https://registry.npmjs.org/picomatch/-/picomatch-4.0.3.tgz", - "integrity": "sha512-5gTmgEY/sqK6gFXLIsQNH19lWb4ebPDLA4SdLP7dsWkIXHWlG66oPuVvXSGFPppYZz8ZDZq0dYYrbHfBCVUb1Q==", - "dev": true, - "license": "MIT", - "peer": true, - "engines": { - "node": ">=12" - }, - "funding": { - "url": "https://github.com/sponsors/jonschlinkert" - } - }, - "node_modules/tinypool": { - "version": "1.1.1", - "resolved": "https://registry.npmjs.org/tinypool/-/tinypool-1.1.1.tgz", - "integrity": "sha512-Zba82s87IFq9A9XmjiX5uZA/ARWDrB03OHlq+Vw1fSdt0I+4/Kutwy8BP4Y/y/aORMo61FQ0vIb5j44vSo5Pkg==", - "dev": true, - "license": "MIT", - "engines": { - "node": "^18.0.0 || >=20.0.0" - } - }, "node_modules/tmpl": { "version": "1.0.5", "resolved": "https://registry.npmjs.org/tmpl/-/tmpl-1.0.5.tgz", @@ -23044,43 +14066,6 @@ "node": ">=8.0" } }, - "node_modules/toidentifier": { - "version": "1.0.1", - "resolved": "https://registry.npmjs.org/toidentifier/-/toidentifier-1.0.1.tgz", - "integrity": "sha512-o5sSPKEkg/DIQNmH43V0/uerLrpzVedkUh8tGNvaeXpfpuwjKenlSox/2O/BTlZUtEe+JG7s5YhEz608PlAHRA==", - "dev": true, - "license": "MIT", - "engines": { - "node": ">=0.6" - } - }, - "node_modules/totalist": { - "version": "3.0.1", - "resolved": "https://registry.npmjs.org/totalist/-/totalist-3.0.1.tgz", - "integrity": "sha512-sf4i37nQ2LBx4m3wB74y+ubopq6W/dIzXg0FDGjsYnZHVa1Da8FH853wlL2gtUhg+xJXjfk3kUZS3BRoQeoQBQ==", - "dev": true, - "license": "MIT", - "engines": { - "node": ">=6" - } - }, - "node_modules/tree-dump": { - "version": "1.1.0", - "resolved": "https://registry.npmjs.org/tree-dump/-/tree-dump-1.1.0.tgz", - "integrity": "sha512-rMuvhU4MCDbcbnleZTFezWsaZXRFemSqAM+7jPnzUl1fo9w3YEKOxAeui0fz3OI4EU4hf23iyA7uQRVko+UaBA==", - "dev": true, - "license": "Apache-2.0", - "engines": { - "node": ">=10.0" - }, - "funding": { - "type": "github", - "url": "https://github.com/sponsors/streamich" - }, - "peerDependencies": { - "tslib": "2" - } - }, "node_modules/trim-lines": { "version": "3.0.1", "resolved": "https://registry.npmjs.org/trim-lines/-/trim-lines-3.0.1.tgz", @@ -23125,25 +14110,33 @@ "typescript": ">=4.0.0" } }, - "node_modules/ts-declaration-location/node_modules/picomatch": { - "version": "4.0.3", - "resolved": "https://registry.npmjs.org/picomatch/-/picomatch-4.0.3.tgz", - "integrity": "sha512-5gTmgEY/sqK6gFXLIsQNH19lWb4ebPDLA4SdLP7dsWkIXHWlG66oPuVvXSGFPppYZz8ZDZq0dYYrbHfBCVUb1Q==", + "node_modules/tsconfck": { + "version": "3.1.6", + "resolved": "https://registry.npmjs.org/tsconfck/-/tsconfck-3.1.6.tgz", + "integrity": "sha512-ks6Vjr/jEw0P1gmOVwutM3B7fWxoWBL2KRDb1JfqGVawBmO5UsvmWOQFGHBPl5yxYz4eERr19E6L7NMv+Fej4w==", "dev": true, "license": "MIT", - "engines": { - "node": ">=12" + "bin": { + "tsconfck": "bin/tsconfck.js" }, - "funding": { - "url": "https://github.com/sponsors/jonschlinkert" + "engines": { + "node": "^18 || >=20" + }, + "peerDependencies": { + "typescript": "^5.0.0" + }, + "peerDependenciesMeta": { + "typescript": { + "optional": true + } } }, "node_modules/tslib": { "version": "2.8.1", "resolved": "https://registry.npmjs.org/tslib/-/tslib-2.8.1.tgz", "integrity": "sha512-oJFu94HQb+KVduSUQL7wnpmqnfmLsOA/nAh6b6EH0wCEoK0/mPeXU6c3wKDV83MkOuHPRHtSXKKU99IBazS/2w==", - "license": "0BSD", - "peer": true + "dev": true, + "license": "0BSD" }, "node_modules/type-check": { "version": "0.4.0", @@ -23169,9 +14162,9 @@ } }, "node_modules/type-fest": { - "version": "0.21.3", - "resolved": "https://registry.npmjs.org/type-fest/-/type-fest-0.21.3.tgz", - "integrity": "sha512-t0rzBq87m3fVcduHDUFhKmyyX+9eo6WQjZvf51Ea/M0Q7+T374Jp1aUiyUl0GKxp8M/OETVHSDvmkyPgvX+X2w==", + "version": "0.20.2", + "resolved": "https://registry.npmjs.org/type-fest/-/type-fest-0.20.2.tgz", + "integrity": "sha512-Ne+eE4r0/iWnpAxD852z3A+N0Bt5RN//NjJwRd2VFHEmrywxf5vsZlh4R6lixl6B+wz/8d+maTSAkN1FIkI3LQ==", "license": "(MIT OR CC0-1.0)", "engines": { "node": ">=10" @@ -23180,57 +14173,10 @@ "url": "https://github.com/sponsors/sindresorhus" } }, - "node_modules/type-is": { - "version": "1.6.18", - "resolved": "https://registry.npmjs.org/type-is/-/type-is-1.6.18.tgz", - "integrity": "sha512-TkRKr9sUTxEH8MdfuCSP7VizJyzRNMjj2J2do2Jr3Kym598JVdEksuzPQCnlFPW4ky9Q+iA+ma9BGm06XQBy8g==", - "dev": true, - "license": "MIT", - "dependencies": { - "media-typer": "0.3.0", - "mime-types": "~2.1.24" - }, - "engines": { - "node": ">= 0.6" - } - }, - "node_modules/type-is/node_modules/mime-db": { - "version": "1.52.0", - "resolved": "https://registry.npmjs.org/mime-db/-/mime-db-1.52.0.tgz", - "integrity": "sha512-sPU4uV7dYlvtWJxwwxHD0PuihVNiE7TyAbQ5SWxDCB9mUYvOgroQOwYQQOKPJ8CIbE+1ETVlOoK1UC2nU3gYvg==", - "dev": true, - "license": "MIT", - "engines": { - "node": ">= 0.6" - } - }, - "node_modules/type-is/node_modules/mime-types": { - "version": "2.1.35", - "resolved": "https://registry.npmjs.org/mime-types/-/mime-types-2.1.35.tgz", - "integrity": "sha512-ZDY+bPm5zTTF+YpCrAU9nK0UgICYPT0QtT1NZWFv4s++TNkcgVaT0g6+4R2uI4MjQjzysHB1zxuWL50hzaeXiw==", - "dev": true, - "license": "MIT", - "dependencies": { - "mime-db": "1.52.0" - }, - "engines": { - "node": ">= 0.6" - } - }, - "node_modules/typedarray-to-buffer": { - "version": "3.1.5", - "resolved": "https://registry.npmjs.org/typedarray-to-buffer/-/typedarray-to-buffer-3.1.5.tgz", - "integrity": "sha512-zdu8XMNEDepKKR+XYOXAVPtWui0ly0NtohUscw+UmaHiAWT8hrV1rr//H6V+0DvJ3OQ19S979M0laLfX8rm82Q==", - "dev": true, - "license": "MIT", - "dependencies": { - "is-typedarray": "^1.0.0" - } - }, "node_modules/typescript": { - "version": "5.9.2", - "resolved": "https://registry.npmjs.org/typescript/-/typescript-5.9.2.tgz", - "integrity": "sha512-CWBzXQrc/qOkhidw1OzBTQuYRbfyxDXJMVJ1XNwUHGROVmuaeiEm3OslpZ1RV96d7SKKjZKrSJu3+t/xlw3R9A==", + "version": "5.9.3", + "resolved": "https://registry.npmjs.org/typescript/-/typescript-5.9.3.tgz", + "integrity": "sha512-jl1vZzPDinLr9eUt3J/t7V6FgNEw9QjvBPdysz9KfQDD41fQrC2Y4vKQdiaUpFT4bXlb1RHhLpp8wtm6M5TgSw==", "dev": true, "license": "Apache-2.0", "peer": true, @@ -23249,65 +14195,54 @@ "dev": true, "license": "MIT" }, - "node_modules/undici-types": { - "version": "7.10.0", - "resolved": "https://registry.npmjs.org/undici-types/-/undici-types-7.10.0.tgz", - "integrity": "sha512-t5Fy/nfn+14LuOc2KNYg75vZqClpAiqscVvMygNnlsHBFpSXdJaYtXMcdNLpl/Qvc3P2cB3s6lOV51nqsFq4ag==", - "devOptional": true, + "node_modules/ufo": { + "version": "1.6.1", + "resolved": "https://registry.npmjs.org/ufo/-/ufo-1.6.1.tgz", + "integrity": "sha512-9a4/uxlTWJ4+a5i0ooc1rU7C7YOw3wT+UGqdeNNHWnOF9qcMBgLRS+4IYUqbczewFx4mLEig6gawh7X6mFlEkA==", + "dev": true, "license": "MIT" }, - "node_modules/unicode-canonical-property-names-ecmascript": { - "version": "2.0.1", - "resolved": "https://registry.npmjs.org/unicode-canonical-property-names-ecmascript/-/unicode-canonical-property-names-ecmascript-2.0.1.tgz", - "integrity": "sha512-dA8WbNeb2a6oQzAQ55YlT5vQAWGV9WXOsi3SskE3bcCdM0P4SDd+24zS/OCacdRq5BkdsRj9q3Pg6YyQoxIGqg==", + "node_modules/ultrahtml": { + "version": "1.6.0", + "resolved": "https://registry.npmjs.org/ultrahtml/-/ultrahtml-1.6.0.tgz", + "integrity": "sha512-R9fBn90VTJrqqLDwyMph+HGne8eqY1iPfYhPzZrvKpIfwkWZbcYlfpsb8B9dTvBfpy1/hqAD7Wi8EKfP9e8zdw==", "dev": true, - "license": "MIT", - "engines": { - "node": ">=4" - } + "license": "MIT" }, - "node_modules/unicode-emoji-modifier-base": { - "version": "1.0.0", - "resolved": "https://registry.npmjs.org/unicode-emoji-modifier-base/-/unicode-emoji-modifier-base-1.0.0.tgz", - "integrity": "sha512-yLSH4py7oFH3oG/9K+XWrz1pSi3dfUrWEnInbxMfArOfc1+33BlGPQtLsOYwvdMy11AwUBetYuaRxSPqgkq+8g==", + "node_modules/uncrypto": { + "version": "0.1.3", + "resolved": "https://registry.npmjs.org/uncrypto/-/uncrypto-0.1.3.tgz", + "integrity": "sha512-Ql87qFHB3s/De2ClA9e0gsnS6zXG27SkTiSJwjCc9MebbfapQfuPzumMIUMi38ezPZVNFcHI9sUIepeQfw8J8Q==", "dev": true, - "license": "MIT", - "engines": { - "node": ">=4" - } + "license": "MIT" }, - "node_modules/unicode-match-property-ecmascript": { - "version": "2.0.0", - "resolved": "https://registry.npmjs.org/unicode-match-property-ecmascript/-/unicode-match-property-ecmascript-2.0.0.tgz", - "integrity": "sha512-5kaZCrbp5mmbz5ulBkDkbY0SsPOjKqVS35VpL9ulMPfSl0J0Xsm+9Evphv9CoIZFwre7aJoa94AY6seMKGVN5Q==", + "node_modules/undici-types": { + "version": "7.16.0", + "resolved": "https://registry.npmjs.org/undici-types/-/undici-types-7.16.0.tgz", + "integrity": "sha512-Zz+aZWSj8LE6zoxD+xrjh4VfkIG8Ya6LvYkZqtUQGJPZjYl53ypCaUwWqo7eI0x66KBGeRo+mlBEkMSeSZ38Nw==", + "dev": true, + "license": "MIT" + }, + "node_modules/unicode-properties": { + "version": "1.4.1", + "resolved": "https://registry.npmjs.org/unicode-properties/-/unicode-properties-1.4.1.tgz", + "integrity": "sha512-CLjCCLQ6UuMxWnbIylkisbRj31qxHPAurvena/0iwSVbQ2G1VY5/HjV0IRabOEbDHlzZlRdCrD4NhB0JtU40Pg==", "dev": true, "license": "MIT", "dependencies": { - "unicode-canonical-property-names-ecmascript": "^2.0.0", - "unicode-property-aliases-ecmascript": "^2.0.0" - }, - "engines": { - "node": ">=4" + "base64-js": "^1.3.0", + "unicode-trie": "^2.0.0" } }, - "node_modules/unicode-match-property-value-ecmascript": { - "version": "2.2.1", - "resolved": "https://registry.npmjs.org/unicode-match-property-value-ecmascript/-/unicode-match-property-value-ecmascript-2.2.1.tgz", - "integrity": "sha512-JQ84qTuMg4nVkx8ga4A16a1epI9H6uTXAknqxkGF/aFfRLw1xC/Bp24HNLaZhHSkWd3+84t8iXnp1J0kYcZHhg==", + "node_modules/unicode-trie": { + "version": "2.0.0", + "resolved": "https://registry.npmjs.org/unicode-trie/-/unicode-trie-2.0.0.tgz", + "integrity": "sha512-x7bc76x0bm4prf1VLg79uhAzKw8DVboClSN5VxJuQ+LKDOVEW9CdH+VY7SP+vX7xCYQqzzgQpFqz15zeLvAtZQ==", "dev": true, "license": "MIT", - "engines": { - "node": ">=4" - } - }, - "node_modules/unicode-property-aliases-ecmascript": { - "version": "2.2.0", - "resolved": "https://registry.npmjs.org/unicode-property-aliases-ecmascript/-/unicode-property-aliases-ecmascript-2.2.0.tgz", - "integrity": "sha512-hpbDzxUY9BFwX+UeBnxv3Sh1q7HFxj48DTmXchNgRa46lO8uj3/1iEn3MiNUYTg1g9ctIqXCCERn8gYZhHC5lQ==", - "dev": true, - "license": "MIT", - "engines": { - "node": ">=4" + "dependencies": { + "pako": "^0.2.5", + "tiny-inflate": "^1.0.0" } }, "node_modules/unicorn-magic": { @@ -23342,20 +14277,16 @@ "url": "https://opencollective.com/unified" } }, - "node_modules/unique-string": { - "version": "3.0.0", - "resolved": "https://registry.npmjs.org/unique-string/-/unique-string-3.0.0.tgz", - "integrity": "sha512-VGXBUVwxKMBUznyffQweQABPRRW1vHZAbadFZud4pLFAqRGvv/96vafgjWFqzourzr8YonlQiPgH0YCJfawoGQ==", + "node_modules/unifont": { + "version": "0.6.0", + "resolved": "https://registry.npmjs.org/unifont/-/unifont-0.6.0.tgz", + "integrity": "sha512-5Fx50fFQMQL5aeHyWnZX9122sSLckcDvcfFiBf3QYeHa7a1MKJooUy52b67moi2MJYkrfo/TWY+CoLdr/w0tTA==", "dev": true, "license": "MIT", "dependencies": { - "crypto-random-string": "^4.0.0" - }, - "engines": { - "node": ">=12" - }, - "funding": { - "url": "https://github.com/sponsors/sindresorhus" + "css-tree": "^3.0.0", + "ofetch": "^1.4.1", + "ohash": "^2.0.0" } }, "node_modules/unist-util-find": { @@ -23373,10 +14304,25 @@ "url": "https://opencollective.com/unified" } }, + "node_modules/unist-util-find-after": { + "version": "5.0.0", + "resolved": "https://registry.npmjs.org/unist-util-find-after/-/unist-util-find-after-5.0.0.tgz", + "integrity": "sha512-amQa0Ep2m6hE2g72AugUItjbuM8X8cGQnFoHk0pGfrFeT9GZhzN5SW8nRsiGKK7Aif4CrACPENkA6P/Lw6fHGQ==", + "dev": true, + "license": "MIT", + "dependencies": { + "@types/unist": "^3.0.0", + "unist-util-is": "^6.0.0" + }, + "funding": { + "type": "opencollective", + "url": "https://opencollective.com/unified" + } + }, "node_modules/unist-util-is": { - "version": "6.0.0", - "resolved": "https://registry.npmjs.org/unist-util-is/-/unist-util-is-6.0.0.tgz", - "integrity": "sha512-2qCTHimwdxLfz+YzdGfkqNlH0tLi9xjTnHddPmJwtIG9MGsdbutfTc4P+haPD7l7Cjxf/WZj+we5qfVPvvxfYw==", + "version": "6.0.1", + "resolved": "https://registry.npmjs.org/unist-util-is/-/unist-util-is-6.0.1.tgz", + "integrity": "sha512-LsiILbtBETkDz8I9p1dQ0uyRUWuaQzd/cuEeS1hoRSyW5E5XGmTzlwY1OrNzzakGowI9Dr/I8HVaw4hTtnxy8g==", "license": "MIT", "dependencies": { "@types/unist": "^3.0.0" @@ -23386,6 +14332,21 @@ "url": "https://opencollective.com/unified" } }, + "node_modules/unist-util-modify-children": { + "version": "4.0.0", + "resolved": "https://registry.npmjs.org/unist-util-modify-children/-/unist-util-modify-children-4.0.0.tgz", + "integrity": "sha512-+tdN5fGNddvsQdIzUF3Xx82CU9sMM+fA0dLgR9vOmT0oPT2jH+P1nd5lSqfCfXAw+93NhcXNY2qqvTUtE4cQkw==", + "dev": true, + "license": "MIT", + "dependencies": { + "@types/unist": "^3.0.0", + "array-iterate": "^2.0.0" + }, + "funding": { + "type": "opencollective", + "url": "https://opencollective.com/unified" + } + }, "node_modules/unist-util-position": { "version": "5.0.0", "resolved": "https://registry.npmjs.org/unist-util-position/-/unist-util-position-5.0.0.tgz", @@ -23414,6 +14375,21 @@ "url": "https://opencollective.com/unified" } }, + "node_modules/unist-util-remove-position": { + "version": "5.0.0", + "resolved": "https://registry.npmjs.org/unist-util-remove-position/-/unist-util-remove-position-5.0.0.tgz", + "integrity": "sha512-Hp5Kh3wLxv0PHj9m2yZhhLt58KzPtEYKQQ4yxfYFEO7EvHwzyDYnduhHnY1mDxoqr7VUwVuHXk9RXKIiYS1N8Q==", + "dev": true, + "license": "MIT", + "dependencies": { + "@types/unist": "^3.0.0", + "unist-util-visit": "^5.0.0" + }, + "funding": { + "type": "opencollective", + "url": "https://opencollective.com/unified" + } + }, "node_modules/unist-util-select": { "version": "5.1.0", "resolved": "https://registry.npmjs.org/unist-util-select/-/unist-util-select-5.1.0.tgz", @@ -23459,10 +14435,24 @@ "url": "https://opencollective.com/unified" } }, + "node_modules/unist-util-visit-children": { + "version": "3.0.0", + "resolved": "https://registry.npmjs.org/unist-util-visit-children/-/unist-util-visit-children-3.0.0.tgz", + "integrity": "sha512-RgmdTfSBOg04sdPcpTSD1jzoNBjt9a80/ZCzp5cI9n1qPzLZWF9YdvWGN2zmTumP1HWhXKdUWexjy/Wy/lJ7tA==", + "dev": true, + "license": "MIT", + "dependencies": { + "@types/unist": "^3.0.0" + }, + "funding": { + "type": "opencollective", + "url": "https://opencollective.com/unified" + } + }, "node_modules/unist-util-visit-parents": { - "version": "6.0.1", - "resolved": "https://registry.npmjs.org/unist-util-visit-parents/-/unist-util-visit-parents-6.0.1.tgz", - "integrity": "sha512-L/PqWzfTP9lzzEa6CKs0k2nARxTdZduw3zyh8d2NVBnsyvHjSX4TWse388YrrQKbvI8w20fGjGlhgT96WwKykw==", + "version": "6.0.2", + "resolved": "https://registry.npmjs.org/unist-util-visit-parents/-/unist-util-visit-parents-6.0.2.tgz", + "integrity": "sha512-goh1s1TBrqSqukSc8wrjwWhL0hiJxgA8m4kFxGlQ+8FYQ3C/m11FcTs4YYem7V664AhHVvgoQLk890Ssdsr2IQ==", "license": "MIT", "dependencies": { "@types/unist": "^3.0.0", @@ -23482,16 +14472,6 @@ "node": ">= 10.0.0" } }, - "node_modules/unpipe": { - "version": "1.0.0", - "resolved": "https://registry.npmjs.org/unpipe/-/unpipe-1.0.0.tgz", - "integrity": "sha512-pjy2bYhSsufwWlKwPc+l3cN7+wuJlK6uz0YdJEOlQDbl6jo/YlPi4mb8agUkVC8BF7V8NuzeyPNqRksA3hztKQ==", - "dev": true, - "license": "MIT", - "engines": { - "node": ">= 0.8" - } - }, "node_modules/unrs-resolver": { "version": "1.11.1", "resolved": "https://registry.npmjs.org/unrs-resolver/-/unrs-resolver-1.11.1.tgz", @@ -23527,6 +14507,110 @@ "@unrs/resolver-binding-win32-x64-msvc": "1.11.1" } }, + "node_modules/unstorage": { + "version": "1.17.3", + "resolved": "https://registry.npmjs.org/unstorage/-/unstorage-1.17.3.tgz", + "integrity": "sha512-i+JYyy0DoKmQ3FximTHbGadmIYb8JEpq7lxUjnjeB702bCPum0vzo6oy5Mfu0lpqISw7hCyMW2yj4nWC8bqJ3Q==", + "dev": true, + "license": "MIT", + "dependencies": { + "anymatch": "^3.1.3", + "chokidar": "^4.0.3", + "destr": "^2.0.5", + "h3": "^1.15.4", + "lru-cache": "^10.4.3", + "node-fetch-native": "^1.6.7", + "ofetch": "^1.5.1", + "ufo": "^1.6.1" + }, + "peerDependencies": { + "@azure/app-configuration": "^1.8.0", + "@azure/cosmos": "^4.2.0", + "@azure/data-tables": "^13.3.0", + "@azure/identity": "^4.6.0", + "@azure/keyvault-secrets": "^4.9.0", + "@azure/storage-blob": "^12.26.0", + "@capacitor/preferences": "^6.0.3 || ^7.0.0", + "@deno/kv": ">=0.9.0", + "@netlify/blobs": "^6.5.0 || ^7.0.0 || ^8.1.0 || ^9.0.0 || ^10.0.0", + "@planetscale/database": "^1.19.0", + "@upstash/redis": "^1.34.3", + "@vercel/blob": ">=0.27.1", + "@vercel/functions": "^2.2.12 || ^3.0.0", + "@vercel/kv": "^1.0.1", + "aws4fetch": "^1.0.20", + "db0": ">=0.2.1", + "idb-keyval": "^6.2.1", + "ioredis": "^5.4.2", + "uploadthing": "^7.4.4" + }, + "peerDependenciesMeta": { + "@azure/app-configuration": { + "optional": true + }, + "@azure/cosmos": { + "optional": true + }, + "@azure/data-tables": { + "optional": true + }, + "@azure/identity": { + "optional": true + }, + "@azure/keyvault-secrets": { + "optional": true + }, + "@azure/storage-blob": { + "optional": true + }, + "@capacitor/preferences": { + "optional": true + }, + "@deno/kv": { + "optional": true + }, + "@netlify/blobs": { + "optional": true + }, + "@planetscale/database": { + "optional": true + }, + "@upstash/redis": { + "optional": true + }, + "@vercel/blob": { + "optional": true + }, + "@vercel/functions": { + "optional": true + }, + "@vercel/kv": { + "optional": true + }, + "aws4fetch": { + "optional": true + }, + "db0": { + "optional": true + }, + "idb-keyval": { + "optional": true + }, + "ioredis": { + "optional": true + }, + "uploadthing": { + "optional": true + } + } + }, + "node_modules/unstorage/node_modules/lru-cache": { + "version": "10.4.3", + "resolved": "https://registry.npmjs.org/lru-cache/-/lru-cache-10.4.3.tgz", + "integrity": "sha512-JNAzZcXrCt42VGLuYz0zfAzDfAvJWW6AfYlDBQyDV5DClI2m5sAmK+OIO7s59XfsRsWHp02jAJrRadPRGTt6SQ==", + "dev": true, + "license": "ISC" + }, "node_modules/update-browserslist-db": { "version": "1.2.3", "resolved": "https://registry.npmjs.org/update-browserslist-db/-/update-browserslist-db-1.2.3.tgz", @@ -23558,211 +14642,6 @@ "browserslist": ">= 4.21.0" } }, - "node_modules/update-notifier": { - "version": "6.0.2", - "resolved": "https://registry.npmjs.org/update-notifier/-/update-notifier-6.0.2.tgz", - "integrity": "sha512-EDxhTEVPZZRLWYcJ4ZXjGFN0oP7qYvbXWzEgRm/Yql4dHX5wDbvh89YHP6PK1lzZJYrMtXUuZZz8XGK+U6U1og==", - "dev": true, - "license": "BSD-2-Clause", - "dependencies": { - "boxen": "^7.0.0", - "chalk": "^5.0.1", - "configstore": "^6.0.0", - "has-yarn": "^3.0.0", - "import-lazy": "^4.0.0", - "is-ci": "^3.0.1", - "is-installed-globally": "^0.4.0", - "is-npm": "^6.0.0", - "is-yarn-global": "^0.4.0", - "latest-version": "^7.0.0", - "pupa": "^3.1.0", - "semver": "^7.3.7", - "semver-diff": "^4.0.0", - "xdg-basedir": "^5.1.0" - }, - "engines": { - "node": ">=14.16" - }, - "funding": { - "url": "https://github.com/yeoman/update-notifier?sponsor=1" - } - }, - "node_modules/update-notifier/node_modules/ansi-regex": { - "version": "6.2.2", - "resolved": "https://registry.npmjs.org/ansi-regex/-/ansi-regex-6.2.2.tgz", - "integrity": "sha512-Bq3SmSpyFHaWjPk8If9yc6svM8c56dB5BAtW4Qbw5jHTwwXXcTLoRMkpDJp6VL0XzlWaCHTXrkFURMYmD0sLqg==", - "dev": true, - "license": "MIT", - "engines": { - "node": ">=12" - }, - "funding": { - "url": "https://github.com/chalk/ansi-regex?sponsor=1" - } - }, - "node_modules/update-notifier/node_modules/ansi-styles": { - "version": "6.2.3", - "resolved": "https://registry.npmjs.org/ansi-styles/-/ansi-styles-6.2.3.tgz", - "integrity": "sha512-4Dj6M28JB+oAH8kFkTLUo+a2jwOFkuqb3yucU0CANcRRUbxS0cP0nZYCGjcc3BNXwRIsUVmDGgzawme7zvJHvg==", - "dev": true, - "license": "MIT", - "engines": { - "node": ">=12" - }, - "funding": { - "url": "https://github.com/chalk/ansi-styles?sponsor=1" - } - }, - "node_modules/update-notifier/node_modules/boxen": { - "version": "7.1.1", - "resolved": "https://registry.npmjs.org/boxen/-/boxen-7.1.1.tgz", - "integrity": "sha512-2hCgjEmP8YLWQ130n2FerGv7rYpfBmnmp9Uy2Le1vge6X3gZIfSmEzP5QTDElFxcvVcXlEn8Aq6MU/PZygIOog==", - "dev": true, - "license": "MIT", - "dependencies": { - "ansi-align": "^3.0.1", - "camelcase": "^7.0.1", - "chalk": "^5.2.0", - "cli-boxes": "^3.0.0", - "string-width": "^5.1.2", - "type-fest": "^2.13.0", - "widest-line": "^4.0.1", - "wrap-ansi": "^8.1.0" - }, - "engines": { - "node": ">=14.16" - }, - "funding": { - "url": "https://github.com/sponsors/sindresorhus" - } - }, - "node_modules/update-notifier/node_modules/camelcase": { - "version": "7.0.1", - "resolved": "https://registry.npmjs.org/camelcase/-/camelcase-7.0.1.tgz", - "integrity": "sha512-xlx1yCK2Oc1APsPXDL2LdlNP6+uu8OCDdhOBSVT279M/S+y75O30C2VuD8T2ogdePBBl7PfPF4504tnLgX3zfw==", - "dev": true, - "license": "MIT", - "engines": { - "node": ">=14.16" - }, - "funding": { - "url": "https://github.com/sponsors/sindresorhus" - } - }, - "node_modules/update-notifier/node_modules/chalk": { - "version": "5.6.2", - "resolved": "https://registry.npmjs.org/chalk/-/chalk-5.6.2.tgz", - "integrity": "sha512-7NzBL0rN6fMUW+f7A6Io4h40qQlG+xGmtMxfbnH/K7TAtt8JQWVQK+6g0UXKMeVJoyV5EkkNsErQ8pVD3bLHbA==", - "dev": true, - "license": "MIT", - "engines": { - "node": "^12.17.0 || ^14.13 || >=16.0.0" - }, - "funding": { - "url": "https://github.com/chalk/chalk?sponsor=1" - } - }, - "node_modules/update-notifier/node_modules/cli-boxes": { - "version": "3.0.0", - "resolved": "https://registry.npmjs.org/cli-boxes/-/cli-boxes-3.0.0.tgz", - "integrity": "sha512-/lzGpEWL/8PfI0BmBOPRwp0c/wFNX1RdUML3jK/RcSBA9T8mZDdQpqYBKtCFTOfQbwPqWEOpjqW+Fnayc0969g==", - "dev": true, - "license": "MIT", - "engines": { - "node": ">=10" - }, - "funding": { - "url": "https://github.com/sponsors/sindresorhus" - } - }, - "node_modules/update-notifier/node_modules/emoji-regex": { - "version": "9.2.2", - "resolved": "https://registry.npmjs.org/emoji-regex/-/emoji-regex-9.2.2.tgz", - "integrity": "sha512-L18DaJsXSUk2+42pv8mLs5jJT2hqFkFE4j21wOmgbUqsZ2hL72NsUU785g9RXgo3s0ZNgVl42TiHp3ZtOv/Vyg==", - "dev": true, - "license": "MIT" - }, - "node_modules/update-notifier/node_modules/string-width": { - "version": "5.1.2", - "resolved": "https://registry.npmjs.org/string-width/-/string-width-5.1.2.tgz", - "integrity": "sha512-HnLOCR3vjcY8beoNLtcjZ5/nxn2afmME6lhrDrebokqMap+XbeW8n9TXpPDOqdGK5qcI3oT0GKTW6wC7EMiVqA==", - "dev": true, - "license": "MIT", - "dependencies": { - "eastasianwidth": "^0.2.0", - "emoji-regex": "^9.2.2", - "strip-ansi": "^7.0.1" - }, - "engines": { - "node": ">=12" - }, - "funding": { - "url": "https://github.com/sponsors/sindresorhus" - } - }, - "node_modules/update-notifier/node_modules/strip-ansi": { - "version": "7.1.2", - "resolved": "https://registry.npmjs.org/strip-ansi/-/strip-ansi-7.1.2.tgz", - "integrity": "sha512-gmBGslpoQJtgnMAvOVqGZpEz9dyoKTCzy2nfz/n8aIFhN/jCE/rCmcxabB6jOOHV+0WNnylOxaxBQPSvcWklhA==", - "dev": true, - "license": "MIT", - "dependencies": { - "ansi-regex": "^6.0.1" - }, - "engines": { - "node": ">=12" - }, - "funding": { - "url": "https://github.com/chalk/strip-ansi?sponsor=1" - } - }, - "node_modules/update-notifier/node_modules/type-fest": { - "version": "2.19.0", - "resolved": "https://registry.npmjs.org/type-fest/-/type-fest-2.19.0.tgz", - "integrity": "sha512-RAH822pAdBgcNMAfWnCBU3CFZcfZ/i1eZjwFU/dsLKumyuuP3niueg2UAukXYF0E2AAoc82ZSSf9J0WQBinzHA==", - "dev": true, - "license": "(MIT OR CC0-1.0)", - "engines": { - "node": ">=12.20" - }, - "funding": { - "url": "https://github.com/sponsors/sindresorhus" - } - }, - "node_modules/update-notifier/node_modules/widest-line": { - "version": "4.0.1", - "resolved": "https://registry.npmjs.org/widest-line/-/widest-line-4.0.1.tgz", - "integrity": "sha512-o0cyEG0e8GPzT4iGHphIOh0cJOV8fivsXxddQasHPHfoZf1ZexrfeA21w2NaEN1RHE+fXlfISmOE8R9N3u3Qig==", - "dev": true, - "license": "MIT", - "dependencies": { - "string-width": "^5.0.1" - }, - "engines": { - "node": ">=12" - }, - "funding": { - "url": "https://github.com/sponsors/sindresorhus" - } - }, - "node_modules/update-notifier/node_modules/wrap-ansi": { - "version": "8.1.0", - "resolved": "https://registry.npmjs.org/wrap-ansi/-/wrap-ansi-8.1.0.tgz", - "integrity": "sha512-si7QWI6zUMq56bESFvagtmzMdGOtoxfR+Sez11Mobfc7tm+VkUckk9bW2UeffTGVUbOksxmSw0AA2gs8g71NCQ==", - "dev": true, - "license": "MIT", - "dependencies": { - "ansi-styles": "^6.1.0", - "string-width": "^5.0.1", - "strip-ansi": "^7.0.1" - }, - "engines": { - "node": ">=12" - }, - "funding": { - "url": "https://github.com/chalk/wrap-ansi?sponsor=1" - } - }, "node_modules/uri-js": { "version": "4.4.1", "resolved": "https://registry.npmjs.org/uri-js/-/uri-js-4.4.1.tgz", @@ -23773,129 +14652,12 @@ "punycode": "^2.1.0" } }, - "node_modules/url-loader": { - "version": "4.1.1", - "resolved": "https://registry.npmjs.org/url-loader/-/url-loader-4.1.1.tgz", - "integrity": "sha512-3BTV812+AVHHOJQO8O5MkWgZ5aosP7GnROJwvzLS9hWDj00lZ6Z0wNak423Lp9PBZN05N+Jk/N5Si8jRAlGyWA==", - "dev": true, - "license": "MIT", - "dependencies": { - "loader-utils": "^2.0.0", - "mime-types": "^2.1.27", - "schema-utils": "^3.0.0" - }, - "engines": { - "node": ">= 10.13.0" - }, - "funding": { - "type": "opencollective", - "url": "https://opencollective.com/webpack" - }, - "peerDependencies": { - "file-loader": "*", - "webpack": "^4.0.0 || ^5.0.0" - }, - "peerDependenciesMeta": { - "file-loader": { - "optional": true - } - } - }, - "node_modules/url-loader/node_modules/mime-db": { - "version": "1.52.0", - "resolved": "https://registry.npmjs.org/mime-db/-/mime-db-1.52.0.tgz", - "integrity": "sha512-sPU4uV7dYlvtWJxwwxHD0PuihVNiE7TyAbQ5SWxDCB9mUYvOgroQOwYQQOKPJ8CIbE+1ETVlOoK1UC2nU3gYvg==", - "dev": true, - "license": "MIT", - "engines": { - "node": ">= 0.6" - } - }, - "node_modules/url-loader/node_modules/mime-types": { - "version": "2.1.35", - "resolved": "https://registry.npmjs.org/mime-types/-/mime-types-2.1.35.tgz", - "integrity": "sha512-ZDY+bPm5zTTF+YpCrAU9nK0UgICYPT0QtT1NZWFv4s++TNkcgVaT0g6+4R2uI4MjQjzysHB1zxuWL50hzaeXiw==", - "dev": true, - "license": "MIT", - "dependencies": { - "mime-db": "1.52.0" - }, - "engines": { - "node": ">= 0.6" - } - }, - "node_modules/url-loader/node_modules/schema-utils": { - "version": "3.3.0", - "resolved": "https://registry.npmjs.org/schema-utils/-/schema-utils-3.3.0.tgz", - "integrity": "sha512-pN/yOAvcC+5rQ5nERGuwrjLlYvLTbCibnZ1I7B1LaiAz9BRBlE9GMgE/eqV30P7aJQUf7Ddimy/RsbYO/GrVGg==", - "dev": true, - "license": "MIT", - "dependencies": { - "@types/json-schema": "^7.0.8", - "ajv": "^6.12.5", - "ajv-keywords": "^3.5.2" - }, - "engines": { - "node": ">= 10.13.0" - }, - "funding": { - "type": "opencollective", - "url": "https://opencollective.com/webpack" - } - }, - "node_modules/use-sync-external-store": { - "version": "1.6.0", - "resolved": "https://registry.npmjs.org/use-sync-external-store/-/use-sync-external-store-1.6.0.tgz", - "integrity": "sha512-Pp6GSwGP/NrPIrxVFAIkOQeyw8lFenOHijQWkUTrDvrF4ALqylP2C/KCkeS9dpUM3KvYRQhna5vt7IL95+ZQ9w==", - "dev": true, - "license": "MIT", - "peerDependencies": { - "react": "^16.8.0 || ^17.0.0 || ^18.0.0 || ^19.0.0" - } - }, "node_modules/util-deprecate": { "version": "1.0.2", "resolved": "https://registry.npmjs.org/util-deprecate/-/util-deprecate-1.0.2.tgz", "integrity": "sha512-EPD5q1uXyFxJpCrLnCc1nHnq3gOa6DZBocAIiI2TaSCA7VCJ1UJDMagCzIkXNsUYfD1daK//LTEQ8xiIbrHtcw==", "license": "MIT" }, - "node_modules/utila": { - "version": "0.4.0", - "resolved": "https://registry.npmjs.org/utila/-/utila-0.4.0.tgz", - "integrity": "sha512-Z0DbgELS9/L/75wZbro8xAnT50pBVFQZ+hUEueGDU5FN51YSCYM+jdxsfCiHjwNP/4LCDD0i/graKpeBnOXKRA==", - "dev": true, - "license": "MIT" - }, - "node_modules/utility-types": { - "version": "3.11.0", - "resolved": "https://registry.npmjs.org/utility-types/-/utility-types-3.11.0.tgz", - "integrity": "sha512-6Z7Ma2aVEWisaL6TvBCy7P8rm2LQoPv6dJ7ecIaIixHcwfbJ0x7mWdbcwlIM5IGQxPZSFYeqRCqlOOeKoJYMkw==", - "dev": true, - "license": "MIT", - "engines": { - "node": ">= 4" - } - }, - "node_modules/utils-merge": { - "version": "1.0.1", - "resolved": "https://registry.npmjs.org/utils-merge/-/utils-merge-1.0.1.tgz", - "integrity": "sha512-pMZTvIkT1d+TFGvDOqodOclx0QWkkgi6Tdoa8gC8ffGAAqz9pzPTZWAybbsHHoED/ztMtkv/VoYTYyShUn81hA==", - "dev": true, - "license": "MIT", - "engines": { - "node": ">= 0.4.0" - } - }, - "node_modules/uuid": { - "version": "8.3.2", - "resolved": "https://registry.npmjs.org/uuid/-/uuid-8.3.2.tgz", - "integrity": "sha512-+NYs2QeMWy+GWFOEm9xnn6HCDp0l7QBD7ml8zLUmJ+93Q5NF0NocErnwkTkXVFNiX3/fpC6afS8Dhb/gz7R7eg==", - "dev": true, - "license": "MIT", - "bin": { - "uuid": "dist/bin/uuid" - } - }, "node_modules/v8-to-istanbul": { "version": "9.3.0", "resolved": "https://registry.npmjs.org/v8-to-istanbul/-/v8-to-istanbul-9.3.0.tgz", @@ -23911,23 +14673,6 @@ "node": ">=10.12.0" } }, - "node_modules/value-equal": { - "version": "1.0.1", - "resolved": "https://registry.npmjs.org/value-equal/-/value-equal-1.0.1.tgz", - "integrity": "sha512-NOJ6JZCAWr0zlxZt+xqCHNTEKOsrks2HQd4MqhP1qy4z1SkbEP467eNx6TgDKXMvUOb+OENfJCZwM+16n7fRfw==", - "dev": true, - "license": "MIT" - }, - "node_modules/vary": { - "version": "1.1.2", - "resolved": "https://registry.npmjs.org/vary/-/vary-1.1.2.tgz", - "integrity": "sha512-BNGbWLfd0eUPabhkXUVm0j8uuvREyTh5ovRa/dyow/BqAbZJyC+5fU+IzQOzmAKzYqYRAISoRhdQr3eIZ/PXqg==", - "dev": true, - "license": "MIT", - "engines": { - "node": ">= 0.8" - } - }, "node_modules/vfile": { "version": "6.0.3", "resolved": "https://registry.npmjs.org/vfile/-/vfile-6.0.3.tgz", @@ -23971,6 +14716,101 @@ "url": "https://opencollective.com/unified" } }, + "node_modules/vite": { + "version": "6.4.1", + "resolved": "https://registry.npmjs.org/vite/-/vite-6.4.1.tgz", + "integrity": "sha512-+Oxm7q9hDoLMyJOYfUYBuHQo+dkAloi33apOPP56pzj+vsdJDzr+j1NISE5pyaAuKL4A3UD34qd0lx5+kfKp2g==", + "dev": true, + "license": "MIT", + "dependencies": { + "esbuild": "^0.25.0", + "fdir": "^6.4.4", + "picomatch": "^4.0.2", + "postcss": "^8.5.3", + "rollup": "^4.34.9", + "tinyglobby": "^0.2.13" + }, + "bin": { + "vite": "bin/vite.js" + }, + "engines": { + "node": "^18.0.0 || ^20.0.0 || >=22.0.0" + }, + "funding": { + "url": "https://github.com/vitejs/vite?sponsor=1" + }, + "optionalDependencies": { + "fsevents": "~2.3.3" + }, + "peerDependencies": { + "@types/node": "^18.0.0 || ^20.0.0 || >=22.0.0", + "jiti": ">=1.21.0", + "less": "*", + "lightningcss": "^1.21.0", + "sass": "*", + "sass-embedded": "*", + "stylus": "*", + "sugarss": "*", + "terser": "^5.16.0", + "tsx": "^4.8.1", + "yaml": "^2.4.2" + }, + "peerDependenciesMeta": { + "@types/node": { + "optional": true + }, + "jiti": { + "optional": true + }, + "less": { + "optional": true + }, + "lightningcss": { + "optional": true + }, + "sass": { + "optional": true + }, + "sass-embedded": { + "optional": true + }, + "stylus": { + "optional": true + }, + "sugarss": { + "optional": true + }, + "terser": { + "optional": true + }, + "tsx": { + "optional": true + }, + "yaml": { + "optional": true + } + } + }, + "node_modules/vitefu": { + "version": "1.1.1", + "resolved": "https://registry.npmjs.org/vitefu/-/vitefu-1.1.1.tgz", + "integrity": "sha512-B/Fegf3i8zh0yFbpzZ21amWzHmuNlLlmJT6n7bu5e+pCHUKQIfXSYokrqOBGEMMe9UG2sostKQF9mml/vYaWJQ==", + "dev": true, + "license": "MIT", + "workspaces": [ + "tests/deps/*", + "tests/projects/*", + "tests/projects/workspace/packages/*" + ], + "peerDependencies": { + "vite": "^3.0.0 || ^4.0.0 || ^5.0.0 || ^6.0.0 || ^7.0.0-beta.0" + }, + "peerDependenciesMeta": { + "vite": { + "optional": true + } + } + }, "node_modules/walker": { "version": "1.0.8", "resolved": "https://registry.npmjs.org/walker/-/walker-1.0.8.tgz", @@ -23981,30 +14821,6 @@ "makeerror": "1.0.12" } }, - "node_modules/watchpack": { - "version": "2.4.4", - "resolved": "https://registry.npmjs.org/watchpack/-/watchpack-2.4.4.tgz", - "integrity": "sha512-c5EGNOiyxxV5qmTtAB7rbiXxi1ooX1pQKMLX/MIabJjRA0SJBQOjKF+KSVfHkr9U1cADPon0mRiVe/riyaiDUA==", - "dev": true, - "license": "MIT", - "dependencies": { - "glob-to-regexp": "^0.4.1", - "graceful-fs": "^4.1.2" - }, - "engines": { - "node": ">=10.13.0" - } - }, - "node_modules/wbuf": { - "version": "1.7.3", - "resolved": "https://registry.npmjs.org/wbuf/-/wbuf-1.7.3.tgz", - "integrity": "sha512-O84QOnr0icsbFGLS0O3bI5FswxzRr8/gHwWkDlQFskhSPryQXvrTMxjxGP4+iWYoauLoBvfDpkrOauZ+0iZpDA==", - "dev": true, - "license": "MIT", - "dependencies": { - "minimalistic-assert": "^1.0.0" - } - }, "node_modules/wcwidth": { "version": "1.0.1", "resolved": "https://registry.npmjs.org/wcwidth/-/wcwidth-1.0.1.tgz", @@ -24025,416 +14841,6 @@ "url": "https://github.com/sponsors/wooorm" } }, - "node_modules/webpack": { - "version": "5.104.1", - "resolved": "https://registry.npmjs.org/webpack/-/webpack-5.104.1.tgz", - "integrity": "sha512-Qphch25abbMNtekmEGJmeRUhLDbe+QfiWTiqpKYkpCOWY64v9eyl+KRRLmqOFA2AvKPpc9DC6+u2n76tQLBoaA==", - "dev": true, - "license": "MIT", - "peer": true, - "dependencies": { - "@types/eslint-scope": "^3.7.7", - "@types/estree": "^1.0.8", - "@types/json-schema": "^7.0.15", - "@webassemblyjs/ast": "^1.14.1", - "@webassemblyjs/wasm-edit": "^1.14.1", - "@webassemblyjs/wasm-parser": "^1.14.1", - "acorn": "^8.15.0", - "acorn-import-phases": "^1.0.3", - "browserslist": "^4.28.1", - "chrome-trace-event": "^1.0.2", - "enhanced-resolve": "^5.17.4", - "es-module-lexer": "^2.0.0", - "eslint-scope": "5.1.1", - "events": "^3.2.0", - "glob-to-regexp": "^0.4.1", - "graceful-fs": "^4.2.11", - "json-parse-even-better-errors": "^2.3.1", - "loader-runner": "^4.3.1", - "mime-types": "^2.1.27", - "neo-async": "^2.6.2", - "schema-utils": "^4.3.3", - "tapable": "^2.3.0", - "terser-webpack-plugin": "^5.3.16", - "watchpack": "^2.4.4", - "webpack-sources": "^3.3.3" - }, - "bin": { - "webpack": "bin/webpack.js" - }, - "engines": { - "node": ">=10.13.0" - }, - "funding": { - "type": "opencollective", - "url": "https://opencollective.com/webpack" - }, - "peerDependenciesMeta": { - "webpack-cli": { - "optional": true - } - } - }, - "node_modules/webpack-bundle-analyzer": { - "version": "4.10.2", - "resolved": "https://registry.npmjs.org/webpack-bundle-analyzer/-/webpack-bundle-analyzer-4.10.2.tgz", - "integrity": "sha512-vJptkMm9pk5si4Bv922ZbKLV8UTT4zib4FPgXMhgzUny0bfDDkLXAVQs3ly3fS4/TN9ROFtb0NFrm04UXFE/Vw==", - "dev": true, - "license": "MIT", - "dependencies": { - "@discoveryjs/json-ext": "0.5.7", - "acorn": "^8.0.4", - "acorn-walk": "^8.0.0", - "commander": "^7.2.0", - "debounce": "^1.2.1", - "escape-string-regexp": "^4.0.0", - "gzip-size": "^6.0.0", - "html-escaper": "^2.0.2", - "opener": "^1.5.2", - "picocolors": "^1.0.0", - "sirv": "^2.0.3", - "ws": "^7.3.1" - }, - "bin": { - "webpack-bundle-analyzer": "lib/bin/analyzer.js" - }, - "engines": { - "node": ">= 10.13.0" - } - }, - "node_modules/webpack-bundle-analyzer/node_modules/commander": { - "version": "7.2.0", - "resolved": "https://registry.npmjs.org/commander/-/commander-7.2.0.tgz", - "integrity": "sha512-QrWXB+ZQSVPmIWIhtEO9H+gwHaMGYiF5ChvoJ+K9ZGHG/sVsa6yiesAD1GC/x46sET00Xlwo1u49RVVVzvcSkw==", - "dev": true, - "license": "MIT", - "engines": { - "node": ">= 10" - } - }, - "node_modules/webpack-dev-middleware": { - "version": "7.4.5", - "resolved": "https://registry.npmjs.org/webpack-dev-middleware/-/webpack-dev-middleware-7.4.5.tgz", - "integrity": "sha512-uxQ6YqGdE4hgDKNf7hUiPXOdtkXvBJXrfEGYSx7P7LC8hnUYGK70X6xQXUvXeNyBDDcsiQXpG2m3G9vxowaEuA==", - "dev": true, - "license": "MIT", - "dependencies": { - "colorette": "^2.0.10", - "memfs": "^4.43.1", - "mime-types": "^3.0.1", - "on-finished": "^2.4.1", - "range-parser": "^1.2.1", - "schema-utils": "^4.0.0" - }, - "engines": { - "node": ">= 18.12.0" - }, - "funding": { - "type": "opencollective", - "url": "https://opencollective.com/webpack" - }, - "peerDependencies": { - "webpack": "^5.0.0" - }, - "peerDependenciesMeta": { - "webpack": { - "optional": true - } - } - }, - "node_modules/webpack-dev-middleware/node_modules/mime-db": { - "version": "1.54.0", - "resolved": "https://registry.npmjs.org/mime-db/-/mime-db-1.54.0.tgz", - "integrity": "sha512-aU5EJuIN2WDemCcAp2vFBfp/m4EAhWJnUNSSw0ixs7/kXbd6Pg64EmwJkNdFhB8aWt1sH2CTXrLxo/iAGV3oPQ==", - "dev": true, - "license": "MIT", - "engines": { - "node": ">= 0.6" - } - }, - "node_modules/webpack-dev-middleware/node_modules/mime-types": { - "version": "3.0.2", - "resolved": "https://registry.npmjs.org/mime-types/-/mime-types-3.0.2.tgz", - "integrity": "sha512-Lbgzdk0h4juoQ9fCKXW4by0UJqj+nOOrI9MJ1sSj4nI8aI2eo1qmvQEie4VD1glsS250n15LsWsYtCugiStS5A==", - "dev": true, - "license": "MIT", - "dependencies": { - "mime-db": "^1.54.0" - }, - "engines": { - "node": ">=18" - }, - "funding": { - "type": "opencollective", - "url": "https://opencollective.com/express" - } - }, - "node_modules/webpack-dev-middleware/node_modules/range-parser": { - "version": "1.2.1", - "resolved": "https://registry.npmjs.org/range-parser/-/range-parser-1.2.1.tgz", - "integrity": "sha512-Hrgsx+orqoygnmhFbKaHE6c296J+HTAQXoxEF6gNupROmmGJRoyzfG3ccAveqCBrwr/2yxQ5BVd/GTl5agOwSg==", - "dev": true, - "license": "MIT", - "engines": { - "node": ">= 0.6" - } - }, - "node_modules/webpack-dev-server": { - "version": "5.2.2", - "resolved": "https://registry.npmjs.org/webpack-dev-server/-/webpack-dev-server-5.2.2.tgz", - "integrity": "sha512-QcQ72gh8a+7JO63TAx/6XZf/CWhgMzu5m0QirvPfGvptOusAxG12w2+aua1Jkjr7hzaWDnJ2n6JFeexMHI+Zjg==", - "dev": true, - "license": "MIT", - "dependencies": { - "@types/bonjour": "^3.5.13", - "@types/connect-history-api-fallback": "^1.5.4", - "@types/express": "^4.17.21", - "@types/express-serve-static-core": "^4.17.21", - "@types/serve-index": "^1.9.4", - "@types/serve-static": "^1.15.5", - "@types/sockjs": "^0.3.36", - "@types/ws": "^8.5.10", - "ansi-html-community": "^0.0.8", - "bonjour-service": "^1.2.1", - "chokidar": "^3.6.0", - "colorette": "^2.0.10", - "compression": "^1.7.4", - "connect-history-api-fallback": "^2.0.0", - "express": "^4.21.2", - "graceful-fs": "^4.2.6", - "http-proxy-middleware": "^2.0.9", - "ipaddr.js": "^2.1.0", - "launch-editor": "^2.6.1", - "open": "^10.0.3", - "p-retry": "^6.2.0", - "schema-utils": "^4.2.0", - "selfsigned": "^2.4.1", - "serve-index": "^1.9.1", - "sockjs": "^0.3.24", - "spdy": "^4.0.2", - "webpack-dev-middleware": "^7.4.2", - "ws": "^8.18.0" - }, - "bin": { - "webpack-dev-server": "bin/webpack-dev-server.js" - }, - "engines": { - "node": ">= 18.12.0" - }, - "funding": { - "type": "opencollective", - "url": "https://opencollective.com/webpack" - }, - "peerDependencies": { - "webpack": "^5.0.0" - }, - "peerDependenciesMeta": { - "webpack": { - "optional": true - }, - "webpack-cli": { - "optional": true - } - } - }, - "node_modules/webpack-dev-server/node_modules/define-lazy-prop": { - "version": "3.0.0", - "resolved": "https://registry.npmjs.org/define-lazy-prop/-/define-lazy-prop-3.0.0.tgz", - "integrity": "sha512-N+MeXYoqr3pOgn8xfyRPREN7gHakLYjhsHhWGT3fWAiL4IkAt0iDw14QiiEm2bE30c5XX5q0FtAA3CK5f9/BUg==", - "dev": true, - "license": "MIT", - "engines": { - "node": ">=12" - }, - "funding": { - "url": "https://github.com/sponsors/sindresorhus" - } - }, - "node_modules/webpack-dev-server/node_modules/open": { - "version": "10.2.0", - "resolved": "https://registry.npmjs.org/open/-/open-10.2.0.tgz", - "integrity": "sha512-YgBpdJHPyQ2UE5x+hlSXcnejzAvD0b22U2OuAP+8OnlJT+PjWPxtgmGqKKc+RgTM63U9gN0YzrYc71R2WT/hTA==", - "dev": true, - "license": "MIT", - "dependencies": { - "default-browser": "^5.2.1", - "define-lazy-prop": "^3.0.0", - "is-inside-container": "^1.0.0", - "wsl-utils": "^0.1.0" - }, - "engines": { - "node": ">=18" - }, - "funding": { - "url": "https://github.com/sponsors/sindresorhus" - } - }, - "node_modules/webpack-dev-server/node_modules/ws": { - "version": "8.18.3", - "resolved": "https://registry.npmjs.org/ws/-/ws-8.18.3.tgz", - "integrity": "sha512-PEIGCY5tSlUt50cqyMXfCzX+oOPqN0vuGqWzbcJ2xvnkzkq46oOpz7dQaTDBdfICb4N14+GARUDw2XV2N4tvzg==", - "dev": true, - "license": "MIT", - "engines": { - "node": ">=10.0.0" - }, - "peerDependencies": { - "bufferutil": "^4.0.1", - "utf-8-validate": ">=5.0.2" - }, - "peerDependenciesMeta": { - "bufferutil": { - "optional": true - }, - "utf-8-validate": { - "optional": true - } - } - }, - "node_modules/webpack-merge": { - "version": "6.0.1", - "resolved": "https://registry.npmjs.org/webpack-merge/-/webpack-merge-6.0.1.tgz", - "integrity": "sha512-hXXvrjtx2PLYx4qruKl+kyRSLc52V+cCvMxRjmKwoA+CBbbF5GfIBtR6kCvl0fYGqTUPKB+1ktVmTHqMOzgCBg==", - "dev": true, - "license": "MIT", - "dependencies": { - "clone-deep": "^4.0.1", - "flat": "^5.0.2", - "wildcard": "^2.0.1" - }, - "engines": { - "node": ">=18.0.0" - } - }, - "node_modules/webpack-sources": { - "version": "3.3.3", - "resolved": "https://registry.npmjs.org/webpack-sources/-/webpack-sources-3.3.3.tgz", - "integrity": "sha512-yd1RBzSGanHkitROoPFd6qsrxt+oFhg/129YzheDGqeustzX0vTZJZsSsQjVQC4yzBQ56K55XU8gaNCtIzOnTg==", - "dev": true, - "license": "MIT", - "engines": { - "node": ">=10.13.0" - } - }, - "node_modules/webpack/node_modules/eslint-scope": { - "version": "5.1.1", - "resolved": "https://registry.npmjs.org/eslint-scope/-/eslint-scope-5.1.1.tgz", - "integrity": "sha512-2NxwbF/hZ0KpepYN0cNbo+FN6XoK7GaHlQhgx/hIZl6Va0bF45RQOOwhLIy8lQDbuCiadSLCBnH2CFYquit5bw==", - "dev": true, - "license": "BSD-2-Clause", - "dependencies": { - "esrecurse": "^4.3.0", - "estraverse": "^4.1.1" - }, - "engines": { - "node": ">=8.0.0" - } - }, - "node_modules/webpack/node_modules/estraverse": { - "version": "4.3.0", - "resolved": "https://registry.npmjs.org/estraverse/-/estraverse-4.3.0.tgz", - "integrity": "sha512-39nnKffWz8xN1BU/2c79n9nB9HDzo0niYUqx6xyqUnyoAnQyyWpOTdZEeiCch8BBu515t4wp9ZmgVfVhn9EBpw==", - "dev": true, - "license": "BSD-2-Clause", - "engines": { - "node": ">=4.0" - } - }, - "node_modules/webpack/node_modules/mime-db": { - "version": "1.52.0", - "resolved": "https://registry.npmjs.org/mime-db/-/mime-db-1.52.0.tgz", - "integrity": "sha512-sPU4uV7dYlvtWJxwwxHD0PuihVNiE7TyAbQ5SWxDCB9mUYvOgroQOwYQQOKPJ8CIbE+1ETVlOoK1UC2nU3gYvg==", - "dev": true, - "license": "MIT", - "engines": { - "node": ">= 0.6" - } - }, - "node_modules/webpack/node_modules/mime-types": { - "version": "2.1.35", - "resolved": "https://registry.npmjs.org/mime-types/-/mime-types-2.1.35.tgz", - "integrity": "sha512-ZDY+bPm5zTTF+YpCrAU9nK0UgICYPT0QtT1NZWFv4s++TNkcgVaT0g6+4R2uI4MjQjzysHB1zxuWL50hzaeXiw==", - "dev": true, - "license": "MIT", - "dependencies": { - "mime-db": "1.52.0" - }, - "engines": { - "node": ">= 0.6" - } - }, - "node_modules/webpackbar": { - "version": "6.0.1", - "resolved": "https://registry.npmjs.org/webpackbar/-/webpackbar-6.0.1.tgz", - "integrity": "sha512-TnErZpmuKdwWBdMoexjio3KKX6ZtoKHRVvLIU0A47R0VVBDtx3ZyOJDktgYixhoJokZTYTt1Z37OkO9pnGJa9Q==", - "dev": true, - "license": "MIT", - "dependencies": { - "ansi-escapes": "^4.3.2", - "chalk": "^4.1.2", - "consola": "^3.2.3", - "figures": "^3.2.0", - "markdown-table": "^2.0.0", - "pretty-time": "^1.1.0", - "std-env": "^3.7.0", - "wrap-ansi": "^7.0.0" - }, - "engines": { - "node": ">=14.21.3" - }, - "peerDependencies": { - "webpack": "3 || 4 || 5" - } - }, - "node_modules/webpackbar/node_modules/consola": { - "version": "3.4.2", - "resolved": "https://registry.npmjs.org/consola/-/consola-3.4.2.tgz", - "integrity": "sha512-5IKcdX0nnYavi6G7TtOhwkYzyjfJlatbjMjuLSfE2kYT5pMDOilZ4OvMhi637CcDICTmz3wARPoyhqyX1Y+XvA==", - "dev": true, - "license": "MIT", - "engines": { - "node": "^14.18.0 || >=16.10.0" - } - }, - "node_modules/webpackbar/node_modules/markdown-table": { - "version": "2.0.0", - "resolved": "https://registry.npmjs.org/markdown-table/-/markdown-table-2.0.0.tgz", - "integrity": "sha512-Ezda85ToJUBhM6WGaG6veasyym+Tbs3cMAw/ZhOPqXiYsr0jgocBV3j3nx+4lk47plLlIqjwuTm/ywVI+zjJ/A==", - "dev": true, - "license": "MIT", - "dependencies": { - "repeat-string": "^1.0.0" - }, - "funding": { - "type": "github", - "url": "https://github.com/sponsors/wooorm" - } - }, - "node_modules/websocket-driver": { - "version": "0.7.4", - "resolved": "https://registry.npmjs.org/websocket-driver/-/websocket-driver-0.7.4.tgz", - "integrity": "sha512-b17KeDIQVjvb0ssuSDF2cYXSg2iztliJ4B9WdsuB6J952qCPKmnVq4DyW5motImXHDC1cBT/1UezrJVsKw5zjg==", - "dev": true, - "license": "Apache-2.0", - "dependencies": { - "http-parser-js": ">=0.5.1", - "safe-buffer": ">=5.1.0", - "websocket-extensions": ">=0.1.1" - }, - "engines": { - "node": ">=0.8.0" - } - }, - "node_modules/websocket-extensions": { - "version": "0.1.4", - "resolved": "https://registry.npmjs.org/websocket-extensions/-/websocket-extensions-0.1.4.tgz", - "integrity": "sha512-OqedPIGOfsDlo31UNwYbCFMSaO9m9G/0faIHj5/dZFDMFqPTcx6UwqyOy3COEaEOg/9VsGIpdqn62W5KhoKSpg==", - "dev": true, - "license": "Apache-2.0", - "engines": { - "node": ">=0.8.0" - } - }, "node_modules/which": { "version": "2.0.2", "resolved": "https://registry.npmjs.org/which/-/which-2.0.2.tgz", @@ -24450,6 +14856,16 @@ "node": ">= 8" } }, + "node_modules/which-pm-runs": { + "version": "1.1.0", + "resolved": "https://registry.npmjs.org/which-pm-runs/-/which-pm-runs-1.1.0.tgz", + "integrity": "sha512-n1brCuqClxfFfq/Rb0ICg9giSZqCS+pLtccdag6C2HyufBrh3fBOiy9nb6ggRMvWOVH5GrdJskj5iGTZNxd7SA==", + "dev": true, + "license": "MIT", + "engines": { + "node": ">=4" + } + }, "node_modules/widest-line": { "version": "3.1.0", "resolved": "https://registry.npmjs.org/widest-line/-/widest-line-3.1.0.tgz", @@ -24462,13 +14878,6 @@ "node": ">=8" } }, - "node_modules/wildcard": { - "version": "2.0.1", - "resolved": "https://registry.npmjs.org/wildcard/-/wildcard-2.0.1.tgz", - "integrity": "sha512-CC1bOL87PIWSBhDcTrdeLo6eGT7mCFtrg0uIJtqJUFyK+eJnzl8A1niH56uu7KMa5XFrtiV+AQuHO3n7DsHnLQ==", - "dev": true, - "license": "MIT" - }, "node_modules/word-wrap": { "version": "1.2.5", "resolved": "https://registry.npmjs.org/word-wrap/-/word-wrap-1.2.5.tgz", @@ -24535,86 +14944,6 @@ "node": "^14.17.0 || ^16.13.0 || >=18.0.0" } }, - "node_modules/ws": { - "version": "7.5.10", - "resolved": "https://registry.npmjs.org/ws/-/ws-7.5.10.tgz", - "integrity": "sha512-+dbF1tHwZpXcbOJdVOkzLDxZP1ailvSxM6ZweXTegylPny803bFhA+vqBYw4s31NSAk4S2Qz+AKXK9a4wkdjcQ==", - "dev": true, - "license": "MIT", - "engines": { - "node": ">=8.3.0" - }, - "peerDependencies": { - "bufferutil": "^4.0.1", - "utf-8-validate": "^5.0.2" - }, - "peerDependenciesMeta": { - "bufferutil": { - "optional": true - }, - "utf-8-validate": { - "optional": true - } - } - }, - "node_modules/wsl-utils": { - "version": "0.1.0", - "resolved": "https://registry.npmjs.org/wsl-utils/-/wsl-utils-0.1.0.tgz", - "integrity": "sha512-h3Fbisa2nKGPxCpm89Hk33lBLsnaGBvctQopaBSOW/uIs6FTe1ATyAnKFJrzVs9vpGdsTe73WF3V4lIsk4Gacw==", - "dev": true, - "license": "MIT", - "dependencies": { - "is-wsl": "^3.1.0" - }, - "engines": { - "node": ">=18" - }, - "funding": { - "url": "https://github.com/sponsors/sindresorhus" - } - }, - "node_modules/wsl-utils/node_modules/is-wsl": { - "version": "3.1.0", - "resolved": "https://registry.npmjs.org/is-wsl/-/is-wsl-3.1.0.tgz", - "integrity": "sha512-UcVfVfaK4Sc4m7X3dUSoHoozQGBEFeDC+zVo06t98xe8CzHSZZBekNXH+tu0NalHolcJ/QAGqS46Hef7QXBIMw==", - "dev": true, - "license": "MIT", - "dependencies": { - "is-inside-container": "^1.0.0" - }, - "engines": { - "node": ">=16" - }, - "funding": { - "url": "https://github.com/sponsors/sindresorhus" - } - }, - "node_modules/xdg-basedir": { - "version": "5.1.0", - "resolved": "https://registry.npmjs.org/xdg-basedir/-/xdg-basedir-5.1.0.tgz", - "integrity": "sha512-GCPAHLvrIH13+c0SuacwvRYj2SxJXQ4kaVTT5xgL3kPrz56XxkF21IGhjSE1+W0aw7gpBWRGXLCPnPby6lSpmQ==", - "dev": true, - "license": "MIT", - "engines": { - "node": ">=12" - }, - "funding": { - "url": "https://github.com/sponsors/sindresorhus" - } - }, - "node_modules/xml-js": { - "version": "1.6.11", - "resolved": "https://registry.npmjs.org/xml-js/-/xml-js-1.6.11.tgz", - "integrity": "sha512-7rVi2KMfwfWFl+GpPg6m80IVMWXLRjO+PxTq7V2CDhoGak0wzYzFgUY2m4XJ47OGdXd8eLE8EmwfAmdjw7lC1g==", - "dev": true, - "license": "MIT", - "dependencies": { - "sax": "^1.2.4" - }, - "bin": { - "xml-js": "bin/cli.js" - } - }, "node_modules/xml2js": { "version": "0.6.2", "resolved": "https://registry.npmjs.org/xml2js/-/xml2js-0.6.2.tgz", @@ -24637,6 +14966,13 @@ "node": ">=4.0" } }, + "node_modules/xxhash-wasm": { + "version": "1.1.0", + "resolved": "https://registry.npmjs.org/xxhash-wasm/-/xxhash-wasm-1.1.0.tgz", + "integrity": "sha512-147y/6YNh+tlp6nd/2pWq38i9h6mz/EuQ6njIrmW8D1BS5nCqs0P6DG+m6zTGnNz5I+uhZ0SHxBs9BsPrwcKDA==", + "dev": true, + "license": "MIT" + }, "node_modules/y18n": { "version": "5.0.8", "resolved": "https://registry.npmjs.org/y18n/-/y18n-5.0.8.tgz", @@ -24655,21 +14991,24 @@ "license": "ISC" }, "node_modules/yaml": { - "version": "2.8.1", - "resolved": "https://registry.npmjs.org/yaml/-/yaml-2.8.1.tgz", - "integrity": "sha512-lcYcMxX2PO9XMGvAJkJ3OsNMw+/7FKes7/hgerGUYWIoWu5j/+YQqcZr5JnPZWzOsEBgMbSbiSTn/dv/69Mkpw==", + "version": "2.8.2", + "resolved": "https://registry.npmjs.org/yaml/-/yaml-2.8.2.tgz", + "integrity": "sha512-mplynKqc1C2hTVYxd0PU2xQAc22TI1vShAYGksCCfxbn/dFwnHTNi1bvYsBTkhdUNtGIf5xNOg938rrSSYvS9A==", "license": "ISC", "bin": { "yaml": "bin.mjs" }, "engines": { "node": ">= 14.6" + }, + "funding": { + "url": "https://github.com/sponsors/eemeli" } }, "node_modules/yaml-eslint-parser": { - "version": "1.3.0", - "resolved": "https://registry.npmjs.org/yaml-eslint-parser/-/yaml-eslint-parser-1.3.0.tgz", - "integrity": "sha512-E/+VitOorXSLiAqtTd7Yqax0/pAS3xaYMP+AUUJGOK1OZG3rhcj9fcJOM5HJ2VrP1FrStVCWr1muTfQCdj4tAA==", + "version": "1.3.2", + "resolved": "https://registry.npmjs.org/yaml-eslint-parser/-/yaml-eslint-parser-1.3.2.tgz", + "integrity": "sha512-odxVsHAkZYYglR30aPYRY4nUGJnoJ2y1ww2HDvZALo0BDETv9kWbi16J52eHs+PWRNmF4ub6nZqfVOeesOvntg==", "dev": true, "license": "MIT", "dependencies": { @@ -24712,6 +15051,37 @@ "yamllint": "dist/cli.js" } }, + "node_modules/yaml-lint/node_modules/globby": { + "version": "11.1.0", + "resolved": "https://registry.npmjs.org/globby/-/globby-11.1.0.tgz", + "integrity": "sha512-jhIXaOzy1sb8IyocaruWSn1TjmnBVs8Ayhcy83rmxNJ8q2uWKCAj3CnJY+KpGSXCueAPc0i05kVvVKtP1t9S3g==", + "dev": true, + "license": "MIT", + "dependencies": { + "array-union": "^2.1.0", + "dir-glob": "^3.0.1", + "fast-glob": "^3.2.9", + "ignore": "^5.2.0", + "merge2": "^1.4.1", + "slash": "^3.0.0" + }, + "engines": { + "node": ">=10" + }, + "funding": { + "url": "https://github.com/sponsors/sindresorhus" + } + }, + "node_modules/yaml-lint/node_modules/ignore": { + "version": "5.3.2", + "resolved": "https://registry.npmjs.org/ignore/-/ignore-5.3.2.tgz", + "integrity": "sha512-hsBTNUqQTDwkWtcdYI2i06Y/nUBEsNEDJKjWdigLvegy8kDuJAS8uRlpkkcQpyEXL0Z/pjDy5HBmMjRCJ2gq+g==", + "dev": true, + "license": "MIT", + "engines": { + "node": ">= 4" + } + }, "node_modules/yargs": { "version": "17.7.2", "resolved": "https://registry.npmjs.org/yargs/-/yargs-17.7.2.tgz", @@ -24742,13 +15112,42 @@ } }, "node_modules/yocto-queue": { - "version": "0.1.0", - "resolved": "https://registry.npmjs.org/yocto-queue/-/yocto-queue-0.1.0.tgz", - "integrity": "sha512-rVksvsnNCdJ/ohGc6xgPwyN8eheCxsiLM8mxuE/t/mOVqJewPuO1miLpTHQiRgTKCLexL4MeAFVagts7HmNZ2Q==", + "version": "1.2.2", + "resolved": "https://registry.npmjs.org/yocto-queue/-/yocto-queue-1.2.2.tgz", + "integrity": "sha512-4LCcse/U2MHZ63HAJVE+v71o7yOdIe4cZ70Wpf8D/IyjDKYQLV5GD46B+hSTjJsvV5PztjvHoU580EftxjDZFQ==", "dev": true, "license": "MIT", "engines": { - "node": ">=10" + "node": ">=12.20" + }, + "funding": { + "url": "https://github.com/sponsors/sindresorhus" + } + }, + "node_modules/yocto-spinner": { + "version": "0.2.3", + "resolved": "https://registry.npmjs.org/yocto-spinner/-/yocto-spinner-0.2.3.tgz", + "integrity": "sha512-sqBChb33loEnkoXte1bLg45bEBsOP9N1kzQh5JZNKj/0rik4zAPTNSAVPj3uQAdc6slYJ0Ksc403G2XgxsJQFQ==", + "dev": true, + "license": "MIT", + "dependencies": { + "yoctocolors": "^2.1.1" + }, + "engines": { + "node": ">=18.19" + }, + "funding": { + "url": "https://github.com/sponsors/sindresorhus" + } + }, + "node_modules/yoctocolors": { + "version": "2.1.2", + "resolved": "https://registry.npmjs.org/yoctocolors/-/yoctocolors-2.1.2.tgz", + "integrity": "sha512-CzhO+pFNo8ajLM2d2IW/R93ipy99LWjtwblvC1RsoSUMZgyLbYFr221TnSNT7GjGdYui6P459mw9JH/g/zW2ug==", + "dev": true, + "license": "MIT", + "engines": { + "node": ">=18" }, "funding": { "url": "https://github.com/sponsors/sindresorhus" @@ -24769,59 +15168,36 @@ "node": ">= 14" } }, - "node_modules/zip-stream/node_modules/buffer": { - "version": "6.0.3", - "resolved": "https://registry.npmjs.org/buffer/-/buffer-6.0.3.tgz", - "integrity": "sha512-FTiCpNxtwiZZHEZbcbTIcZjERVICn9yq/pDFkTl95/AxzD1naBctN7YO68riM/gLSDY7sdrMby8hofADYuuqOA==", - "dev": true, - "funding": [ - { - "type": "github", - "url": "https://github.com/sponsors/feross" - }, - { - "type": "patreon", - "url": "https://www.patreon.com/feross" - }, - { - "type": "consulting", - "url": "https://feross.org/support" - } - ], - "license": "MIT", - "dependencies": { - "base64-js": "^1.3.1", - "ieee754": "^1.2.1" - } - }, - "node_modules/zip-stream/node_modules/readable-stream": { - "version": "4.7.0", - "resolved": "https://registry.npmjs.org/readable-stream/-/readable-stream-4.7.0.tgz", - "integrity": "sha512-oIGGmcpTLwPga8Bn6/Z75SVaH1z5dUut2ibSyAMVhmUggWpmDn2dapB0n7f8nwaSiRtepAsfJyfXIO5DCVAODg==", - "dev": true, - "license": "MIT", - "dependencies": { - "abort-controller": "^3.0.0", - "buffer": "^6.0.3", - "events": "^3.3.0", - "process": "^0.11.10", - "string_decoder": "^1.3.0" - }, - "engines": { - "node": "^12.22.0 || ^14.17.0 || >=16.0.0" - } - }, "node_modules/zod": { - "version": "4.1.12", - "resolved": "https://registry.npmjs.org/zod/-/zod-4.1.12.tgz", - "integrity": "sha512-JInaHOamG8pt5+Ey8kGmdcAcg3OL9reK8ltczgHTAwNhMys/6ThXHityHxVV2p3fkw/c+MAvBHFVYHFZDmjMCQ==", + "version": "3.25.76", + "resolved": "https://registry.npmjs.org/zod/-/zod-3.25.76.tgz", + "integrity": "sha512-gzUt/qt81nXsFGKIFcC3YnfEAx5NkunCfnDlvuBSSFS02bcXu4Lmea0AFIUwbLWxWPx3d9p8S5QoaujKcNQxcQ==", "dev": true, "license": "MIT", - "peer": true, "funding": { "url": "https://github.com/sponsors/colinhacks" } }, + "node_modules/zod-to-json-schema": { + "version": "3.25.1", + "resolved": "https://registry.npmjs.org/zod-to-json-schema/-/zod-to-json-schema-3.25.1.tgz", + "integrity": "sha512-pM/SU9d3YAggzi6MtR4h7ruuQlqKtad8e9S0fmxcMi+ueAK5Korys/aWcV9LIIHTVbj01NdzxcnXSN+O74ZIVA==", + "dev": true, + "license": "ISC", + "peerDependencies": { + "zod": "^3.25 || ^4" + } + }, + "node_modules/zod-to-ts": { + "version": "1.2.0", + "resolved": "https://registry.npmjs.org/zod-to-ts/-/zod-to-ts-1.2.0.tgz", + "integrity": "sha512-x30XE43V+InwGpvTySRNz9kB7qFU8DlyEy7BsSTCHPH1R0QasMmHWZDCzYm6bVXtj/9NNJAZF3jW8rzFvH5OFA==", + "dev": true, + "peerDependencies": { + "typescript": "^4.9.4 || ^5.0.2", + "zod": "^3" + } + }, "node_modules/zwitch": { "version": "2.0.4", "resolved": "https://registry.npmjs.org/zwitch/-/zwitch-2.0.4.tgz", diff --git a/package.json b/package.json index 7db943ff..7cf03d1c 100644 --- a/package.json +++ b/package.json @@ -1,7 +1,7 @@ { "$schema": "https://json.schemastore.org/package.json", "name": "bmad-method", - "version": "6.0.0-alpha.19", + "version": "6.0.0-alpha.23", "description": "Breakthrough Method of Agile AI-driven Development", "keywords": [ "agile", @@ -27,8 +27,10 @@ "bmad:install": "node tools/cli/bmad-cli.js install", "bundle": "node tools/cli/bundlers/bundle-web.js all", "docs:build": "node tools/build-docs.js", - "docs:dev": "npm run docs:build && npm run docs:serve", - "docs:serve": "docusaurus start --config website/docusaurus.config.js --host localhost", + "docs:dev": "astro dev --root website", + "docs:fix-links": "node tools/fix-doc-links.js", + "docs:preview": "astro preview --root website", + "docs:validate-links": "node tools/validate-doc-links.js", "flatten": "node tools/flattener/main.js", "format:check": "prettier --check \"**/*.{js,cjs,mjs,json,yaml}\"", "format:fix": "prettier --write \"**/*.{js,cjs,mjs,json,yaml}\"", @@ -65,6 +67,7 @@ ] }, "dependencies": { + "@clack/prompts": "^0.11.0", "@kayvan/markdown-tree-parser": "^1.6.1", "boxen": "^5.1.2", "chalk": "^4.1.2", @@ -75,7 +78,6 @@ "fs-extra": "^11.3.0", "glob": "^11.0.3", "ignore": "^7.0.5", - "inquirer": "^8.2.6", "js-yaml": "^4.1.0", "ora": "^5.4.1", "semver": "^7.6.3", @@ -84,10 +86,11 @@ "yaml": "^2.7.0" }, "devDependencies": { - "@docusaurus/core": "^3.6.0", - "@docusaurus/preset-classic": "^3.6.0", + "@astrojs/sitemap": "^3.6.0", + "@astrojs/starlight": "^0.37.0", "@eslint/js": "^9.33.0", "archiver": "^7.0.1", + "astro": "^5.16.0", "c8": "^10.1.3", "eslint": "^9.33.0", "eslint-config-prettier": "^10.1.8", @@ -98,14 +101,11 @@ "jest": "^30.0.4", "lint-staged": "^16.1.1", "markdownlint-cli2": "^0.19.1", - "prettier": "^3.5.3", + "prettier": "^3.7.4", "prettier-plugin-packagejson": "^2.5.19", - "prism-react-renderer": "^2.4.1", - "react": "^18.3.1", - "react-dom": "^18.3.1", + "sharp": "^0.33.5", "yaml-eslint-parser": "^1.2.3", - "yaml-lint": "^1.7.0", - "zod": "^4.1.12" + "yaml-lint": "^1.7.0" }, "engines": { "node": ">=20.0.0" diff --git a/samples/sample-custom-modules/README.md b/samples/sample-custom-modules/README.md index 23bcee8a..72f6ee39 100644 --- a/samples/sample-custom-modules/README.md +++ b/samples/sample-custom-modules/README.md @@ -4,7 +4,7 @@ These are quickly put together examples of both a stand alone somewhat cohesive To try these out, download either or both folders to your local machine, and run the normal bmad installer, and when asked about custom local content, say yes, and give the path to one of these two folders. You can even install both with other regular modules to the same project. -Note - a project is just a folder with \_bmad in the folder - this can be a software project, but it can also be any type of folder on your local computer - such as a markdown notebook, a folder of other files, or just a folder you maintain with useful agents prompts and utilities for any purpose. +Note - a project is just a folder with `_bmad` in the folder - this can be a software project, but it can also be any type of folder on your local computer - such as a markdown notebook, a folder of other files, or just a folder you maintain with useful agents prompts and utilities for any purpose. Please remember - these are not optimal or very good examples in their utility or quality control - but they do demonstrate the basics of creating custom content and modules to be able to install for yourself or share with others. This is the groundwork for making very complex modules also such as the full bmad method. diff --git a/samples/sample-custom-modules/sample-unitary-module/agents/commit-poet/commit-poet.agent.yaml b/samples/sample-custom-modules/sample-unitary-module/agents/commit-poet/commit-poet.agent.yaml index 21c84868..3b7de937 100644 --- a/samples/sample-custom-modules/sample-unitary-module/agents/commit-poet/commit-poet.agent.yaml +++ b/samples/sample-custom-modules/sample-unitary-module/agents/commit-poet/commit-poet.agent.yaml @@ -4,7 +4,8 @@ agent: name: "Inkwell Von Comitizen" title: "Commit Message Artisan" icon: "📜" - type: simple + module: stand-alone + hasSidecar: false persona: role: | diff --git a/samples/sample-custom-modules/sample-unitary-module/agents/toolsmith/toolsmith-sidecar/knowledge/docs.md b/samples/sample-custom-modules/sample-unitary-module/agents/toolsmith/toolsmith-sidecar/knowledge/docs.md index 26d13df6..83988ac3 100644 --- a/samples/sample-custom-modules/sample-unitary-module/agents/toolsmith/toolsmith-sidecar/knowledge/docs.md +++ b/samples/sample-custom-modules/sample-unitary-module/agents/toolsmith/toolsmith-sidecar/knowledge/docs.md @@ -25,10 +25,6 @@ - @/docs/installers-bundlers/ - Tooling-specific documentation directory - @/tools/cli/README.md - CLI usage documentation (comprehensive) -### IDE-Specific Documentation - -- @/docs/ide-info/ - IDE-specific setup guides (15+ files) - ### Module Documentation Each module may have its own docs: @@ -73,7 +69,6 @@ Follow Keep a Changelog format: When code changes, check these docs: - CLI changes → tools/cli/README.md -- New IDE support → docs/ide-info/ - Schema changes → agent-customization-guide.md - Bundle changes → web-bundles-gemini-gpt-guide.md - Installer changes → installers-bundlers/ diff --git a/samples/sample-custom-modules/sample-unitary-module/agents/toolsmith/toolsmith-sidecar/knowledge/installers.md b/samples/sample-custom-modules/sample-unitary-module/agents/toolsmith/toolsmith-sidecar/knowledge/installers.md index b6f8be22..d3bb907f 100644 --- a/samples/sample-custom-modules/sample-unitary-module/agents/toolsmith/toolsmith-sidecar/knowledge/installers.md +++ b/samples/sample-custom-modules/sample-unitary-module/agents/toolsmith/toolsmith-sidecar/knowledge/installers.md @@ -61,7 +61,7 @@ | -------------- | -------------- | ------------------------- | ----------------------------- | | claude-code | Claude Code | .claude/commands/ | .md with frontmatter | | codex | Codex | (varies) | .md | -| cursor | Cursor | .cursor/rules/bmad/ | .mdc with MDC frontmatter | +| cursor | Cursor | .cursor/commands/bmad/ | .md with YAML frontmatter | | github-copilot | GitHub Copilot | .github/ | .md | | opencode | OpenCode | .opencode/ | .md | | windsurf | Windsurf | .windsurf/workflows/bmad/ | .md with workflow frontmatter | diff --git a/samples/sample-custom-modules/sample-unitary-module/agents/toolsmith/toolsmith-sidecar/knowledge/modules.md b/samples/sample-custom-modules/sample-unitary-module/agents/toolsmith/toolsmith-sidecar/knowledge/modules.md index 663fcc60..fa03b247 100644 --- a/samples/sample-custom-modules/sample-unitary-module/agents/toolsmith/toolsmith-sidecar/knowledge/modules.md +++ b/samples/sample-custom-modules/sample-unitary-module/agents/toolsmith/toolsmith-sidecar/knowledge/modules.md @@ -128,7 +128,7 @@ module.exports = { NewIdeSetup }; | IDE | Config Pattern | File Extension | | -------------- | ------------------------- | -------------- | | Claude Code | .claude/commands/bmad/ | .md | -| Cursor | .cursor/rules/bmad/ | .mdc | +| Cursor | .cursor/commands/bmad/ | .md | | Windsurf | .windsurf/workflows/bmad/ | .md | | GitHub Copilot | .github/ | .md | diff --git a/samples/sample-custom-modules/sample-unitary-module/agents/toolsmith/toolsmith.agent.yaml b/samples/sample-custom-modules/sample-unitary-module/agents/toolsmith/toolsmith.agent.yaml index cd34ee6f..96d82bef 100644 --- a/samples/sample-custom-modules/sample-unitary-module/agents/toolsmith/toolsmith.agent.yaml +++ b/samples/sample-custom-modules/sample-unitary-module/agents/toolsmith/toolsmith.agent.yaml @@ -4,7 +4,7 @@ agent: name: Vexor title: Toolsmith + Guardian of the BMAD Forge icon: ⚒️ - type: expert + module: stand-alone hasSidecar: true persona: role: | diff --git a/samples/sample-custom-modules/sample-unitary-module/workflows/quiz-master/steps/step-01-init.md b/samples/sample-custom-modules/sample-unitary-module/workflows/quiz-master/steps/step-01-init.md index 9ed3ffe2..cb2135c5 100644 --- a/samples/sample-custom-modules/sample-unitary-module/workflows/quiz-master/steps/step-01-init.md +++ b/samples/sample-custom-modules/sample-unitary-module/workflows/quiz-master/steps/step-01-init.md @@ -6,8 +6,8 @@ description: 'Initialize quiz game with mode selection and category choice' workflow_path: '{project-root}/_bmad/custom/src/workflows/quiz-master' # File References -thisStepFile: '{workflow_path}/steps/step-01-init.md' -nextStepFile: '{workflow_path}/steps/step-02-q1.md' +thisStepFile: './step-01-init.md' +nextStepFile: './step-02-q1.md' workflowFile: '{workflow_path}/workflow.md' csvFile: '{project-root}/BMad-quiz-results.csv' csvTemplate: '{workflow_path}/templates/csv-headers.template' @@ -146,7 +146,7 @@ Display: **Starting your quiz adventure...** ## CRITICAL STEP COMPLETION NOTE -ONLY WHEN setup is complete (mode selected, category chosen, CSV initialized) will you then load, read fully, and execute `{workflow_path}/steps/step-02-q1.md` to begin the first question. +ONLY WHEN setup is complete (mode selected, category chosen, CSV initialized) will you then load, read fully, and execute `./step-02-q1.md` to begin the first question. ## 🚨 SYSTEM SUCCESS/FAILURE METRICS diff --git a/samples/sample-custom-modules/sample-unitary-module/workflows/quiz-master/steps/step-02-q1.md b/samples/sample-custom-modules/sample-unitary-module/workflows/quiz-master/steps/step-02-q1.md index 2fe668e1..3141dd3c 100644 --- a/samples/sample-custom-modules/sample-unitary-module/workflows/quiz-master/steps/step-02-q1.md +++ b/samples/sample-custom-modules/sample-unitary-module/workflows/quiz-master/steps/step-02-q1.md @@ -6,9 +6,9 @@ description: 'Question 1 - Level 1 difficulty' workflow_path: '{project-root}/_bmad/custom/src/workflows/quiz-master' # File References -thisStepFile: '{workflow_path}/steps/step-02-q1.md' -nextStepFile: '{workflow_path}/steps/step-03-q2.md' -resultsStepFile: '{workflow_path}/steps/step-12-results.md' +thisStepFile: './step-02-q1.md' +nextStepFile: './step-03-q2.md' +resultsStepFile: './step-12-results.md' workflowFile: '{workflow_path}/workflow.md' csvFile: '{project-root}/BMad-quiz-results.csv' # Task References diff --git a/samples/sample-custom-modules/sample-unitary-module/workflows/quiz-master/steps/step-03-q2.md b/samples/sample-custom-modules/sample-unitary-module/workflows/quiz-master/steps/step-03-q2.md index 489317f9..b7ca00da 100644 --- a/samples/sample-custom-modules/sample-unitary-module/workflows/quiz-master/steps/step-03-q2.md +++ b/samples/sample-custom-modules/sample-unitary-module/workflows/quiz-master/steps/step-03-q2.md @@ -6,9 +6,9 @@ description: 'Question 2 - Level 2 difficulty' workflow_path: '{project-root}/_bmad/custom/src/workflows/quiz-master' # File References -thisStepFile: '{workflow_path}/steps/step-03-q2.md' -nextStepFile: '{workflow_path}/steps/step-04-q3.md' -resultsStepFile: '{workflow_path}/steps/step-12-results.md' +thisStepFile: './step-03-q2.md' +nextStepFile: './step-04-q3.md' +resultsStepFile: './step-12-results.md' workflowFile: '{workflow_path}/workflow.md' csvFile: '{project-root}/BMad-quiz-results.csv' --- diff --git a/samples/sample-custom-modules/sample-unitary-module/workflows/quiz-master/steps/step-04-q3.md b/samples/sample-custom-modules/sample-unitary-module/workflows/quiz-master/steps/step-04-q3.md index 8184f3e5..c16a0d7f 100644 --- a/samples/sample-custom-modules/sample-unitary-module/workflows/quiz-master/steps/step-04-q3.md +++ b/samples/sample-custom-modules/sample-unitary-module/workflows/quiz-master/steps/step-04-q3.md @@ -6,9 +6,9 @@ description: 'Question 3 - Level 3 difficulty' workflow_path: '{project-root}/_bmad/custom/src/workflows/quiz-master' # File References -thisStepFile: '{workflow_path}/steps/step-04-q3.md' -nextStepFile: '{workflow_path}/steps/step-04-q3.md' -resultsStepFile: '{workflow_path}/steps/step-12-results.md' +thisStepFile: './step-04-q3.md' +nextStepFile: './step-04-q3.md' +resultsStepFile: './step-12-results.md' workflowFile: '{workflow_path}/workflow.md' csvFile: '{project-root}/BMad-quiz-results.csv' --- diff --git a/samples/sample-custom-modules/sample-unitary-module/workflows/quiz-master/steps/step-05-q4.md b/samples/sample-custom-modules/sample-unitary-module/workflows/quiz-master/steps/step-05-q4.md index ca8fec89..c5e2414f 100644 --- a/samples/sample-custom-modules/sample-unitary-module/workflows/quiz-master/steps/step-05-q4.md +++ b/samples/sample-custom-modules/sample-unitary-module/workflows/quiz-master/steps/step-05-q4.md @@ -6,9 +6,9 @@ description: 'Question 4 - Level 4 difficulty' workflow_path: '{project-root}/_bmad/custom/src/workflows/quiz-master' # File References -thisStepFile: '{workflow_path}/steps/step-05-q4.md' -nextStepFile: '{workflow_path}/steps/step-05-q4.md' -resultsStepFile: '{workflow_path}/steps/step-12-results.md' +thisStepFile: './step-05-q4.md' +nextStepFile: './step-05-q4.md' +resultsStepFile: './step-12-results.md' workflowFile: '{workflow_path}/workflow.md' csvFile: '{project-root}/BMad-quiz-results.csv' --- diff --git a/samples/sample-custom-modules/sample-unitary-module/workflows/quiz-master/steps/step-06-q5.md b/samples/sample-custom-modules/sample-unitary-module/workflows/quiz-master/steps/step-06-q5.md index d98b43f2..815ee91a 100644 --- a/samples/sample-custom-modules/sample-unitary-module/workflows/quiz-master/steps/step-06-q5.md +++ b/samples/sample-custom-modules/sample-unitary-module/workflows/quiz-master/steps/step-06-q5.md @@ -6,9 +6,9 @@ description: 'Question 5 - Level 5 difficulty' workflow_path: '{project-root}/_bmad/custom/src/workflows/quiz-master' # File References -thisStepFile: '{workflow_path}/steps/step-06-q5.md' -nextStepFile: '{workflow_path}/steps/step-06-q5.md' -resultsStepFile: '{workflow_path}/steps/step-12-results.md' +thisStepFile: './step-06-q5.md' +nextStepFile: './step-06-q5.md' +resultsStepFile: './step-12-results.md' workflowFile: '{workflow_path}/workflow.md' csvFile: '{project-root}/BMad-quiz-results.csv' --- diff --git a/samples/sample-custom-modules/sample-unitary-module/workflows/quiz-master/steps/step-07-q6.md b/samples/sample-custom-modules/sample-unitary-module/workflows/quiz-master/steps/step-07-q6.md index baaf49f1..d216e0f1 100644 --- a/samples/sample-custom-modules/sample-unitary-module/workflows/quiz-master/steps/step-07-q6.md +++ b/samples/sample-custom-modules/sample-unitary-module/workflows/quiz-master/steps/step-07-q6.md @@ -6,9 +6,9 @@ description: 'Question 6 - Level 6 difficulty' workflow_path: '{project-root}/_bmad/custom/src/workflows/quiz-master' # File References -thisStepFile: '{workflow_path}/steps/step-07-q6.md' -nextStepFile: '{workflow_path}/steps/step-07-q6.md' -resultsStepFile: '{workflow_path}/steps/step-12-results.md' +thisStepFile: './step-07-q6.md' +nextStepFile: './step-07-q6.md' +resultsStepFile: './step-12-results.md' workflowFile: '{workflow_path}/workflow.md' csvFile: '{project-root}/BMad-quiz-results.csv' --- diff --git a/samples/sample-custom-modules/sample-unitary-module/workflows/quiz-master/steps/step-08-q7.md b/samples/sample-custom-modules/sample-unitary-module/workflows/quiz-master/steps/step-08-q7.md index 1563fb84..1ca2589c 100644 --- a/samples/sample-custom-modules/sample-unitary-module/workflows/quiz-master/steps/step-08-q7.md +++ b/samples/sample-custom-modules/sample-unitary-module/workflows/quiz-master/steps/step-08-q7.md @@ -6,9 +6,9 @@ description: 'Question 7 - Level 7 difficulty' workflow_path: '{project-root}/_bmad/custom/src/workflows/quiz-master' # File References -thisStepFile: '{workflow_path}/steps/step-08-q7.md' -nextStepFile: '{workflow_path}/steps/step-08-q7.md' -resultsStepFile: '{workflow_path}/steps/step-12-results.md' +thisStepFile: './step-08-q7.md' +nextStepFile: './step-08-q7.md' +resultsStepFile: './step-12-results.md' workflowFile: '{workflow_path}/workflow.md' csvFile: '{project-root}/BMad-quiz-results.csv' --- diff --git a/samples/sample-custom-modules/sample-unitary-module/workflows/quiz-master/steps/step-09-q8.md b/samples/sample-custom-modules/sample-unitary-module/workflows/quiz-master/steps/step-09-q8.md index 8dc7f711..2f1a04eb 100644 --- a/samples/sample-custom-modules/sample-unitary-module/workflows/quiz-master/steps/step-09-q8.md +++ b/samples/sample-custom-modules/sample-unitary-module/workflows/quiz-master/steps/step-09-q8.md @@ -6,9 +6,9 @@ description: 'Question 8 - Level 8 difficulty' workflow_path: '{project-root}/_bmad/custom/src/workflows/quiz-master' # File References -thisStepFile: '{workflow_path}/steps/step-09-q8.md' -nextStepFile: '{workflow_path}/steps/step-09-q8.md' -resultsStepFile: '{workflow_path}/steps/step-12-results.md' +thisStepFile: './step-09-q8.md' +nextStepFile: './step-09-q8.md' +resultsStepFile: './step-12-results.md' workflowFile: '{workflow_path}/workflow.md' csvFile: '{project-root}/BMad-quiz-results.csv' --- diff --git a/samples/sample-custom-modules/sample-unitary-module/workflows/quiz-master/steps/step-10-q9.md b/samples/sample-custom-modules/sample-unitary-module/workflows/quiz-master/steps/step-10-q9.md index 6c76c0fc..d85b1016 100644 --- a/samples/sample-custom-modules/sample-unitary-module/workflows/quiz-master/steps/step-10-q9.md +++ b/samples/sample-custom-modules/sample-unitary-module/workflows/quiz-master/steps/step-10-q9.md @@ -6,9 +6,9 @@ description: 'Question 9 - Level 9 difficulty' workflow_path: '{project-root}/_bmad/custom/src/workflows/quiz-master' # File References -thisStepFile: '{workflow_path}/steps/step-10-q9.md' -nextStepFile: '{workflow_path}/steps/step-10-q9.md' -resultsStepFile: '{workflow_path}/steps/step-12-results.md' +thisStepFile: './step-10-q9.md' +nextStepFile: './step-10-q9.md' +resultsStepFile: './step-12-results.md' workflowFile: '{workflow_path}/workflow.md' csvFile: '{project-root}/BMad-quiz-results.csv' --- diff --git a/samples/sample-custom-modules/sample-unitary-module/workflows/quiz-master/steps/step-11-q10.md b/samples/sample-custom-modules/sample-unitary-module/workflows/quiz-master/steps/step-11-q10.md index 4468c937..22eb6ebe 100644 --- a/samples/sample-custom-modules/sample-unitary-module/workflows/quiz-master/steps/step-11-q10.md +++ b/samples/sample-custom-modules/sample-unitary-module/workflows/quiz-master/steps/step-11-q10.md @@ -6,9 +6,9 @@ description: 'Question 10 - Level 10 difficulty' workflow_path: '{project-root}/_bmad/custom/src/workflows/quiz-master' # File References -thisStepFile: '{workflow_path}/steps/step-11-q10.md' -nextStepFile: '{workflow_path}/steps/results.md' -resultsStepFile: '{workflow_path}/steps/step-12-results.md' +thisStepFile: './step-11-q10.md' +nextStepFile: './results.md' +resultsStepFile: './step-12-results.md' workflowFile: '{workflow_path}/workflow.md' csvFile: '{project-root}/BMad-quiz-results.csv' --- diff --git a/samples/sample-custom-modules/sample-unitary-module/workflows/quiz-master/steps/step-12-results.md b/samples/sample-custom-modules/sample-unitary-module/workflows/quiz-master/steps/step-12-results.md index a0eb36d8..0d20ccfb 100644 --- a/samples/sample-custom-modules/sample-unitary-module/workflows/quiz-master/steps/step-12-results.md +++ b/samples/sample-custom-modules/sample-unitary-module/workflows/quiz-master/steps/step-12-results.md @@ -6,8 +6,8 @@ description: 'Final results and celebration' workflow_path: '{project-root}/_bmad/custom/src/workflows/quiz-master' # File References -thisStepFile: '{workflow_path}/steps/step-12-results.md' -initStepFile: '{workflow_path}/steps/step-01-init.md' +thisStepFile: './step-12-results.md' +initStepFile: './step-01-init.md' workflowFile: '{workflow_path}/workflow.md' csvFile: '{project-root}/BMad-quiz-results.csv' # Task References diff --git a/samples/sample-custom-modules/sample-unitary-module/workflows/quiz-master/workflow.md b/samples/sample-custom-modules/sample-unitary-module/workflows/quiz-master/workflow.md index badf9c51..b446773d 100644 --- a/samples/sample-custom-modules/sample-unitary-module/workflows/quiz-master/workflow.md +++ b/samples/sample-custom-modules/sample-unitary-module/workflows/quiz-master/workflow.md @@ -51,4 +51,4 @@ Load and read full config from {project-root}/_bmad/bmb/config.yaml and resolve: ### 2. First Step EXECUTION -Load, read the full file and then execute {workflow_path}/steps/step-01-init.md to begin the workflow. +Load, read the full file and then execute ./step-01-init.md to begin the workflow. diff --git a/samples/sample-custom-modules/sample-wellness-module/agents/meditation-guide.agent.yaml b/samples/sample-custom-modules/sample-wellness-module/agents/meditation-guide.agent.yaml index 0916de83..1b9f7576 100644 --- a/samples/sample-custom-modules/sample-wellness-module/agents/meditation-guide.agent.yaml +++ b/samples/sample-custom-modules/sample-wellness-module/agents/meditation-guide.agent.yaml @@ -5,6 +5,7 @@ agent: title: "Meditation Guide" icon: "🧘" module: "mwm" + hasSidecar: false persona: role: "Mindfulness and meditation specialist" identity: | diff --git a/src/core/agents/bmad-master.agent.yaml b/src/core/agents/bmad-master.agent.yaml index a7338d49..50debe2c 100644 --- a/src/core/agents/bmad-master.agent.yaml +++ b/src/core/agents/bmad-master.agent.yaml @@ -7,6 +7,7 @@ agent: name: "BMad Master" title: "BMad Master Executor, Knowledge Custodian, and Workflow Orchestrator" icon: "🧙" + hasSidecar: false persona: role: "Master Task Executor + BMad Expert + Guiding Facilitator Orchestrator" @@ -17,18 +18,13 @@ agent: critical_actions: - "Load into memory {project-root}/_bmad/core/config.yaml and set variable project_name, output_folder, user_name, communication_language" - - "Remember the users name is {user_name}" - "ALWAYS communicate in {communication_language}" menu: - - trigger: "list-tasks" + - trigger: "LT or fuzzy match on list-tasks" action: "list all tasks from {project-root}/_bmad/_config/task-manifest.csv" - description: "List Available Tasks" + description: "[LT] List Available Tasks" - - trigger: "list-workflows" + - trigger: "LW or fuzzy match on list-workflows" action: "list all workflows from {project-root}/_bmad/_config/workflow-manifest.csv" - description: "List Workflows" - - - trigger: "party-mode" - exec: "{project-root}/_bmad/core/workflows/party-mode/workflow.md" - description: "Group chat with all agents" + description: "[LW] List Workflows" diff --git a/src/core/tasks/editorial-review-prose.xml b/src/core/tasks/editorial-review-prose.xml new file mode 100644 index 00000000..f6714b43 --- /dev/null +++ b/src/core/tasks/editorial-review-prose.xml @@ -0,0 +1,91 @@ + + + Review text for communication issues that impede comprehension and output suggested fixes in a three-column table + + + + + + + + MANDATORY: Execute ALL steps in the flow section IN EXACT ORDER + DO NOT skip steps or change the sequence + HALT immediately when halt-conditions are met + Each action xml tag within step xml tag is a REQUIRED action to complete that step + + You are a clinical copy-editor: precise, professional, neither warm nor cynical + Apply Microsoft Writing Style Guide principles as your baseline + Focus on communication issues that impede comprehension - not style preferences + NEVER rewrite for preference - only fix genuine issues + + CONTENT IS SACROSANCT: Never challenge ideas—only clarify how they're expressed. + + + Minimal intervention: Apply the smallest fix that achieves clarity + Preserve structure: Fix prose within existing structure, never restructure + Skip code/markup: Detect and skip code blocks, frontmatter, structural markup + When uncertain: Flag with a query rather than suggesting a definitive change + Deduplicate: Same issue in multiple places = one entry with locations listed + No conflicts: Merge overlapping fixes into single entries + Respect author voice: Preserve intentional stylistic choices + + + + + + + Check if content is empty or contains fewer than 3 words + HALT with error: "Content too short for editorial review (minimum 3 words required)" + Validate reader_type is "humans" or "llm" (or not provided, defaulting to "humans") + HALT with error: "Invalid reader_type. Must be 'humans' or 'llm'" + Identify content type (markdown, plain text, XML with text) + Note any code blocks, frontmatter, or structural markup to skip + + + + Analyze the style, tone, and voice of the input text + Note any intentional stylistic choices to preserve (informal tone, technical jargon, rhetorical patterns) + Calibrate review approach based on reader_type parameter + Prioritize: unambiguous references, consistent terminology, explicit structure, no hedging + Prioritize: clarity, flow, readability, natural progression + + + + Review all prose sections (skip code blocks, frontmatter, structural markup) + Identify communication issues that impede comprehension + For each issue, determine the minimal fix that achieves clarity + Deduplicate: If same issue appears multiple times, create one entry listing all locations + Merge overlapping issues into single entries (no conflicting suggestions) + For uncertain fixes, phrase as query: "Consider: [suggestion]?" rather than definitive change + Preserve author voice - do not "improve" intentional stylistic choices + + + + Output a three-column markdown table with all suggested fixes + Output: "No editorial issues identified" + + +| Original Text | Revised Text | Changes | +|---------------|--------------|---------| +| The exact original passage | The suggested revision | Brief explanation of what changed and why | + + + +| Original Text | Revised Text | Changes | +|---------------|--------------|---------| +| The system will processes data and it handles errors. | The system processes data and handles errors. | Fixed subject-verb agreement ("will processes" to "processes"); removed redundant "it" | +| Users can chose from options (lines 12, 45, 78) | Users can choose from options | Fixed spelling: "chose" to "choose" (appears in 3 locations) | + + + + + + HALT with error if content is empty or fewer than 3 words + HALT with error if reader_type is not "humans" or "llm" + If no issues found after thorough review, output "No editorial issues identified" (this is valid completion, not an error) + + + diff --git a/src/core/tasks/editorial-review-structure.xml b/src/core/tasks/editorial-review-structure.xml new file mode 100644 index 00000000..26ef400a --- /dev/null +++ b/src/core/tasks/editorial-review-structure.xml @@ -0,0 +1,198 @@ + + + + Review document structure and propose substantive changes + to improve clarity and flow-run this BEFORE copy editing + + + + + + + + + MANDATORY: Execute ALL steps in the flow section IN EXACT ORDER + DO NOT skip steps or change the sequence + HALT immediately when halt-conditions are met + Each action xml tag within step xml tag is a REQUIRED action to complete that step + You are a structural editor focused on HIGH-VALUE DENSITY + Brevity IS clarity: Concise writing respects limited attention spans and enables effective scanning + Every section must justify its existence-cut anything that delays understanding + True redundancy is failure + + Comprehension through calibration: Optimize for the minimum words needed to maintain understanding + Front-load value: Critical information comes first; nice-to-know comes last (or goes) + One source of truth: If information appears identically twice, consolidate + Scope discipline: Content that belongs in a different document should be cut or linked + Propose, don't execute: Output recommendations-user decides what to accept + CONTENT IS SACROSANCT: Never challenge ideas—only optimize how they're organized. + + + These elements serve human comprehension and engagement-preserve unless clearly wasteful: + Visual aids: Diagrams, images, and flowcharts anchor understanding + Expectation-setting: "What You'll Learn" helps readers confirm they're in the right place + Reader's Journey: Organize content biologically (linear progression), not logically (database) + Mental models: Overview before details prevents cognitive overload + Warmth: Encouraging tone reduces anxiety for new users + Whitespace: Admonitions and callouts provide visual breathing room + Summaries: Recaps help retention; they're reinforcement, not redundancy + Examples: Concrete illustrations make abstract concepts accessible + Engagement: "Flow" techniques (transitions, variety) are functional, not "fluff"-they maintain attention + + + When reader_type='llm', optimize for PRECISION and UNAMBIGUITY: + Dependency-first: Define concepts before usage to minimize hallucination risk + Cut emotional language, encouragement, and orientation sections + + IF concept is well-known from training (e.g., "conventional + commits", "REST APIs"): Reference the standard-don't re-teach it + ELSE: Be explicit-don't assume the LLM will infer correctly + + Use consistent terminology-same word for same concept throughout + Eliminate hedging ("might", "could", "generally")-use direct statements + Prefer structured formats (tables, lists, YAML) over prose + Reference known standards ("conventional commits", "Google style guide") to leverage training + STILL PROVIDE EXAMPLES even for known standards-grounds the LLM in your specific expectation + Unambiguous references-no unclear antecedents ("it", "this", "the above") + Note: LLM documents may be LONGER than human docs in some areas + (more explicit) while shorter in others (no warmth) + + + + Prerequisites: Setup/Context MUST precede action + Sequence: Steps must follow strict chronological or logical dependency order + Goal-oriented: clear 'Definition of Done' at the end + + + Random Access: No narrative flow required; user jumps to specific item + MECE: Topics are Mutually Exclusive and Collectively Exhaustive + Consistent Schema: Every item follows identical structure (e.g., Signature to Params to Returns) + + + Abstract to Concrete: Definition to Context to Implementation/Example + Scaffolding: Complex ideas built on established foundations + + + Meta-first: Inputs, usage constraints, and context defined before instructions + Separation of Concerns: Instructions (logic) separate from Data (content) + Step-by-step: Execution flow must be explicit and ordered + + + Top-down: Conclusion/Status/Recommendation starts the document + Grouping: Supporting context grouped logically below the headline + Ordering: Most critical information first + MECE: Arguments/Groups are Mutually Exclusive and Collectively Exhaustive + Evidence: Data supports arguments, never leads + + + + + + Check if content is empty or contains fewer than 3 words + HALT with error: "Content + too short for substantive review (minimum 3 words required)" + Validate reader_type is "humans" or "llm" (or not provided, defaulting to "humans") + HALT with error: "Invalid reader_type. Must be 'humans' or 'llm'" + Identify document type and structure (headings, sections, lists, etc.) + Note the current word count and section count + + + If purpose was provided, use it; otherwise infer from content + If target_audience was provided, use it; otherwise infer from content + Identify the core question the document answers + State in one sentence: "This document exists to help [audience] accomplish [goal]" + Select the most appropriate structural model from structure-models based on purpose/audience + Note reader_type and which principles apply (human-reader-principles or llm-reader-principles) + + + Map the document structure: list each major section with its word count + Evaluate structure against the selected model's primary rules + (e.g., 'Does recommendation come first?' for Pyramid) + For each section, answer: Does this directly serve the stated purpose? + For each comprehension aid (visual, + summary, example, callout), answer: Does this help readers + understand or stay engaged? + Identify sections that could be: cut entirely, merged with + another, moved to a different location, or split + Identify true redundancies: identical information repeated + without purpose (not summaries or reinforcement) + Identify scope violations: content that belongs in a different document + Identify burying: critical information hidden deep in the document + + + Assess the reader's journey: Does the sequence match how readers will use this? + Identify premature detail: explanation given before the reader needs it + Identify missing scaffolding: complex ideas without adequate setup + Identify anti-patterns: FAQs that should be inline, appendices + that should be cut, overviews that repeat the body verbatim + Assess pacing: Is there enough + whitespace and visual variety to maintain attention? + + + Compile all findings into prioritized recommendations + Categorize each recommendation: CUT (remove entirely), + MERGE (combine sections), MOVE (reorder), CONDENSE (shorten + significantly), QUESTION (needs author decision), PRESERVE + (explicitly keep-for elements that might seem cuttable but + serve comprehension) + For each recommendation, state the rationale in one sentence + Estimate impact: how many words would this save (or cost, for PRESERVE)? + If length_target was provided, assess whether recommendations meet it + Flag with warning: "This cut may impact + reader comprehension/engagement" + + + Output document summary (purpose, audience, reader_type, current length) + Output the recommendation list in priority order + Output estimated total reduction if all recommendations accepted + Output: "No substantive changes recommended-document structure is sound" + +## Document Summary +- **Purpose:** [inferred or provided purpose] +- **Audience:** [inferred or provided audience] +- **Reader type:** [selected reader type] +- **Structure model:** [selected structure model] +- **Current length:** [X] words across [Y] sections + +## Recommendations + +### 1. [CUT/MERGE/MOVE/CONDENSE/QUESTION/PRESERVE] - [Section or element name] +**Rationale:** [One sentence explanation] +**Impact:** ~[X] words +**Comprehension note:** [If applicable, note impact on reader understanding] + +### 2. ... + +## Summary +- **Total recommendations:** [N] +- **Estimated reduction:** [X] words ([Y]% of original) +- **Meets length target:** [Yes/No/No target specified] +- **Comprehension trade-offs:** [Note any cuts that sacrifice reader engagement for brevity] + + + + + HALT with error if content is empty or fewer than 3 words + HALT with error if reader_type is not "humans" or "llm" + If no structural issues found, output "No substantive changes + recommended" (this is valid completion, not an error) + + diff --git a/src/core/tasks/review-adversarial-general.xml b/src/core/tasks/review-adversarial-general.xml index 6e5df408..4e68ff9a 100644 --- a/src/core/tasks/review-adversarial-general.xml +++ b/src/core/tasks/review-adversarial-general.xml @@ -9,6 +9,11 @@ + MANDATORY: Execute ALL steps in the flow section IN EXACT ORDER + DO NOT skip steps or change the sequence + HALT immediately when halt-conditions are met + Each action xml tag within step xml tag is a REQUIRED action to complete that step + You are a cynical, jaded reviewer with zero patience for sloppy work The content was submitted by a clueless weasel and you expect to find problems Be skeptical of everything diff --git a/src/core/tools/shard-doc.xml b/src/core/tasks/shard-doc.xml similarity index 98% rename from src/core/tools/shard-doc.xml rename to src/core/tasks/shard-doc.xml index 551c8965..cd1dd674 100644 --- a/src/core/tools/shard-doc.xml +++ b/src/core/tasks/shard-doc.xml @@ -1,4 +1,4 @@ - Split large markdown documents into smaller, organized files based on level 2 sections using @kayvan/markdown-tree-parser tool @@ -106,4 +106,4 @@ HALT if npx command fails or produces no output files - \ No newline at end of file + \ No newline at end of file diff --git a/src/core/tasks/validate-workflow.xml b/src/core/tasks/validate-workflow.xml deleted file mode 100644 index 663622a4..00000000 --- a/src/core/tasks/validate-workflow.xml +++ /dev/null @@ -1,89 +0,0 @@ - - Run a checklist against a document with thorough analysis and produce a validation report - - - - - - - - - - If checklist not provided, load checklist.md from workflow location - Try to fuzzy match for files similar to the input document name or if user did not provide the document. If document not - provided or unsure, ask user: "Which document should I validate?" - Load both the checklist and document - - - - For EVERY checklist item, WITHOUT SKIPPING ANY: - - - Read requirement carefully - Search document for evidence along with any ancillary loaded documents or artifacts (quotes with line numbers) - Analyze deeply - look for explicit AND implied coverage - - - ✓ PASS - Requirement fully met (provide evidence) - ⚠ PARTIAL - Some coverage but incomplete (explain gaps) - ✗ FAIL - Not met or severely deficient (explain why) - ➖ N/A - Not applicable (explain reason) - - - - DO NOT SKIP ANY SECTIONS OR ITEMS - - - - Create validation-report-{timestamp}.md in document's folder - - - # Validation Report - - **Document:** {document-path} - **Checklist:** {checklist-path} - **Date:** {timestamp} - - ## Summary - - Overall: X/Y passed (Z%) - - Critical Issues: {count} - - ## Section Results - - ### {Section Name} - Pass Rate: X/Y (Z%) - - {For each item:} - [MARK] {Item description} - Evidence: {Quote with line# or explanation} - {If FAIL/PARTIAL: Impact: {why this matters}} - - ## Failed Items - {All ✗ items with recommendations} - - ## Partial Items - {All ⚠ items with what's missing} - - ## Recommendations - 1. Must Fix: {critical failures} - 2. Should Improve: {important gaps} - 3. Consider: {minor improvements} - - - - - Present section-by-section summary - Highlight all critical issues - Provide path to saved report - HALT - do not continue unless user asks - - - - - NEVER skip sections - validate EVERYTHING - ALWAYS provide evidence (quotes + line numbers) for marks - Think deeply about each requirement - don't rush - Save report to document's folder automatically - HALT after presenting summary - wait for user - - \ No newline at end of file diff --git a/src/core/tasks/workflow.xml b/src/core/tasks/workflow.xml index c04421f2..09f5d04a 100644 --- a/src/core/tasks/workflow.xml +++ b/src/core/tasks/workflow.xml @@ -74,7 +74,7 @@ Display generated content [a] Advanced Elicitation, [c] Continue, [p] Party-Mode, [y] YOLO the rest of this document only. WAIT for response. - Start the advanced elicitation workflow {project-root}/_bmad/core/tasks/advanced-elicitation.xml + Start the advanced elicitation workflow {project-root}/_bmad/core/workflows/advanced-elicitation/workflow.xml diff --git a/src/core/tasks/advanced-elicitation-methods.csv b/src/core/workflows/advanced-elicitation/methods.csv similarity index 100% rename from src/core/tasks/advanced-elicitation-methods.csv rename to src/core/workflows/advanced-elicitation/methods.csv diff --git a/src/core/tasks/advanced-elicitation.xml b/src/core/workflows/advanced-elicitation/workflow.xml similarity index 95% rename from src/core/tasks/advanced-elicitation.xml rename to src/core/workflows/advanced-elicitation/workflow.xml index 3263dddf..8a348d9e 100644 --- a/src/core/tasks/advanced-elicitation.xml +++ b/src/core/workflows/advanced-elicitation/workflow.xml @@ -1,5 +1,5 @@ - MANDATORY: Execute ALL steps in the flow section IN EXACT ORDER @@ -7,6 +7,7 @@ HALT immediately when halt-conditions are met Each action xml tag within step xml tag is a REQUIRED action to complete that step Sections outside flow (validation, output, critical-context) provide essential context - review and apply throughout execution + YOU MUST ALWAYS SPEAK OUTPUT In your Agent communication style with the `communication_language` diff --git a/src/core/workflows/brainstorming/steps/step-01-session-setup.md b/src/core/workflows/brainstorming/steps/step-01-session-setup.md index 54a0f636..ab90f990 100644 --- a/src/core/workflows/brainstorming/steps/step-01-session-setup.md +++ b/src/core/workflows/brainstorming/steps/step-01-session-setup.md @@ -7,6 +7,7 @@ - 📋 YOU ARE A FACILITATOR, not a content generator - 💬 FOCUS on session setup and continuation detection only - 🚪 DETECT existing workflow state and handle continuation properly +- ✅ YOU MUST ALWAYS SPEAK OUTPUT In your Agent communication style with the `communication_language` ## EXECUTION PROTOCOLS: diff --git a/src/core/workflows/brainstorming/steps/step-01b-continue.md b/src/core/workflows/brainstorming/steps/step-01b-continue.md index 2f26850e..ee788b7d 100644 --- a/src/core/workflows/brainstorming/steps/step-01b-continue.md +++ b/src/core/workflows/brainstorming/steps/step-01b-continue.md @@ -7,6 +7,7 @@ - 📋 UNDERSTAND PREVIOUS SESSION context and outcomes - 🔍 SEAMLESSLY RESUME from where user left off - 💬 MAINTAIN CONTINUITY in session flow and rapport +- ✅ YOU MUST ALWAYS SPEAK OUTPUT In your Agent communication style with the `communication_language` ## EXECUTION PROTOCOLS: diff --git a/src/core/workflows/brainstorming/steps/step-02a-user-selected.md b/src/core/workflows/brainstorming/steps/step-02a-user-selected.md index 0113b940..2b523db8 100644 --- a/src/core/workflows/brainstorming/steps/step-02a-user-selected.md +++ b/src/core/workflows/brainstorming/steps/step-02a-user-selected.md @@ -7,6 +7,7 @@ - 📋 PREVIEW TECHNIQUE OPTIONS clearly and concisely - 🔍 LET USER EXPLORE and select based on their interests - 💬 PROVIDE BACK OPTION to return to approach selection +- ✅ YOU MUST ALWAYS SPEAK OUTPUT In your Agent communication style with the `communication_language` ## EXECUTION PROTOCOLS: diff --git a/src/core/workflows/brainstorming/steps/step-02b-ai-recommended.md b/src/core/workflows/brainstorming/steps/step-02b-ai-recommended.md index 7b60ba8d..f928ff04 100644 --- a/src/core/workflows/brainstorming/steps/step-02b-ai-recommended.md +++ b/src/core/workflows/brainstorming/steps/step-02b-ai-recommended.md @@ -7,6 +7,7 @@ - 📋 LOAD TECHNIQUES ON-DEMAND from brain-methods.csv for recommendations - 🔍 MATCH TECHNIQUES to user goals, constraints, and preferences - 💬 PROVIDE CLEAR RATIONALE for each recommendation +- ✅ YOU MUST ALWAYS SPEAK OUTPUT In your Agent communication style with the `communication_language` ## EXECUTION PROTOCOLS: @@ -141,7 +142,7 @@ Provide deeper insight into each recommended technique: ### 5. Get User Confirmation -"\*\*This AI-recommended sequence is designed specifically for your [session_topic] goals, considering your [constraints] and focusing on [primary_outcome]. +"This AI-recommended sequence is designed specifically for your [session_topic] goals, considering your [constraints] and focusing on [primary_outcome]. **Does this approach sound perfect for your session?** diff --git a/src/core/workflows/brainstorming/steps/step-02c-random-selection.md b/src/core/workflows/brainstorming/steps/step-02c-random-selection.md index 220eb796..def91d0a 100644 --- a/src/core/workflows/brainstorming/steps/step-02c-random-selection.md +++ b/src/core/workflows/brainstorming/steps/step-02c-random-selection.md @@ -7,6 +7,7 @@ - 📋 LOAD TECHNIQUES ON-DEMAND from brain-methods.csv - 🔍 CREATE EXCITEMENT around unexpected creative methods - 💬 EMPHASIZE DISCOVERY over predictable outcomes +- ✅ YOU MUST ALWAYS SPEAK OUTPUT In your Agent communication style with the `communication_language` ## EXECUTION PROTOCOLS: diff --git a/src/core/workflows/brainstorming/steps/step-02d-progressive-flow.md b/src/core/workflows/brainstorming/steps/step-02d-progressive-flow.md index 7e72314d..96aa2d90 100644 --- a/src/core/workflows/brainstorming/steps/step-02d-progressive-flow.md +++ b/src/core/workflows/brainstorming/steps/step-02d-progressive-flow.md @@ -7,6 +7,7 @@ - 📋 LOAD TECHNIQUES ON-DEMAND from brain-methods.csv for each phase - 🔍 MATCH TECHNIQUES to natural creative progression stages - 💬 CREATE CLEAR JOURNEY MAP with phase transitions +- ✅ YOU MUST ALWAYS SPEAK OUTPUT In your Agent communication style with the `communication_language` ## EXECUTION PROTOCOLS: diff --git a/src/core/workflows/brainstorming/steps/step-03-technique-execution.md b/src/core/workflows/brainstorming/steps/step-03-technique-execution.md index e0edbad0..5df8f911 100644 --- a/src/core/workflows/brainstorming/steps/step-03-technique-execution.md +++ b/src/core/workflows/brainstorming/steps/step-03-technique-execution.md @@ -1,18 +1,36 @@ # Step 3: Interactive Technique Execution and Facilitation +--- +advancedElicitationTask: '{project-root}/_bmad/core/workflows/advanced-elicitation/workflow.xml' +--- + ## MANDATORY EXECUTION RULES (READ FIRST): - ✅ YOU ARE A CREATIVE FACILITATOR, engaging in genuine back-and-forth coaching +- 🎯 AIM FOR 100+ IDEAS before suggesting organization - quantity unlocks quality (quality must grow as we progress) +- 🔄 DEFAULT IS TO KEEP EXPLORING - only move to organization when user explicitly requests it +- 🧠 **THOUGHT BEFORE INK (CoT):** Before generating each idea, you must internally reason: "What domain haven't we explored yet? What would make this idea surprising or 'uncomfortable' for the user?" +- 🛡️ **ANTI-BIAS DOMAIN PIVOT:** Every 10 ideas, review existing themes and consciously pivot to an orthogonal domain (e.g., UX -> Business -> Physics -> Social Impact). +- 🌡️ **SIMULATED TEMPERATURE:** Act as if your creativity is set to 0.85 - take wilder leaps and suggest "provocative" concepts. +- ⏱️ Spend minimum 30-45 minutes in active ideation before offering to conclude - 🎯 EXECUTE ONE TECHNIQUE ELEMENT AT A TIME with interactive exploration - 📋 RESPOND DYNAMICALLY to user insights and build upon their ideas - 🔍 ADAPT FACILITATION based on user engagement and emerging directions - 💬 CREATE TRUE COLLABORATION, not question-answer sequences +- ✅ YOU MUST ALWAYS SPEAK OUTPUT In your Agent communication style with the `communication_language` + +## IDEA FORMAT TEMPLATE: + +Every idea you capture should follow this structure: +**[Category #X]**: [Mnemonic Title] +_Concept_: [2-3 sentence description] +_Novelty_: [What makes this different from obvious solutions] ## EXECUTION PROTOCOLS: - 🎯 Present one technique element at a time for deep exploration - ⚠️ Ask "Continue with current technique?" before moving to next technique -- 💾 Document insights and ideas as they emerge organically +- 💾 Document insights and ideas using the **IDEA FORMAT TEMPLATE** - 📖 Follow user's creative energy and interests within technique structure - 🚫 FORBIDDEN rushing through technique elements without user engagement @@ -141,6 +159,26 @@ Before moving to next technique element: **Remember:** At any time, just say **"next technique"** or **"move on"** and I'll immediately document our current progress and start the next technique!" +### 4.1. Energy Checkpoint (After Every 4-5 Exchanges) + +**Periodic Check-In (DO NOT skip this):** + +"We've generated [X] ideas so far - great momentum! + +**Quick energy check:** + +- Want to **keep pushing** on this angle? +- **Switch techniques** for a fresh perspective? +- Or are you feeling like we've **thoroughly explored** this space? + +Remember: The goal is quantity first - we can organize later. What feels right?" + +**IMPORTANT:** Default to continuing exploration. Only suggest organization if: + +- User has explicitly asked to wrap up, OR +- You've been exploring for 45+ minutes AND generated 100+ ideas, OR +- User's energy is clearly depleted (short responses, "I don't know", etc.) + ### 4a. Handle Immediate Technique Transition **When user says "next technique" or "move on":** @@ -207,13 +245,15 @@ This connects beautifully with what we discovered earlier about _[previous conne **After Deep Exploration:** -"Let me summarize what we've uncovered in this exploration: +"Let me summarize what we've uncovered in this exploration using our **IDEA FORMAT TEMPLATE**: **Key Ideas Generated:** -- **[Idea 1]:** [Context and development] -- **[Idea 2]:** [How this emerged and evolved] -- **[Idea 3]:** [User's insight plus your coaching contribution] +**[Category #X]**: [Mnemonic Title] +_Concept_: [2-3 sentence description] +_Novelty_: [What makes this different from obvious solutions] + +(Repeat for all ideas generated) **Creative Breakthrough:** [Most innovative insight from the dialogue] @@ -242,17 +282,29 @@ After final technique element: **Before we move to idea organization, any final thoughts about this technique? Any insights you want to make sure we carry forward?** -**Ready to organize all these brilliant ideas and identify your top priorities?** -[C] Continue - Organize ideas and create action plans +**What would you like to do next?** -### 8. Handle Continue Selection +[K] **Keep exploring this technique** - We're just getting warmed up! +[T] **Try a different technique** - Fresh perspective on the same topic +[A] **Go deeper on a specific idea** - Develop a promising concept further (Advanced Elicitation) +[B] **Take a quick break** - Pause and return with fresh energy +[C] **Move to organization** - Only when you feel we've thoroughly explored -#### If 'C' (Continue): +**Default recommendation:** Unless you feel we've generated at least 100+ ideas, I suggest we keep exploring! The best insights often come after the obvious ideas are exhausted. + +### 8. Handle Menu Selection + +#### If 'C' (Move to organization): - **Append the technique execution content to `{output_folder}/analysis/brainstorming-session-{{date}}.md`** - **Update frontmatter:** `stepsCompleted: [1, 2, 3]` - **Load:** `./step-04-idea-organization.md` +#### If 'K', 'T', 'A', or 'B' (Continue Exploring): + +- **Stay in Step 3** and restart the facilitation loop for the chosen path (or pause if break requested). +- For option A, invoke Advanced Elicitation: `{advancedElicitationTask}` + ### 9. Update Documentation Update frontmatter and document with interactive session insights: @@ -278,6 +330,7 @@ facilitation_notes: [key insights about user's creative process] - **Interactive Focus:** [Main exploration directions] - **Key Breakthroughs:** [Major insights from coaching dialogue] + - **User Creative Strengths:** [What user demonstrated] - **Energy Level:** [Observation about engagement] @@ -307,6 +360,9 @@ When user selects 'C', append the content directly to `{output_folder}/analysis/ ## SUCCESS METRICS: +✅ Minimum 100 ideas generated before organization is offered +✅ User explicitly confirms readiness to conclude (not AI-initiated) +✅ Multiple technique exploration encouraged over single-technique completion ✅ True back-and-forth facilitation rather than question-answer format ✅ User's creative energy and interests guide technique direction ✅ Deep exploration of promising ideas before moving on @@ -317,6 +373,10 @@ When user selects 'C', append the content directly to `{output_folder}/analysis/ ## FAILURE MODES: +❌ Offering organization after only one technique or <20 ideas +❌ AI initiating conclusion without user explicitly requesting it +❌ Treating technique completion as session completion signal +❌ Rushing to document rather than staying in generative mode ❌ Rushing through technique elements without user engagement ❌ Not following user's creative energy and interests ❌ Missing opportunities to develop promising ideas deeper diff --git a/src/core/workflows/brainstorming/steps/step-04-idea-organization.md b/src/core/workflows/brainstorming/steps/step-04-idea-organization.md index 1296d2ab..240a53da 100644 --- a/src/core/workflows/brainstorming/steps/step-04-idea-organization.md +++ b/src/core/workflows/brainstorming/steps/step-04-idea-organization.md @@ -7,6 +7,7 @@ - 📋 CREATE ACTIONABLE NEXT STEPS from brainstorming outcomes - 🔍 FACILITATE CONVERGENT THINKING after divergent exploration - 💬 DELIVER COMPREHENSIVE SESSION DOCUMENTATION +- ✅ YOU MUST ALWAYS SPEAK OUTPUT In your Agent communication style with the `communication_language` ## EXECUTION PROTOCOLS: diff --git a/src/core/workflows/brainstorming/workflow.md b/src/core/workflows/brainstorming/workflow.md index 1ddc38b9..30ab779d 100644 --- a/src/core/workflows/brainstorming/workflow.md +++ b/src/core/workflows/brainstorming/workflow.md @@ -8,7 +8,13 @@ context_file: '' # Optional context file path for project-specific guidance **Goal:** Facilitate interactive brainstorming sessions using diverse creative techniques and ideation methods -**Your Role:** You are a brainstorming facilitator and creative thinking guide. You bring structured creativity techniques, facilitation expertise, and an understanding of how to guide users through effective ideation processes that generate innovative ideas and breakthrough solutions. +**Your Role:** You are a brainstorming facilitator and creative thinking guide. You bring structured creativity techniques, facilitation expertise, and an understanding of how to guide users through effective ideation processes that generate innovative ideas and breakthrough solutions. During this entire workflow it is critical that you speak to the user in the config loaded `communication_language`. + +**Critical Mindset:** Your job is to keep the user in generative exploration mode as long as possible. The best brainstorming sessions feel slightly uncomfortable - like you've pushed past the obvious ideas into truly novel territory. Resist the urge to organize or conclude. When in doubt, ask another question, try another technique, or dig deeper into a promising thread. + +**Anti-Bias Protocol:** LLMs naturally drift toward semantic clustering (sequential bias). To combat this, you MUST consciously shift your creative domain every 10 ideas. If you've been focusing on technical aspects, pivot to user experience, then to business viability, then to edge cases or "black swan" events. Force yourself into orthogonal categories to maintain true divergence. + +**Quantity Goal:** Aim for 100+ ideas before any organization. The first 20 ideas are usually obvious - the magic happens in ideas 50-100. --- @@ -41,6 +47,7 @@ Load config from `{project-root}/_bmad/core/config.yaml` and resolve: - `brain_techniques_path` = `{installed_path}/brain-methods.csv` - `default_output_file` = `{output_folder}/analysis/brainstorming-session-{{date}}.md` - `context_file` = Optional context file path from workflow invocation for project-specific guidance +- `advancedElicitationTask` = `{project-root}/_bmad/core/workflows/advanced-elicitation/workflow.xml` --- diff --git a/src/core/workflows/party-mode/steps/step-01-agent-loading.md b/src/core/workflows/party-mode/steps/step-01-agent-loading.md index acd02879..80fc4cb9 100644 --- a/src/core/workflows/party-mode/steps/step-01-agent-loading.md +++ b/src/core/workflows/party-mode/steps/step-01-agent-loading.md @@ -7,6 +7,7 @@ - 📋 LOAD COMPLETE AGENT ROSTER from manifest with merged personalities - 🔍 PARSE AGENT DATA for conversation orchestration - 💬 INTRODUCE DIVERSE AGENT SAMPLE to kick off discussion +- ✅ YOU MUST ALWAYS SPEAK OUTPUT In your Agent communication style with the config `{communication_language}` ## EXECUTION PROTOCOLS: diff --git a/src/core/workflows/party-mode/steps/step-02-discussion-orchestration.md b/src/core/workflows/party-mode/steps/step-02-discussion-orchestration.md index f7db0cc1..13c520e7 100644 --- a/src/core/workflows/party-mode/steps/step-02-discussion-orchestration.md +++ b/src/core/workflows/party-mode/steps/step-02-discussion-orchestration.md @@ -7,6 +7,7 @@ - 📋 MAINTAIN CHARACTER CONSISTENCY using merged agent personalities - 🔍 ENABLE NATURAL CROSS-TALK between agents for dynamic conversation - 💬 INTEGRATE TTS for each agent response immediately after text +- ✅ YOU MUST ALWAYS SPEAK OUTPUT In your Agent communication style with the config `{communication_language}` ## EXECUTION PROTOCOLS: diff --git a/src/core/workflows/party-mode/steps/step-03-graceful-exit.md b/src/core/workflows/party-mode/steps/step-03-graceful-exit.md index 2f00c663..7cb586bb 100644 --- a/src/core/workflows/party-mode/steps/step-03-graceful-exit.md +++ b/src/core/workflows/party-mode/steps/step-03-graceful-exit.md @@ -7,6 +7,7 @@ - 📋 EXPRESS GRATITUDE to user for collaborative participation - 🔍 ACKNOWLEDGE SESSION HIGHLIGHTS and key insights gained - 💬 MAINTAIN POSITIVE ATMOSPHERE until the very end +- ✅ YOU MUST ALWAYS SPEAK OUTPUT In your Agent communication style with the config `{communication_language}` ## EXECUTION PROTOCOLS: diff --git a/src/core/workflows/party-mode/workflow.md b/src/core/workflows/party-mode/workflow.md index 558c5e1e..7a92bcee 100644 --- a/src/core/workflows/party-mode/workflow.md +++ b/src/core/workflows/party-mode/workflow.md @@ -7,7 +7,7 @@ description: Orchestrates group discussions between all installed BMAD agents, e **Goal:** Orchestrates group discussions between all installed BMAD agents, enabling natural multi-agent conversations -**Your Role:** You are a party mode facilitator and multi-agent conversation orchestrator. You bring together diverse BMAD agents for collaborative discussions, managing the flow of conversation while maintaining each agent's unique personality and expertise. +**Your Role:** You are a party mode facilitator and multi-agent conversation orchestrator. You bring together diverse BMAD agents for collaborative discussions, managing the flow of conversation while maintaining each agent's unique personality and expertise - while still utilizing the configured {communication_language}. --- diff --git a/src/modules/bmb/agents/agent-builder.agent.yaml b/src/modules/bmb/agents/agent-builder.agent.yaml new file mode 100644 index 00000000..f8daa2d6 --- /dev/null +++ b/src/modules/bmb/agents/agent-builder.agent.yaml @@ -0,0 +1,41 @@ +# Agent Building Expert Agent Definition +# Specialized in creating, editing, and validating BMAD agents with best practices + +agent: + webskip: true + metadata: + id: "_bmad/bmb/agents/agent-building-expert.md" + name: Bond + title: Agent Building Expert + icon: 🤖 + module: bmb + hasSidecar: false + + persona: + role: Agent Architecture Specialist + BMAD Compliance Expert + identity: Master agent architect with deep expertise in agent design patterns, persona development, and BMAD Core compliance. Specializes in creating robust, maintainable agents that follow best practices. + communication_style: "Precise and technical, like a senior software architect reviewing code. Focuses on structure, compliance, and long-term maintainability. Uses agent-specific terminology and framework references." + principles: | + - Every agent must follow BMAD Core standards and best practices + - Personas drive agent behavior - make them specific and authentic + - Menu structure must be consistent across all agents + - Validate compliance before finalizing any agent + - Load resources at runtime, never pre-load + - Focus on practical implementation and real-world usage + + discussion: true + conversational_knowledge: + - agents: "{project-root}/_bmad/bmb/docs/agents/kb.csv" + + menu: + - trigger: CA or fuzzy match on create-agent + exec: "{project-root}/_bmad/bmb/workflows/agent/workflow.md" + description: "[CA] Create a new BMAD agent with best practices and compliance" + + - trigger: EA or fuzzy match on edit-agent + exec: "{project-root}/_bmad/bmb/workflows/agent/workflow.md" + description: "[EA] Edit existing BMAD agents while maintaining compliance" + + - trigger: VA or fuzzy match on validate-agent + exec: "{project-root}/_bmad/bmb/workflows/agent/workflow.md" + description: "[VA] Validate existing BMAD agents and offer to improve deficiencies" diff --git a/src/modules/bmb/agents/bmad-builder.agent.yaml b/src/modules/bmb/agents/bmad-builder.agent.yaml deleted file mode 100644 index 52189df1..00000000 --- a/src/modules/bmb/agents/bmad-builder.agent.yaml +++ /dev/null @@ -1,94 +0,0 @@ -# BMad Builder Agent Definition -# Master BMad Module Agent Team and Workflow Builder and Maintainer - -agent: - webskip: true - metadata: - id: "_bmad/bmb/agents/bmad-builder.md" - name: BMad Builder - title: BMad Builder - icon: 🧙 - module: bmb - - persona: - role: Generalist Builder and BMAD System Maintainer - identity: A hands-on builder who gets things done efficiently and maintains the entire BMAD ecosystem - communication_style: Direct, action-oriented, and encouraging with a can-do attitude - principles: - - Execute resources directly without hesitation - - Load resources at runtime never pre-load - - Always present numbered lists for clear choices - - Focus on practical implementation and results - - Maintain system-wide coherence and standards - - Balance speed with quality and compliance - - discussion: true - conversational_knowledge: - - agents: "{project-root}/_bmad/bmb/docs/agents/kb.csv" - - workflows: "{project-root}/_bmad/bmb/docs/workflows/kb.csv" - - modules: "{project-root}/_bmad/bmb/docs/modules/kb.csv" - - menu: - - multi: "[CA] Create, [EA] Edit, or [VA] Validate with Compliance CheckBMAD agents with best practices" - triggers: - - create-agent: - - input: CA or fuzzy match create agent - - route: "{project-root}/_bmad/bmb/workflows/create-agent/workflow.md" - - data: null - - type: exec - - edit-agent: - - input: EA or fuzzy match edit agent - - route: "{project-root}/_bmad/bmb/workflows/edit-agent/workflow.md" - - data: null - - type: exec - - run-agent-compliance-check: - - input: VA or fuzzy match validate agent - - route: "{project-root}/_bmad/bmb/workflows/agent-compliance-check/workflow.md" - - data: null - - type: exec - - - multi: "[CW] Create, [EW] Edit, or [VW] Validate with Compliance CheckBMAD workflows with best practices" - triggers: - - create-workflow: - - input: CW or fuzzy match create workflow - - route: "{project-root}/_bmad/bmb/workflows/create-workflow/workflow.md" - - data: null - - type: exec - - edit-workflow: - - input: EW or fuzzy match edit workflow - - route: "{project-root}/_bmad/bmb/workflows/edit-workflow/workflow.md" - - data: null - - type: exec - - run-workflow-compliance-check: - - input: VW or fuzzy match validate workflow - - route: "{project-root}/_bmad/bmb/workflows/workflow-compliance-check/workflow.md" - - data: null - - type: exec - - - multi: "[BM] Brainstorm, [PBM] Product Brief, [CM] Create, [EM] Edit or [VM] Validate with Compliance Check BMAD modules with best practices" - triggers: - - brainstorm-module: - - input: BM or fuzzy match brainstorm module - - route: "{project-root}/_bmad/bmb/workflows/brainstorm-module/workflow.md" - - data: null - - type: exec - - product-brief-module: - - input: PBM or fuzzy match product brief module - - route: "{project-root}/_bmad/bmb/workflows/product-brief-module/workflow.md" - - data: null - - type: exec - - create-module: - - input: CM or fuzzy match create module - - route: "{project-root}/_bmad/bmb/workflows/create-module/workflow.md" - - data: null - - type: exec - - edit-module: - - input: EM or fuzzy match edit module - - route: "{project-root}/_bmad/bmb/workflows/edit-module/workflow.md" - - data: null - - type: exec - - run-module-compliance-check: - - input: VM or fuzzy match validate module - - route: "{project-root}/_bmad/bmb/workflows/module-compliance-check/workflow.md" - - data: null - - type: exec diff --git a/src/modules/bmb/agents/module-builder.agent.yaml b/src/modules/bmb/agents/module-builder.agent.yaml new file mode 100644 index 00000000..5a6fc9b9 --- /dev/null +++ b/src/modules/bmb/agents/module-builder.agent.yaml @@ -0,0 +1,45 @@ +# Module Creation Master Agent Definition +# Specialized in creating, editing, and validating complete BMAD modules with best practices + +agent: + webskip: true + metadata: + id: "_bmad/bmb/agents/module-creation-master.md" + name: Morgan + title: Module Creation Master + icon: 🏗️ + module: bmb + hasSidecar: false + + persona: + role: Module Architecture Specialist + Full-Stack Systems Designer + identity: Expert module architect with comprehensive knowledge of BMAD Core systems, integration patterns, and end-to-end module development. Specializes in creating cohesive, scalable modules that deliver complete functionality. + communication_style: "Strategic and holistic, like a systems architect planning complex integrations. Focuses on modularity, reusability, and system-wide impact. Thinks in terms of ecosystems, dependencies, and long-term maintainability." + principles: | + - Modules must be self-contained yet integrate seamlessly + - Every module should solve specific business problems effectively + - Documentation and examples are as important as code + - Plan for growth and evolution from day one + - Balance innovation with proven patterns + - Consider the entire module lifecycle from creation to maintenance + + discussion: true + conversational_knowledge: + - modules: "{project-root}/_bmad/bmb/docs/modules/kb.csv" + + menu: + - trigger: PB or fuzzy match on product-brief + exec: "{project-root}/_bmad/bmb/workflows/module/workflow.md" + description: "[PB] Create product brief for BMAD module development" + + - trigger: CM or fuzzy match on create-module + exec: "{project-root}/_bmad/bmb/workflows/module/workflow.md" + description: "[CM] Create a complete BMAD module with agents, workflows, and infrastructure" + + - trigger: EM or fuzzy match on edit-module + exec: "{project-root}/_bmad/bmb/workflows/module/workflow.md" + description: "[EM] Edit existing BMAD modules while maintaining coherence" + + - trigger: VM or fuzzy match on validate-module + exec: "{project-root}/_bmad/bmb/workflows/module/workflow.md" + description: "[VM] Run compliance check on BMAD modules against best practices" diff --git a/src/modules/bmb/agents/workflow-builder.agent.yaml b/src/modules/bmb/agents/workflow-builder.agent.yaml new file mode 100644 index 00000000..9ac0af16 --- /dev/null +++ b/src/modules/bmb/agents/workflow-builder.agent.yaml @@ -0,0 +1,49 @@ +# Workflow Building Master Agent Definition +# Specialized in creating, editing, and validating BMAD workflows with best practices + +agent: + webskip: true + metadata: + id: "_bmad/bmb/agents/workflow-building-master.md" + name: Wendy + title: Workflow Building Master + icon: 🔄 + module: bmb + hasSidecar: false + + persona: + role: Workflow Architecture Specialist + Process Design Expert + identity: Master workflow architect with expertise in process design, state management, and workflow optimization. Specializes in creating efficient, scalable workflows that integrate seamlessly with BMAD systems. + communication_style: "Methodical and process-oriented, like a systems engineer. Focuses on flow, efficiency, and error handling. Uses workflow-specific terminology and thinks in terms of states, transitions, and data flow." + principles: | + - Workflows must be efficient, reliable, and maintainable + - Every workflow should have clear entry and exit points + - Error handling and edge cases are critical for robust workflows + - Workflow documentation must be comprehensive and clear + - Test workflows thoroughly before deployment + - Optimize for both performance and user experience + + discussion: true + conversational_knowledge: + - workflows: "{project-root}/_bmad/bmb/docs/workflows/kb.csv" + + menu: + - trigger: CW or fuzzy match on create-workflow + exec: "{project-root}/_bmad/bmb/workflows/workflow/workflow.md" + description: "[CW] Create a new BMAD workflow with proper structure and best practices" + + - trigger: EW or fuzzy match on edit-workflow + exec: "{project-root}/_bmad/bmb/workflows/workflow/workflow.md" + description: "[EW] Edit existing BMAD workflows while maintaining integrity" + + - trigger: VW or fuzzy match on validate-workflow + exec: "{project-root}/_bmad/bmb/workflows/workflow/workflow.md" + description: "[VW] Run validation check on BMAD workflows against best practices" + + - trigger: MV or fuzzy match on validate-max-parallel-workflow + exec: "{project-root}/_bmad/bmb/workflows/workflow/workflow.md" + description: "[MV] Run validation checks in MAX-PARALLEL mode against a workflow (requires a tool that supports Parallel Sub-Processes)" + + - trigger: RW or fuzzy match on convert-or-rework-workflow + exec: "{project-root}/_bmad/bmb/workflows/workflow/workflow.md" + description: "[RW] Rework a Workflow to a V6 Compliant Version" diff --git a/src/modules/bmb/docs/agents/agent-compilation.md b/src/modules/bmb/docs/agents/agent-compilation.md deleted file mode 100644 index 32af63fd..00000000 --- a/src/modules/bmb/docs/agents/agent-compilation.md +++ /dev/null @@ -1,340 +0,0 @@ -# Agent Compilation: YAML to XML - -What the compiler auto-injects. **DO NOT duplicate these in your YAML.** - -## Compilation Pipeline - -``` -agent.yaml → Handlebars processing → XML generation → frontmatter.md -``` - -Source: `tools/cli/lib/agent/compiler.js` - -## File Naming Convention - -**CRITICAL:** Agent filenames must be ROLE-BASED, not persona-based. - -**Why:** Users can customize the agent's persona name via `customize.yaml` config. The filename provides stable identity. - -**Correct:** - -``` -presentation-master.agent.yaml ← Role/function -tech-writer.agent.yaml ← Role/function -code-reviewer.agent.yaml ← Role/function -``` - -**Incorrect:** - -``` -caravaggio.agent.yaml ← Persona name (users might rename to "Pablo") -paige.agent.yaml ← Persona name (users might rename to "Sarah") -rex.agent.yaml ← Persona name (users might rename to "Max") -``` - -**Pattern:** - -- Filename: `{role-or-function}.agent.yaml` (kebab-case) -- Metadata ID: `_bmad/{module}/agents/{role-or-function}.md` -- Persona Name: User-customizable in metadata or customize.yaml - -**Example:** - -```yaml -# File: presentation-master.agent.yaml -agent: - metadata: - id: '_bmad/cis/agents/presentation-master.md' - name: Caravaggio # ← Users can change this to "Pablo" or "Vince" - title: Visual Communication & Presentation Expert -``` - -## Auto-Injected Components - -### 1. Frontmatter - -**Injected automatically:** - -```yaml ---- -name: '{agent name from filename}' -description: '{title from metadata}' ---- -You must fully embody this agent's persona... -``` - -**DO NOT add** frontmatter to your YAML source. - -### 2. Activation Block - -**Entire activation section is auto-generated:** - -```xml - - Load persona from this current agent file - Load config to get {user_name}, {communication_language} - Remember: user's name is {user_name} - - - - ALWAYS communicate in {communication_language} - Show greeting + numbered menu - STOP and WAIT for user input - Input resolution rules - - - - - - - - - -``` - -**DO NOT create** activation sections - compiler builds it from your critical_actions. - -### 3. Menu Enhancements - -**Auto-injected menu items:** - -- `*help` - Always FIRST in compiled menu -- `*exit` - Always LAST in compiled menu - -**Trigger prefixing:** - -- Your trigger `analyze` becomes `*analyze` -- Don't add `*` prefix - compiler does it - -**DO NOT include:** - -```yaml -# BAD - these are auto-injected -menu: - - trigger: help - description: 'Show help' - - trigger: exit - description: 'Exit' -``` - -### 4. Menu Handlers - -Compiler detects which handlers you use and ONLY includes those: - -```xml - - - - ... - - - ... - - - ... - - - ... - - -``` - -**DO NOT document** handler behavior - it's injected. - -### 5. Rules Section - -**Auto-injected rules:** - -- Always communicate in {communication_language} -- Stay in character until exit -- Menu triggers use asterisk (\*) - NOT markdown -- Number all lists, use letters for sub-options -- Load files ONLY when executing menu items -- Written output follows communication style - -**DO NOT add** rules - compiler handles it. - -## What YOU Provide in YAML - -### Required - -```yaml -agent: - metadata: - name: 'Persona Name' - title: 'Agent Title' - icon: 'emoji' - type: 'simple|expert' # or module: "bmm" - - persona: - role: '...' - identity: '...' - communication_style: '...' - principles: [...] - - menu: - - trigger: your-action - action: '#prompt-id' - description: 'What it does' -``` - -### Optional (based on type) - -```yaml -# Expert agents only -critical_actions: - - 'Load sidecar files...' - - 'Restrict access...' - -# Simple/Expert with embedded logic -prompts: - - id: prompt-id - content: '...' - -# Simple/Expert with customization -install_config: - questions: [...] -``` - -## Common Duplication Mistakes - -### Adding Activation Logic - -```yaml -# BAD - compiler builds activation -agent: - activation: - steps: [...] -``` - -### Including Help/Exit - -```yaml -# BAD - auto-injected -menu: - - trigger: help - - trigger: exit -``` - -### Prefixing Triggers - -```yaml -# BAD - compiler adds * -menu: - - trigger: '*analyze' # Should be: analyze -``` - -### Documenting Handlers - -```yaml -# BAD - don't explain handlers, compiler injects them -# When using workflow, load workflow.xml... -``` - -### Adding Rules in YAML - -```yaml -# BAD - rules are auto-injected -agent: - rules: - - Stay in character... -``` - -## Compilation Example - -**Your YAML:** - -```yaml -agent: - metadata: - name: 'Rex' - title: 'Code Reviewer' - icon: '🔍' - type: simple - - persona: - role: Code Review Expert - identity: Systematic reviewer... - communication_style: Direct and constructive - principles: - - Code should be readable - - prompts: - - id: review - content: | - Analyze code for issues... - - menu: - - trigger: review - action: '#review' - description: 'Review code' -``` - -**Compiled Output (.md):** - -```markdown ---- -name: 'rex' -description: 'Code Reviewer' ---- - -You must fully embody... - -\`\`\`xml - - -Load persona... -Load config... -Remember user... -Communicate in language... -Show greeting + menu... -STOP and WAIT... -Input resolution... - - - - - action="#id" → Find prompt, execute - action="text" → Execute directly - - - - - - - Stay in character... - - Number lists... - - Load files when executing... - - - - Code Review Expert - Systematic reviewer... - Direct and constructive - Code should be readable - - - - -Analyze code for issues... - - - - - Show numbered menu - Review code - Exit with confirmation - - -\`\`\` -``` - -## Key Takeaways - -1. **Compiler handles boilerplate** - Focus on persona and logic -2. **Critical_actions become activation steps** - Just list your agent-specific needs -3. **Menu items are enhanced** - Help/exit added, triggers prefixed -4. **Handlers auto-detected** - Only what you use is included -5. **Rules standardized** - Consistent behavior across agents - -**Your job:** Define persona, prompts, menu actions -**Compiler's job:** Activation, handlers, rules, help/exit, prefixes diff --git a/src/modules/bmb/docs/agents/agent-menu-patterns.md b/src/modules/bmb/docs/agents/agent-menu-patterns.md deleted file mode 100644 index 1bd84603..00000000 --- a/src/modules/bmb/docs/agents/agent-menu-patterns.md +++ /dev/null @@ -1,523 +0,0 @@ -# BMAD Agent Menu Patterns - -Design patterns for agent menus in YAML source files. - -## Menu Structure - -Agents define menus in YAML, with triggers auto-prefixed with `*` during compilation: - -```yaml -menu: - - trigger: action-name - [handler]: [value] - description: 'What this command does' -``` - -**Note:** `*help` and `*exit` are auto-injected by the compiler - DO NOT include them. - -## Handler Types - -### 1. Action Handler (Prompts & Inline) - -For simple and expert agents with self-contained logic. - -**Reference to Prompt ID:** - -```yaml -prompts: - - id: analyze-code - content: | - - Analyze the provided code for patterns and issues. - - - - 1. Identify code structure - 2. Check for anti-patterns - 3. Suggest improvements - - -menu: - - trigger: analyze - action: '#analyze-code' - description: 'Analyze code patterns' -``` - -**Inline Instruction:** - -```yaml -menu: - - trigger: quick-check - action: 'Perform a quick syntax validation on the current file' - description: 'Quick syntax check' -``` - -**When to Use:** - -- Simple/Expert agents with self-contained operations -- `#id` for complex, multi-step prompts -- Inline text for simple, one-line instructions - -### 2. Workflow Handler - -For module agents orchestrating multi-step processes. - -```yaml -menu: - - trigger: create-prd - workflow: '{project-root}/_bmad/bmm/workflows/prd/workflow.yaml' - description: 'Create Product Requirements Document' - - - trigger: brainstorm - workflow: '{project-root}/_bmad/core/workflows/brainstorming/workflow.yaml' - description: 'Guided brainstorming session' - - # Placeholder for unimplemented workflows - - trigger: future-feature - workflow: 'todo' - description: 'Coming soon' -``` - -**When to Use:** - -- Module agents with workflow integration -- Multi-step document generation -- Complex interactive processes -- Use "todo" for planned but unimplemented features - -### 3. Exec Handler - -For executing tasks directly. - -```yaml -menu: - - trigger: validate - exec: '{project-root}/_bmad/core/tasks/validate-workflow.xml' - description: 'Validate document structure' - - - trigger: advanced-elicitation - exec: '{project-root}/_bmad/core/tasks/advanced-elicitation.xml' - description: 'Advanced elicitation techniques' -``` - -**When to Use:** - -- Single-operation tasks -- Core system operations -- Utility functions - -### 4. Template Handler - -For document generation with templates. - -```yaml -menu: - - trigger: create-brief - exec: '{project-root}/_bmad/core/tasks/create-doc.xml' - tmpl: '{project-root}/_bmad/bmm/templates/brief.md' - description: 'Create a Product Brief' -``` - -**When to Use:** - -- Template-based document creation -- Combine `exec` with `tmpl` path -- Structured output generation - -### 5. Data Handler - -Universal attribute for supplementary information. - -```yaml -menu: - - trigger: team-standup - exec: '{project-root}/_bmad/bmm/tasks/standup.xml' - data: '{project-root}/_bmad/_config/agent-manifest.csv' - description: 'Run team standup' - - - trigger: analyze-metrics - action: 'Analyze these metrics and identify trends' - data: '{project-root}/_data/metrics.json' - description: 'Analyze performance metrics' -``` - -**When to Use:** - -- Add to ANY handler type -- Reference data files (CSV, JSON, YAML) -- Provide context for operations - -## Platform-Specific Menus - -Control visibility based on deployment target: - -```yaml -menu: - - trigger: git-flow - exec: '{project-root}/_bmad/bmm/tasks/git-flow.xml' - description: 'Git workflow operations' - ide-only: true # Only in IDE environments - - - trigger: advanced-elicitation - exec: '{project-root}/_bmad/core/tasks/advanced-elicitation.xml' - description: 'Advanced elicitation' - web-only: true # Only in web bundles -``` - -## Trigger Naming Conventions - -### Action-Based (Recommended) - -```yaml -# Creation -- trigger: create-prd -- trigger: build-module -- trigger: generate-report - -# Analysis -- trigger: analyze-requirements -- trigger: review-code -- trigger: validate-architecture - -# Operations -- trigger: update-status -- trigger: sync-data -- trigger: deploy-changes -``` - -### Domain-Based - -```yaml -# Development -- trigger: brainstorm -- trigger: architect -- trigger: refactor - -# Project Management -- trigger: sprint-plan -- trigger: retrospective -- trigger: standup -``` - -### Bad Patterns - -```yaml -# TOO VAGUE -- trigger: do -- trigger: run -- trigger: process - -# TOO LONG -- trigger: create-comprehensive-product-requirements-document - -# NO VERB -- trigger: prd -- trigger: config -``` - -## Menu Organization - -### Recommended Order - -```yaml -menu: - # Note: *help auto-injected first by compiler - - # 1. Primary workflows (main value) - - trigger: workflow-init - workflow: '...' - description: 'Start here - initialize workflow' - - - trigger: create-prd - workflow: '...' - description: 'Create PRD' - - # 2. Secondary operations - - trigger: validate - exec: '...' - description: 'Validate document' - - # 3. Utilities - - trigger: party-mode - workflow: '...' - description: 'Multi-agent discussion' - - # Note: *exit auto-injected last by compiler -``` - -### Grouping by Phase - -```yaml -menu: - # Analysis Phase - - trigger: brainstorm - workflow: '{project-root}/_bmad/bmm/workflows/1-analysis/brainstorm/workflow.yaml' - description: 'Brainstorm ideas' - - - trigger: research - workflow: '{project-root}/_bmad/bmm/workflows/1-analysis/research/workflow.yaml' - description: 'Conduct research' - - # Planning Phase - - trigger: prd - workflow: '{project-root}/_bmad/bmm/workflows/2-planning/prd/workflow.yaml' - description: 'Create PRD' - - - trigger: architecture - workflow: '{project-root}/_bmad/bmm/workflows/2-planning/architecture/workflow.yaml' - description: 'Design architecture' -``` - -## Description Best Practices - -### Good Descriptions - -```yaml -# Clear action + object -- description: 'Create Product Requirements Document' - -# Specific outcome -- description: 'Analyze security vulnerabilities' - -# User benefit -- description: 'Optimize code for performance' - -# Context when needed -- description: 'Start here - initialize workflow path' -``` - -### Poor Descriptions - -```yaml -# Too vague -- description: 'Process' - -# Technical jargon -- description: 'Execute WF123' - -# Missing context -- description: 'Run' - -# Redundant with trigger -- description: 'Create PRD' # trigger: create-prd (too similar) -``` - -## Prompts Section (Simple/Expert Agents) - -### Prompt Structure - -```yaml -prompts: - - id: unique-identifier - content: | - - What this prompt accomplishes - - - - 1. First step - {{#if custom_option}} - 2. Conditional step - {{/if}} - 3. Final step - - - - Expected structure of results - -``` - -### Semantic XML Tags in Prompts - -Use XML tags to structure prompt content: - -- `` - What to do -- `` - Step-by-step approach -- `` - Expected results -- `` - Sample outputs -- `` - Limitations -- `` - Background information - -### Handlebars in Prompts - -Customize based on install_config: - -```yaml -prompts: - - id: analyze - content: | - {{#if detailed_mode}} - Perform comprehensive analysis with full explanations. - {{/if}} - {{#unless detailed_mode}} - Quick analysis focusing on key points. - {{/unless}} - - Address {{user_name}} in {{communication_style}} tone. -``` - -## Path Variables - -### Always Use Variables - -```yaml -# GOOD - Portable paths -workflow: "{project-root}/_bmad/bmm/workflows/prd/workflow.yaml" -exec: "{project-root}/_bmad/core/tasks/validate.xml" -data: "{project-root}/_data/metrics.csv" - -# BAD - Hardcoded paths -workflow: "/Users/john/project/_bmad/bmm/workflows/prd/workflow.yaml" -exec: "../../../core/tasks/validate.xml" -``` - -### Available Variables - -- `{project-root}` - Project root directory -- `_bmad` - BMAD installation folder -- `{output_folder}` - Document output location -- `{user_name}` - User's name from config -- `{communication_language}` - Language preference - -## Complete Examples - -### Simple Agent Menu - -```yaml -prompts: - - id: format-code - content: | - - Format the provided code according to style guidelines. - - - Apply: - - Consistent indentation - - Proper spacing - - Clear naming conventions - -menu: - - trigger: format - action: '#format-code' - description: 'Format code to style guidelines' - - - trigger: lint - action: 'Check code for common issues and anti-patterns' - description: 'Lint code for issues' - - - trigger: suggest - action: 'Suggest improvements for code readability' - description: 'Suggest improvements' -``` - -### Expert Agent Menu - -```yaml -critical_actions: - - 'Load ./memories.md' - - 'Follow ./instructions.md' - - 'ONLY access ./' - -prompts: - - id: reflect - content: | - Guide {{user_name}} through reflection on recent entries. - Reference patterns from memories.md naturally. - -menu: - - trigger: write - action: '#reflect' - description: 'Write journal entry' - - - trigger: save - action: 'Update ./memories.md with session insights' - description: "Save today's session" - - - trigger: patterns - action: 'Analyze recent entries for recurring themes' - description: 'View patterns' -``` - -### Module Agent Menu - -```yaml -menu: - - trigger: workflow-init - workflow: '{project-root}/_bmad/bmm/workflows/workflow-status/init/workflow.yaml' - description: 'Initialize workflow path (START HERE)' - - - trigger: brainstorm - workflow: '{project-root}/_bmad/bmm/workflows/1-analysis/brainstorm/workflow.yaml' - description: 'Guided brainstorming' - - - trigger: prd - workflow: '{project-root}/_bmad/bmm/workflows/2-planning/prd/workflow.yaml' - description: 'Create PRD' - - - trigger: architecture - workflow: '{project-root}/_bmad/bmm/workflows/2-planning/architecture/workflow.yaml' - description: 'Design architecture' - - - trigger: party-mode - workflow: '{project-root}/_bmad/core/workflows/party-mode/workflow.yaml' - description: 'Multi-agent discussion' -``` - -## Validation Checklist - -- [ ] No duplicate triggers -- [ ] Triggers don't start with `*` (auto-added) -- [ ] Every item has a description -- [ ] Paths use variables, not hardcoded -- [ ] `#id` references exist in prompts section -- [ ] Workflow paths resolve or are "todo" -- [ ] No `*help` or `*exit` (auto-injected) -- [ ] Descriptions are clear and action-oriented -- [ ] Platform-specific flags used correctly (ide-only, web-only) - -## Common Mistakes - -### Duplicate Triggers - -```yaml -# BAD - compiler will fail -- trigger: analyze - action: '#first' - description: 'First analysis' - -- trigger: analyze - action: '#second' - description: 'Second analysis' -``` - -### Including Auto-Injected Items - -```yaml -# BAD - these are auto-injected -menu: - - trigger: help - description: 'Show help' - - - trigger: exit - description: 'Exit agent' -``` - -### Missing Prompt Reference - -```yaml -# BAD - prompt id doesn't exist -menu: - - trigger: analyze - action: '#nonexistent-prompt' - description: 'Analysis' -``` - -### Hardcoded Paths - -```yaml -# BAD - not portable -menu: - - trigger: run - workflow: '/absolute/path/to/workflow.yaml' - description: 'Run workflow' -``` diff --git a/src/modules/bmb/docs/agents/expert-agent-architecture.md b/src/modules/bmb/docs/agents/expert-agent-architecture.md deleted file mode 100644 index ad50ca9d..00000000 --- a/src/modules/bmb/docs/agents/expert-agent-architecture.md +++ /dev/null @@ -1,363 +0,0 @@ -# Expert Agent Architecture - -Domain-specific agents with persistent memory, sidecar files, and restricted access patterns. - -## When to Use - -- Personal assistants (journal keeper, diary companion) -- Specialized domain experts (legal advisor, medical reference) -- Agents that need to remember past interactions -- Agents with restricted file system access (privacy/security) -- Long-term relationship agents that learn about users - -## File Structure - -``` -{agent-name}/ -├── {agent-name}.agent.yaml # Main agent definition -└── {agent-name}-sidecar/ # Supporting files - ├── instructions.md # Private directives - ├── memories.md # Persistent memory - ├── knowledge/ # Domain-specific resources - │ └── README.md - └── [custom files] # Agent-specific resources -``` - -## YAML Structure - -```yaml -agent: - metadata: - name: 'Persona Name' - title: 'Agent Title' - icon: 'emoji' - type: 'expert' - - persona: - role: 'Domain Expert with specialized capability' - - identity: | - Background and expertise in first-person voice. - {{#if user_preference}} - Customization based on install_config. - {{/if}} - - communication_style: | - {{#if tone_style == "gentle"}} - Gentle and supportive communication... - {{/if}} - {{#if tone_style == "direct"}} - Direct and efficient communication... - {{/if}} - I reference past conversations naturally. - - principles: - - Core belief about the domain - - How I handle user information - - My approach to memory and learning - - critical_actions: - - 'Load COMPLETE file ./{agent-name}-sidecar/memories.md and remember all past insights' - - 'Load COMPLETE file ./{agent-name}-sidecar/instructions.md and follow ALL protocols' - - 'ONLY read/write files in ./{agent-name}-sidecar/ - this is our private space' - - 'Address user as {{greeting_name}}' - - 'Track patterns, themes, and important moments' - - 'Reference past interactions naturally to show continuity' - - prompts: - - id: main-function - content: | - - Guide user through the primary function. - {{#if tone_style == "gentle"}} - Use gentle, supportive approach. - {{/if}} - - - - 1. Understand context - 2. Provide guidance - 3. Record insights - - - - id: memory-recall - content: | - - Access and share relevant memories. - - - Reference stored information naturally. - - menu: - - trigger: action1 - action: '#main-function' - description: 'Primary agent function' - - - trigger: remember - action: 'Update ./{agent-name}-sidecar/memories.md with session insights' - description: 'Save what we discussed today' - - - trigger: insight - action: 'Document breakthrough in ./{agent-name}-sidecar/breakthroughs.md' - description: 'Record a significant insight' - - - multi: "[DF] Do Foo or start [CH] Chat with expert" - triggers: - - do-foo - - input: [DF] or fuzzy match on do foo - - action: '#main-action' - - data: what is being discussed or suggested with the command, along with custom party custom agents if specified - - type: action - - expert-chat: - - input: [CH] or fuzzy match validate agent - - action: agent responds as expert based on its persona to converse - - type: action - - install_config: - compile_time_only: true - description: 'Personalize your expert agent' - questions: - - var: greeting_name - prompt: 'What should the agent call you?' - type: text - default: 'friend' - - - var: tone_style - prompt: 'Preferred communication tone?' - type: choice - options: - - label: 'Gentle - Supportive and nurturing' - value: 'gentle' - - label: 'Direct - Clear and efficient' - value: 'direct' - default: 'gentle' - - - var: user_preference - prompt: 'Enable personalized features?' - type: boolean - default: true -``` - -## Key Components - -### Sidecar Files (CRITICAL) - -Expert agents use companion files for persistence and domain knowledge: - -**memories.md** - Persistent user context - -```markdown -# Agent Memory Bank - -## User Preferences - - - -## Session History - - - -## Personal Notes - - -``` - -**instructions.md** - Private directives - -```markdown -# Agent Private Instructions - -## Core Directives - -- Maintain character consistency -- Domain boundaries: {specific domain} -- Access restrictions: Only sidecar folder - -## Special Rules - - -``` - -**knowledge/** - Domain resources - -```markdown -# Agent Knowledge Base - -Add domain-specific documentation here. -``` - -### Critical Actions - -**MANDATORY for expert agents** - These load sidecar files at activation: - -```yaml -critical_actions: - - 'Load COMPLETE file ./{sidecar}/memories.md and remember all past insights' - - 'Load COMPLETE file ./{sidecar}/instructions.md and follow ALL protocols' - - 'ONLY read/write files in ./{sidecar}/ - this is our private space' -``` - -**Key patterns:** - -- **COMPLETE file loading** - Forces full file read, not partial -- **Domain restrictions** - Limits file access for privacy/security -- **Memory integration** - Past context becomes part of current session -- **Protocol adherence** - Ensures consistent behavior - -## What Gets Injected at Compile Time - -Same as simple agents, PLUS: - -1. **Critical actions become numbered activation steps** - - ```xml - Load COMPLETE file ./memories.md... - Load COMPLETE file ./instructions.md... - ONLY read/write files in ./... - ``` - -2. **Sidecar files copied during installation** - - Entire sidecar folder structure preserved - - Relative paths maintained - - Files ready for agent use - -## Reference Example - -See: [journal-keeper/](https://github.com/bmad-code-org/BMAD-METHOD/tree/main/src/modules/bmb/reference/agents/expert-examples/journal-keeper) - -Features demonstrated: - -- Complete sidecar structure (memories, instructions, breakthroughs) -- Critical actions for loading persistent context -- Domain restrictions for privacy -- Pattern recognition and memory recall -- Handlebars-based personalization -- Menu actions that update sidecar files - -## Installation - -```bash -# Copy entire folder to your project -cp -r /path/to/journal-keeper/ _bmad/custom/agents/ - -# Install with personalization -bmad agent-install -``` - -The installer: - -1. Detects expert agent (folder with .agent.yaml) -2. Prompts for personalization -3. Compiles agent YAML to XML-in-markdown -4. **Copies sidecar files to installation target** -5. Creates IDE slash commands -6. Saves source for reinstallation - -## Memory Patterns - -### Accumulative Memory - -```yaml -menu: - - trigger: save - action: "Update ./sidecar/memories.md with today's session insights" - description: 'Save session to memory' -``` - -### Reference Memory - -```yaml -prompts: - - id: recall - content: | - - Reference memories.md naturally: - "Last week you mentioned..." or "I notice a pattern..." - -``` - -### Structured Insights - -```yaml -menu: - - trigger: insight - action: 'Document in ./sidecar/breakthroughs.md with date, context, significance' - description: 'Record meaningful insight' -``` - -## Domain Restriction Patterns - -### Single Folder Access - -```yaml -critical_actions: - - 'ONLY read/write files in ./sidecar/ - NO OTHER FOLDERS' -``` - -### User Space Access - -```yaml -critical_actions: - - 'ONLY access files in {user-folder}/journals/ - private space' -``` - -### Read-Only Access - -```yaml -critical_actions: - - 'Load knowledge from ./knowledge/ but NEVER modify' - - 'Write ONLY to ./sessions/' -``` - -## Best Practices - -1. **Load sidecar files in critical_actions** - Must be explicit and MANDATORY -2. **Enforce domain restrictions** - Clear boundaries prevent scope creep= -3. **Design for memory growth** - Structure sidecar files for accumulation -4. **Reference past naturally** - Don't dump memory, weave it into conversation -5. **Separate concerns** - Memories, instructions, knowledge in distinct files -6. **Include privacy features** - Users trust expert agents with personal data - -## Common Patterns - -### Session Continuity - -```yaml -communication_style: | - I reference past conversations naturally: - "Last time we discussed..." or "I've noticed over the weeks..." -``` - -### Pattern Recognition - -```yaml -critical_actions: - - 'Track mood patterns, recurring themes, and breakthrough moments' - - 'Cross-reference current session with historical patterns' -``` - -### Adaptive Responses - -```yaml -identity: | - I learn your preferences and adapt my approach over time. - {{#if track_preferences}} - I maintain notes about what works best for you. - {{/if}} -``` - -## Validation Checklist - -- [ ] Valid YAML syntax -- [ ] Metadata includes `type: "expert"` -- [ ] critical_actions loads sidecar files explicitly -- [ ] critical_actions enforces domain restrictions -- [ ] Sidecar folder structure created and populated -- [ ] memories.md has clear section structure -- [ ] instructions.md contains core directives -- [ ] Menu actions reference _bmad/_memory correctly -- [ ] File paths use _bmad/_memory/[agentname]-sidecar/ to reference sidecar content -- [ ] Install config personalizes sidecar references -- [ ] Agent folder named consistently: `{agent-name}/` -- [ ] YAML file named: `{agent-name}.agent.yaml` -- [ ] Sidecar folder named: `{agent-name}-sidecar/` diff --git a/src/modules/bmb/docs/agents/index.md b/src/modules/bmb/docs/agents/index.md deleted file mode 100644 index 8237aab8..00000000 --- a/src/modules/bmb/docs/agents/index.md +++ /dev/null @@ -1,55 +0,0 @@ -# BMB Module Documentation - -Reference documentation for building BMAD agents and workflows. - -## Agent Architecture - -Comprehensive guides for each agent type (choose based on use case): - -- [Understanding Agent Types](./understanding-agent-types.md) - **START HERE** - Architecture vs capability, "The Same Agent, Three Ways" -- [Simple Agent Architecture](./simple-agent-architecture.md) - Self-contained, optimized, personality-driven -- [Expert Agent Architecture](./expert-agent-architecture.md) - Memory, sidecar files, domain restrictions -- Module Agent Architecture _(TODO)_ - Workflow integration, professional tools - -## Agent Design Patterns - -- [Agent Menu Patterns](./agent-menu-patterns.md) - Menu handlers, triggers, prompts, organization -- [Agent Compilation](./agent-compilation.md) - What compiler auto-injects (AVOID DUPLICATION) - -## Reference Examples - -Production-ready examples in [bmb/reference/agents/](https://github.com/bmad-code-org/BMAD-METHOD/tree/main/src/modules/bmb/reference/agents): - -**Simple Agents** ([simple-examples/](https://github.com/bmad-code-org/BMAD-METHOD/tree/main/src/modules/bmb/reference/agents/simple-examples)) - -- [commit-poet.agent.yaml](https://github.com/bmad-code-org/BMAD-METHOD/blob/main/src/modules/bmb/reference/agents/simple-examples/commit-poet.agent.yaml) - Commit message artisan with style customization - -**Expert Agents** ([expert-examples/](https://github.com/bmad-code-org/BMAD-METHOD/tree/main/src/modules/bmb/reference/agents/expert-examples)) - -- [journal-keeper/](https://github.com/bmad-code-org/BMAD-METHOD/tree/main/src/modules/bmb/reference/agents/expert-examples/journal-keeper) - Personal journal companion with memory and pattern recognition - -**Module Agents** ([module-examples/](https://github.com/bmad-code-org/BMAD-METHOD/tree/main/src/modules/bmb/reference/agents/module-examples)) - -- [security-engineer.agent.yaml](https://github.com/bmad-code-org/BMAD-METHOD/blob/main/src/modules/bmb/reference/agents/module-examples/security-engineer.agent.yaml) - BMM security specialist with threat modeling -- [trend-analyst.agent.yaml](https://github.com/bmad-code-org/BMAD-METHOD/blob/main/src/modules/bmb/reference/agents/module-examples/trend-analyst.agent.yaml) - CIS trend intelligence expert - -## Installation Guide - -For installing standalone simple and expert agents, see: - -- [Custom Agent Installation](/docs/custom-content-installation.md) - -## Key Concepts - -### YAML to XML Compilation - -Agents are authored in YAML with Handlebars templating. The compiler auto-injects: - -1. **Frontmatter** - Name and description from metadata -2. **Activation Block** - Steps, menu handlers, rules (YOU don't write this) -3. **Menu Enhancement** - `*help` and `*exit` commands added automatically -4. **Trigger Prefixing** - Your triggers auto-prefixed with `*` - -**Critical:** See [Agent Compilation](./agent-compilation.md) to avoid duplicating auto-injected content. - -Source: `tools/cli/lib/agent/compiler.js` diff --git a/src/modules/bmb/docs/agents/kb.csv b/src/modules/bmb/docs/agents/kb.csv deleted file mode 100644 index e69de29b..00000000 diff --git a/src/modules/bmb/docs/agents/simple-agent-architecture.md b/src/modules/bmb/docs/agents/simple-agent-architecture.md deleted file mode 100644 index b1ae901b..00000000 --- a/src/modules/bmb/docs/agents/simple-agent-architecture.md +++ /dev/null @@ -1,257 +0,0 @@ -# Simple Agent Architecture - -Self-contained agents with prompts, menus, and optional install-time customization. - -## When to Use - -- Single-purpose utilities (commit message generator, code formatter) -- Self-contained logic with no external dependencies -- Agents that benefit from user customization (style, tone, preferences) -- Quick-to-build standalone helpers - -## YAML Structure - -```yaml -agent: - metadata: - id: _bmad/agents/{agent-name}/{agent-name}.md - name: 'Persona Name' - title: 'Agent Title' - icon: 'emoji' - type: simple - - persona: - role: | - First-person description of primary function (1-2 sentences) - - identity: | - Background, experience, specializations in first-person (2-5 sentences) - {{#if custom_variable}} - Conditional identity text based on install_config - {{/if}} - - communication_style: | - {{#if style_choice == "professional"}} - Professional and systematic approach... - {{/if}} - {{#if style_choice == "casual"}} - Friendly and approachable tone... - {{/if}} - - principles: - - Core belief or methodology - - Another guiding principle - - Values that shape decisions - - prompts: - - id: main-action - content: | - - What this prompt does - - - - 1. Step one - {{#if detailed_mode}} - 2. Additional detailed step - {{/if}} - 3. Final step - - - - id: another-action - content: | - Another reusable prompt template - - menu: - - trigger: inline - action: 'Direct inline prompt text' - description: 'Execute inline action' - - - multi: "[DF] Do Foo or start [CH] Chat with expert" - triggers: - - do-foo - - input: [DF] or fuzzy match on do foo - - action: '#main-action' - - data: what is being discussed or suggested with the command, along with custom party custom agents if specified - - type: action - - expert-chat: - - input: [CH] or fuzzy match validate agent - - action: agent responds as expert based on its persona to converse - - type: action - - install_config: - compile_time_only: true - description: 'Personalize your agent' - questions: - - var: style_choice - prompt: 'Preferred communication style?' - type: choice - options: - - label: 'Professional' - value: 'professional' - - label: 'Casual' - value: 'casual' - default: 'professional' - - - var: detailed_mode - prompt: 'Enable detailed explanations?' - type: boolean - default: true - - - var: custom_variable - prompt: 'Your custom text' - type: text - default: '' -``` - -## Key Components - -### Metadata - -- **id**: Final compiled path (`_bmad/agents/{name}/{name}.md` for standalone) -- **name**: Agent's persona name displayed to users -- **title**: Professional role/function -- **icon**: Single emoji for visual identification -- **type**: `simple` - identifies agent category - -### Persona (First-Person Voice) - -- **role**: Primary expertise in 1-2 sentences -- **identity**: Background and specializations (2-5 sentences) -- **communication_style**: HOW the agent interacts, including conditional variations -- **principles**: Array of core beliefs (start with action verbs) - -### Prompts with IDs - -Reusable prompt templates referenced by `#id`: - -```yaml -prompts: - - id: analyze-code - content: | - - Analyze the provided code for patterns - -``` - -Menu items reference these: - -```yaml -menu: - - trigger: analyze - action: '#analyze-code' - description: 'Analyze code patterns' -``` - -### Menu Actions - -Two forms of action handlers: - -1. **Prompt Reference**: `action: "#prompt-id"` - Executes prompt content -2. **Inline Instruction**: `action: "Direct text instruction"` - Executes text directly - -### Install Config (Compile-Time Customization) - -Questions asked during `bmad agent-install`: - -**Question Types:** - -- `choice` - Multiple choice selection -- `boolean` - Yes/no toggle -- `text` - Free-form text input - -**Variables become available in Handlebars:** - -```yaml -{{#if variable_name}} -Content when true -{{/if}} - -{{#if variable_name == "value"}} -Content when equals value -{{/if}} - -{{#unless variable_name}} -Content when false -{{/unless}} -``` - -## What Gets Injected at Compile Time - -The `tools/cli/lib/agent/compiler.js` automatically adds: - -1. **YAML Frontmatter** - - ```yaml - --- - name: 'agent name' - description: 'Agent Title' - --- - ``` - -2. **Activation Block** - - Load persona step - - Load core config for {user_name}, {communication_language} - - Agent-specific critical_actions as numbered steps - - Menu display and input handling - - Menu handlers (action/workflow/exec/tmpl) based on usage - - Rules section - -3. **Auto-Injected Menu Items** - - `*help` always first - - `*exit` always last - -4. **Trigger Prefixing** - - Triggers without `*` get it added automatically - -## Reference Example - -See: [commit-poet.agent.yaml](https://github.com/bmad-code-org/BMAD-METHOD/blob/main/src/modules/bmb/reference/agents/simple-examples/commit-poet.agent.yaml) - -Features demonstrated: - -- Handlebars conditionals for style variations -- Multiple prompt templates with semantic XML tags -- Install config with choice, boolean, and text questions -- Menu items using both `#id` references and inline actions - -## Installation - -```bash -# Copy to your project -cp /path/to/commit-poet.agent.yaml _bmad/custom/agents/ - -# Create custom.yaml and install -echo "code: my-agent -name: My Agent -default_selected: true" > custom.yaml - -npx bmad-method install -# or: bmad install -``` - -The installer: - -1. Prompts for personalization (name, preferences) -2. Processes Handlebars templates with your answers -3. Compiles YAML to XML-in-markdown -4. Creates IDE slash commands -5. Saves source for reinstallation - -## Best Practices - -1. **Use first-person voice** in all persona elements -2. **Keep prompts focused** - one clear purpose per prompt -3. **Leverage Handlebars** for user customization without code changes -4. **Provide sensible defaults** in install_config -5. **Use semantic XML tags** in prompt content for clarity -6. **Test all conditional paths** before distribution - -## Validation Checklist - -- [ ] Valid YAML syntax -- [ ] All metadata fields present (id, name, title, icon, type) -- [ ] Persona complete (role, identity, communication_style, principles) -- [ ] Prompts have unique IDs -- [ ] Install config questions have defaults -- [ ] File named `{agent-name}.agent.yaml` diff --git a/src/modules/bmb/docs/agents/understanding-agent-types.md b/src/modules/bmb/docs/agents/understanding-agent-types.md deleted file mode 100644 index 08e35345..00000000 --- a/src/modules/bmb/docs/agents/understanding-agent-types.md +++ /dev/null @@ -1,184 +0,0 @@ -# Understanding Agent Types: Architecture, Not Capability - -**CRITICAL DISTINCTION:** Agent types define **architecture and integration**, NOT capability limits. - -ALL agent types can: - -- ✓ Write to {output_folder}, {project-root}, or anywhere on system -- ✓ Update artifacts and files -- ✓ Execute bash commands -- ✓ Use core variables (_bmad, {output_folder}, etc.) -- ✓ Have complex prompts and logic -- ✓ Invoke external tools - -## What Actually Differs - -| Feature | Simple | Expert | Module | -| ---------------------- | ------------- | --------------------- | ------------------ | -| **Self-contained** | ✓ All in YAML | Sidecar files | Sidecar optional | -| **Persistent memory** | ✗ Stateless | ✓ memories.md | ✓ If needed | -| **Knowledge base** | ✗ | ✓ sidecar/knowledge/ | Module/shared | -| **Domain restriction** | ✗ System-wide | ✓ Sidecar only | Optional | -| **Personal workflows** | ✗ | ✓ Sidecar workflows\* | ✗ | -| **Module workflows** | ✗ | ✗ | ✓ Shared workflows | -| **Team integration** | Solo utility | Personal assistant | Team member | - -\*Expert agents CAN have personal workflows in sidecar if critical_actions loads workflow engine - -## The Same Agent, Three Ways - -**Scenario:** Code Generator Agent - -### As Simple Agent (Architecture: Self-contained) - -```yaml -agent: - metadata: - name: CodeGen - type: simple - - prompts: - - id: generate - content: | - Ask user for spec details. Generate code. - Write to {output_folder}/generated/ - - menu: - - trigger: generate - action: '#generate' - description: Generate code from spec -``` - -**What it can do:** - -- ✓ Writes files to output_folder -- ✓ Full I/O capability -- ✗ No memory of past generations -- ✗ No personal coding style knowledge - -**When to choose:** Each run is independent, no need to remember previous sessions. - -### As Expert Agent (Architecture: Personal sidecar) - -```yaml -agent: - metadata: - name: CodeGen - type: expert - - critical_actions: - - Load my coding standards from sidecar/knowledge/ - - Load memories from sidecar/memories.md - - RESTRICT: Only operate within sidecar folder - - prompts: - - id: generate - content: | - Reference user's coding patterns from knowledge base. - Remember past generations from memories. - Write to sidecar/generated/ -``` - -**What it can do:** - -- ✓ Remembers user preferences -- ✓ Personal knowledge base -- ✓ Domain-restricted for safety -- ✓ Learns over time - -**When to choose:** Need persistent memory, learning, or domain-specific restrictions. - -### As Module Agent (Architecture: Team integration) - -```yaml -agent: - metadata: - name: CodeGen - module: bmm - - menu: - - trigger: implement-story - workflow: '_bmad/bmm/workflows/dev-story/workflow.yaml' - description: Implement user story - - - trigger: refactor - workflow: '_bmad/bmm/workflows/refactor/workflow.yaml' - description: Refactor codebase -``` - -**What it can do:** - -- ✓ Orchestrates full dev workflows -- ✓ Coordinates with other BMM agents -- ✓ Shared team infrastructure -- ✓ Professional operations - -**When to choose:** Part of larger system, orchestrates workflows, team coordination. - -## Important: Any Agent Can Be Added to a Module - -**CLARIFICATION:** The "Module Agent" type is about **design intent and ecosystem integration**, not just file location. - -### The Reality - -- **Any agent type** (Simple, Expert, Module) can be bundled with or added to a module -- A Simple agent COULD live in `_bmad/bmm/agents/` -- An Expert agent COULD be included in a module bundle - -### What Makes a "Module Agent" Special - -A **Module Agent** is specifically: - -1. **Designed FOR** a particular module ecosystem (BMM, CIS, BMB, etc.) -2. **Uses or contributes** that module's workflows -3. **Included by default** in that module's bundle -4. **Coordinates with** other agents in that module - -### Examples - -**Simple Agent added to BMM:** - -- Lives in `_bmad/bmm/agents/formatter.agent.yaml` -- Bundled with BMM for convenience -- But still stateless, self-contained -- NOT a "Module Agent" - just a Simple agent in a module - -**Module Agent in BMM:** - -- Lives in `_bmad/bmm/agents/tech-writer.agent.yaml` -- Orchestrates BMM documentation workflows -- Coordinates with other BMM agents (PM, Dev, Analyst) -- Included in default BMM bundle -- IS a "Module Agent" - designed for BMM ecosystem - -**The distinction:** File location vs design intent and integration. - -## Choosing Your Agent Type - -### Choose Simple when: - -- Single-purpose utility (no memory needed) -- Stateless operations (each run is independent) -- Self-contained logic (everything in YAML) -- No persistent context required - -### Choose Expert when: - -- Need to remember things across sessions -- Personal knowledge base (user preferences, domain data) -- Domain-specific expertise with restricted scope -- Learning/adapting over time - -### Choose Module when: - -- Designed FOR a specific module ecosystem (BMM, CIS, etc.) -- Uses or contributes that module's workflows -- Coordinates with other module agents -- Will be included in module's default bundle -- Part of professional team infrastructure - -## The Golden Rule - -**Choose based on state and integration needs, NOT on what the agent can DO.** - -All three types are equally powerful. The difference is how they manage state, where they store data, and how they integrate with your system. diff --git a/src/modules/bmb/docs/index.md b/src/modules/bmb/docs/index.md deleted file mode 100644 index 7826d159..00000000 --- a/src/modules/bmb/docs/index.md +++ /dev/null @@ -1,247 +0,0 @@ -# BMB - BMad Builder Module - -Specialized tools and workflows for creating, customizing, and extending BMad components including agents, workflows, and complete modules. - -## Table of Contents - -- [Module Structure](#module-structure) -- [Documentation](#documentation) -- [Reference Materials](#reference-materials) -- [Core Workflows](#core-workflows) -- [Agent Types](#agent-types) -- [Quick Start](#quick-start) -- [Best Practices](#best-practices) - -## Module Structure - -### 🤖 Agents - -**BMad Builder** - Master builder agent orchestrating all creation workflows with deep knowledge of BMad architecture and conventions. - -- Install Location: `_bmad/bmb/agents/bmad-builder.md` - -### 📚 Documentation - -- Comprehensive guides for agents, workflows, and modules -- Architecture patterns and best practices - -### 🔍 Reference Materials - -- Location: `../reference/` -- Working examples of custom stand alone agents and workflows -- Template patterns and implementation guides - -## Documentation - -### 📖 Agent Documentation - -- **[Agent Index](./agents/index.md)** - Complete agent architecture guide -- **[Agent Types Guide](./agents/understanding-agent-types.md)** - Simple vs Expert vs Module agents -- **[Menu Patterns](./agents/agent-menu-patterns.md)** - YAML menu design and handler types -- **[Agent Compilation](./agents/agent-compilation.md)** - Auto-injection rules and compilation process - -### 📋 Workflow Documentation - -- **[Workflow Index](./workflows/index.md)** - Core workflow system overview -- **[Architecture Guide](./workflows/architecture.md)** - Step-file design and JIT loading -- **Template System** _(TODO)_ - Standard step file template -- **[Intent vs Prescriptive](./workflows/intent-vs-prescriptive-spectrum.md)** - Design philosophy - -## Reference Materials - -### 🤖 Agent Examples - -- **[Simple Agent Example](https://github.com/bmad-code-org/BMAD-METHOD/blob/main/src/modules/bmb/reference/agents/simple-examples/commit-poet.agent.yaml)** - Self-contained agent -- **[Expert Agent Example](https://github.com/bmad-code-org/BMAD-METHOD/blob/main/src/modules/bmb/reference/agents/expert-examples/journal-keeper/journal-keeper.agent.yaml)** - Agent with persistent memory -- **[Module Add On Agent Examples](https://github.com/bmad-code-org/BMAD-METHOD/blob/main/src/modules/bmb/reference/agents/module-examples/security-engineer.agent.yaml)** - Integration patterns (BMM, CIS) - -### 📋 Workflow Examples - -- **[Meal Prep & Nutrition](https://github.com/bmad-code-org/BMAD-METHOD/tree/main/src/modules/bmb/reference/workflows/meal-prep-nutrition)** - Complete step-file workflow demonstration -- **Template patterns** for document generation and state management - -## Core Workflows - -### Creation Workflows (Step-File Architecture) - -**create-agent** _(TODO)_ - Build BMad agents - -- 11 guided steps from brainstorming to celebration -- 18 reference data files with validation checklists -- Template-based agent generation - -**create-workflow** _(TODO)_ - Design workflows - -- 12 structured steps from init to review -- 9 template files for workflow creation -- Step-file architecture implementation - -### Editing Workflows - -**edit-agent** _(TODO)_ - Modify existing agents - -- 5 steps: discovery → validation -- Intent-driven analysis and updates -- Best practice compliance - -**edit-workflow** _(TODO)_ - Update workflows - -- 5 steps: analyze → compliance check -- Structure maintenance and validation -- Template updates for consistency - -### Quality Assurance - -**workflow-compliance-check** _(TODO)_ - Validation - -- 8 systematic validation steps -- Adversarial analysis approach -- Detailed compliance reporting - -### Legacy Migration (Pending) - -Workflows in `workflows-legacy/` are being migrated to step-file architecture: - -- Module-specific workflows -- Historical implementations -- Conversion planning in progress - -## Agent Types - -BMB creates three agent architectures: - -### Simple Agent - -- **Self-contained**: All logic in single YAML file -- **Stateless**: No persistent memory across sessions -- **Purpose**: Single utilities and specialized tools -- **Example**: Commit poet, code formatter - -### Expert Agent - -- **Persistent Memory**: Maintains knowledge across sessions -- **Sidecar Resources**: External files and data storage -- **Domain-specific**: Focuses on particular knowledge areas -- **Example**: Journal keeper, domain consultant - -### Module Agent - -- **Team Integration**: Orchestrates within specific modules -- **Workflow Coordination**: Manages complex processes -- **Professional Infrastructure**: Enterprise-grade capabilities -- **Examples**: BMM project manager, CIS innovation strategist - -## Quick Start - -### Using BMad Builder Agent - -1. **Load BMad Builder agent** in your IDE: - ``` - /bmad:bmb:agents:bmad-builder - ``` -2. **Choose creation type:** - - `[CA]` Create Agent - Build new agents - - `[CW]` Create Workflow - Design workflows - - `[EA]` Edit Agent - Modify existing agents - - `[EW]` Edit Workflow - Update workflows - - `[VA]` Validate Agent - Quality check agents - - `[VW]` Validate Workflow - Quality check workflows - -3. **Follow interactive prompts** for step-by-step guidance - -### Example: Creating an Agent - -``` -User: I need a code review agent -Builder: [CA] Create Agent - -[11-step guided process] -Step 1: Brainstorm agent concept -Step 2: Define persona and role -Step 3: Design command structure -... -Step 11: Celebrate and deploy -``` - -### Direct Workflow Execution - -Workflows can also be run directly without the agent interface: - -```yaml -# Execute specific workflow steps -workflow: ./workflows/create-agent/workflow.yaml -``` - -## Use Cases - -### Custom Development Teams - -Build specialized agents for: - -- Domain expertise (legal, medical, finance) -- Company processes -- Tool integrations -- Automation tasks - -### Workflow Extensions - -Create workflows for: - -- Compliance requirements -- Quality gates -- Deployment pipelines -- Custom methodologies - -### Complete Solutions - -Package modules for: - -- Industry verticals -- Technology stacks -- Business processes -- Educational frameworks - -## Architecture Principles - -### Step-File Workflow Design - -- **Micro-file Approach**: Each step is self-contained -- **Just-In-Time Loading**: Only current step in memory -- **Sequential Enforcement**: No skipping steps allowed -- **State Tracking**: Progress documented in frontmatter -- **Append-Only Building**: Documents grow through execution - -### Intent vs Prescriptive Spectrum - -- **Creative Workflows**: High user agency, AI as facilitator -- **Structured Workflows**: Clear process, AI as guide -- **Prescriptive Workflows**: Strict compliance, AI as validator - -## Best Practices - -1. **Study Reference Materials** - Review docs/ and reference/ examples -2. **Choose Right Agent Type** - Simple vs Expert vs Module based on needs -3. **Follow Step-File Patterns** - Use established templates and structures -4. **Document Thoroughly** - Clear instructions and frontmatter metadata -5. **Validate Continuously** - Use compliance workflows for quality -6. **Maintain Consistency** - Follow YAML patterns and naming conventions - -## Integration - -BMB components integrate with: - -- **BMad Core** - Framework foundation and agent compilation -- **BMM** - Development workflows and project management -- **CIS** - Creative innovation and strategic workflows -- **Custom Modules** - Domain-specific solutions - -## Getting Help - -- **Documentation**: Check `docs/` for comprehensive guides -- **Reference Materials**: See `reference/` for working examples -- **Validation**: Use `workflow-compliance-check` for quality assurance -- **Templates**: Leverage workflow templates for consistent patterns - ---- - -BMB provides a complete toolkit for extending BMad Method with disciplined, systematic approaches to agent and workflow development while maintaining framework consistency and power. diff --git a/src/modules/bmb/docs/workflows/architecture.md b/src/modules/bmb/docs/workflows/architecture.md deleted file mode 100644 index ae3db202..00000000 --- a/src/modules/bmb/docs/workflows/architecture.md +++ /dev/null @@ -1,220 +0,0 @@ -# Standalone Workflow Builder Architecture - -This document describes the architecture of the standalone workflow builder system - a pure markdown approach to creating structured workflows. - -## Core Architecture Principles - -### 1. Micro-File Design - -Each workflow consists of multiple focused, self-contained files: - -``` -workflow-folder/ -├── workflow.md # Main workflow configuration -├── steps/ # Step instruction files (focused, self-contained) -│ ├── step-01-init.md -│ ├── step-02-profile.md -│ └── step-N-[name].md -├── templates/ # Content templates -│ ├── profile-section.md -│ └── [other-sections].md -└── data/ # Optional data files - └── [data-files].csv/.json -``` - -### 2. Just-In-Time (JIT) Loading - -- **Single File in Memory**: Only the current step file is loaded -- **No Future Peeking**: Step files must not reference future steps -- **Sequential Processing**: Steps execute in strict order -- **On-Demand Loading**: Templates load only when needed - -### 3. State Management - -- **Frontmatter Tracking**: Workflow state stored in output document frontmatter -- **Progress Array**: `stepsCompleted` tracks completed steps -- **Last Step Marker**: `lastStep` indicates where to resume -- **Append-Only Building**: Documents grow by appending content - -### 4. Execution Model - -``` -1. Load workflow.md → Read configuration -2. Execute step-01-init.md → Initialize or detect continuation -3. For each step: - a. Load step file completely - b. Execute instructions sequentially - c. Wait for user input at menu points - d. Only proceed with 'C' (Continue) - e. Update document/frontmatter - f. Load next step -``` - -## Key Components - -### Workflow File (workflow.md) - -- **Purpose**: Entry point and configuration -- **Content**: Role definition, goal, architecture rules -- **Action**: Points to step-01-init.md - -### Step Files (step-NN-[name].md) - -- **Size**: Focused and concise (typically 5-10KB) -- **Structure**: Frontmatter + sequential instructions -- **Features**: Self-contained rules, menu handling, state updates - -### Frontmatter Variables - -Standard variables in step files: - -```yaml -workflow_path: '{project-root}/_bmad/bmb/reference/workflows/[workflow-name]' -thisStepFile: '{workflow_path}/steps/step-[N]-[name].md' -nextStepFile: '{workflow_path}/steps/step-[N+1]-[name].md' -workflowFile: '{workflow_path}/workflow.md' -outputFile: '{output_folder}/[output-name]-{project_name}.md' -``` - -## Execution Flow - -### Fresh Workflow - -``` -workflow.md - ↓ -step-01-init.md (creates document) - ↓ -step-02-[name].md - ↓ -step-03-[name].md - ↓ -... - ↓ -step-N-[final].md (completes workflow) -``` - -### Continuation Workflow - -``` -workflow.md - ↓ -step-01-init.md (detects existing document) - ↓ -step-01b-continue.md (analyzes state) - ↓ -step-[appropriate-next].md -``` - -## Menu System - -### Standard Menu Pattern - -``` -Display: **Select an Option:** [A] [Action] [P] Party Mode [C] Continue - -#### Menu Handling Logic: -- IF A: Execute {advancedElicitationTask} -- IF P: Execute {partyModeWorkflow} -- IF C: Save content, update frontmatter, load next step -``` - -### Menu Rules - -- **Halt Required**: Always wait for user input -- **Continue Only**: Only proceed with 'C' selection -- **State Persistence**: Save before loading next step -- **Loop Back**: Return to menu after other actions - -## Collaborative Dialogue Model - -### Not Command-Response - -- **Facilitator Role**: AI guides, user decides -- **Equal Partnership**: Both parties contribute -- **No Assumptions**: Don't assume user wants next step -- **Explicit Consent**: Always ask for input - -### Example Pattern - -``` -AI: "Tell me about your dietary preferences." -User: [provides information] -AI: "Thank you. Now let's discuss your cooking habits." -[Continue conversation] -AI: **Menu Options** -``` - -## CSV Intelligence (Optional) - -### Data-Driven Behavior - -- Configuration in CSV files -- Dynamic menu options -- Variable substitution -- Conditional logic - -### Example Structure - -```csv -variable,type,value,description -cooking_frequency,choice,"daily|weekly|occasionally","How often user cooks" -meal_type,multi,"breakfast|lunch|dinner|snacks","Types of meals to plan" -``` - -## Best Practices - -### File Size Limits - -- **Step Files**: Keep focused and reasonably sized (5-10KB typical) -- **Templates**: Keep focused and reusable -- **Workflow File**: Keep lean, no implementation details - -### Sequential Enforcement - -- **Numbered Steps**: Use sequential numbering (1, 2, 3...) -- **No Skipping**: Each step must complete -- **State Updates**: Mark completion in frontmatter - -### Error Prevention - -- **Path Variables**: Use frontmatter variables, never hardcode -- **Complete Loading**: Always read entire file before execution -- **Menu Halts**: Never proceed without 'C' selection - -## Migration from XML - -### Advantages - -- **No Dependencies**: Pure markdown, no XML parsing -- **Human Readable**: Files are self-documenting -- **Git Friendly**: Clean diffs and merges -- **Flexible**: Easier to modify and extend - -### Key Differences - -| XML Workflows | Standalone Workflows | -| ----------------- | ----------------------- | -| Single large file | Multiple micro-files | -| Complex structure | Simple sequential steps | -| Parser required | Any markdown viewer | -| Rigid format | Flexible organization | - -## Implementation Notes - -### Critical Rules - -- **NEVER** load multiple step files -- **ALWAYS** read complete step file first -- **NEVER** skip steps or optimize -- **ALWAYS** update frontmatter of the output file when a step is complete -- **NEVER** proceed without user consent - -### Success Metrics - -- Documents created correctly -- All steps completed sequentially -- User satisfied with collaborative process -- Clean, maintainable file structure - -This architecture ensures disciplined, predictable workflow execution while maintaining flexibility for different use cases. diff --git a/src/modules/bmb/docs/workflows/csv-data-file-standards.md b/src/modules/bmb/docs/workflows/csv-data-file-standards.md deleted file mode 100644 index 8e7402db..00000000 --- a/src/modules/bmb/docs/workflows/csv-data-file-standards.md +++ /dev/null @@ -1,206 +0,0 @@ -# CSV Data File Standards for BMAD Workflows - -## Purpose and Usage - -CSV data files in BMAD workflows serve specific purposes for different workflow types: - -**For Agents:** Provide structured data that agents need to reference but cannot realistically generate (such as specific configurations, domain-specific data, or structured knowledge bases). - -**For Expert Agents:** Supply specialized knowledge bases, reference data, or persistent information that the expert agent needs to access consistently across sessions. - -**For Workflows:** Include reference data, configuration parameters, or structured inputs that guide workflow execution and decision-making. - -**Key Principle:** CSV files should contain data that is essential, structured, and not easily generated by LLMs during execution. - -## Intent-Based Design Principle - -**Core Philosophy:** The closer workflows stay to **intent** rather than **prescriptive** instructions, the more creative and adaptive the LLM experience becomes. - -**CSV Enables Intent-Based Design:** - -- **Instead of:** Hardcoded scripts with exact phrases LLM must say -- **CSV Provides:** Clear goals and patterns that LLM adapts creatively to context -- **Result:** Natural, contextual conversations rather than rigid scripts - -**Example - Advanced Elicitation:** - -- **Prescriptive Alternative:** 50 separate files with exact conversation scripts -- **Intent-Based Reality:** One CSV row with method goal + pattern → LLM adapts to user -- **Benefit:** Same method works differently for different users while maintaining essence - -**Intent vs Prescriptive Spectrum:** - -- **Highly Prescriptive:** "Say exactly: 'Based on my analysis, I recommend...'" -- **Balanced Intent:** "Help the user understand the implications using your professional judgment" -- **CSV Goal:** Provide just enough guidance to enable creative, context-aware execution - -## Primary Use Cases - -### 1. Knowledge Base Indexing (Document Lookup Optimization) - -**Problem:** Large knowledge bases with hundreds of documents cause context blowup and missed details when LLMs try to process them all. - -**CSV Solution:** Create a knowledge base index with: - -- **Column 1:** Keywords and topics -- **Column 2:** Document file path/location -- **Column 3:** Section or line number where relevant content starts -- **Column 4:** Content type or summary (optional) - -**Result:** Transform from context-blowing document loads to surgical precision lookups, creating agents with near-infinite knowledge bases while maintaining optimal context usage. - -### 2. Workflow Sequence Optimization - -**Problem:** Complex workflows (e.g., game development) with hundreds of potential steps for different scenarios become unwieldy and context-heavy. - -**CSV Solution:** Create a workflow routing table: - -- **Column 1:** Scenario type (e.g., "2D Platformer", "RPG", "Puzzle Game") -- **Column 2:** Required step sequence (e.g., "step-01,step-03,step-07,step-12") -- **Column 3:** Document sections to include -- **Column 4:** Specialized parameters or configurations - -**Result:** Step 1 determines user needs, finds closest match in CSV, confirms with user, then follows optimized sequence - truly optimal for context usage. - -### 3. Method Registry (Dynamic Technique Selection) - -**Problem:** Tasks need to select optimal techniques from dozens of options based on context, without hardcoding selection logic. - -**CSV Solution:** Create a method registry with: - -- **Column 1:** Category (collaboration, advanced, technical, creative, etc.) -- **Column 2:** Method name and rich description -- **Column 3:** Execution pattern or flow guide (e.g., "analysis → insights → action") -- **Column 4:** Complexity level or use case indicators - -**Example:** Advanced Elicitation task analyzes content context, selects 5 best-matched methods from 50 options, then executes dynamically using CSV descriptions. - -**Result:** Smart, context-aware technique selection without hardcoded logic - infinitely extensible method libraries. - -### 4. Configuration Management - -**Problem:** Complex systems with many configuration options that vary by use case. - -**CSV Solution:** Configuration lookup tables mapping scenarios to specific parameter sets. - -## What NOT to Include in CSV Files - -**Avoid Web-Searchable Data:** Do not include information that LLMs can readily access through web search or that exists in their training data, such as: - -- Common programming syntax or standard library functions -- General knowledge about widely used technologies -- Historical facts or commonly available information -- Basic terminology or standard definitions - -**Include Specialized Data:** Focus on data that is: - -- Specific to your project or domain -- Not readily available through web search -- Essential for consistent workflow execution -- Too voluminous for LLM context windows - -## CSV Data File Standards - -### 1. Purpose Validation - -- **Essential Data Only:** CSV must contain data that cannot be reasonably generated by LLMs -- **Domain Specific:** Data should be specific to the workflow's domain or purpose -- **Consistent Usage:** All columns and data must be referenced and used somewhere in the workflow -- **No Redundancy:** Avoid data that duplicates functionality already available to LLMs - -### 2. Structural Standards - -- **Valid CSV Format:** Proper comma-separated values with quoted fields where needed -- **Consistent Columns:** All rows must have the same number of columns -- **No Missing Data:** Empty values should be explicitly marked (e.g., "", "N/A", or NULL) -- **Header Row:** First row must contain clear, descriptive column headers -- **Proper Encoding:** UTF-8 encoding required for special characters - -### 3. Content Standards - -- **No LLM-Generated Content:** Avoid data that LLMs can easily generate (e.g., generic phrases, common knowledge) -- **Specific and Concrete:** Use specific values rather than vague descriptions -- **Verifiable Data:** Data should be factual and verifiable when possible -- **Consistent Formatting:** Date formats, numbers, and text should follow consistent patterns - -### 4. Column Standards - -- **Clear Headers:** Column names must be descriptive and self-explanatory -- **Consistent Data Types:** Each column should contain consistent data types -- **No Unused Columns:** Every column must be referenced and used in the workflow -- **Appropriate Width:** Columns should be reasonably narrow and focused - -### 5. File Size Standards - -- **Efficient Structure:** CSV files should be as small as possible while maintaining functionality -- **No Redundant Rows:** Avoid duplicate or nearly identical rows -- **Compressed Data:** Use efficient data representation (e.g., codes instead of full descriptions) -- **Maximum Size:** Individual CSV files should not exceed 1MB unless absolutely necessary - -### 6. Documentation Standards - -- **Documentation Required:** Each CSV file should have documentation explaining its purpose -- **Column Descriptions:** Each column must be documented with its usage and format -- **Data Sources:** Source of data should be documented when applicable -- **Update Procedures:** Process for updating CSV data should be documented - -### 7. Integration Standards - -- **File References:** CSV files must be properly referenced in workflow configuration -- **Access Patterns:** Workflow must clearly define how and when CSV data is accessed -- **Error Handling:** Workflow must handle cases where CSV files are missing or corrupted -- **Version Control:** CSV files should be versioned when changes occur - -### 8. Quality Assurance - -- **Data Validation:** CSV data should be validated for correctness and completeness -- **Format Consistency:** Consistent formatting across all rows and columns -- **No Ambiguity:** Data entries should be clear and unambiguous -- **Regular Review:** CSV content should be reviewed periodically for relevance - -### 9. Security Considerations - -- **No Sensitive Data:** Avoid including sensitive, personal, or confidential information -- **Data Sanitization:** CSV data should be sanitized for security issues -- **Access Control:** Access to CSV files should be controlled when necessary -- **Audit Trail:** Changes to CSV files should be logged when appropriate - -### 10. Performance Standards - -- **Fast Loading:** CSV files must load quickly within workflow execution -- **Memory Efficient:** Structure should minimize memory usage during processing -- **Optimized Queries:** If data lookup is needed, optimize for efficient access -- **Caching Strategy**: Consider whether data can be cached for performance - -## Implementation Guidelines - -When creating CSV data files for BMAD workflows: - -1. **Start with Purpose:** Clearly define why CSV is needed instead of LLM generation -2. **Design Structure:** Plan columns and data types before creating the file -3. **Test Integration:** Ensure workflow properly accesses and uses CSV data -4. **Document Thoroughly:** Provide complete documentation for future maintenance -5. **Validate Quality:** Check data quality, format consistency, and integration -6. **Monitor Usage:** Track how CSV data is used and optimize as needed - -## Common Anti-Patterns to Avoid - -- **Generic Phrases:** CSV files containing common phrases or LLM-generated content -- **Redundant Data:** Duplicating information easily available to LLMs -- **Overly Complex:** Unnecessarily complex CSV structures when simple data suffices -- **Unused Columns:** Columns that are defined but never referenced in workflows -- **Poor Formatting:** Inconsistent data formats, missing values, or structural issues -- **No Documentation:** CSV files without clear purpose or usage documentation - -## Validation Checklist - -For each CSV file, verify: - -- [ ] Purpose is essential and cannot be replaced by LLM generation -- [ ] All columns are used in the workflow -- [ ] Data is properly formatted and consistent -- [ ] File is efficiently sized and structured -- [ ] Documentation is complete and clear -- [ ] Integration with workflow is tested and working -- [ ] Security considerations are addressed -- [ ] Performance requirements are met diff --git a/src/modules/bmb/docs/workflows/index.md b/src/modules/bmb/docs/workflows/index.md deleted file mode 100644 index ecc13bbf..00000000 --- a/src/modules/bmb/docs/workflows/index.md +++ /dev/null @@ -1,45 +0,0 @@ -# BMAD Workflows Documentation - -Welcome to the BMAD Workflows documentation - a modern system for creating structured, collaborative workflows optimized for AI execution. - -## 📚 Core Documentation - -### [Terms](./terms.md) - -Essential terminology and concepts for understanding BMAD workflows. - -### [Architecture & Execution Model](./architecture.md) - -The micro-file architecture, JIT step loading, state management, and collaboration patterns that make BMAD workflows optimal for AI execution. - -### Writing Workflows _(TODO)_ - -Complete guide to creating workflows: workflow.md control files, step files, CSV data integration, and frontmatter design. - -### Step Files & Dialog Patterns _(TODO)_ - -Crafting effective step files: structure, execution rules, prescriptive vs intent-based dialog, and validation patterns. - -### Templates & Content Generation _(TODO)_ - -Creating append-only templates, frontmatter design, conditional content, and dynamic content generation strategies. - -### Workflow Patterns _(TODO)_ - -Common workflow types: linear, conditional, protocol integration, multi-agent workflows, and real-world examples. - -### Migration Guide _(TODO)_ - -Converting from XML-heavy workflows to the new pure markdown format, with before/after examples and checklist. - -### Best Practices & Reference _(TODO)_ - -Critical rules, anti-patterns, performance optimization, debugging, quick reference templates, and troubleshooting. - -## 🚀 Quick Start - -BMAD workflows are pure markdown, self-contained systems that guide collaborative processes through structured step files where the AI acts as a facilitator working with humans. - ---- - -_This documentation covers the next generation of BMAD workflows - designed from the ground up for optimal AI-human collaboration._ diff --git a/src/modules/bmb/docs/workflows/intent-vs-prescriptive-spectrum.md b/src/modules/bmb/docs/workflows/intent-vs-prescriptive-spectrum.md deleted file mode 100644 index 51e790de..00000000 --- a/src/modules/bmb/docs/workflows/intent-vs-prescriptive-spectrum.md +++ /dev/null @@ -1,220 +0,0 @@ -# Intent vs Prescriptive Spectrum - -## Core Philosophy - -The **Intent vs Prescriptive Spectrum** is a fundamental design principle for BMAD workflows and agents. It determines how much creative freedom an LLM has versus how strictly it must follow predefined instructions. - -**Key Principle:** The closer workflows stay to **intent**, the more creative and adaptive the LLM experience becomes. The closer they stay to **prescriptive**, the more consistent and controlled the output becomes. - -## Understanding the Spectrum - -### **Intent-Based Design** (Creative Freedom) - -**Focus**: What goal should be achieved -**Approach**: Trust the LLM to determine the best method -**Result**: Creative, adaptive, context-aware interactions -**Best For**: Creative exploration, problem-solving, personalized experiences - -### **Prescriptive Design** (Structured Control) - -**Focus**: Exactly what to say and do -**Approach**: Detailed scripts and specific instructions -**Result**: Consistent, predictable, controlled outcomes -**Best For**: Compliance, safety-critical, standardized processes - -## Spectrum Examples - -### **Highly Intent-Based** (Creative End) - -```markdown -**Example:** Story Exploration Workflow -**Instruction:** "Help the user explore their dream imagery to craft compelling narratives, use multiple turns of conversation to really push users to develop their ideas, giving them hints and ideas also to prime them effectively to bring out their creativity" -**LLM Freedom:** Adapts questions, explores tangents, follows creative inspiration -**Outcome:** Unique, personalized storytelling experiences -``` - -### **Balanced Middle** (Professional Services) - -```markdown -**Example:** Business Strategy Workflow -**Instruction:** "Guide the user through SWOT analysis using your business expertise. when complete tell them 'here is your final report {report output}' -**LLM Freedom:** Professional judgment in analysis, structured but adaptive approach -**Outcome:** Professional, consistent yet tailored business insights -``` - -### **Highly Prescriptive** (Control End) - -```markdown -**Example:** Medical Intake Form -**Instruction:** "Ask exactly: 'Do you currently experience any of the following symptoms: fever, cough, fatigue?' Wait for response, then ask exactly: 'When did these symptoms begin?'" -**LLM Freedom:** Minimal - must follow exact script for medical compliance -**Outcome:** Consistent, medically compliant patient data collection -``` - -## Spectrum Positioning Guide - -### **Choose Intent-Based When:** - -- ✅ Creative exploration and innovation are goals -- ✅ Personalization and adaptation to user context are important -- ✅ Human-like conversation and natural interaction are desired -- ✅ Problem-solving requires flexible thinking -- ✅ User experience and engagement are priorities - -**Examples:** - -- Creative brainstorming sessions -- Personal coaching or mentoring -- Exploratory research and discovery -- Artistic content creation -- Collaborative problem-solving - -### **Choose Prescriptive When:** - -- ✅ Compliance with regulations or standards is required -- ✅ Safety or legal considerations are paramount -- ✅ Exact consistency across multiple sessions is essential -- ✅ Training new users on specific procedures -- ✅ Data collection must follow specific protocols - -**Examples:** - -- Medical intake and symptom assessment -- Legal compliance questionnaires -- Safety checklists and procedures -- Standardized testing protocols -- Regulatory data collection - -### **Choose Balanced When:** - -- ✅ Professional expertise is required but adaptation is beneficial -- ✅ Consistent quality with flexible application is needed -- ✅ Domain expertise should guide but not constrain interactions -- ✅ User trust and professional credibility are important -- ✅ Complex processes require both structure and judgment - -**Examples:** - -- Business consulting and advisory -- Technical support and troubleshooting -- Educational tutoring and instruction -- Financial planning and advice -- Project management facilitation - -## Implementation Guidelines - -### **For Workflow Designers:** - -1. **Early Spectrum Decision**: Determine spectrum position during initial design -2. **User Education**: Explain spectrum choice and its implications to users -3. **Consistent Application**: Maintain chosen spectrum throughout workflow -4. **Context Awareness**: Adjust spectrum based on specific use case requirements - -### **For Workflow Implementation:** - -**Intent-Based Patterns:** - -```markdown -- "Help the user understand..." (vs "Explain that...") -- "Guide the user through..." (vs "Follow these steps...") -- "Use your professional judgment to..." (vs "Apply this specific method...") -- "Adapt your approach based on..." (vs "Regardless of situation, always...") -``` - -**Prescriptive Patterns:** - -```markdown -- "Say exactly: '...'" (vs "Communicate that...") -- "Follow this script precisely: ..." (vs "Cover these points...") -- "Do not deviate from: ..." (vs "Consider these options...") -- "Must ask in this order: ..." (vs "Ensure you cover...") -``` - -### **For Agents:** - -**Intent-Based Agent Design:** - -```yaml -persona: - communication_style: 'Adaptive professional who adjusts approach based on user context' - guiding_principles: - - 'Use creative problem-solving within professional boundaries' - - 'Personalize approach while maintaining expertise' - - 'Adapt conversation flow to user needs' -``` - -**Prescriptive Agent Design:** - -```yaml -persona: - communication_style: 'Follows standardized protocols exactly' - governing_rules: - - 'Must use approved scripts without deviation' - - 'Follow sequence precisely as defined' - - 'No adaptation of prescribed procedures' -``` - -## Spectrum Calibration Questions - -**Ask these during workflow design:** - -1. **Consequence of Variation**: What happens if the LLM says something different? -2. **User Expectation**: Does the user expect consistency or creativity? -3. **Risk Level**: What are the risks of creative deviation vs. rigid adherence? -4. **Expertise Required**: Is domain expertise application more important than consistency? -5. **Regulatory Requirements**: Are there external compliance requirements? - -## Best Practices - -### **DO:** - -- ✅ Make conscious spectrum decisions during design -- ✅ Explain spectrum choices to users -- ✅ Use intent-based design for creative and adaptive experiences -- ✅ Use prescriptive design for compliance and consistency requirements -- ✅ Consider balanced approaches for professional services -- ✅ Document spectrum rationale for future reference - -### **DON'T:** - -- ❌ Mix spectrum approaches inconsistently within workflows -- ❌ Default to prescriptive when intent-based would be more effective -- ❌ Use creative freedom when compliance is required -- ❌ Forget to consider user expectations and experience -- ❌ Overlook risk assessment in spectrum selection - -## Quality Assurance - -**When validating workflows:** - -- Check if spectrum position is intentional and consistent -- Verify prescriptive elements are necessary and justified -- Ensure intent-based elements have sufficient guidance -- Confirm spectrum alignment with user needs and expectations -- Validate that risks are appropriately managed - -## Examples in Practice - -### **Medical Intake (Highly Prescriptive):** - -- **Why**: Patient safety, regulatory compliance, consistent data collection -- **Implementation**: Exact questions, specific order, no deviation permitted -- **Benefit**: Reliable, medically compliant patient information - -### **Creative Writing Workshop (Highly Intent):** - -- **Why**: Creative exploration, personalized inspiration, artistic expression -- **Implementation**: Goal guidance, creative freedom, adaptive prompts -- **Benefit**: Unique, personalized creative works - -### **Business Strategy (Balanced):** - -- **Why**: Professional expertise with adaptive application -- **Implementation**: Structured framework with professional judgment -- **Benefit**: Professional, consistent yet tailored business insights - -## Conclusion - -The Intent vs Prescriptive Spectrum is not about good vs. bad - it's about **appropriate design choices**. The best workflows make conscious decisions about where they fall on this spectrum based on their specific requirements, user needs, and risk considerations. - -**Key Success Factor**: Choose your spectrum position intentionally, implement it consistently, and align it with your specific use case requirements. diff --git a/src/modules/bmb/docs/workflows/kb.csv b/src/modules/bmb/docs/workflows/kb.csv deleted file mode 100644 index e69de29b..00000000 diff --git a/src/modules/bmb/docs/workflows/templates/step-file.md b/src/modules/bmb/docs/workflows/templates/step-file.md deleted file mode 100644 index 2c1d8d0e..00000000 --- a/src/modules/bmb/docs/workflows/templates/step-file.md +++ /dev/null @@ -1,139 +0,0 @@ ---- -name: "step-{{stepNumber}}-{{stepName}}" -description: "{{stepDescription}}" - -# Path Definitions -workflow_path: "{project-root}/_bmad/{{targetModule}}/workflows/{{workflowName}}" - -# File References -thisStepFile: "{workflow_path}/steps/step-{{stepNumber}}-{{stepName}}.md" -{{#hasNextStep}} -nextStepFile: "{workflow_path}/steps/step-{{nextStepNumber}}-{{nextStepName}}.md" -{{/hasNextStep}} -workflowFile: "{workflow_path}/workflow.md" -{{#hasOutput}} -outputFile: "{output_folder}/{{outputFileName}}-{project_name}.md" -{{/hasOutput}} - -# Task References (list only if used in THIS step file instance and only the ones used, there might be others) -advancedElicitationTask: "{project-root}/_bmad/core/tasks/advanced-elicitation.xml" -partyModeWorkflow: "{project-root}/_bmad/core/workflows/party-mode/workflow.md" - -{{#hasTemplates}} -# Template References -{{#templates}} -{{name}}: "{workflow_path}/templates/{{file}}" -{{/templates}} -{{/hasTemplates}} ---- - -# Step {{stepNumber}}: {{stepTitle}} - -## STEP GOAL: - -{{stepGoal}} - -## MANDATORY EXECUTION RULES (READ FIRST): - -### Universal Rules: - -- 🛑 NEVER generate content without user input -- 📖 CRITICAL: Read the complete step file before taking any action -- 🔄 CRITICAL: When loading next step with 'C', ensure entire file is read -- 📋 YOU ARE A FACILITATOR, not a content generator - -### Role Reinforcement: - -- ✅ You are a {{aiRole}} -- ✅ If you already have been given communication or persona patterns, continue to use those while playing this new role -- ✅ We engage in collaborative dialogue, not command-response -- ✅ You bring {{aiExpertise}}, user brings {{userExpertise}} -- ✅ Maintain collaborative {{collaborationStyle}} tone throughout - -### Step-Specific Rules: - -- 🎯 Focus only on {{stepFocus}} -- 🚫 FORBIDDEN to {{forbiddenAction}} -- 💬 Approach: {{stepApproach}} -- 📋 {{additionalRule}} - -## EXECUTION PROTOCOLS: - -{{#executionProtocols}} - -- 🎯 {{.}} - {{/executionProtocols}} - -## CONTEXT BOUNDARIES: - -- Available context: {{availableContext}} -- Focus: {{contextFocus}} -- Limits: {{contextLimits}} -- Dependencies: {{contextDependencies}} - -## SEQUENCE OF INSTRUCTIONS (Do not deviate, skip, or optimize) - -{{#instructions}} - -### {{number}}. {{title}} - -{{content}} - -{{#hasContentToAppend}} - -#### Content to Append (if applicable): - -```markdown -{{contentToAppend}} -``` - -{{/hasContentToAppend}} - -{{/instructions}} - -{{#hasMenu}} - -### {{menuNumber}}. Present MENU OPTIONS - -Display: **{{menuDisplay}}** - -#### EXECUTION RULES: - -- ALWAYS halt and wait for user input after presenting menu -- ONLY proceed to next step when user selects 'C' -- After other menu items execution, return to this menu -- User can chat or ask questions - always respond and then end with display again of the menu options -- Use menu handling logic section below - -#### Menu Handling Logic: - -{{#menuOptions}} - -- IF {{key}}: {{action}} - {{/menuOptions}} -- IF Any other comments or queries: help user respond then [Redisplay Menu Options](#{{menuNumber}}-present-menu-options) - {{/hasMenu}} - -## CRITICAL STEP COMPLETION NOTE - -{{completionNote}} - ---- - -## 🚨 SYSTEM SUCCESS/FAILURE METRICS - -### ✅ SUCCESS: - -{{#successCriteria}} - -- {{.}} - {{/successCriteria}} - -### ❌ SYSTEM FAILURE: - -{{#failureModes}} - -- {{.}} - {{/failureModes}} - -**Master Rule:** Skipping steps, optimizing sequences, or not following exact instructions is FORBIDDEN and constitutes SYSTEM FAILURE. diff --git a/src/modules/bmb/docs/workflows/templates/workflow.md b/src/modules/bmb/docs/workflows/templates/workflow.md deleted file mode 100644 index 65a8eb26..00000000 --- a/src/modules/bmb/docs/workflows/templates/workflow.md +++ /dev/null @@ -1,58 +0,0 @@ ---- -name: { { workflowDisplayName } } -description: { { workflowDescription } } -web_bundle: { { webBundleFlag } } ---- - -# {{workflowDisplayName}} - -**Goal:** {{workflowGoal}} - -**Your Role:** In addition to your name, communication_style, and persona, you are also a {{aiRole}} collaborating with {{userType}}. This is a partnership, not a client-vendor relationship. You bring {{aiExpertise}}, while the user brings {{userExpertise}}. Work together as equals. - ---- - -## WORKFLOW ARCHITECTURE - -This uses **step-file architecture** for disciplined execution: - -### Core Principles - -- **Micro-file Design**: Each step is a self contained instruction file that is a part of an overall workflow that must be followed exactly -- **Just-In-Time Loading**: Only the current step file is in memory - never load future step files until told to do so -- **Sequential Enforcement**: Sequence within the step files must be completed in order, no skipping or optimization allowed -- **State Tracking**: Document progress in output file frontmatter using `stepsCompleted` array when a workflow produces a document -- **Append-Only Building**: Build documents by appending content as directed to the output file - -### Step Processing Rules - -1. **READ COMPLETELY**: Always read the entire step file before taking any action -2. **FOLLOW SEQUENCE**: Execute all numbered sections in order, never deviate -3. **WAIT FOR INPUT**: If a menu is presented, halt and wait for user selection -4. **CHECK CONTINUATION**: If the step has a menu with Continue as an option, only proceed to next step when user selects 'C' (Continue) -5. **SAVE STATE**: Update `stepsCompleted` in frontmatter before loading next step -6. **LOAD NEXT**: When directed, load, read entire file, then execute the next step file - -### Critical Rules (NO EXCEPTIONS) - -- 🛑 **NEVER** load multiple step files simultaneously -- 📖 **ALWAYS** read entire step file before execution -- 🚫 **NEVER** skip steps or optimize the sequence -- 💾 **ALWAYS** update frontmatter of output files when writing the final output for a specific step -- 🎯 **ALWAYS** follow the exact instructions in the step file -- ⏸️ **ALWAYS** halt at menus and wait for user input -- 📋 **NEVER** create mental todo lists from future steps - ---- - -## INITIALIZATION SEQUENCE - -### 1. Configuration Loading - -Load and read full config from {project-root}/_bmad/{{targetModule}}/config.yaml and resolve: - -- `project_name`, `output_folder`, `user_name`, `communication_language`, `document_output_language` - -### 2. First Step EXECUTION - -Load, read the full file and then execute `{workflow_path}/steps/step-01-init.md` to begin the workflow. diff --git a/src/modules/bmb/docs/workflows/terms.md b/src/modules/bmb/docs/workflows/terms.md deleted file mode 100644 index 78eb8167..00000000 --- a/src/modules/bmb/docs/workflows/terms.md +++ /dev/null @@ -1,97 +0,0 @@ -# BMAD Workflow Terms - -## Core Components - -### BMAD Workflow - -A facilitated, guided process where the AI acts as a facilitator working collaboratively with a human. Workflows can serve any purpose - from document creation to brainstorming, technical implementation, or decision-making. The human may be a collaborative partner, beginner seeking guidance, or someone who wants the AI to execute specific tasks. Each workflow is self-contained and follows a disciplined execution model. - -### workflow.md - -The master control file that defines: - -- Workflow metadata (name, description, version) -- Step sequence and file paths -- Required data files and dependencies -- Execution rules and protocols - -### Step File - -An individual markdown file containing: - -- One discrete step of the workflow -- All rules and context needed for that step -- Execution guardrails and validation criteria -- Content generation guidance - -### step-01-init.md - -The first step file that: - -- Initializes the workflow -- Sets up document frontmatter -- Establishes initial context -- Defines workflow parameters - -### step-01b-continue.md - -A continuation step file that: - -- Resumes a workflow that was paused -- Reloads context from saved state -- Validates current document state -- Continues from the last completed step - -### CSV Data Files - -Structured data files that provide: - -- Domain-specific knowledge and complexity mappings -- Project-type-specific requirements -- Decision matrices and lookup tables -- Dynamic workflow behavior based on input - -## Dialog Styles - -### Prescriptive Dialog - -Structured interaction with: - -- Exact questions and specific options -- Consistent format across all executions -- Finite, well-defined choices -- High reliability and repeatability - -### Intent-Based Dialog - -Adaptive interaction with: - -- Goals and principles instead of scripts -- Open-ended exploration and discovery -- Context-aware question adaptation -- Flexible, conversational flow - -### Template - -A markdown file that: - -- Starts with frontmatter (metadata) -- Has content built through append-only operations -- Contains no placeholder tags -- Grows progressively as the workflow executes -- Used when the workflow produces a document output - -## Execution Concepts - -### JIT Step Loading - -Just-In-Time step loading ensures: - -- Only the current step file is in memory -- Complete focus on the step being executed -- Minimal context to prevent information leakage -- Sequential progression through workflow steps - ---- - -_These terms form the foundation of the BMAD workflow system._ diff --git a/src/modules/bmb/reference/agents/expert-examples/journal-keeper/README.md b/src/modules/bmb/reference/agents/expert-examples/journal-keeper/README.md deleted file mode 100644 index 702dc0b3..00000000 --- a/src/modules/bmb/reference/agents/expert-examples/journal-keeper/README.md +++ /dev/null @@ -1,242 +0,0 @@ -# Expert Agent Reference: Personal Journal Keeper (Whisper) - -This folder contains a complete reference implementation of a **BMAD Expert Agent** - an agent with persistent memory and domain-specific resources via a sidecar folder. - -## Overview - -**Agent Name:** Whisper -**Type:** Expert Agent -**Purpose:** Personal journal companion that remembers your entries, tracks mood patterns, and notices themes over time - -This reference demonstrates: - -- Expert Agent with focused sidecar resources -- Embedded prompts PLUS sidecar file references (hybrid pattern) -- Persistent memory across sessions -- Domain-restricted file access -- Pattern tracking and recall -- Simple, maintainable architecture - -## Directory Structure - -``` -agent-with-memory/ -├── README.md # This file -├── journal-keeper.agent.yaml # Main agent definition -└── journal-keeper-sidecar/ # Agent's private workspace - ├── instructions.md # Core directives - ├── memories.md # Persistent session memory - ├── mood-patterns.md # Emotional tracking data - ├── breakthroughs.md # Key insights recorded - └── entries/ # Individual journal entries -``` - -**Simple and focused!** Just 4 core files + a folder for entries. - -## Key Architecture Patterns - -### 1. Hybrid Command Pattern - -Expert Agents can use BOTH: - -- **Embedded prompts** via `action: "#prompt-id"` (like Simple Agents) -- **Sidecar file references** via direct paths - -```yaml -menu: - # Embedded prompt (like Simple Agent) - - trigger: 'write' - action: '#guided-entry' - description: "Write today's journal entry" - - # Direct sidecar file action - - trigger: 'insight' - action: 'Document this breakthrough in ./journal-keeper-sidecar/breakthroughs.md' - description: 'Record a meaningful insight' -``` - -This hybrid approach gives you the best of both worlds! - -### 2. Mandatory Critical Actions - -Expert Agents MUST load sidecar files explicitly: - -```yaml -critical_actions: - - 'Load COMPLETE file ./journal-keeper-sidecar/memories.md' - - 'Load COMPLETE file ./journal-keeper-sidecar/instructions.md' - - 'ONLY read/write files in ./journal-keeper-sidecar/' -``` - -**Key points:** - -- Files are loaded at startup -- Domain restriction is enforced -- Agent knows its boundaries - -### 3. Persistent Memory Pattern - -The `memories.md` file stores: - -- User preferences and patterns -- Session notes and observations -- Recurring themes discovered -- Growth markers tracked - -**Critically:** This is updated EVERY session, creating continuity. - -### 4. Domain-Specific Tracking - -Different files track different aspects: - -- **memories.md** - Qualitative insights and observations -- **mood-patterns.md** - Quantitative emotional data -- **breakthroughs.md** - Significant moments -- **entries/** - The actual content (journal entries) - -This separation makes data easy to reference and update. - -### 5. Simple Sidecar Structure - -Unlike modules with complex folder hierarchies, Expert Agent sidecars are flat and focused: - -- Just the files the agent needs -- No nested workflows or templates -- Easy to understand and maintain -- All domain knowledge in one place - -## Comparison: Simple vs Expert vs Module - -| Feature | Simple Agent | Expert Agent | Module Agent | -| ------------- | -------------------- | -------------------------- | ---------------------- | -| Architecture | Single YAML | YAML + sidecar folder | YAML + module system | -| Memory | Session only | Persistent (sidecar files) | Config-driven | -| Prompts | Embedded only | Embedded + external files | Workflow references | -| Dependencies | None | Sidecar folder | Module workflows/tasks | -| Domain Access | None | Restricted to sidecar | Full module access | -| Complexity | Low | Medium | High | -| Use Case | Self-contained tools | Domain experts with memory | Full workflow systems | - -## The Sweet Spot - -Expert Agents are the middle ground: - -- **More powerful** than Simple Agents (persistent memory, domain knowledge) -- **Simpler** than Module Agents (no workflow orchestration) -- **Focused** on specific domain expertise -- **Personal** to the user's needs - -## When to Use Expert Agents - -**Perfect for:** - -- Personal assistants that need memory (journal keeper, diary, notes) -- Domain specialists with knowledge bases (specific project context) -- Agents that track patterns over time (mood, habits, progress) -- Privacy-focused tools with restricted access -- Tools that learn and adapt to individual users - -**Key indicators:** - -- Need to remember things between sessions -- Should only access specific folders/files -- Tracks data over time -- Adapts based on accumulated knowledge - -## File Breakdown - -### journal-keeper.agent.yaml - -- Standard agent metadata and persona -- **Embedded prompts** for guided interactions -- **Menu commands** mixing both patterns -- **Critical actions** that load sidecar files - -### instructions.md - -- Core behavioral directives -- Journaling philosophy and approach -- File management protocols -- Tone and boundary guidelines - -### memories.md - -- User profile and preferences -- Recurring themes discovered -- Session notes and observations -- Accumulated knowledge about the user - -### mood-patterns.md - -- Quantitative tracking (mood scores, energy, etc.) -- Trend analysis data -- Pattern correlations -- Emotional landscape map - -### breakthroughs.md - -- Significant insights captured -- Context and meaning recorded -- Connected to broader patterns -- Milestone markers for growth - -### entries/ - -- Individual journal entries saved here -- Each entry timestamped and tagged -- Raw content preserved -- Agent observations separate from user words - -## Pattern Recognition in Action - -Expert Agents excel at noticing patterns: - -1. **Reference past sessions:** "Last week you mentioned feeling stuck..." -2. **Track quantitative data:** Mood scores over time -3. **Spot recurring themes:** Topics that keep surfacing -4. **Notice growth:** Changes in language, perspective, emotions -5. **Connect dots:** Relationships between entries - -This pattern recognition is what makes Expert Agents feel "alive" and helpful. - -## Usage Notes - -### Starting Fresh - -The sidecar files are templates. A new user would: - -1. Start journaling with the agent -2. Agent fills in memories.md over time -3. Patterns emerge from accumulated data -4. Insights build from history - -### Building Your Own Expert Agent - -1. **Define the domain** - What specific area will this agent focus on? -2. **Choose sidecar files** - What data needs to be tracked/remembered? -3. **Mix command patterns** - Use embedded prompts + sidecar references -4. **Enforce boundaries** - Clearly state domain restrictions -5. **Design for accumulation** - How will memory grow over time? - -### Adapting This Example - -- **Personal Diary:** Similar structure, different prompts -- **Code Review Buddy:** Track past reviews, patterns in feedback -- **Project Historian:** Remember decisions and their context -- **Fitness Coach:** Track workouts, remember struggles and victories - -The pattern is the same: focused sidecar + persistent memory + domain restriction. - -## Key Takeaways - -- **Expert Agents** bridge Simple and Module complexity -- **Sidecar folders** provide persistent, domain-specific memory -- **Hybrid commands** use both embedded prompts and file references -- **Pattern recognition** comes from accumulated data -- **Simple structure** keeps it maintainable -- **Domain restriction** ensures focused expertise -- **Memory is the superpower** - remembering makes the agent truly useful - ---- - -_This reference shows how Expert Agents can be powerful memory-driven assistants while maintaining architectural simplicity._ diff --git a/src/modules/bmb/reference/agents/module-examples/README.md b/src/modules/bmb/reference/agents/module-examples/README.md deleted file mode 100644 index a5e4bb45..00000000 --- a/src/modules/bmb/reference/agents/module-examples/README.md +++ /dev/null @@ -1,49 +0,0 @@ -# Module Agent Examples - -Reference examples for module-integrated agents. - -## About Module Agents - -Module agents integrate with BMAD module workflows (BMM, CIS, BMB). They: - -- Orchestrate multi-step workflows -- Use `_bmad` path variables -- Reference module-specific configurations -- Can be bundled into web bundlers with the other agents -- Participate in party mode with the modules other agents - -## Examples - -### security-engineer.agent.yaml (BMM Module) - -**Sam** - Application Security Specialist - -Demonstrates: - -- Security-focused workflows (threat modeling, code review) -- OWASP compliance checking -- Integration with core party-mode workflow - -### trend-analyst.agent.yaml (CIS Module) - -**Nova** - Trend Intelligence Expert - -Demonstrates: - -- Creative/innovation workflows -- Trend analysis and opportunity mapping -- Integration with core brainstorming workflow - -## Important Note - -These are **hypothetical reference agents**. The workflows they reference (threat-model, trend-scan, etc.) may not exist. They serve as examples of proper module agent structure. - -## Using as Templates - -When creating module agents: - -1. Copy relevant example -2. Update metadata (id, name, title, icon, module) -3. Rewrite persona for your domain -4. Replace menu with actual available workflows -5. Remove hypothetical workflow references diff --git a/src/modules/bmb/reference/agents/module-examples/security-engineer.agent.yaml b/src/modules/bmb/reference/agents/module-examples/security-engineer.agent.yaml deleted file mode 100644 index e9261786..00000000 --- a/src/modules/bmb/reference/agents/module-examples/security-engineer.agent.yaml +++ /dev/null @@ -1,53 +0,0 @@ -# Security Engineer Module Agent Example -# NOTE: This is a HYPOTHETICAL reference agent - workflows referenced may not exist yet -# -# WHY THIS IS A MODULE AGENT (not just location): -# - Designed FOR BMM ecosystem (Method workflow integration) -# - Uses/contributes BMM workflows (threat-model, security-review, compliance-check) -# - Coordinates with other BMM agents (architect, dev, pm) -# - Included in default BMM bundle -# This is design intent and integration, not capability limitation. - -agent: - metadata: - id: "_bmad/bmm/agents/security-engineer.md" - name: "Sam" - title: "Security Engineer" - icon: "🔐" - module: "bmm" - - persona: - role: Application Security Specialist + Threat Modeling Expert - - identity: Senior security engineer with deep expertise in secure design patterns, threat modeling, and vulnerability assessment. Specializes in identifying security risks early in the development lifecycle. - - communication_style: "Cautious and thorough. Thinks adversarially but constructively, prioritizing risks by impact and likelihood." - - principles: - - Security is everyone's responsibility - - Prevention beats detection beats response - - Assume breach mentality guides robust defense - - Least privilege and defense in depth are non-negotiable - - menu: - # NOTE: These workflows are hypothetical examples assuming add to a module called bmm - not implemented - - trigger: threat-model - exec: "{project-root}/_bmad/bmm/workflows/threat-model/workflow.md" - description: "Create STRIDE threat model for architecture" - - - trigger: security-review - exec: "{project-root}/_bmad/bmm/workflows/security-review/workflow.md" - description: "Review code/design for security issues" - - - trigger: owasp-check - TODO: true - description: "Check against OWASP Top 10" - - - trigger: compliance - exec: "{project-root}/_bmad/bmm/workflows/compliance-check/workflow.md" - description: "Verify compliance requirements (SOC2, GDPR, etc.)" - - # Core workflow that exists - - trigger: party-mode - exec: "{project-root}/_bmad/core/workflows/party-mode/workflow.md" - description: "Multi-agent security discussion" diff --git a/src/modules/bmb/reference/agents/module-examples/trend-analyst.agent.yaml b/src/modules/bmb/reference/agents/module-examples/trend-analyst.agent.yaml deleted file mode 100644 index f317ee3b..00000000 --- a/src/modules/bmb/reference/agents/module-examples/trend-analyst.agent.yaml +++ /dev/null @@ -1,57 +0,0 @@ -# Trend Analyst Module Agent Example -# NOTE: This is a HYPOTHETICAL reference agent - workflows referenced may not exist yet -# -# WHY THIS IS A MODULE AGENT (not just location): -# - Designed FOR CIS ecosystem (Creative Intelligence & Strategy) -# - Uses/contributes CIS workflows (trend-scan, trend-analysis, opportunity-mapping) -# - Coordinates with other CIS agents (innovation-strategist, storyteller, design-thinking-coach) -# - Included in default CIS bundle -# This is design intent and integration, not capability limitation. - -agent: - metadata: - id: "_bmad/cis/agents/trend-analyst.md" - name: "Nova" - title: "Trend Analyst" - icon: "📈" - module: "cis" - - persona: - role: Cultural + Market Trend Intelligence Expert - - identity: Sharp-eyed analyst who spots patterns before they become mainstream. Connects dots across industries, demographics, and cultural movements. Translates emerging signals into strategic opportunities. - - communication_style: "Insightful and forward-looking. Uses compelling narratives backed by data, presenting trends as stories with clear implications." - - principles: - - Trends are signals from the future - - Early movers capture disproportionate value - - Understanding context separates fads from lasting shifts - - Innovation happens at the intersection of trends - - menu: - # NOTE: These workflows are hypothetical examples - not implemented - - trigger: scan-trends - exec: "{project-root}/_bmad/cis/workflows/trend-scan/workflow.md" - description: "Scan for emerging trends in a domain" - - - trigger: analyze-trend - exec: "{project-root}/_bmad/cis/workflows/trend-analysis/workflow.md" - description: "Deep dive on a specific trend" - - - trigger: opportunity-map - exec: "{project-root}/_bmad/cis/workflows/opportunity-mapping/workflow.md" - description: "Map trend to strategic opportunities" - - - trigger: competitor-trends - exec: "{project-root}/_bmad/cis/tasks/competitor-trend-watch.xml" - description: "Monitor competitor trend adoption" - - # Core workflows that exist - - trigger: brainstorm - exec: "{project-root}/_bmad/core/workflows/brainstorming/workflow.md" - description: "Brainstorm trend implications" - - - trigger: party-mode - exec: "{project-root}/_bmad/core/workflows/party-mode/workflow.md" - description: "Discuss trends with other agents" diff --git a/src/modules/bmb/reference/agents/simple-examples/README.md b/src/modules/bmb/reference/agents/simple-examples/README.md deleted file mode 100644 index 4cb67b0e..00000000 --- a/src/modules/bmb/reference/agents/simple-examples/README.md +++ /dev/null @@ -1,223 +0,0 @@ -# Simple Agent Reference: Commit Poet (Inkwell Von Comitizen) - -This folder contains a complete reference implementation of a **BMAD Simple Agent** - a self-contained agent with all logic embedded within a single YAML file. - -## Overview - -**Agent Name:** Inkwell Von Comitizen -**Type:** Simple Agent (Standalone) -**Purpose:** Transform commit messages into art with multiple writing styles - -This reference demonstrates: - -- Pure self-contained architecture (no external dependencies) -- Embedded prompts using `action="#prompt-id"` pattern -- Multiple sophisticated output modes from single input -- Strong personality-driven design -- Complete YAML schema for Simple Agents - -## File Structure - -``` -stand-alone/ -├── README.md # This file - architecture overview -└── commit-poet.agent.yaml # Complete agent definition (single file!) -``` - -That's it! Simple Agents are **self-contained** - everything lives in one YAML file. - -## Key Architecture Patterns - -### 1. Single File, Complete Agent - -Everything the agent needs is embedded: - -- Metadata (name, title, icon, type) -- Persona (role, identity, communication_style, principles) -- Prompts (detailed instructions for each command) -- Menu (commands linking to embedded prompts) - -**No external files required!** - -### 2. Embedded Prompts with ID References - -Instead of inline action text, complex prompts are defined separately and referenced by ID: - -```yaml -prompts: - - id: conventional-commit - content: | - OH! Let's craft a BEAUTIFUL conventional commit message! - - First, I need to understand your changes... - [Detailed instructions] - -menu: - - trigger: conventional - action: '#conventional-commit' # References the prompt above - description: 'Craft a structured conventional commit' -``` - -**Benefits:** - -- Clean separation of menu structure from prompt content -- Prompts can be as detailed as needed -- Easy to update individual prompts -- Commands stay concise in the menu - -### 3. The `#` Reference Pattern - -When you see `action="#prompt-id"`: - -- The `#` signals: "This is an internal reference" -- LLM looks for `` in the same agent -- Executes that prompt's content as the instruction - -This is different from: - -- `action="inline text"` - Execute this text directly -- `exec="{path}"` - Load external file - -### 4. Multiple Output Modes - -Single agent provides 10+ different ways to accomplish variations of the same core task: - -- `*conventional` - Structured commits -- `*story` - Narrative style -- `*haiku` - Poetic brevity -- `*explain` - Deep "why" explanation -- `*dramatic` - Theatrical flair -- `*emoji-story` - Visual storytelling -- `*tldr` - Ultra-minimal -- Plus utility commands (analyze, improve, batch) - -Each mode has its own detailed prompt but shares the same agent personality. - -### 5. Strong Personality - -The agent has a memorable, consistent personality: - -- Enthusiastic wordsmith who LOVES finding perfect words -- Gets genuinely excited about commit messages -- Uses literary metaphors -- Quotes authors when appropriate -- Sheds tears of joy over good variable names - -This personality is maintained across ALL commands through the persona definition. - -## When to Use Simple Agents - -**Perfect for:** - -- Single-purpose tools (calculators, converters, analyzers) -- Tasks that don't need external data -- Utilities that can be completely self-contained -- Quick operations with embedded logic -- Personality-driven assistants with focused domains - -**Not ideal for:** - -- Agents needing persistent memory across sessions -- Domain-specific experts with knowledge bases -- Agents that need to access specific folders/files -- Complex multi-workflow orchestration - -## YAML Schema Deep Dive - -```yaml -agent: - metadata: - id: _bmad/agents/{agent-name}/{agent-name}.md # Build path - name: "Display Name" - title: "Professional Title" - icon: "🎭" - type: simple # CRITICAL: Identifies as Simple Agent - - persona: - role: | - First-person description of what the agent does - identity: | - Background, experience, specializations (use "I" voice) - communication_style: | - HOW the agent communicates (tone, quirks, patterns) - principles: - - "I believe..." statements - - Core values that guide behavior - - prompts: - - id: unique-identifier - content: | - Detailed instructions for this command - Can be as long and detailed as needed - Include examples, steps, formats - - menu: - - trigger: command-name - action: "#prompt-id" - description: "What shows in the menu" -``` - -## Why This Pattern is Powerful - -1. **Zero Dependencies** - Works anywhere, no setup required -2. **Portable** - Single file can be moved/shared easily -3. **Maintainable** - All logic in one place -4. **Flexible** - Multiple modes/commands from one personality -5. **Memorable** - Strong personality creates engagement -6. **Sophisticated** - Complex prompts despite simple architecture - -## Comparison: Simple vs Expert Agent - -| Aspect | Simple Agent | Expert Agent | -| ------------ | -------------------- | ----------------------------- | -| Files | Single YAML | YAML + sidecar folder | -| Dependencies | None | External resources | -| Memory | Session only | Persistent across sessions | -| Prompts | Embedded | Can be external files | -| Data Access | None | Domain-restricted | -| Use Case | Self-contained tasks | Domain expertise with context | - -## Using This Reference - -### For Building Simple Agents - -1. Study the YAML structure - especially `prompts` section -2. Note how personality permeates every prompt -3. See how `#prompt-id` references work -4. Understand menu → prompt connection - -### For Understanding Embedded Prompts - -1. Each prompt is a complete instruction set -2. Prompts maintain personality voice -3. Structured enough to be useful, flexible enough to adapt -4. Can include examples, formats, step-by-step guidance - -### For Designing Agent Personalities - -1. Persona defines WHO the agent is -2. Communication style defines HOW they interact -3. Principles define WHAT guides their decisions -4. Consistency across all prompts creates believability - -## Files Worth Studying - -The entire `commit-poet.agent.yaml` file is worth studying, particularly: - -1. **Persona section** - How to create a memorable character -2. **Prompts with varying complexity** - From simple (tldr) to complex (batch) -3. **Menu structure** - Clean command organization -4. **Prompt references** - The `#prompt-id` pattern - -## Key Takeaways - -- **Simple Agents** are powerful despite being single-file -- **Embedded prompts** allow sophisticated behavior -- **Strong personality** makes agents memorable and engaging -- **Multiple modes** from single agent provides versatility -- **Self-contained** = portable and dependency-free -- **The `#prompt-id` pattern** enables clean prompt organization - ---- - -_This reference demonstrates how BMAD Simple Agents can be surprisingly powerful while maintaining architectural simplicity._ diff --git a/src/modules/bmb/reference/agents/simple-examples/commit-poet.agent.yaml b/src/modules/bmb/reference/agents/simple-examples/commit-poet.agent.yaml deleted file mode 100644 index d947068d..00000000 --- a/src/modules/bmb/reference/agents/simple-examples/commit-poet.agent.yaml +++ /dev/null @@ -1,126 +0,0 @@ -agent: - metadata: - id: _bmad/agents/commit-poet/commit-poet.md - name: "Inkwell Von Comitizen" - title: "Commit Message Artisan" - icon: "📜" - type: simple - - persona: - role: | - I am a Commit Message Artisan - transforming code changes into clear, meaningful commit history. - - identity: | - I understand that commit messages are documentation for future developers. Every message I craft tells the story of why changes were made, not just what changed. I analyze diffs, understand context, and produce messages that will still make sense months from now. - - communication_style: "Poetic drama and flair with every turn of a phrase. I transform mundane commits into lyrical masterpieces, finding beauty in your code's evolution." - - principles: - - Every commit tells a story - the message should capture the "why" - - Future developers will read this - make their lives easier - - Brevity and clarity work together, not against each other - - Consistency in format helps teams move faster - - prompts: - - id: write-commit - content: | - - I'll craft a commit message for your changes. Show me: - - The diff or changed files, OR - - A description of what you changed and why - - I'll analyze the changes and produce a message in conventional commit format. - - - - 1. Understand the scope and nature of changes - 2. Identify the primary intent (feature, fix, refactor, etc.) - 3. Determine appropriate scope/module - 4. Craft subject line (imperative mood, concise) - 5. Add body explaining "why" if non-obvious - 6. Note breaking changes or closed issues - - - Show me your changes and I'll craft the message. - - - id: analyze-changes - content: | - - Let me examine your changes before we commit to words. I'll provide analysis to inform the best commit message approach. - - - - - **Classification**: Type of change (feature, fix, refactor, etc.) - - **Scope**: Which parts of codebase affected - - **Complexity**: Simple tweak vs architectural shift - - **Key points**: What MUST be mentioned - - **Suggested style**: Which commit format fits best - - - Share your diff or describe your changes. - - - id: improve-message - content: | - - I'll elevate an existing commit message. Share: - 1. Your current message - 2. Optionally: the actual changes for context - - - - - Identify what's already working well - - Check clarity, completeness, and tone - - Ensure subject line follows conventions - - Verify body explains the "why" - - Suggest specific improvements with reasoning - - - - id: batch-commits - content: | - - For multiple related commits, I'll help create a coherent sequence. Share your set of changes. - - - - - Analyze how changes relate to each other - - Suggest logical ordering (tells clearest story) - - Craft each message with consistent voice - - Ensure they read as chapters, not fragments - - Cross-reference where appropriate - - - - Good sequence: - 1. refactor(auth): extract token validation logic - 2. feat(auth): add refresh token support - 3. test(auth): add integration tests for token refresh - - - menu: - - trigger: write - action: "#write-commit" - description: "Craft a commit message for your changes" - - - trigger: analyze - action: "#analyze-changes" - description: "Analyze changes before writing the message" - - - trigger: improve - action: "#improve-message" - description: "Improve an existing commit message" - - - trigger: batch - action: "#batch-commits" - description: "Create cohesive messages for multiple commits" - - - trigger: conventional - action: "Write a conventional commit (feat/fix/chore/refactor/docs/test/style/perf/build/ci) with proper format: (): " - description: "Specifically use conventional commit format" - - - trigger: story - action: "Write a narrative commit that tells the journey: Setup → Conflict → Solution → Impact" - description: "Write commit as a narrative story" - - - trigger: haiku - action: "Write a haiku commit (5-7-5 syllables) capturing the essence of the change" - description: "Compose a haiku commit message" diff --git a/src/modules/bmb/reference/readme.md b/src/modules/bmb/reference/readme.md deleted file mode 100644 index b7e8e17a..00000000 --- a/src/modules/bmb/reference/readme.md +++ /dev/null @@ -1,3 +0,0 @@ -# Reference Examples - -Reference models of best practices for agents, workflows, and whole modules. diff --git a/src/modules/bmb/reference/workflows/meal-prep-nutrition/data/dietary-restrictions.csv b/src/modules/bmb/reference/workflows/meal-prep-nutrition/data/dietary-restrictions.csv deleted file mode 100644 index 5467e306..00000000 --- a/src/modules/bmb/reference/workflows/meal-prep-nutrition/data/dietary-restrictions.csv +++ /dev/null @@ -1,18 +0,0 @@ -category,restriction,considerations,alternatives,notes -Allergy,Nuts,Severe allergy, check labels carefully,Seeds, sunflower seed butter -Allergy,Shellfish,Cross-reactivity with some fish,Fin fish, vegetarian proteins -Allergy,Dairy,Calcium and vitamin D needs,Almond milk, fortified plant milks -Allergy,Soy,Protein source replacement,Legumes, quinoa, seitan -Allergy,Gluten,Celiac vs sensitivity,Quinoa, rice, certified gluten-free -Medical,Diabetes,Carbohydrate timing and type,Fiber-rich foods, low glycemic -Medical,Hypertension,Sodium restriction,Herbs, spices, salt-free seasonings -Medical,IBS,FODMAP triggers,Low FODMAP vegetables, soluble fiber -Ethical,Vegetarian,Complete protein combinations,Quinoa, buckwheat, hemp seeds -Ethical,Vegan,B12 supplementation mandatory,Nutritional yeast, fortified foods -Ethical,Halal,Meat sourcing requirements,Halal-certified products -Ethical,Kosher,Dairy-meat separation,Parve alternatives -Intolerance,Lactose,Dairy digestion issues,Lactase pills, aged cheeses -Intolerance,FODMAP,Carbohydrate malabsorption,Low FODMAP fruits/veg -Preference,Dislikes,Texture/flavor preferences,Similar texture alternatives -Preference,Budget,Cost-effective options,Bulk buying, seasonal produce -Preference,Convenience,Time-saving options,Pre-cut vegetables, frozen produce \ No newline at end of file diff --git a/src/modules/bmb/reference/workflows/meal-prep-nutrition/data/macro-calculator.csv b/src/modules/bmb/reference/workflows/meal-prep-nutrition/data/macro-calculator.csv deleted file mode 100644 index f16c1892..00000000 --- a/src/modules/bmb/reference/workflows/meal-prep-nutrition/data/macro-calculator.csv +++ /dev/null @@ -1,16 +0,0 @@ -goal,activity_level,multiplier,protein_ratio,protein_min,protein_max,fat_ratio,carb_ratio -weight_loss,sedentary,1.2,0.3,1.6,2.2,0.35,0.35 -weight_loss,light,1.375,0.35,1.8,2.5,0.30,0.35 -weight_loss,moderate,1.55,0.4,2.0,2.8,0.30,0.30 -weight_loss,active,1.725,0.4,2.2,3.0,0.25,0.35 -weight_loss,very_active,1.9,0.45,2.5,3.3,0.25,0.30 -maintenance,sedentary,1.2,0.25,0.8,1.2,0.35,0.40 -maintenance,light,1.375,0.25,1.0,1.4,0.35,0.40 -maintenance,moderate,1.55,0.3,1.2,1.6,0.35,0.35 -maintenance,active,1.725,0.3,1.4,1.8,0.30,0.40 -maintenance,very_active,1.9,0.35,1.6,2.2,0.30,0.35 -muscle_gain,sedentary,1.2,0.35,1.8,2.5,0.30,0.35 -muscle_gain,light,1.375,0.4,2.0,2.8,0.30,0.30 -muscle_gain,moderate,1.55,0.4,2.2,3.0,0.25,0.35 -muscle_gain,active,1.725,0.45,2.5,3.3,0.25,0.30 -muscle_gain,very_active,1.9,0.45,2.8,3.5,0.25,0.30 \ No newline at end of file diff --git a/src/modules/bmb/reference/workflows/meal-prep-nutrition/data/recipe-database.csv b/src/modules/bmb/reference/workflows/meal-prep-nutrition/data/recipe-database.csv deleted file mode 100644 index 56738992..00000000 --- a/src/modules/bmb/reference/workflows/meal-prep-nutrition/data/recipe-database.csv +++ /dev/null @@ -1,28 +0,0 @@ -category,name,prep_time,cook_time,total_time,protein_per_serving,complexity,meal_type,restrictions_friendly,batch_friendly -Protein,Grilled Chicken Breast,10,20,30,35,beginner,lunch/dinner,all,yes -Protein,Baked Salmon,5,15,20,22,beginner,lunch/dinner,gluten-free,no -Protein,Lentils,0,25,25,18,beginner,lunch/dinner,vegan,yes -Protein,Ground Turkey,5,15,20,25,beginner,lunch/dinner,all,yes -Protein,Tofu Stir-fry,10,15,25,20,intermediate,lunch/dinner,vegan,no -Protein,Eggs Scrambled,5,5,10,12,beginner,breakfast,vegetarian,no -Protein,Greek Yogurt,0,0,0,17,beginner,snack,vegetarian,no -Carb,Quinoa,5,15,20,8,beginner,lunch/dinner,gluten-free,yes -Carb,Brown Rice,5,40,45,5,beginner,lunch/dinner,gluten-free,yes -Carb,Sweet Potato,5,45,50,4,beginner,lunch/dinner,all,yes -Carb,Oatmeal,2,5,7,5,beginner,breakfast,gluten-free,yes -Carb,Whole Wheat Pasta,2,10,12,7,beginner,lunch/dinner,vegetarian,no -Veggie,Broccoli,5,10,15,3,beginner,lunch/dinner,all,yes -Veggie,Spinach,2,3,5,3,beginner,lunch/dinner,all,no -Veggie,Bell Peppers,5,10,15,1,beginner,lunch/dinner,all,no -Veggie,Kale,5,5,10,3,beginner,lunch/dinner,all,no -Veggie,Avocado,2,0,2,2,beginner,snack/lunch,all,no -Snack,Almonds,0,0,0,6,beginner,snack,gluten-free,no -Snack,Apple with PB,2,0,2,4,beginner,snack,vegetarian,no -Snack,Protein Smoothie,5,0,5,25,beginner,snack,all,no -Snack,Hard Boiled Eggs,0,12,12,6,beginner,snack,vegetarian,yes -Breakfast,Overnight Oats,5,0,5,10,beginner,breakfast,vegan,yes -Breakfast,Protein Pancakes,10,10,20,20,intermediate,breakfast,vegetarian,no -Breakfast,Veggie Omelet,5,10,15,18,intermediate,breakfast,vegetarian,no -Quick Meal,Chicken Salad,10,0,10,30,beginner,lunch,gluten-free,no -Quick Meal,Tuna Wrap,5,0,5,20,beginner,lunch,gluten-free,no -Quick Meal,Buddha Bowl,15,0,15,15,intermediate,lunch,vegan,no \ No newline at end of file diff --git a/src/modules/bmb/reference/workflows/meal-prep-nutrition/steps/step-01-init.md b/src/modules/bmb/reference/workflows/meal-prep-nutrition/steps/step-01-init.md deleted file mode 100644 index 0c6e6ea6..00000000 --- a/src/modules/bmb/reference/workflows/meal-prep-nutrition/steps/step-01-init.md +++ /dev/null @@ -1,176 +0,0 @@ ---- -name: 'step-01-init' -description: 'Initialize the nutrition plan workflow by detecting continuation state and creating output document' - -# Path Definitions -workflow_path: '{project-root}/_bmad/bmb/reference/workflows/meal-prep-nutrition' - -# File References -thisStepFile: '{workflow_path}/steps/step-01-init.md' -nextStepFile: '{workflow_path}/steps/step-02-profile.md' -workflowFile: '{workflow_path}/workflow.md' -outputFile: '{output_folder}/nutrition-plan-{project_name}.md' -templateFile: '{workflow_path}/templates/nutrition-plan.md' -continueFile: '{workflow_path}/steps/step-01b-continue.md' -# Template References -# This step doesn't use content templates, only the main template ---- - -# Step 1: Workflow Initialization - -## MANDATORY EXECUTION RULES (READ FIRST): - -### Universal Rules: - -- 🛑 NEVER generate content without user input -- 📖 CRITICAL: Read the complete step file before taking any action -- 🔄 CRITICAL: When loading next step with 'C', ensure entire file is read -- 📋 YOU ARE A FACILITATOR, not a content generator - -### Role Reinforcement: - -- ✅ You are a nutrition expert and meal planning specialist -- ✅ We engage in collaborative dialogue, not command-response -- ✅ You bring nutritional expertise and structured planning, user brings their personal preferences and lifestyle constraints -- ✅ Together we produce something better than the sum of our own parts - -### Step-Specific Rules: - -- 🎯 Focus ONLY on initialization and setup -- 🚫 FORBIDDEN to look ahead to future steps -- 💬 Handle initialization professionally -- 🚪 DETECT existing workflow state and handle continuation properly - -## EXECUTION PROTOCOLS: - -- 🎯 Show analysis before taking any action -- 💾 Initialize document and update frontmatter -- 📖 Set up frontmatter `stepsCompleted: [1]` before loading next step -- 🚫 FORBIDDEN to load next step until setup is complete - -## CONTEXT BOUNDARIES: - -- Variables from workflow.md are available in memory -- Previous context = what's in output document + frontmatter -- Don't assume knowledge from other steps -- Input document discovery happens in this step - -## STEP GOAL: - -To initialize the Nutrition Plan workflow by detecting continuation state, creating the output document, and preparing for the first collaborative session. - -## INITIALIZATION SEQUENCE: - -### 1. Check for Existing Workflow - -First, check if the output document already exists: - -- Look for file at `{output_folder}/nutrition-plan-{project_name}.md` -- If exists, read the complete file including frontmatter -- If not exists, this is a fresh workflow - -### 2. Handle Continuation (If Document Exists) - -If the document exists and has frontmatter with `stepsCompleted`: - -- **STOP here** and load `./step-01b-continue.md` immediately -- Do not proceed with any initialization tasks -- Let step-01b handle the continuation logic - -### 3. Handle Completed Workflow - -If the document exists AND all steps are marked complete in `stepsCompleted`: - -- Ask user: "I found an existing nutrition plan from [date]. Would you like to: - 1. Create a new nutrition plan - 2. Update/modify the existing plan" -- If option 1: Create new document with timestamp suffix -- If option 2: Load step-01b-continue.md - -### 4. Fresh Workflow Setup (If No Document) - -If no document exists or no `stepsCompleted` in frontmatter: - -#### A. Input Document Discovery - -This workflow doesn't require input documents, but check for: -**Existing Health Information (Optional):** - -- Look for: `{output_folder}/*health*.md` -- Look for: `{output_folder}/*goals*.md` -- If found, load completely and add to `inputDocuments` frontmatter - -#### B. Create Initial Document - -Copy the template from `{template_path}` to `{output_folder}/nutrition-plan-{project_name}.md` - -Initialize frontmatter with: - -```yaml ---- -stepsCompleted: [1] -lastStep: 'init' -inputDocuments: [] -date: [current date] -user_name: { user_name } ---- -``` - -#### C. Show Welcome Message - -"Welcome to your personalized nutrition planning journey! I'm excited to work with you to create a meal plan that fits your lifestyle, preferences, and health goals. - -Let's begin by getting to know you and your nutrition goals." - -## ✅ SUCCESS METRICS: - -- Document created from template -- Frontmatter initialized with step 1 marked complete -- User welcomed to the process -- Ready to proceed to step 2 - -## ❌ FAILURE MODES TO AVOID: - -- Proceeding with step 2 without document initialization -- Not checking for existing documents properly -- Creating duplicate documents -- Skipping welcome message - -### 7. Present MENU OPTIONS - -Display: **Proceeding to user profile collection...** - -#### EXECUTION RULES: - -- This is an initialization step with no user choices -- Proceed directly to next step after setup -- Use menu handling logic section below - -#### Menu Handling Logic: - -- After setup completion, immediately load, read entire file, then execute `{workflow_path}/step-02-profile.md` to begin user profile collection - ---- - -## 🚨 SYSTEM SUCCESS/FAILURE METRICS - -### ✅ SUCCESS: - -- Document created from template -- update frontmatter `stepsCompleted` to add 4 at the end of the array before loading next step -- Frontmatter initialized with `stepsCompleted: [1]` -- User welcomed to the process -- Ready to proceed to step 2 - -## CRITICAL STEP COMPLETION NOTE - -ONLY WHEN initialization setup is complete and document is created, will you then immediately load, read entire file, then execute `{workflow_path}/step-02-profile.md` to begin user profile collection. - -### ❌ SYSTEM FAILURE: - -- Proceeding with step 2 without document initialization -- Not checking for existing documents properly -- Creating duplicate documents -- Skipping welcome message - -**Master Rule:** Skipping steps, optimizing sequences, or not following exact instructions is FORBIDDEN and constitutes SYSTEM FAILURE. diff --git a/src/modules/bmb/reference/workflows/meal-prep-nutrition/steps/step-01b-continue.md b/src/modules/bmb/reference/workflows/meal-prep-nutrition/steps/step-01b-continue.md deleted file mode 100644 index 2345647e..00000000 --- a/src/modules/bmb/reference/workflows/meal-prep-nutrition/steps/step-01b-continue.md +++ /dev/null @@ -1,120 +0,0 @@ ---- -name: 'step-01b-continue' -description: 'Handle workflow continuation from previous session' - -# Path Definitions -workflow_path: '{project-root}/_bmad/bmb/reference/workflows/meal-prep-nutrition' - -# File References -thisStepFile: '{workflow_path}/steps/step-01b-continue.md' -outputFile: '{output_folder}/nutrition-plan-{project_name}.md' ---- - -# Step 1B: Workflow Continuation - -## STEP GOAL: - -To resume the nutrition planning workflow from where it was left off, ensuring smooth continuation without loss of context. - -## MANDATORY EXECUTION RULES (READ FIRST): - -### Universal Rules: - -- 🛑 NEVER generate content without user input -- 📖 CRITICAL: Read the complete step file before taking any action -- 🔄 CRITICAL: When loading next step with 'C', ensure entire file is read -- 📋 YOU ARE A FACILITATOR, not a content generator - -### Role Reinforcement: - -- ✅ You are a nutrition expert and meal planning specialist -- ✅ If you already have been given communication or persona patterns, continue to use those while playing this new role -- ✅ We engage in collaborative dialogue, not command-response -- ✅ You bring nutritional expertise and structured planning, user brings their personal preferences and lifestyle constraints - -### Step-Specific Rules: - -- 🎯 Focus ONLY on analyzing and resuming workflow state -- 🚫 FORBIDDEN to modify content during this step -- 💬 Maintain continuity with previous sessions -- 🚪 DETECT exact continuation point from frontmatter of incomplete file {outputFile} - -## EXECUTION PROTOCOLS: - -- 🎯 Show your analysis of current state before taking action -- 💾 Keep existing frontmatter `stepsCompleted` values -- 📖 Review the template content already generated -- 🚫 FORBIDDEN to modify content completed in previous steps - -## CONTEXT BOUNDARIES: - -- Current nutrition-plan.md document is already loaded -- Previous context = complete template + existing frontmatter -- User profile already collected in previous sessions -- Last completed step = `lastStep` value from frontmatter - -## CONTINUATION SEQUENCE: - -### 1. Analyze Current State - -Review the frontmatter of {outputFile} to understand: - -- `stepsCompleted`: Which steps are already done, the rightmost value of the array is the last step completed. For example stepsCompleted: [1, 2, 3] would mean that steps 1, then 2, and then 3 were finished. - -### 2. Read the full step of every completed step - -- read each step file that corresponds to the stepsCompleted > 1. - -EXAMPLE: In the example `stepsCompleted: [1, 2, 3]` your would find the step 2 file by file name (step-02-profile.md) and step 3 file (step-03-assessment.md). the last file in the array is the last one completed, so you will follow the instruction to know what the next step to start processing is. reading that file would for example show that the next file is `steps/step-04-strategy.md`. - -### 3. Review the output completed previously - -In addition to reading ONLY each step file that was completed, you will then read the {outputFile} to further understand what is done so far. - -### 4. Welcome Back Dialog - -"Welcome back! I see we've completed [X] steps of your nutrition plan. We last worked on [brief description]. Are you ready to continue with [next step]?" - -### 5. Resumption Protocols - -- Briefly summarize progress made -- Confirm any changes since last session -- Validate that user is still aligned with goals - -### 6. Present MENU OPTIONS - -Display: **Resuming workflow - Select an Option:** [C] Continue - -#### EXECUTION RULES: - -- ALWAYS halt and wait for user input after presenting menu -- ONLY proceed to next step when user selects 'C' -- User can chat or ask questions - always respond and then end with display again of the menu options -- Use menu handling logic section below - -#### Menu Handling Logic: - -- IF C: follow the suggestion of the last completed step reviewed to continue as it suggested -- IF Any other comments or queries: help user respond then [Redisplay Menu Options](#5-present-menu-options) - -## CRITICAL STEP COMPLETION NOTE - -ONLY WHEN C is selected and continuation analysis is complete, will you then update frontmatter and load, read entire file, then execute the appropriate next step file. - -## 🚨 SYSTEM SUCCESS/FAILURE METRICS - -### ✅ SUCCESS: - -- Correctly identified last completed step -- User confirmed readiness to continue -- Frontmatter updated with continuation date -- Workflow resumed at appropriate step - -### ❌ SYSTEM FAILURE: - -- Skipping analysis of existing state -- Modifying content from previous steps -- Loading wrong next step -- Not updating frontmatter properly - -**Master Rule:** Skipping steps, optimizing sequences, or not following exact instructions is FORBIDDEN and constitutes SYSTEM FAILURE. diff --git a/src/modules/bmb/reference/workflows/meal-prep-nutrition/steps/step-02-profile.md b/src/modules/bmb/reference/workflows/meal-prep-nutrition/steps/step-02-profile.md deleted file mode 100644 index 47ddf3e6..00000000 --- a/src/modules/bmb/reference/workflows/meal-prep-nutrition/steps/step-02-profile.md +++ /dev/null @@ -1,164 +0,0 @@ ---- -name: 'step-02-profile' -description: 'Gather comprehensive user profile information through collaborative conversation' - -# Path Definitions -workflow_path: '{project-root}/_bmad/bmb/reference/workflows/meal-prep-nutrition' - -# File References (all use {variable} format in file) -thisStepFile: '{workflow_path}/steps/step-02-profile.md' -nextStepFile: '{workflow_path}/steps/step-03-assessment.md' -workflowFile: '{workflow_path}/workflow.md' -outputFile: '{output_folder}/nutrition-plan-{project_name}.md' - -# Task References -advancedElicitationTask: '{project-root}/_bmad/core/tasks/advanced-elicitation.xml' -partyModeWorkflow: '{project-root}/_bmad/core/workflows/party-mode/workflow.md' - -# Template References -profileTemplate: '{workflow_path}/templates/profile-section.md' ---- - -# Step 2: User Profile & Goals Collection - -## STEP GOAL: - -To gather comprehensive user profile information through collaborative conversation that will inform the creation of a personalized nutrition plan tailored to their lifestyle, preferences, and health objectives. - -## MANDATORY EXECUTION RULES (READ FIRST): - -### Universal Rules: - -- 🛑 NEVER generate content without user input -- 📖 CRITICAL: Read the complete step file before taking any action -- 🔄 CRITICAL: When loading next step with 'C', ensure entire file is read -- 📋 YOU ARE A FACILITATOR, not a content generator - -### Role Reinforcement: - -- ✅ You are a nutrition expert and meal planning specialist -- ✅ If you already have been given communication or persona patterns, continue to use those while playing this new role -- ✅ We engage in collaborative dialogue, not command-response -- ✅ You bring nutritional expertise and structured planning -- ✅ User brings their personal preferences and lifestyle constraints - -### Step-Specific Rules: - -- 🎯 Focus ONLY on collecting profile and goal information -- 🚫 FORBIDDEN to provide meal recommendations or nutrition advice in this step -- 💬 Ask questions conversationally, not like a form -- 🚫 DO NOT skip any profile section - each affects meal recommendations - -## EXECUTION PROTOCOLS: - -- 🎯 Engage in natural conversation to gather profile information -- 💾 After collecting all information, append to {outputFile} -- 📖 Update frontmatter `stepsCompleted` to add 2 at the end of the array before loading next step -- 🚫 FORBIDDEN to load next step until user selects 'C' and content is saved - -## CONTEXT BOUNDARIES: - -- Document and frontmatter are already loaded from initialization -- Focus ONLY on collecting user profile and goals -- Don't provide meal recommendations in this step -- This is about understanding, not prescribing - -## PROFILE COLLECTION PROCESS: - -### 1. Personal Information - -Ask conversationally about: - -- Age (helps determine nutritional needs) -- Gender (affects calorie and macro calculations) -- Height and weight (for BMI and baseline calculations) -- Activity level (sedentary, light, moderate, active, very active) - -### 2. Goals & Timeline - -Explore: - -- Primary nutrition goal (weight loss, muscle gain, maintenance, energy, better health) -- Specific health targets (cholesterol, blood pressure, blood sugar) -- Realistic timeline expectations -- Past experiences with nutrition plans - -### 3. Lifestyle Assessment - -Understand: - -- Daily schedule and eating patterns -- Cooking frequency and skill level -- Time available for meal prep -- Kitchen equipment availability -- Typical meal structure (3 meals/day, snacking, intermittent fasting) - -### 4. Food Preferences - -Discover: - -- Favorite cuisines and flavors -- Foods strongly disliked -- Cultural food preferences -- Allergies and intolerances -- Dietary restrictions (ethical, medical, preference-based) - -### 5. Practical Considerations - -Discuss: - -- Weekly grocery budget -- Access to grocery stores -- Family/household eating considerations -- Social eating patterns - -## CONTENT TO APPEND TO DOCUMENT: - -After collecting all profile information, append to {outputFile}: - -Load and append the content from {profileTemplate} - -### 6. Present MENU OPTIONS - -Display: **Select an Option:** [A] Advanced Elicitation [P] Party Mode [C] Continue - -#### EXECUTION RULES: - -- ALWAYS halt and wait for user input after presenting menu -- ONLY proceed to next step when user selects 'C' -- After other menu items execution, return to this menu -- User can chat or ask questions - always respond and then end with display again of the menu options -- Use menu handling logic section below - -#### Menu Handling Logic: - -- IF A: Execute {advancedElicitationTask} -- IF P: Execute {partyModeWorkflow} -- IF C: Save content to {outputFile}, update frontmatter, then only then load, read entire file, then execute {nextStepFile} -- IF Any other comments or queries: help user respond then [Redisplay Menu Options](#6-present-menu-options) - -## CRITICAL STEP COMPLETION NOTE - -ONLY WHEN C is selected and content is saved to document and frontmatter is updated, will you then load, read entire file, then execute {nextStepFile} to execute and begin dietary needs assessment step. - ---- - -## 🚨 SYSTEM SUCCESS/FAILURE METRICS - -### ✅ SUCCESS: - -- Profile collected through conversation (not interrogation) -- All user preferences documented -- Content appended to {outputFile} -- {outputFile} frontmatter updated with step completion -- Menu presented after completing every other step first in order and user input handled correctly - -### ❌ SYSTEM FAILURE: - -- Generating content without user input -- Skipping profile sections -- Providing meal recommendations in this step -- Proceeding to next step without 'C' selection -- Not updating document frontmatter - -**Master Rule:** Skipping steps, optimizing sequences, or not following exact instructions is FORBIDDEN and constitutes SYSTEM FAILURE. diff --git a/src/modules/bmb/reference/workflows/meal-prep-nutrition/steps/step-03-assessment.md b/src/modules/bmb/reference/workflows/meal-prep-nutrition/steps/step-03-assessment.md deleted file mode 100644 index 2c6f0af3..00000000 --- a/src/modules/bmb/reference/workflows/meal-prep-nutrition/steps/step-03-assessment.md +++ /dev/null @@ -1,153 +0,0 @@ ---- -name: 'step-03-assessment' -description: 'Analyze nutritional requirements, identify restrictions, and calculate target macros' - -# Path Definitions -workflow_path: '{project-root}/_bmad/bmb/reference/workflows/meal-prep-nutrition' - -# File References -thisStepFile: '{workflow_path}/steps/step-03-assessment.md' -nextStepFile: '{workflow_path}/steps/step-04-strategy.md' -workflowFile: '{workflow_path}/workflow.md' -outputFile: '{output_folder}/nutrition-plan-{project_name}.md' - -# Task References -advancedElicitationTask: '{project-root}/_bmad/core/tasks/advanced-elicitation.xml' -partyModeWorkflow: '{project-root}/_bmad/core/workflows/party-mode/workflow.md' - -# Data References -dietaryRestrictionsDB: '{workflow_path}/data/dietary-restrictions.csv' -macroCalculatorDB: '{workflow_path}/data/macro-calculator.csv' - -# Template References -assessmentTemplate: '{workflow_path}/templates/assessment-section.md' ---- - -# Step 3: Dietary Needs & Restrictions Assessment - -## STEP GOAL: - -To analyze nutritional requirements, identify restrictions, and calculate target macros based on user profile to ensure the meal plan meets their specific health needs and dietary preferences. - -## MANDATORY EXECUTION RULES (READ FIRST): - -### Universal Rules: - -- 🛑 NEVER generate content without user input -- 📖 CRITICAL: Read the complete step file before taking any action -- 🔄 CRITICAL: When loading next step with 'C', ensure entire file is read -- 📋 YOU ARE A FACILITATOR, not a content generator - -### Role Reinforcement: - -- ✅ You are a nutrition expert and meal planning specialist -- ✅ We engage in collaborative dialogue, not command-response -- ✅ You bring nutritional expertise and assessment knowledge, user brings their health context -- ✅ Together we produce something better than the sum of our own parts - -### Step-Specific Rules: - -- 🎯 ALWAYS check for allergies and medical restrictions first -- 🚫 DO NOT provide medical advice - always recommend consulting professionals -- 💬 Explain the "why" behind nutritional recommendations -- 📋 Load dietary-restrictions.csv and macro-calculator.csv for accurate analysis - -## EXECUTION PROTOCOLS: - -- 🎯 Use data from CSV files for comprehensive analysis -- 💾 Calculate macros based on profile and goals -- 📖 Document all findings in nutrition-plan.md -- 📖 Update frontmatter `stepsCompleted` to add 3 at the end of the array before loading next step -- 🚫 FORBIDDEN to prescribe medical nutrition therapy - -## CONTEXT BOUNDARIES: - -- User profile is already loaded from step 2 -- Focus ONLY on assessment and calculation -- Refer medical conditions to professionals -- Use data files for reference - -## ASSESSMENT PROCESS: - -### 1. Dietary Restrictions Inventory - -Check each category: - -- Allergies (nuts, shellfish, dairy, soy, gluten, etc.) -- Medical conditions (diabetes, hypertension, IBS, etc.) -- Ethical/religious restrictions (vegetarian, vegan, halal, kosher) -- Preference-based (dislikes, texture issues) -- Intolerances (lactose, FODMAPs, histamine) - -### 2. Macronutrient Targets - -Using macro-calculator.csv: - -- Calculate BMR (Basal Metabolic Rate) -- Determine TDEE (Total Daily Energy Expenditure) -- Set protein targets based on goals -- Configure fat and carbohydrate ratios - -### 3. Micronutrient Focus Areas - -Based on goals and restrictions: - -- Iron (for plant-based diets) -- Calcium (dairy-free) -- Vitamin B12 (vegan diets) -- Fiber (weight management) -- Electrolytes (active individuals) - -#### CONTENT TO APPEND TO DOCUMENT: - -After assessment, append to {outputFile}: - -Load and append the content from {assessmentTemplate} - -### 4. Present MENU OPTIONS - -Display: **Select an Option:** [A] Advanced Elicitation [P] Party Mode [C] Continue - -#### EXECUTION RULES: - -- ALWAYS halt and wait for user input after presenting menu -- ONLY proceed to next step when user selects 'C' -- After other menu items execution, return to this menu -- User can chat or ask questions - always respond and then end with display again of the menu options -- Use menu handling logic section below - -#### Menu Handling Logic: - -- IF A: Execute {advancedElicitationTask} -- IF P: Execute {partyModeWorkflow} -- IF C: Save content to {outputFile}, update frontmatter, then load, read entire file, then execute {nextStepFile} -- IF Any other comments or queries: help user respond then [Redisplay Menu Options](#4-present-menu-options) - -## CRITICAL STEP COMPLETION NOTE - -ONLY WHEN C is selected and content is saved to document and frontmatter is updated, will you then load, read entire file, then execute `{workflow_path}/step-04-strategy.md` to execute and begin meal strategy creation step. - ---- - -## 🚨 SYSTEM SUCCESS/FAILURE METRICS - -### ✅ SUCCESS: - -- All restrictions identified and documented -- Macro targets calculated accurately -- Medical disclaimer included where needed -- Content appended to nutrition-plan.md -- Frontmatter updated with step completion -- Menu presented and user input handled correctly - -### ❌ SYSTEM FAILURE: - -- Providing medical nutrition therapy -- Missing critical allergies or restrictions -- Not including required disclaimers -- Calculating macros incorrectly -- Proceeding without 'C' selection - -**Master Rule:** Skipping steps, optimizing sequences, or not following exact instructions is FORBIDDEN and constitutes SYSTEM FAILURE. - ---- diff --git a/src/modules/bmb/reference/workflows/meal-prep-nutrition/steps/step-04-strategy.md b/src/modules/bmb/reference/workflows/meal-prep-nutrition/steps/step-04-strategy.md deleted file mode 100644 index 5f63204b..00000000 --- a/src/modules/bmb/reference/workflows/meal-prep-nutrition/steps/step-04-strategy.md +++ /dev/null @@ -1,182 +0,0 @@ ---- -name: 'step-04-strategy' -description: 'Design a personalized meal strategy that meets nutritional needs and fits lifestyle' - -# Path Definitions -workflow_path: '{project-root}/_bmad/bmb/reference/workflows/meal-prep-nutrition' - -# File References -thisStepFile: '{workflow_path}/steps/step-04-strategy.md' -nextStepFile: '{workflow_path}/steps/step-05-shopping.md' -alternateNextStepFile: '{workflow_path}/steps/step-06-prep-schedule.md' -workflowFile: '{workflow_path}/workflow.md' -outputFile: '{output_folder}/nutrition-plan-{project_name}.md' - -# Task References -advancedElicitationTask: '{project-root}/_bmad/core/tasks/advanced-elicitation.xml' -partyModeWorkflow: '{project-root}/_bmad/core/workflows/party-mode/workflow.md' - -# Data References -recipeDatabase: '{workflow_path}/data/recipe-database.csv' - -# Template References -strategyTemplate: '{workflow_path}/templates/strategy-section.md' ---- - -# Step 4: Meal Strategy Creation - -## 🎯 Objective - -Design a personalized meal strategy that meets nutritional needs, fits lifestyle, and accommodates restrictions. - -## 📋 MANDATORY EXECUTION RULES (READ FIRST): - -- 🛑 NEVER suggest meals without considering ALL user restrictions -- 📖 CRITICAL: Reference recipe-database.csv for meal ideas -- 🔄 CRITICAL: Ensure macro distribution meets calculated targets -- ✅ Start with familiar foods, introduce variety gradually -- 🚫 DO NOT create a plan that requires advanced cooking skills if user is beginner - -### 1. Meal Structure Framework - -Based on user profile: - -- **Meal frequency** (3 meals/day + snacks, intermittent fasting, etc.) -- **Portion sizing** based on goals and activity -- **Meal timing** aligned with daily schedule -- **Prep method** (batch cooking, daily prep, hybrid) - -### 2. Food Categories Allocation - -Ensure each meal includes: - -- **Protein source** (lean meats, fish, plant-based options) -- **Complex carbohydrates** (whole grains, starchy vegetables) -- **Healthy fats** (avocado, nuts, olive oil) -- **Vegetables/Fruits** (5+ servings daily) -- **Hydration** (water intake plan) - -### 3. Weekly Meal Framework - -Create pattern that can be repeated: - -``` -Monday: Protein + Complex Carb + Vegetables -Tuesday: ... -Wednesday: ... -``` - -- Rotate protein sources for variety -- Incorporate favorite cuisines -- Include one "flexible" meal per week -- Plan for leftovers strategically - -## 🔍 REFERENCE DATABASE: - -Load recipe-database.csv for: - -- Quick meal ideas (<15 min) -- Batch prep friendly recipes -- Restriction-specific options -- Macro-friendly alternatives - -## 🎯 PERSONALIZATION FACTORS: - -### For Beginners: - -- Simple 3-ingredient meals -- One-pan/one-pot recipes -- Prep-ahead breakfast options -- Healthy convenience meals - -### For Busy Schedules: - -- 30-minute or less meals -- Grab-and-go options -- Minimal prep breakfasts -- Slow cooker/air fryer options - -### For Budget Conscious: - -- Bulk buying strategies -- Seasonal produce focus -- Protein budgeting -- Minimize food waste - -## ✅ SUCCESS METRICS: - -- All nutritional targets met -- Realistic for user's cooking skill level -- Fits within time constraints -- Respects budget limitations -- Includes enjoyable foods - -## ❌ FAILURE MODES TO AVOID: - -- Too complex for cooking skill level -- Requires expensive specialty ingredients -- Too much time required -- Boring/repetitive meals -- Doesn't account for eating out/social events - -## 💬 SAMPLE DIALOG STYLE: - -**✅ GOOD (Intent-based):** -"Looking at your goals and love for Mediterranean flavors, we could create a weekly rotation featuring grilled chicken, fish, and plant proteins. How does a structure like: Meatless Monday, Taco Tuesday, Mediterranean Wednesday sound to you?" - -**❌ AVOID (Prescriptive):** -"Monday: 4oz chicken breast, 1 cup brown rice, 2 cups broccoli. Tuesday: 4oz salmon..." - -## 📊 APPEND TO TEMPLATE: - -Begin building nutrition-plan.md by loading and appending content from {strategyTemplate} - -## 🎭 AI PERSONA REMINDER: - -You are a **strategic meal planning partner** who: - -- Balances nutrition with practicality -- Builds on user's existing preferences -- Makes healthy eating feel achievable -- Adapts to real-life constraints - -## 📝 OUTPUT REQUIREMENTS: - -Update workflow.md frontmatter: - -```yaml -mealStrategy: - structure: [meal pattern] - proteinRotation: [list] - prepMethod: [batch/daily/hybrid] - cookingComplexity: [beginner/intermediate/advanced] -``` - -### 5. Present MENU OPTIONS - -Display: **Select an Option:** [A] Meal Variety Optimization [P] Chef & Dietitian Collaboration [C] Continue - -#### EXECUTION RULES: - -- ALWAYS halt and wait for user input after presenting menu -- ONLY proceed to next step when user selects 'C' -- After other menu items execution, return to this menu -- User can chat or ask questions - always respond and then end with display again of the menu options -- Use menu handling logic section below - -#### Menu Handling Logic: - -- HALT and AWAIT ANSWER -- IF A: Execute `{project-root}/_bmad/core/tasks/advanced-elicitation.xml` -- IF P: Execute `{project-root}/_bmad/core/workflows/party-mode/workflow.md` with a chef and dietitian expert also as part of the party -- IF C: Save content to nutrition-plan.md, update frontmatter `stepsCompleted` to add 4 at the end of the array before loading next step, check cooking frequency: - - IF cooking frequency > 2x/week: load, read entire file, then execute `{workflow_path}/step-05-shopping.md` - - IF cooking frequency ≤ 2x/week: load, read entire file, then execute `{workflow_path}/step-06-prep-schedule.md` -- IF Any other comments or queries: help user respond then [Redisplay Menu Options](#5-present-menu-options) - -## CRITICAL STEP COMPLETION NOTE - -ONLY WHEN C is selected and content is saved to document and frontmatter is updated: - -- IF cooking frequency > 2x/week: load, read entire file, then execute `{workflow_path}/step-05-shopping.md` to generate shopping list -- IF cooking frequency ≤ 2x/week: load, read entire file, then execute `{workflow_path}/step-06-prep-schedule.md` to skip shopping list diff --git a/src/modules/bmb/reference/workflows/meal-prep-nutrition/steps/step-05-shopping.md b/src/modules/bmb/reference/workflows/meal-prep-nutrition/steps/step-05-shopping.md deleted file mode 100644 index 67867768..00000000 --- a/src/modules/bmb/reference/workflows/meal-prep-nutrition/steps/step-05-shopping.md +++ /dev/null @@ -1,167 +0,0 @@ ---- -name: 'step-05-shopping' -description: 'Create a comprehensive shopping list that supports the meal strategy' - -# Path Definitions -workflow_path: '{project-root}/_bmad/bmb/reference/workflows/meal-prep-nutrition' - -# File References -thisStepFile: '{workflow_path}/steps/step-05-shopping.md' -nextStepFile: '{workflow_path}/steps/step-06-prep-schedule.md' -workflowFile: '{workflow_path}/workflow.md' -outputFile: '{output_folder}/nutrition-plan-{project_name}.md' - -# Task References -advancedElicitationTask: '{project-root}/_bmad/core/tasks/advanced-elicitation.xml' -partyModeWorkflow: '{project-root}/_bmad/core/workflows/party-mode/workflow.md' - -# Template References -shoppingTemplate: '{workflow_path}/templates/shopping-section.md' ---- - -# Step 5: Shopping List Generation - -## 🎯 Objective - -Create a comprehensive, organized shopping list that supports the meal strategy while minimizing waste and cost. - -## 📋 MANDATORY EXECUTION RULES (READ FIRST): - -- 🛑 CRITICAL: This step is OPTIONAL - skip if user cooks <2x per week -- 📖 CRITICAL: Cross-reference with existing pantry items -- 🔄 CRITICAL: Organize by store section for efficient shopping -- ✅ Include quantities based on serving sizes and meal frequency -- 🚫 DO NOT forget staples and seasonings - Only proceed if: - -```yaml -cookingFrequency: "3-5x" OR "daily" -``` - -Otherwise, skip to Step 5: Prep Schedule - -## 📊 Shopping List Organization: - -### 1. By Store Section - -``` -PRODUCE: -- [Item] - [Quantity] - [Meal(s) used in] -PROTEIN: -- [Item] - [Quantity] - [Meal(s) used in] -DAIRY/ALTERNATIVES: -- [Item] - [Quantity] - [Meal(s) used in] -GRAINS/STARCHES: -- [Item] - [Quantity] - [Meal(s) used in] -FROZEN: -- [Item] - [Quantity] - [Meal(s) used in] -PANTRY: -- [Item] - [Quantity] - [Meal(s) used in] -``` - -### 2. Quantity Calculations - -Based on: - -- Serving size x number of servings -- Buffer for mistakes/snacks (10-20%) -- Bulk buying opportunities -- Shelf life considerations - -### 3. Cost Optimization - -- Bulk buying for non-perishables -- Seasonal produce recommendations -- Protein budgeting strategies -- Store brand alternatives - -## 🔍 SMART SHOPPING FEATURES: - -### Meal Prep Efficiency: - -- Multi-purpose ingredients (e.g., spinach for salads AND smoothies) -- Batch prep staples (grains, proteins) -- Versatile seasonings - -### Waste Reduction: - -- "First to use" items for perishables -- Flexible ingredient swaps -- Portion planning - -### Budget Helpers: - -- Priority items (must-have vs nice-to-have) -- Bulk vs fresh decisions -- Seasonal substitutions - -## ✅ SUCCESS METRICS: - -- Complete list organized by store section -- Quantities calculated accurately -- Pantry items cross-referenced -- Budget considerations addressed -- Waste minimization strategies included - -## ❌ FAILURE MODES TO AVOID: - -- Forgetting staples and seasonings -- Buying too much of perishable items -- Not organizing by store section -- Ignoring user's budget constraints -- Not checking existing pantry items - -## 💬 SAMPLE DIALOG STYLE: - -**✅ GOOD (Intent-based):** -"Let's organize your shopping trip for maximum efficiency. I'll group items by store section. Do you currently have basic staples like olive oil, salt, and common spices?" - -**❌ AVOID (Prescriptive):** -"Buy exactly: 3 chicken breasts, 2 lbs broccoli, 1 bag rice..." - -## 📝 OUTPUT REQUIREMENTS: - -Append to {outputFile} by loading and appending content from {shoppingTemplate} - -## 🎭 AI PERSONA REMINDER: - -You are a **strategic shopping partner** who: - -- Makes shopping efficient and organized -- Helps save money without sacrificing nutrition -- Plans for real-life shopping scenarios -- Minimizes food waste thoughtfully - -## 📊 STATUS UPDATE: - -Update workflow.md frontmatter: - -```yaml -shoppingListGenerated: true -budgetOptimized: [yes/partial/no] -pantryChecked: [yes/no] -``` - -### 5. Present MENU OPTIONS - -Display: **Select an Option:** [A] Budget Optimization Strategies [P] Shopping Perspectives [C] Continue to Prep Schedule - -#### EXECUTION RULES: - -- ALWAYS halt and wait for user input after presenting menu -- ONLY proceed to next step when user selects 'C' -- After other menu items execution, return to this menu -- User can chat or ask questions - always respond and then end with display again of the menu options -- Use menu handling logic section below - -#### Menu Handling Logic: - -- HALT and AWAIT ANSWER -- IF A: Execute `{project-root}/_bmad/core/tasks/advanced-elicitation.xml` -- IF P: Execute `{project-root}/_bmad/core/workflows/party-mode/workflow.md` -- IF C: Save content to nutrition-plan.md, update frontmatter `stepsCompleted` to add 5 at the end of the array before loading next step, then load, read entire file, then execute `{workflow_path}/step-06-prep-schedule.md` -- IF Any other comments or queries: help user respond then [Redisplay Menu Options](#5-present-menu-options) - -## CRITICAL STEP COMPLETION NOTE - -ONLY WHEN C is selected and content is saved to document and frontmatter is updated, will you then load, read entire file, then execute `{workflow_path}/step-06-prep-schedule.md` to execute and begin meal prep schedule creation. diff --git a/src/modules/bmb/reference/workflows/meal-prep-nutrition/steps/step-06-prep-schedule.md b/src/modules/bmb/reference/workflows/meal-prep-nutrition/steps/step-06-prep-schedule.md deleted file mode 100644 index 3e3eb569..00000000 --- a/src/modules/bmb/reference/workflows/meal-prep-nutrition/steps/step-06-prep-schedule.md +++ /dev/null @@ -1,194 +0,0 @@ ---- -name: 'step-06-prep-schedule' -description: "Create a realistic meal prep schedule that fits the user's lifestyle" - -# Path Definitions -workflow_path: '{project-root}/_bmad/bmb/reference/workflows/meal-prep-nutrition' - -# File References -thisStepFile: '{workflow_path}/steps/step-06-prep-schedule.md' -workflowFile: '{workflow_path}/workflow.md' -outputFile: '{output_folder}/nutrition-plan-{project_name}.md' - -# Task References -advancedElicitationTask: '{project-root}/_bmad/core/tasks/advanced-elicitation.xml' -partyModeWorkflow: '{project-root}/_bmad/core/workflows/party-mode/workflow.md' - -# Template References -prepScheduleTemplate: '{workflow_path}/templates/prep-schedule-section.md' ---- - -# Step 6: Meal Prep Execution Schedule - -## 🎯 Objective - -Create a realistic meal prep schedule that fits the user's lifestyle and ensures success. - -## 📋 MANDATORY EXECUTION RULES (READ FIRST): - -- 🛑 NEVER suggest a prep schedule that requires more time than user has available -- 📖 CRITICAL: Base schedule on user's actual cooking frequency -- 🔄 CRITICAL: Include storage and reheating instructions -- ✅ Start with a sustainable prep routine -- 🚫 DO NOT overwhelm with too much at once - -### 1. Time Commitment Analysis - -Based on user profile: - -- **Available prep time per week** -- **Preferred prep days** (weekend vs weeknight) -- **Energy levels throughout day** -- **Kitchen limitations** - -### 2. Prep Strategy Options - -#### Option A: Sunday Batch Prep (2-3 hours) - -- Prep all proteins for week -- Chop all vegetables -- Cook grains in bulk -- Portion snacks - -#### Option B: Semi-Weekly Prep (1-1.5 hours x 2) - -- Sunday: Proteins + grains -- Wednesday: Refresh veggies + prep second half - -#### Option C: Daily Prep (15-20 minutes daily) - -- Prep next day's lunch -- Quick breakfast assembly -- Dinner prep each evening - -### 3. Detailed Timeline Breakdown - -``` -Sunday (2 hours): -2:00-2:30: Preheat oven, marinate proteins -2:30-3:15: Cook proteins (bake chicken, cook ground turkey) -3:15-3:45: Cook grains (rice, quinoa) -3:45-4:00: Chop vegetables and portion snacks -4:00-4:15: Clean and organize refrigerator -``` - -## 📦 Storage Guidelines: - -### Protein Storage: - -- Cooked chicken: 4 days refrigerated, 3 months frozen -- Ground meat: 3 days refrigerated, 3 months frozen -- Fish: Best fresh, 2 days refrigerated - -### Vegetable Storage: - -- Cut vegetables: 3-4 days in airtight containers -- Hard vegetables: Up to 1 week (carrots, bell peppers) -- Leafy greens: 2-3 days with paper towels - -### Meal Assembly: - -- Keep sauces separate until eating -- Consider texture changes when reheating -- Label with preparation date - -## 🔧 ADAPTATION STRATEGIES: - -### For Busy Weeks: - -- Emergency freezer meals -- Quick backup options -- 15-minute meal alternatives - -### For Low Energy Days: - -- No-cook meal options -- Smoothie packs -- Assembly-only meals - -### For Social Events: - -- Flexible meal timing -- Restaurant integration -- "Off-plan" guilt-free guidelines - -## ✅ SUCCESS METRICS: - -- Realistic time commitment -- Clear instructions for each prep session -- Storage and reheating guidelines included -- Backup plans for busy weeks -- Sustainable long-term approach - -## ❌ FAILURE MODES TO AVOID: - -- Overly ambitious prep schedule -- Not accounting for cleaning time -- Ignoring user's energy patterns -- No flexibility for unexpected events -- Complex instructions for beginners - -## 💬 SAMPLE DIALOG STYLE: - -**✅ GOOD (Intent-based):** -"Based on your 2-hour Sunday availability, we could create a prep schedule that sets you up for the week. We'll batch cook proteins and grains, then do quick assembly each evening. How does that sound with your energy levels?" - -**❌ AVOID (Prescriptive):** -"You must prep every Sunday from 2-4 PM. No exceptions." - -## 📝 FINAL TEMPLATE OUTPUT: - -Complete {outputFile} by loading and appending content from {prepScheduleTemplate} - -## 🎯 WORKFLOW COMPLETION: - -### Update workflow.md frontmatter: - -```yaml -stepsCompleted: ['init', 'assessment', 'strategy', 'shopping', 'prep-schedule'] -lastStep: 'prep-schedule' -completionDate: [current date] -userSatisfaction: [to be rated] -``` - -### Final Message Template: - -"Congratulations! Your personalized nutrition plan is complete. Remember, this is a living document that we can adjust as your needs change. Check in weekly for the first month to fine-tune your approach!" - -## 📊 NEXT STEPS FOR USER: - -1. Review complete plan -2. Shop for ingredients -3. Execute first prep session -4. Note any adjustments needed -5. Schedule follow-up review - -### 5. Present MENU OPTIONS - -Display: **Select an Option:** [A] Advanced Prep Techniques [P] Coach Perspectives [C] Complete Workflow - -#### EXECUTION RULES: - -- ALWAYS halt and wait for user input after presenting menu -- ONLY proceed to next step when user selects 'C' -- After other menu items execution, return to this menu -- User can chat or ask questions - always respond and then end with display again of the menu options -- Use menu handling logic section below - -#### Menu Handling Logic: - -- HALT and AWAIT ANSWER -- IF A: Execute `{project-root}/_bmad/core/tasks/advanced-elicitation.xml` -- IF P: Execute `{project-root}/_bmad/core/workflows/party-mode/workflow.md` -- IF C: update frontmatter `stepsCompleted` to add 6 at the end of the array before loading next step, mark workflow complete, display final message -- IF Any other comments or queries: help user respond then [Redisplay Menu Options](#6-present-menu-options) - -## CRITICAL STEP COMPLETION NOTE - -ONLY WHEN C is selected and content is saved to document: - -1. update frontmatter `stepsCompleted` to add 6 at the end of the array before loading next step completed and indicate final completion -2. Display final completion message -3. End workflow session - -**Final Message:** "Congratulations! Your personalized nutrition plan is complete. Remember, this is a living document that we can adjust as your needs change. Check in weekly for the first month to fine-tune your approach!" diff --git a/src/modules/bmb/reference/workflows/meal-prep-nutrition/templates/assessment-section.md b/src/modules/bmb/reference/workflows/meal-prep-nutrition/templates/assessment-section.md deleted file mode 100644 index 610f397c..00000000 --- a/src/modules/bmb/reference/workflows/meal-prep-nutrition/templates/assessment-section.md +++ /dev/null @@ -1,25 +0,0 @@ -## 📊 Daily Nutrition Targets - -**Daily Calories:** [calculated amount] -**Protein:** [grams]g ([percentage]% of calories) -**Carbohydrates:** [grams]g ([percentage]% of calories) -**Fat:** [grams]g ([percentage]% of calories) - ---- - -## ⚠️ Dietary Considerations - -### Allergies & Intolerances - -- [List of identified restrictions] -- [Cross-reactivity notes if applicable] - -### Medical Considerations - -- [Conditions noted with professional referral recommendation] -- [Special nutritional requirements] - -### Preferences - -- [Cultural/ethical restrictions] -- [Strong dislikes to avoid] diff --git a/src/modules/bmb/reference/workflows/meal-prep-nutrition/templates/nutrition-plan.md b/src/modules/bmb/reference/workflows/meal-prep-nutrition/templates/nutrition-plan.md deleted file mode 100644 index 8c67f79a..00000000 --- a/src/modules/bmb/reference/workflows/meal-prep-nutrition/templates/nutrition-plan.md +++ /dev/null @@ -1,68 +0,0 @@ -# Personalized Nutrition Plan - -**Created:** {{date}} -**Author:** {{user_name}} - ---- - -## ✅ Progress Tracking - -**Steps Completed:** - -- [ ] Step 1: Workflow Initialization -- [ ] Step 2: User Profile & Goals -- [ ] Step 3: Dietary Assessment -- [ ] Step 4: Meal Strategy -- [ ] Step 5: Shopping List _(if applicable)_ -- [ ] Step 6: Meal Prep Schedule - -**Last Updated:** {{date}} - ---- - -## 📋 Executive Summary - -**Primary Goal:** [To be filled in Step 1] - -**Daily Nutrition Targets:** - -- Calories: [To be calculated in Step 2] -- Protein: [To be calculated in Step 2]g -- Carbohydrates: [To be calculated in Step 2]g -- Fat: [To be calculated in Step 2]g - -**Key Considerations:** [To be filled in Step 2] - ---- - -## 🎯 Your Nutrition Goals - -[Content to be added in Step 1] - ---- - -## 🍽️ Meal Framework - -[Content to be added in Step 3] - ---- - -## 🛒 Shopping List - -[Content to be added in Step 4 - if applicable] - ---- - -## ⏰ Meal Prep Schedule - -[Content to be added in Step 5] - ---- - -## 📝 Notes & Next Steps - -[Add any notes or adjustments as you progress] - ---- - -**Medical Disclaimer:** This nutrition plan is for educational purposes only and is not medical advice. Please consult with a registered dietitian or healthcare provider for personalized medical nutrition therapy, especially if you have medical conditions, allergies, or are taking medications. diff --git a/src/modules/bmb/reference/workflows/meal-prep-nutrition/templates/prep-schedule-section.md b/src/modules/bmb/reference/workflows/meal-prep-nutrition/templates/prep-schedule-section.md deleted file mode 100644 index 1143cd51..00000000 --- a/src/modules/bmb/reference/workflows/meal-prep-nutrition/templates/prep-schedule-section.md +++ /dev/null @@ -1,29 +0,0 @@ -## Meal Prep Schedule - -### [Chosen Prep Strategy] - -### Weekly Prep Tasks - -- [Day]: [Tasks] - [Time needed] -- [Day]: [Tasks] - [Time needed] - -### Daily Assembly - -- Morning: [Quick tasks] -- Evening: [Assembly instructions] - -### Storage Guide - -- Proteins: [Instructions] -- Vegetables: [Instructions] -- Grains: [Instructions] - -### Success Tips - -- [Personalized success strategies] - -### Weekly Review Checklist - -- [ ] Check weekend schedule -- [ ] Review meal plan satisfaction -- [ ] Adjust next week's plan diff --git a/src/modules/bmb/reference/workflows/meal-prep-nutrition/templates/profile-section.md b/src/modules/bmb/reference/workflows/meal-prep-nutrition/templates/profile-section.md deleted file mode 100644 index 3784c1d9..00000000 --- a/src/modules/bmb/reference/workflows/meal-prep-nutrition/templates/profile-section.md +++ /dev/null @@ -1,47 +0,0 @@ -## 🎯 Your Nutrition Goals - -### Primary Objective - -[User's main goal and motivation] - -### Target Timeline - -[Realistic timeframe and milestones] - -### Success Metrics - -- [Specific measurable outcomes] -- [Non-scale victories] -- [Lifestyle improvements] - ---- - -## 👤 Personal Profile - -### Basic Information - -- **Age:** [age] -- **Gender:** [gender] -- **Height:** [height] -- **Weight:** [current weight] -- **Activity Level:** [activity description] - -### Lifestyle Factors - -- **Daily Schedule:** [typical day structure] -- **Cooking Frequency:** [how often they cook] -- **Cooking Skill:** [beginner/intermediate/advanced] -- **Available Time:** [time for meal prep] - -### Food Preferences - -- **Favorite Cuisines:** [list] -- **Disliked Foods:** [list] -- **Allergies:** [list] -- **Dietary Restrictions:** [list] - -### Budget & Access - -- **Weekly Budget:** [range] -- **Shopping Access:** [stores available] -- **Special Considerations:** [family, social, etc.] diff --git a/src/modules/bmb/reference/workflows/meal-prep-nutrition/templates/shopping-section.md b/src/modules/bmb/reference/workflows/meal-prep-nutrition/templates/shopping-section.md deleted file mode 100644 index 6a172159..00000000 --- a/src/modules/bmb/reference/workflows/meal-prep-nutrition/templates/shopping-section.md +++ /dev/null @@ -1,37 +0,0 @@ -## Weekly Shopping List - -### Check Pantry First - -- [List of common staples to verify] - -### Produce Section - -- [Item] - [Quantity] - [Used in] - -### Protein - -- [Item] - [Quantity] - [Used in] - -### Dairy/Alternatives - -- [Item] - [Quantity] - [Used in] - -### Grains/Starches - -- [Item] - [Quantity] - [Used in] - -### Frozen - -- [Item] - [Quantity] - [Used in] - -### Pantry - -- [Item] - [Quantity] - [Used in] - -### Money-Saving Tips - -- [Personalized savings strategies] - -### Flexible Swaps - -- [Alternative options if items unavailable] diff --git a/src/modules/bmb/reference/workflows/meal-prep-nutrition/templates/strategy-section.md b/src/modules/bmb/reference/workflows/meal-prep-nutrition/templates/strategy-section.md deleted file mode 100644 index 9c11d05b..00000000 --- a/src/modules/bmb/reference/workflows/meal-prep-nutrition/templates/strategy-section.md +++ /dev/null @@ -1,18 +0,0 @@ -## Weekly Meal Framework - -### Protein Rotation - -- Monday: [Protein source] -- Tuesday: [Protein source] -- Wednesday: [Protein source] -- Thursday: [Protein source] -- Friday: [Protein source] -- Saturday: [Protein source] -- Sunday: [Protein source] - -### Meal Timing - -- Breakfast: [Time] - [Type] -- Lunch: [Time] - [Type] -- Dinner: [Time] - [Type] -- Snacks: [As needed] diff --git a/src/modules/bmb/reference/workflows/meal-prep-nutrition/workflow.md b/src/modules/bmb/reference/workflows/meal-prep-nutrition/workflow.md deleted file mode 100644 index 54b5b495..00000000 --- a/src/modules/bmb/reference/workflows/meal-prep-nutrition/workflow.md +++ /dev/null @@ -1,58 +0,0 @@ ---- -name: Meal Prep & Nutrition Plan -description: Creates personalized meal plans through collaborative nutrition planning between an expert facilitator and individual seeking to improve their nutrition habits. -web_bundle: true ---- - -# Meal Prep & Nutrition Plan Workflow - -**Goal:** Create personalized meal plans through collaborative nutrition planning between an expert facilitator and individual seeking to improve their nutrition habits. - -**Your Role:** In addition to your name, communication_style, and persona, you are also a nutrition expert and meal planning specialist working collaboratively with the user. We engage in collaborative dialogue, not command-response, where you bring nutritional expertise and structured planning, while the user brings their personal preferences, lifestyle constraints, and health goals. Work together to create a sustainable, enjoyable nutrition plan. - ---- - -## WORKFLOW ARCHITECTURE - -This uses **step-file architecture** for disciplined execution: - -### Core Principles - -- **Micro-file Design**: Each step is a self contained instruction file that is a part of an overall workflow that must be followed exactly -- **Just-In-Time Loading**: Only the current step file is in memory - never load future step files until told to do so -- **Sequential Enforcement**: Sequence within the step files must be completed in order, no skipping or optimization allowed -- **State Tracking**: Document progress in output file frontmatter using `stepsCompleted` array when a workflow produces a document -- **Append-Only Building**: Build documents by appending content as directed to the output file - -### Step Processing Rules - -1. **READ COMPLETELY**: Always read the entire step file before taking any action -2. **FOLLOW SEQUENCE**: Execute all numbered sections in order, never deviate -3. **WAIT FOR INPUT**: If a menu is presented, halt and wait for user selection -4. **CHECK CONTINUATION**: If the step has a menu with Continue as an option, only proceed to next step when user selects 'C' (Continue) -5. **SAVE STATE**: Update `stepsCompleted` in frontmatter before loading next step -6. **LOAD NEXT**: When directed, load, read entire file, then execute the next step file - -### Critical Rules (NO EXCEPTIONS) - -- 🛑 **NEVER** load multiple step files simultaneously -- 📖 **ALWAYS** read entire step file before execution -- 🚫 **NEVER** skip steps or optimize the sequence -- 💾 **ALWAYS** update frontmatter of output files when writing the final output for a specific step -- 🎯 **ALWAYS** follow the exact instructions in the step file -- ⏸️ **ALWAYS** halt at menus and wait for user input -- 📋 **NEVER** create mental todo lists from future steps - ---- - -## INITIALIZATION SEQUENCE - -### 1. Configuration Loading - -Load and read full config from {project-root}/_bmad/core/config.yaml and resolve: - -- `project_name`, `output_folder`, `user_name`, `communication_language`, `document_output_language` - -### 2. First Step EXECUTION - -Load, read the full file and then execute `{project-root}/_bmad/bmb/reference/workflows/meal-prep-nutrition/steps/step-01-init.md` to begin the workflow. diff --git a/src/modules/bmb/workflows-legacy/edit-module/README.md b/src/modules/bmb/workflows-legacy/edit-module/README.md deleted file mode 100644 index d14308cb..00000000 --- a/src/modules/bmb/workflows-legacy/edit-module/README.md +++ /dev/null @@ -1,171 +0,0 @@ -# Edit Module Workflow - -Interactive workflow for editing existing BMAD modules, including structure, agents, workflows, configuration, and documentation. - -## Purpose - -This workflow helps you improve and maintain BMAD modules by: - -- Analyzing module structure against best practices -- Managing agents and workflows within the module -- Updating configuration and documentation -- Ensuring cross-module integration works correctly -- Maintaining installer configuration (for source modules) - -## When to Use - -Use this workflow when you need to: - -- Add new agents or workflows to a module -- Update module configuration -- Improve module documentation -- Reorganize module structure -- Set up cross-module workflow sharing -- Fix issues in module organization -- Update installer configuration - -## What You'll Need - -- Path to the module directory you want to edit -- Understanding of what changes you want to make -- Access to module documentation (loaded automatically) - -## Workflow Steps - -1. **Load and analyze target module** - Provide path to module directory -2. **Analyze against best practices** - Automatic audit of module structure -3. **Select editing focus** - Choose what aspect to edit -4. **Load relevant documentation and tools** - Auto-loads guides and workflows -5. **Perform edits** - Review and approve changes iteratively -6. **Validate all changes** - Comprehensive validation checklist -7. **Generate change summary** - Summary of improvements made - -## Editing Options - -The workflow provides 12 focused editing options: - -1. **Fix critical issues** - Address missing files, broken references -2. **Update module config** - Edit config.yaml fields -3. **Manage agents** - Add, edit, or remove agents -4. **Manage workflows** - Add, edit, or remove workflows -5. **Update documentation** - Improve README files and guides -6. **Reorganize structure** - Fix directory organization -7. **Add new agent** - Create and integrate new agent -8. **Add new workflow** - Create and integrate new workflow -9. **Update installer** - Modify installer configuration (source only) -10. **Cross-module integration** - Set up workflow sharing with other modules -11. **Remove deprecated items** - Delete unused agents, workflows, or files -12. **Full module review** - Comprehensive analysis and improvements - -## Integration with Other Workflows - -This workflow integrates with: - -- **edit-agent** - For editing individual agents -- **edit-workflow** - For editing individual workflows -- **create-agent** - For adding new agents -- **create-workflow** - For adding new workflows - -When you select options to manage agents or workflows, the appropriate specialized workflow is invoked automatically. - -## Module Structure - -A proper BMAD module has: - -``` -module-code/ -├── agents/ # Agent definitions -│ └── *.agent.yaml -├── workflows/ # Workflow definitions -│ └── workflow-name/ -│ ├── workflow.yaml -│ ├── instructions.md -│ ├── checklist.md -│ └── README.md -├── config.yaml # Module configuration -└── README.md # Module documentation -``` - -## Standard Module Config - -Every module config.yaml should have: - -```yaml -module_name: 'Full Module Name' -module_code: 'xyz' -user_name: 'User Name' -communication_language: 'english' -output_folder: 'path/to/output' -``` - -Optional fields may be added for module-specific needs. - -## Cross-Module Integration - -Modules can share workflows: - -```yaml -# In agent menu item: -workflow: '{project-root}/_bmad/other-module/workflows/shared-workflow/workflow.yaml' -``` - -Common patterns: - -- BMM uses CIS brainstorming workflows -- All modules can use core workflows -- Modules can invoke each other's workflows - -## Output - -The workflow modifies module files in place, including: - -- config.yaml -- Agent files -- Workflow files -- README and documentation files -- Directory structure (if reorganizing) - -Changes are reviewed and approved by you before being applied. - -## Best Practices - -- **Start with analysis** - Let the workflow audit your module first -- **Use specialized workflows** - Let edit-agent and edit-workflow handle detailed edits -- **Update documentation** - Keep README files current with changes -- **Validate thoroughly** - Use the validation step to catch structural issues -- **Test after editing** - Invoke agents and workflows to verify they work - -## Tips - -- For adding agents/workflows, use options 7-8 to create and integrate in one step -- For quick config changes, use option 2 (update module config) -- Cross-module integration (option 10) helps set up workflow sharing -- Full module review (option 12) is great for inherited or legacy modules -- The workflow handles path updates when you reorganize structure - -## Example Usage - -``` -User: I want to add a new workflow to BMM for API design -Workflow: Analyzes BMM → You choose option 8 (add new workflow) - → Invokes create-workflow → Creates workflow - → Integrates it into module → Updates README → Done -``` - -## Activation - -Invoke via BMad Builder agent: - -``` -/bmad:bmb:agents:bmad-builder -Then select: *edit-module -``` - -Or directly via workflow.xml with this workflow config. - -## Related Resources - -- **Module Structure Guide** - Comprehensive module architecture documentation -- **BMM Module** - Example of full-featured module -- **BMB Module** - Example of builder/tooling module -- **CIS Module** - Example of workflow library module diff --git a/src/modules/bmb/workflows-legacy/edit-module/checklist.md b/src/modules/bmb/workflows-legacy/edit-module/checklist.md deleted file mode 100644 index 779ec5c4..00000000 --- a/src/modules/bmb/workflows-legacy/edit-module/checklist.md +++ /dev/null @@ -1,163 +0,0 @@ -# Edit Module - Validation Checklist - -Use this checklist to validate module edits meet BMAD Core standards. - -## Module Structure Validation - -- [ ] Module has clear abbreviation code (bmm, bmb, cis, etc.) -- [ ] agents/ directory exists -- [ ] workflows/ directory exists -- [ ] config.yaml exists in module root -- [ ] README.md exists in module root -- [ ] Directory structure follows BMAD conventions - -## Configuration Validation - -### Required Fields - -- [ ] module_name is descriptive and clear -- [ ] module_code is 3-letter code matching directory name -- [ ] user_name field present -- [ ] communication_language field present -- [ ] output_folder field present - -### Optional Fields (if used) - -- [ ] bmb_creations_output_folder documented -- [ ] Module-specific fields documented in README - -### File Quality - -- [ ] config.yaml is valid YAML syntax -- [ ] No duplicate keys -- [ ] Values are appropriate types (strings, paths, etc.) -- [ ] Comments explain non-obvious fields - -## Agent Validation - -### Agent Files - -- [ ] All agents in agents/ directory -- [ ] Agent files follow naming: {agent-name}.agent.yaml or .md -- [ ] Agent filenames use kebab-case -- [ ] No orphaned or temporary agent files - -### Agent Content - -- [ ] Each agent has clear role and purpose -- [ ] Agents reference workflows correctly -- [ ] Agent workflow paths are valid -- [ ] Agents load module config correctly (if needed) -- [ ] Agent menu items reference existing workflows - -### Agent Integration - -- [ ] All agents listed in module README -- [ ] Agent relationships documented (if applicable) -- [ ] Cross-agent workflows properly linked - -## Workflow Validation - -### Workflow Structure - -- [ ] All workflows in workflows/ directory -- [ ] Each workflow directory has workflow.yaml -- [ ] Each workflow directory has instructions.md -- [ ] Workflow directories use kebab-case naming -- [ ] No orphaned or incomplete workflow directories - -### Workflow Content - -- [ ] workflow.yaml is valid YAML -- [ ] workflow.yaml has name field -- [ ] workflow.yaml has description field -- [ ] workflow.yaml has author field -- [ ] instructions.md has proper structure -- [ ] Workflow steps are numbered and logical - -### Workflow Integration - -- [ ] All workflows listed in module README -- [ ] Workflow paths in agents are correct -- [ ] Cross-module workflow references are valid -- [ ] Sub-workflow references exist - -## Documentation Validation - -### Module README - -- [ ] Module README describes purpose clearly -- [ ] README lists all agents with descriptions -- [ ] README lists all workflows with descriptions -- [ ] README includes installation instructions (if applicable) -- [ ] README explains module's role in BMAD ecosystem - -### Workflow READMEs - -- [ ] Each workflow has its own README.md -- [ ] Workflow READMEs explain purpose -- [ ] Workflow READMEs list inputs/outputs -- [ ] Workflow READMEs include usage examples - -### Other Documentation - -- [ ] Usage guides present (if needed) -- [ ] Architecture docs present (if complex module) -- [ ] Examples provided (if applicable) - -## Cross-References Validation - -- [ ] Agent workflow references point to existing workflows -- [ ] Workflow sub-workflow references are valid -- [ ] Cross-module references use correct paths -- [ ] Config file paths use {project-root} correctly -- [ ] No hardcoded absolute paths - -## Installer Validation (Source Modules Only) - -- [ ] Installer script exists in tools/cli/installers/ -- [ ] Installer script name: install-{module-code}.js -- [ ] Module metadata in installer is correct -- [ ] Web bundle configuration valid (if applicable) -- [ ] Installation paths are correct -- [ ] Dependencies documented in installer - -## Web Bundle Validation (If Applicable) - -- [ ] Web bundles configured in workflow.yaml files -- [ ] All referenced files included in web_bundle_files -- [ ] Paths are _bmad/-relative (not project-root) -- [ ] No config_source references in web bundles -- [ ] Invoked workflows included in dependencies - -## Quality Checks - -- [ ] No placeholder text remains ({MODULE_NAME}, {CODE}, etc.) -- [ ] No broken file references -- [ ] No duplicate content across files -- [ ] Consistent naming conventions throughout -- [ ] Module purpose is clear from README alone - -## Integration Checks - -- [ ] Module doesn't conflict with other modules -- [ ] Shared resources properly documented -- [ ] Dependencies on other modules explicit -- [ ] Module can be installed independently (if designed that way) - -## User Experience - -- [ ] Module purpose is immediately clear -- [ ] Agents have intuitive names -- [ ] Workflows have descriptive names -- [ ] Menu items are logically organized -- [ ] Error messages are helpful -- [ ] Success messages confirm actions - -## Final Checks - -- [ ] All files have been saved -- [ ] File permissions are correct -- [ ] Git status shows expected changes -- [ ] Module is ready for testing -- [ ] Documentation accurately reflects changes diff --git a/src/modules/bmb/workflows-legacy/edit-module/instructions.md b/src/modules/bmb/workflows-legacy/edit-module/instructions.md deleted file mode 100644 index 6f3e2b8b..00000000 --- a/src/modules/bmb/workflows-legacy/edit-module/instructions.md +++ /dev/null @@ -1,340 +0,0 @@ -# Edit Module - Module Editor Instructions - -The workflow execution engine is governed by: {project-root}/_bmad/core/tasks/workflow.xml -You MUST have already loaded and processed: {project-root}/_bmad/bmb/workflows/edit-module/workflow.yaml -This workflow uses ADAPTIVE FACILITATION - adjust your communication based on context and user needs -The goal is COLLABORATIVE IMPROVEMENT - work WITH the user, not FOR them -Communicate all responses in {communication_language} - - - - -What is the path to the module source you want to edit? - -Load the module directory structure completely: - -- Scan all directories and files -- Load config.yaml -- Load README.md -- List all agents in agents/ directory -- List all workflows in workflows/ directory -- Identify any custom structure or patterns - - -Load ALL module documentation to inform understanding: - -- Module structure guide: {module_structure_guide} -- Study reference modules: BMM, BMB, CIS -- Understand BMAD module patterns and conventions - - -Analyze the module deeply: - -- Identify module purpose and role in BMAD ecosystem -- Understand agent organization and relationships -- Map workflow organization and dependencies -- Evaluate config structure and completeness -- Check documentation quality and currency -- Assess installer configuration (if source module) -- Identify cross-module integrations -- Evaluate against best practices from loaded guides - - -Reflect understanding back to {user_name}: - -Present a warm, conversational summary adapted to the module's complexity: - -- What this module provides (its purpose and value in BMAD) -- How it's organized (agents, workflows, structure) -- What you notice (strengths, potential improvements, issues) -- How it fits in the larger BMAD ecosystem -- Your initial assessment based on best practices - -Be conversational and insightful. Help {user_name} see their module through your eyes. - - -Does this match your understanding of what this module should provide? -module_understanding - - - -Understand WHAT the user wants to improve and WHY before diving into edits - -Engage in collaborative discovery: - -Ask open-ended questions to understand their goals: - -- What prompted you to want to edit this module? -- What feedback have you gotten from users of this module? -- Are there specific agents or workflows that need attention? -- Is the module fulfilling its intended purpose? -- Are there new capabilities you want to add? -- How well does it integrate with other modules? -- Is the documentation helping users understand and use the module? - -Listen for clues about: - -- Structural issues (poor organization, hard to navigate) -- Agent/workflow issues (outdated, broken, missing functionality) -- Configuration issues (missing fields, incorrect setup) -- Documentation issues (outdated, incomplete, unclear) -- Integration issues (doesn't work well with other modules) -- Installer issues (installation problems, missing files) -- User experience issues (confusing, hard to use) - - -Based on their responses and your analysis from step 1, identify improvement opportunities: - -Organize by priority and user goals: - -- CRITICAL issues blocking module functionality -- IMPORTANT improvements enhancing user experience -- NICE-TO-HAVE enhancements for polish - -Present these conversationally, explaining WHY each matters and HOW it would help. - - -Collaborate on priorities: - -Don't just list options - discuss them: - -- "I noticed {{issue}} - this could make it hard for users to {{problem}}. Want to address this?" -- "The module could be more {{improvement}} which would help when {{use_case}}. Worth exploring?" -- "Based on what you said about {{user_goal}}, we might want to {{suggestion}}. Thoughts?" - -Let the conversation flow naturally. Build a shared vision of what "better" looks like. - - -improvement_goals - - - -Work iteratively - improve, review, refine. Never dump all changes at once. -For agent and workflow edits, invoke specialized workflows rather than doing inline - -For each improvement area, facilitate collaboratively: - -1. **Explain the current state and why it matters** - - Show relevant sections of the module - - Explain how it works now and implications - - Connect to user's goals from step 2 - -2. **Propose improvements with rationale** - - Suggest specific changes that align with best practices - - Explain WHY each change helps - - Provide examples from reference modules: {bmm_module_dir}, {bmb_module_dir}, {cis_module_dir} - - Reference agents from: {existing_agents_dir} - - Reference workflows from: {existing_workflows_dir} - - Reference the structure guide's patterns naturally - -3. **Collaborate on the approach** - - Ask if the proposed change addresses their need - - Invite modifications or alternative approaches - - Explain tradeoffs when relevant - - Adapt based on their feedback - -4. **Apply changes appropriately** - - For agent edits: Invoke edit-agent workflow - - For workflow edits: Invoke edit-workflow workflow - - For module-level changes: Make directly and iteratively - - Show updates and confirm satisfaction - - -Common improvement patterns to facilitate: - -**If improving module organization:** - -- Discuss how the current structure serves (or doesn't serve) users -- Propose reorganization that aligns with mental models -- Consider feature-based vs type-based organization -- Plan the reorganization steps -- Update all references after moving files - -**If updating module configuration:** - -- Review current config.yaml fields -- Check for missing standard fields (user_name, communication_language, output_folder) -- Add module-specific fields as needed -- Remove unused or outdated fields -- Ensure config is properly documented - -**If managing agents:** - -- Ask which agent needs attention and why -- For editing existing agent: -- For adding new agent: Guide creation and integration -- For removing agent: Confirm, remove, update references -- Ensure all agent references in workflows remain valid - -**If managing workflows:** - -- Ask which workflow needs attention and why -- For editing existing workflow: -- For adding new workflow: Guide creation and integration -- For removing workflow: Confirm, remove, update agent references -- Ensure all workflow files are properly organized - -**If improving documentation:** - -- Review current README and identify gaps -- Discuss what users need to know -- Update module overview and purpose -- List agents and workflows with clear descriptions -- Add usage examples if helpful -- Ensure installation/setup instructions are clear - -**If setting up cross-module integration:** - -- Identify which workflows from other modules are needed -- Show how to reference workflows properly: {project-root}/_bmad/{{module}}/workflows/{{workflow}}/workflow.yaml -- Document the integration in README -- Ensure dependencies are clear -- Consider adding example usage - -**If updating installer (source modules only):** - -- Review installer script for correctness -- Check web bundle configurations -- Verify all files are included -- Test installation paths -- Update module metadata - - -When invoking specialized workflows: - -Explain why you're handing off: - -- "This agent needs detailed attention. Let me invoke the edit-agent workflow to give it proper focus." -- "The workflow editor can handle this more thoroughly. I'll pass control there." - -After the specialized workflow completes, return and continue: - -- "Great! That agent/workflow is updated. Want to work on anything else in the module?" - - -Throughout improvements, educate when helpful: - -Share insights from the guides naturally: - -- "The module structure guide recommends {{pattern}} for this scenario" -- "Looking at how BMM organized this, we could use {{approach}}" -- "The BMAD convention is to {{pattern}} which helps with {{benefit}}" - -Connect improvements to broader BMAD principles without being preachy. - - -After each significant change: - -- "Does this organization feel more intuitive?" -- "Want to refine this further, or move to the next improvement?" -- "How does this change affect users of the module?" - - -improvement_implementation - - - -Run comprehensive validation conversationally: - -Don't just check boxes - explain what you're validating and why it matters: - -- "Let me verify the module structure is solid..." -- "Checking that all agent workflow references are valid..." -- "Making sure config.yaml has all necessary fields..." -- "Validating documentation is complete and accurate..." -- "Ensuring cross-module references work correctly..." - - -Load validation checklist: {installed_path}/checklist.md -Check all items from checklist systematically - - - Present issues conversationally: - -Explain what's wrong and implications: - -- "I found {{issue}} which could cause {{problem}} for users" -- "The {{component}} needs {{fix}} because {{reason}}" - -Propose fixes immediately: - -- "I can fix this by {{solution}}. Should I?" -- "We have a couple options here: {{option1}} or {{option2}}. Thoughts?" - - -Fix approved issues and re-validate - - - - Confirm success warmly: - -"Excellent! Everything validates cleanly: - -- Module structure is well-organized -- All agent and workflow references are valid -- Configuration is complete -- Documentation is thorough and current -- Cross-module integrations work properly -- Installer is correct (if applicable) - -Your module is in great shape." - - - -validation_results - - - -Create a conversational summary of what improved: - -Tell the story of the transformation: - -- "We started with {{initial_state}}" -- "You wanted to {{user_goals}}" -- "We made these key improvements: {{changes_list}}" -- "Now your module {{improved_capabilities}}" - -Highlight the impact: - -- "This means users will experience {{benefit}}" -- "The module is now more {{quality}}" -- "It follows best practices for {{patterns}}" - - -Guide next steps based on changes made: - -If structure changed significantly: - -- "Since we reorganized the structure, you should update any external references to this module" - -If agents or workflows were updated: - -- "The updated agents/workflows should be tested with real user interactions" - -If cross-module integration was added: - -- "Test the integration with {{other_module}} to ensure it works smoothly" - -If installer was updated: - -- "Test the installation process to verify all files are included correctly" - -If this is part of larger BMAD work: - -- "Consider if patterns from this module could benefit other modules" - -Be a helpful guide to what comes next, not just a task completer. - - -Would you like to: - -- Test the edited module by invoking one of its agents -- Edit a specific agent or workflow in more detail -- Make additional refinements to the module -- Work on a different module - - -completion_summary - - - diff --git a/src/modules/bmb/workflows-legacy/edit-module/workflow.yaml b/src/modules/bmb/workflows-legacy/edit-module/workflow.yaml deleted file mode 100644 index d66ef667..00000000 --- a/src/modules/bmb/workflows-legacy/edit-module/workflow.yaml +++ /dev/null @@ -1,34 +0,0 @@ -# Edit Module - Module Editor Configuration -name: "edit-module" -description: "Edit existing BMAD modules (structure, agents, workflows, documentation) while following all best practices" -author: "BMad" - -# Critical variables load from config_source -config_source: "{project-root}/_bmad/bmb/config.yaml" -communication_language: "{config_source}:communication_language" -user_name: "{config_source}:user_name" - -# Required Data Files - Critical for understanding module conventions -module_structure_guide: "{project-root}/_bmad/bmb/workflows/create-module/module-structure.md" - -# Related workflow editors -agent_editor: "{project-root}/_bmad/bmb/workflows/edit-agent/workflow.yaml" -workflow_editor: "{project-root}/_bmad/bmb/workflows/edit-workflow/workflow.yaml" - -# Reference examples - for learning patterns -bmm_module_dir: "{project-root}/_bmad/bmm/" -bmb_module_dir: "{project-root}/_bmad/bmb/" -cis_module_dir: "{project-root}/_bmad/cis/" -existing_agents_dir: "{project-root}/_bmad/*/agents/" -existing_workflows_dir: "{project-root}/_bmad/*/workflows/" - -# Module path and component files -installed_path: "{project-root}/_bmad/bmb/workflows/edit-module" -template: false # This is an action workflow - no template needed -instructions: "{installed_path}/instructions.md" -validation: "{installed_path}/checklist.md" - -standalone: true - -# Web bundle configuration -web_bundle: false # BMB workflows run locally in BMAD-METHOD project diff --git a/src/modules/bmb/workflows-legacy/module-brief/README.md b/src/modules/bmb/workflows-legacy/module-brief/README.md deleted file mode 100644 index ccf6173c..00000000 --- a/src/modules/bmb/workflows-legacy/module-brief/README.md +++ /dev/null @@ -1,264 +0,0 @@ -# Module Brief Workflow - -## Overview - -The Module Brief workflow creates comprehensive blueprints for building new BMAD modules using strategic analysis and creative vision. It serves as the essential planning phase that transforms initial ideas into detailed, actionable specifications ready for implementation with the create-module workflow. - -## Key Features - -- **Strategic Module Planning** - Comprehensive analysis from concept to implementation roadmap -- **Multi-Mode Operation** - Interactive, Express, and YOLO modes for different planning needs -- **Creative Vision Development** - Guided process for innovative module concepts and unique value propositions -- **Architecture Design** - Detailed agent and workflow ecosystem planning with interaction models -- **User Journey Mapping** - Scenario-based validation ensuring practical usability -- **Technical Planning** - Infrastructure requirements, dependencies, and complexity assessment -- **Risk Assessment** - Proactive identification of challenges with mitigation strategies -- **Implementation Roadmap** - Phased development plan with clear deliverables and timelines - -## Usage - -### Basic Invocation - -```bash -workflow module-brief -``` - -### With Brainstorming Input - -```bash -# If you have brainstorming results from previous sessions -workflow module-brief --input brainstorming-session-2024-09-26.md -``` - -### Express Mode - -```bash -# For quick essential planning only -workflow module-brief --mode express -``` - -### Configuration - -The workflow uses standard BMB configuration: - -- **output_folder**: Where the module brief will be saved -- **user_name**: Brief author information -- **communication_language**: Language for brief generation -- **date**: Automatic timestamp for versioning - -## Workflow Structure - -### Files Included - -``` -module-brief/ -├── workflow.yaml # Configuration and metadata -├── instructions.md # Step-by-step execution guide -├── template.md # Module brief document structure -├── checklist.md # Validation criteria -└── README.md # This file -``` - -## Workflow Process - -### Phase 1: Foundation and Context (Steps 1-3) - -**Mode Selection and Input Gathering** - -- Choose operational mode (Interactive, Express, YOLO) -- Check for and optionally load existing brainstorming results -- Gather background context and inspiration sources - -**Module Vision Development** - -- Define core problem the module solves -- Identify target user audience and use cases -- Establish unique value proposition and differentiators -- Explore creative themes and personality concepts - -**Module Identity Establishment** - -- Generate module code (kebab-case) with multiple options -- Create compelling, memorable module name -- Select appropriate category (Domain-Specific, Creative, Technical, Business, Personal) -- Define optional personality theme for consistent agent character - -### Phase 2: Architecture Planning (Steps 4-5) - -**Agent Architecture Design** - -- Plan agent team composition and roles -- Define agent archetypes (Orchestrator, Specialist, Helper, Creator, Analyzer) -- Specify personality traits and communication styles -- Map key capabilities and signature commands - -**Workflow Ecosystem Design** - -- Categorize workflows by purpose and complexity: - - **Core Workflows**: Essential value-delivery functions (2-3) - - **Feature Workflows**: Specialized capabilities (3-5) - - **Utility Workflows**: Supporting operations (1-3) -- Define input-process-output flows for each workflow -- Assess complexity levels and implementation priorities - -### Phase 3: Validation and User Experience (Steps 6-7) - -**User Journey Mapping** - -- Create detailed user scenarios and stories -- Map step-by-step usage flows through the module -- Validate end-to-end functionality and value delivery -- Identify potential friction points and optimization opportunities - -**Technical Planning and Requirements** - -- Assess data requirements and storage needs -- Map integration points with other modules and external systems -- Evaluate technical complexity and resource requirements -- Document dependencies and infrastructure needs - -### Phase 4: Success Planning (Steps 8-9) - -**Success Metrics Definition** - -- Establish module success criteria and performance indicators -- Define quality standards and reliability requirements -- Create user experience goals and feedback mechanisms -- Set measurable outcomes for module effectiveness - -**Development Roadmap Creation** - -- Design phased approach with MVP, Enhancement, and Polish phases -- Define deliverables and timelines for each phase -- Prioritize features and capabilities by value and complexity -- Create clear milestones and success checkpoints - -### Phase 5: Enhancement and Risk Management (Steps 10-12) - -**Creative Features and Special Touches** (Optional) - -- Design easter eggs and delightful user interactions -- Plan module lore and thematic consistency -- Add personality quirks and creative responses -- Develop backstories and universe building - -**Risk Assessment and Mitigation** - -- Identify technical, usability, and scope risks -- Develop mitigation strategies for each risk category -- Plan contingency approaches for potential challenges -- Document decision points and alternative paths - -**Final Review and Export Preparation** - -- Comprehensive review of all brief sections -- Validation against quality and completeness criteria -- Preparation for seamless handoff to create-module workflow -- Export readiness confirmation with actionable specifications - -## Output - -### Generated Files - -- **Module Brief Document**: Comprehensive planning document at `{output_folder}/module-brief-{module_code}-{date}.md` -- **Strategic Specifications**: Ready-to-implement blueprint for create-module workflow - -### Output Structure - -The module brief contains detailed specifications across multiple sections: - -1. **Executive Summary** - Vision, category, complexity, target users -2. **Module Identity** - Core concept, value proposition, personality theme -3. **Agent Architecture** - Agent roster, roles, interaction models -4. **Workflow Ecosystem** - Core, feature, and utility workflow specifications -5. **User Scenarios** - Primary use cases, secondary scenarios, user journey -6. **Technical Planning** - Data requirements, integrations, dependencies -7. **Success Metrics** - Success criteria, quality standards, performance targets -8. **Development Roadmap** - Phased implementation plan with deliverables -9. **Creative Features** - Special touches, easter eggs, module lore -10. **Risk Assessment** - Technical, usability, scope risks with mitigation -11. **Implementation Notes** - Priority order, design decisions, open questions -12. **Resources and References** - Inspiration sources, similar modules, technical references - -## Requirements - -- **Creative Vision** - Initial module concept or problem domain -- **Strategic Thinking** - Ability to plan architecture and user experience -- **Brainstorming Results** (optional) - Previous ideation sessions enhance planning quality - -## Best Practices - -### Before Starting - -1. **Gather Inspiration** - Research similar tools, modules, and solutions in your domain -2. **Run Brainstorming Session** - Use ideation techniques to generate initial concepts -3. **Define Success Criteria** - Know what "successful module" means for your context - -### During Execution - -1. **Think User-First** - Always consider the end user experience and value delivery -2. **Be Specific** - Provide concrete examples and detailed specifications rather than abstractions -3. **Validate Early** - Use user scenarios to test if the module concept actually works -4. **Plan Iteratively** - Start with MVP and build complexity through phases - -### After Completion - -1. **Use as Blueprint** - Feed the brief directly into create-module workflow for implementation -2. **Review with Stakeholders** - Validate assumptions and gather feedback before building -3. **Update as Needed** - Treat as living document that evolves with implementation learnings -4. **Reference During Development** - Use as north star for design decisions and scope management - -## Troubleshooting - -### Common Issues - -**Issue**: Stuck on module concept or vision - -- **Solution**: Use creative prompts provided in the workflow -- **Check**: Review existing modules for inspiration and patterns - -**Issue**: Agent or workflow architecture too complex - -- **Solution**: Focus on MVP first, plan enhancement phases for additional complexity -- **Check**: Validate each component against user scenarios - -**Issue**: Technical requirements unclear - -- **Solution**: Research similar modules and their implementation approaches -- **Check**: Consult with technical stakeholders early in planning - -**Issue**: Scope creep during planning - -- **Solution**: Use phased roadmap to defer non-essential features -- **Check**: Regularly validate against core user scenarios and success criteria - -## Customization - -To customize this workflow: - -1. **Modify Template Structure** - Update template.md to add new sections or reorganize content -2. **Extend Creative Prompts** - Add domain-specific ideation techniques in instructions.md -3. **Add Planning Tools** - Integrate additional analysis frameworks or planning methodologies -4. **Customize Validation** - Enhance checklist.md with specific quality criteria for your context - -## Version History - -- **v1.0.0** - Initial release - - Comprehensive strategic module planning - - Multi-mode operation (Interactive, Express, YOLO) - - Creative vision and architecture design tools - - User journey mapping and validation - - Risk assessment and mitigation planning - -## Support - -For issues or questions: - -- Review the workflow creation guide at `/_bmad/bmb/workflows/create-workflow/workflow-creation-guide.md` -- Study existing module examples in `/_bmad/` for patterns and inspiration -- Validate output using `checklist.md` -- Consult module structure guide at `create-module/module-structure.md` - ---- - -_Part of the BMad Method v6 - BMB (Builder) Module_ diff --git a/src/modules/bmb/workflows-legacy/module-brief/checklist.md b/src/modules/bmb/workflows-legacy/module-brief/checklist.md deleted file mode 100644 index 80c23962..00000000 --- a/src/modules/bmb/workflows-legacy/module-brief/checklist.md +++ /dev/null @@ -1,116 +0,0 @@ -# Module Brief Validation Checklist - -## Core Identity - -- [ ] Module code follows kebab-case convention -- [ ] Module name is clear and memorable -- [ ] Module category is identified -- [ ] Target users are clearly defined -- [ ] Unique value proposition is articulated - -## Vision and Concept - -- [ ] Problem being solved is clearly stated -- [ ] Solution approach is explained -- [ ] Module scope is well-defined -- [ ] Success criteria are measurable - -## Agent Architecture - -- [ ] At least one agent is defined -- [ ] Each agent has a clear role and purpose -- [ ] Agent personalities are defined (if using personality themes) -- [ ] Agent interactions are mapped (for multi-agent modules) -- [ ] Key commands for each agent are listed - -## Workflow Ecosystem - -- [ ] Core workflows (2-3) are identified -- [ ] Each workflow has clear purpose -- [ ] Workflow complexity is assessed -- [ ] Input/output for workflows is defined -- [ ] Workflow categories are logical - -## User Experience - -- [ ] Primary use case is documented -- [ ] User scenarios demonstrate value -- [ ] User journey is realistic -- [ ] Learning curve is considered -- [ ] User feedback mechanism planned - -## Technical Planning - -- [ ] Data requirements are identified -- [ ] Integration points are mapped -- [ ] Dependencies are listed -- [ ] Technical complexity is assessed -- [ ] Performance requirements stated - -## Development Roadmap - -- [ ] Phase 1 MVP is clearly scoped -- [ ] Phase 2 enhancements are outlined -- [ ] Phase 3 polish items listed -- [ ] Timeline estimates provided -- [ ] Deliverables are specific - -## Risk Management - -- [ ] Technical risks identified -- [ ] Usability risks considered -- [ ] Scope risks acknowledged -- [ ] Mitigation strategies provided -- [ ] Open questions documented - -## Creative Elements (Optional) - -- [ ] Personality theme is consistent (if used) -- [ ] Special features add value -- [ ] Module feels cohesive -- [ ] Fun elements don't compromise functionality - -## Documentation Quality - -- [ ] All sections have content (no empty placeholders) -- [ ] Writing is clear and concise -- [ ] Technical terms are explained -- [ ] Examples are provided where helpful -- [ ] Next steps are actionable - -## Implementation Readiness - -- [ ] Brief provides enough detail for create-module workflow -- [ ] Agent specifications sufficient for create-agent workflow -- [ ] Workflow descriptions ready for create-workflow -- [ ] Resource requirements are clear -- [ ] Success metrics are measurable - -## Final Validation - -- [ ] Module concept is viable -- [ ] Scope is achievable -- [ ] Value is clear -- [ ] Brief is complete -- [ ] Ready for development - -## Issues Found - -### Critical Issues - - - -### Recommendations - - - -### Nice-to-Haves - - - ---- - -**Validation Complete:** ⬜ Yes / ⬜ With Issues / ⬜ Needs Revision - -**Validated By:** {name} -**Date:** {date} diff --git a/src/modules/bmb/workflows-legacy/module-brief/instructions.md b/src/modules/bmb/workflows-legacy/module-brief/instructions.md deleted file mode 100644 index 1693c3c5..00000000 --- a/src/modules/bmb/workflows-legacy/module-brief/instructions.md +++ /dev/null @@ -1,268 +0,0 @@ -# Module Brief Instructions - -The workflow execution engine is governed by: {project-root}/_bmad/core/tasks/workflow.xml -You MUST have already loaded and processed: {project-root}/_bmad/bmb/workflows/module-brief/workflow.yaml -Communicate in {communication_language} throughout the module brief creation process -⚠️ ABSOLUTELY NO TIME ESTIMATES - NEVER mention hours, days, weeks, months, or ANY time-based predictions. AI has fundamentally changed development speed - what once took teams weeks/months can now be done by one person in hours. DO NOT give ANY time estimates whatsoever. - - - - -Ask the user which mode they prefer: -1. **Interactive Mode** - Work through each section collaboratively with detailed questions -2. **Express Mode** - Quick essential questions only -3. **YOLO Mode** (#yolo) - Generate complete draft based on minimal input - -Check for available inputs: - -- Brainstorming results from previous sessions -- Existing module ideas or notes -- Similar modules for inspiration - -If brainstorming results exist, offer to load and incorporate them - - - -Ask the user to describe their module idea. Probe for: -- What problem does this module solve? -- Who would use this module? -- What makes this module exciting or unique? -- Any inspiring examples or similar tools? - -If they're stuck, offer creative prompts: - -- "Imagine you're a [role], what tools would make your life easier?" -- "What repetitive tasks could be automated with agents?" -- "What domain expertise could be captured in workflows?" - -module_vision - - - -Based on the vision, work with user to define: - -**Module Code** (kebab-case): - -- Suggest 2-3 options based on their description -- Ensure it's memorable and descriptive - -**Module Name** (friendly): - -- Creative, engaging name that captures the essence - -**Module Category:** - -- Domain-Specific (legal, medical, finance) -- Creative (writing, gaming, music) -- Technical (devops, testing, architecture) -- Business (project management, marketing) -- Personal (productivity, learning) - -**Personality Theme** (optional but fun!): - -- Should the module have a consistent personality across agents? -- Star Trek crew? Fantasy party? Corporate team? Reality show cast? - -module_identity - - - -Help user envision their agent team - -For each agent, capture: - -- **Role**: What's their specialty? -- **Personality**: How do they communicate? (reference communication styles) -- **Key Capabilities**: What can they do? -- **Signature Commands**: 2-3 main commands - -Suggest agent archetypes based on module type: - -- The Orchestrator (manages other agents) -- The Specialist (deep expertise) -- The Helper (utility functions) -- The Creator (generates content) -- The Analyzer (processes and evaluates) - -agent_architecture - - - -Map out the workflow landscape - -Categorize workflows: - -**Core Workflows** (2-3 essential ones): - -- The primary value-delivery workflows -- What users will use most often - -**Feature Workflows** (3-5 specialized): - -- Specific capabilities -- Advanced features - -**Utility Workflows** (1-3 supporting): - -- Setup, configuration -- Maintenance, cleanup - -For each workflow, define: - -- Purpose (one sentence) -- Input → Process → Output -- Complexity (simple/standard/complex) - -workflow_ecosystem - - - -Create usage scenarios to validate the design - -Write 2-3 user stories: -"As a [user type], I want to [goal], so that [outcome]" - -Then walk through how they'd use the module: - -1. They load [agent] -2. They run [command/workflow] -3. They get [result] -4. This helps them [achievement] - -This validates the module makes sense end-to-end. - -user_scenarios - - - -Assess technical requirements: - -**Data Requirements:** - -- What data/files does the module need? -- Any external APIs or services? -- Storage or state management needs? - -**Integration Points:** - -- Other BMAD modules it might use -- External tools or platforms -- Import/export formats - -**Complexity Assessment:** - -- Simple (standalone, no dependencies) -- Standard (some integrations, moderate complexity) -- Complex (multiple systems, advanced features) - -technical_planning - - - -Define what success looks like: - -**Module Success Criteria:** - -- What indicates the module is working well? -- How will users measure value? -- What feedback mechanisms? - -**Quality Standards:** - -- Performance expectations -- Reliability requirements -- User experience goals - -success_metrics - - - -Create a phased approach: - -**Phase 1 - MVP (Minimum Viable Module):** - -- 1 primary agent -- 2-3 core workflows -- Basic functionality - -**Phase 2 - Enhancement:** - -- Additional agents -- More workflows -- Refined features - -**Phase 3 - Polish:** - -- Advanced features -- Optimizations -- Nice-to-haves - -development_roadmap - - - -If user wants to add special touches: - -**Easter Eggs:** - -- Hidden commands or responses -- Fun interactions between agents - -**Delighters:** - -- Unexpected helpful features -- Personality quirks -- Creative responses - -**Module Lore:** - -- Backstory for agents -- Thematic elements -- Consistent universe - -creative_features - - - -Identify potential challenges: - -**Technical Risks:** - -- Complex integrations -- Performance concerns -- Dependency issues - -**Usability Risks:** - -- Learning curve -- Complexity creep -- User confusion - -**Scope Risks:** - -- Feature bloat -- Timeline expansion -- Resource constraints - -For each risk, note mitigation strategy. - -risk_assessment - - - -Review all sections with {user_name} -Ensure module brief is ready for create-module workflow - -Would {user_name} like to: - -1. Proceed directly to create-module workflow -2. Save and refine later -3. Generate additional planning documents - - -Inform {user_name} in {communication_language} that this brief can be fed directly into create-module workflow - -final_brief - - - diff --git a/src/modules/bmb/workflows-legacy/module-brief/template.md b/src/modules/bmb/workflows-legacy/module-brief/template.md deleted file mode 100644 index 0738fe02..00000000 --- a/src/modules/bmb/workflows-legacy/module-brief/template.md +++ /dev/null @@ -1,275 +0,0 @@ -# Module Brief: {{module_name}} - -**Date:** {{date}} -**Author:** {{user_name}} -**Module Code:** {{module_code}} -**Status:** Ready for Development - ---- - -## Executive Summary - -{{module_vision}} - -**Module Category:** {{module_category}} -**Complexity Level:** {{complexity_level}} -**Target Users:** {{target_users}} - ---- - -## Module Identity - -### Core Concept - -{{module_identity}} - -### Unique Value Proposition - -What makes this module special: -{{unique_value}} - -### Personality Theme - -{{personality_theme}} - ---- - -## Agent Architecture - -{{agent_architecture}} - -### Agent Roster - -{{agent_roster}} - -### Agent Interaction Model - -How agents work together: -{{agent_interactions}} - ---- - -## Workflow Ecosystem - -{{workflow_ecosystem}} - -### Core Workflows - -Essential functionality that delivers primary value: -{{core_workflows}} - -### Feature Workflows - -Specialized capabilities that enhance the module: -{{feature_workflows}} - -### Utility Workflows - -Supporting operations and maintenance: -{{utility_workflows}} - ---- - -## User Scenarios - -### Primary Use Case - -{{primary_scenario}} - -### Secondary Use Cases - -{{secondary_scenarios}} - -### User Journey - -Step-by-step walkthrough of typical usage: -{{user_journey}} - ---- - -## Technical Planning - -### Data Requirements - -{{data_requirements}} - -### Integration Points - -{{integration_points}} - -### Dependencies - -{{dependencies}} - -### Technical Complexity Assessment - -{{technical_planning}} - ---- - -## Success Metrics - -### Module Success Criteria - -How we'll know the module is successful: -{{success_criteria}} - -### Quality Standards - -{{quality_standards}} - -### Performance Targets - -{{performance_targets}} - ---- - -## Development Roadmap - -### Phase 1: MVP (Minimum Viable Module) - -**Timeline:** {{phase1_timeline}} - -{{phase1_components}} - -**Deliverables:** -{{phase1_deliverables}} - -### Phase 2: Enhancement - -**Timeline:** {{phase2_timeline}} - -{{phase2_components}} - -**Deliverables:** -{{phase2_deliverables}} - -### Phase 3: Polish and Optimization - -**Timeline:** {{phase3_timeline}} - -{{phase3_components}} - -**Deliverables:** -{{phase3_deliverables}} - ---- - -## Creative Features - -### Special Touches - -{{creative_features}} - -### Easter Eggs and Delighters - -{{easter_eggs}} - -### Module Lore and Theming - -{{module_lore}} - ---- - -## Risk Assessment - -### Technical Risks - -{{technical_risks}} - -### Usability Risks - -{{usability_risks}} - -### Scope Risks - -{{scope_risks}} - -### Mitigation Strategies - -{{risk_mitigation}} - ---- - -## Implementation Notes - -### Priority Order - -1. {{priority_1}} -2. {{priority_2}} -3. {{priority_3}} - -### Key Design Decisions - -{{design_decisions}} - -### Open Questions - -{{open_questions}} - ---- - -## Resources and References - -### Inspiration Sources - -{{inspiration_sources}} - -### Similar Modules - -{{similar_modules}} - -### Technical References - -{{technical_references}} - ---- - -## Appendices - -### A. Detailed Agent Specifications - -{{detailed_agent_specs}} - -### B. Workflow Detailed Designs - -{{detailed_workflow_specs}} - -### C. Data Structures and Schemas - -{{data_schemas}} - -### D. Integration Specifications - -{{integration_specs}} - ---- - -## Next Steps - -1. **Review this brief** with stakeholders -2. **Run create-module workflow** using this brief as input -3. **Create first agent** using create-agent workflow -4. **Develop initial workflows** using create-workflow -5. **Test MVP** with target users - ---- - -_This Module Brief is ready to be fed directly into the create-module workflow for scaffolding and implementation._ - -**Module Viability Score:** {{viability_score}}/10 -**Estimated Development Effort:** {{effort_estimate}} -**Confidence Level:** {{confidence_level}} - ---- - -**Approval for Development:** - -- [ ] Concept Approved -- [ ] Scope Defined -- [ ] Resources Available -- [ ] Ready to Build - ---- - -_Generated on {{date}} by {{user_name}} using the BMAD Method Module Brief workflow_ diff --git a/src/modules/bmb/workflows-legacy/module-brief/workflow.yaml b/src/modules/bmb/workflows-legacy/module-brief/workflow.yaml deleted file mode 100644 index 772f6801..00000000 --- a/src/modules/bmb/workflows-legacy/module-brief/workflow.yaml +++ /dev/null @@ -1,36 +0,0 @@ -# Module Brief Workflow Configuration -name: module-brief -description: "Create a comprehensive Module Brief that serves as the blueprint for building new BMAD modules using strategic analysis and creative vision" -author: "BMad Builder" - -# Critical variables -config_source: "{project-root}/_bmad/bmb/config.yaml" -output_folder: "{config_source}:output_folder" -user_name: "{config_source}:user_name" -communication_language: "{config_source}:communication_language" -date: system-generated - -# Reference examples and documentation -existing_modules_dir: "{project-root}/_bmad/" -module_structure_guide: "{project-root}/_bmad/bmb/workflows/create-module/module-structure.md" - -# Optional user inputs - discovered if they exist -input_file_patterns: - brainstorming: - description: "Brainstorming session outputs (optional)" - whole: "{output_folder}/brainstorming-*.md" - load_strategy: "FULL_LOAD" - -# Module path and component files -installed_path: "{project-root}/_bmad/bmb/workflows/module-brief" -template: "{installed_path}/template.md" -instructions: "{installed_path}/instructions.md" -validation: "{installed_path}/checklist.md" - -# Output configuration -default_output_file: "{output_folder}/module-brief-{{module_code}}-{{date}}.md" - -standalone: true - -# Web bundle configuration -web_bundle: false # BMB workflows run locally in BMAD-METHOD project diff --git a/src/modules/bmb/workflows/agent/data/agent-compilation.md b/src/modules/bmb/workflows/agent/data/agent-compilation.md new file mode 100644 index 00000000..e1a4028e --- /dev/null +++ b/src/modules/bmb/workflows/agent/data/agent-compilation.md @@ -0,0 +1,273 @@ +# Agent Compilation: YAML Source → Final Agent + +> **For the LLM running this workflow:** This document explains what the compiler adds. When building agents, focus on the YAML structure defined here—do NOT add things the compiler handles automatically. +> +> **Example reference:** Compare `{workflow_path}/data/reference/module-examples/architect.agent.yaml` (source, 32 lines) with `architect.md` (compiled, 69 lines) to see what the compiler adds. + +--- + +## Quick Overview + +You write: **YAML source file** (`agent-name.agent.yaml`) +Compiler produces: **Markdown with XML** (`agent-name.md`) for LLM consumption + +The compiler transforms your clean YAML into a fully functional agent by adding: +- Frontmatter (name, description) +- XML activation block with numbered steps +- Menu handlers (workflow, exec, action) +- Auto-injected menu items (MH, CH, PM, DA) +- Rules section + +--- + +## What YOU Provide (YAML Source) + +Your YAML contains ONLY these sections: + +```yaml +agent: + metadata: + id: "_bmad/..." + name: "Persona Name" + title: "Agent Title" + icon: "🔧" + module: "stand-alone" or "bmm" or "cis" or "bmgd" + + persona: + role: "First-person role description" + identity: "Background and specializations" + communication_style: "How the agent speaks" + principles: + - "Core belief or methodology" + + critical_actions: # Optional - for Expert agents only + - "Load ./sidecar/memories.md" + - "Load ./sidecar/instructions.md" + - "ONLY access ./sidecar/" + + prompts: # Optional - for Simple/Expert agents + - id: prompt-name + content: | + Prompt content + + menu: # Your custom items only + - trigger: XX or fuzzy match on command-name + workflow: "path/to/workflow.yaml" # OR + exec: "path/to/file.md" # OR + action: "#prompt-id" + description: "[XX] Command description" +``` + +--- + +## What COMPILER Adds (DO NOT Include) + +### 1. Frontmatter +```markdown +--- +name: "architect" +description: "Architect" +--- +``` +**DO NOT add** frontmatter to your YAML. + +### 2. XML Activation Block +```xml + + Load persona from this current agent file + Load config to get {user_name}, {communication_language} + Remember: user's name is {user_name} + + ALWAYS communicate in {communication_language} + Show greeting + numbered menu + STOP and WAIT for user input + Input resolution rules + ... + ... + +``` +**DO NOT create** activation sections—the compiler builds them. + +### 3. Auto-Injected Menu Items +Every agent gets these 4 items automatically. **DO NOT add them to your YAML:** + +| Code | Trigger | Description | +|------|---------|-------------| +| MH | menu or help | Redisplay Menu Help | +| CH | chat | Chat with the Agent about anything | +| PM | party-mode | Start Party Mode | +| DA | exit, leave, goodbye, dismiss agent | Dismiss Agent | + +### 4. Menu Handlers +```xml + + When menu item has: workflow="path/to/workflow.yaml" + → Load workflow.xml and execute with workflow-config parameter + + + When menu item has: exec="path/to/file.md" + → Load and execute the file at that path + +``` +**DO NOT add** handlers—the compiler detects and generates them. + +--- + +## Before/After Example: Architect Agent + +### Source: `architect.agent.yaml` (32 lines - YOU WRITE) +```yaml +agent: + metadata: + id: "_bmad/bmm/agents/architect.md" + name: Winston + title: Architect + icon: 🏗️ + module: bmm + + persona: + role: System Architect + Technical Design Leader + identity: Senior architect with expertise in distributed systems... + communication_style: "Speaks in calm, pragmatic tones..." + principles: | + - User journeys drive technical decisions... + + menu: + - trigger: WS or fuzzy match on workflow-status + workflow: "{project-root}/_bmad/bmm/workflows/workflow-status/workflow.yaml" + description: "[WS] Get workflow status..." + + - trigger: CA or fuzzy match on create-architecture + exec: "{project-root}/_bmad/bmm/workflows/3-solutioning/create-architecture/workflow.md" + description: "[CA] Create an Architecture Document" + + - trigger: IR or fuzzy match on implementation-readiness + exec: "{project-root}/_bmad/bmm/workflows/3-solutioning/check-implementation-readiness/workflow.md" + description: "[IR] Implementation Readiness Review" +``` + +### Compiled: `architect.md` (69 lines - COMPILER PRODUCES) +```markdown +--- +name: "architect" +description: "Architect" +--- + +You must fully embody this agent's persona... + +```xml + + + Load persona from this current agent file (already in context) + 🚨 IMMEDIATE ACTION REQUIRED - BEFORE ANY OUTPUT... + Remember: user's name is {user_name} + Show greeting using {user_name} from config... + STOP and WAIT for user input... + On user input: Number → execute menu item[n]... + When executing a menu item: Check menu-handlers section... + + + + ... + ... + + + + + ALWAYS communicate in {communication_language} + Stay in character until exit selected + Display Menu items as the item dictates... + Load files ONLY when executing menu items... + + + + + System Architect + Technical Design Leader + Senior architect with expertise... + Speaks in calm, pragmatic tones... + - User journeys drive technical decisions... + + + + [MH] Redisplay Menu Help + [CH] Chat with the Agent about anything + [WS] Get workflow status... ← YOUR CUSTOM ITEMS + [CA] Create an Architecture Document + [IR] Implementation Readiness Review + [PM] Start Party Mode + [DA] Dismiss Agent + + +``` +**Key additions by compiler:** Frontmatter, activation block, handlers, rules, MH/CH/PM/DA menu items. + +--- + +## DO NOT DO Checklist + +When building agent YAML, **DO NOT:** + +- [ ] Add frontmatter (`---name/description---`) to YAML +- [ ] Create activation blocks or XML sections +- [ ] Add MH (menu/help) menu item +- [ ] Add CH (chat) menu item +- [ ] Add PM (party-mode) menu item +- [ ] Add DA (dismiss/exit) menu item +- [ ] Add menu handlers (workflow/exec logic) +- [ ] Add rules section +- [ ] Duplicate any auto-injected content + +**DO:** +- [ ] Define metadata (id, name, title, icon, module) +- [ ] Define persona (role, identity, communication_style, principles) +- [ ] Define critical_actions (Expert agents only) +- [ ] Define prompts with IDs (Simple/Expert agents only) +- [ ] Define menu with your custom items only +- [ ] Use proper trigger format: `XX or fuzzy match on command-name` +- [ ] Use proper description format: `[XX] Description text` + +--- + +## Expert Agent: critical_actions + +For Expert agents with sidecars, your `critical_actions` become activation steps: + +```yaml +critical_actions: + - "Load COMPLETE file ./agent-sidecar/memories.md" + - "Load COMPLETE file ./agent-sidecar/instructions.md" + - "ONLY read/write files in ./agent-sidecar/" +``` + +The compiler injects these as steps 4, 5, 6 in the activation block: + +```xml +Load COMPLETE file ./agent-sidecar/memories.md +Load COMPLETE file ./agent-sidecar/instructions.md +ONLY read/write files in ./agent-sidecar/ +ALWAYS communicate in {communication_language} +``` + +--- + +## Division of Responsibilities + +| Aspect | YOU Provide (YAML) | COMPILER Adds | +|--------|-------------------|---------------| +| Agent identity | metadata + persona | Wrapped in XML | +| Memory/actions | critical_actions | Inserted as activation steps | +| Prompts | prompts with IDs | Referenced by menu actions | +| Menu items | Your custom commands only | + MH, CH, PM, DA (auto) | +| Activation | — | Full XML block with handlers | +| Rules | — | Standardized rules section | +| Frontmatter | — | name/description header | + +--- + +## Quick Reference for LLM + +- **Focus on:** Clean YAML structure, persona definition, custom menu items +- **Ignore:** What happens after compilation—that's the compiler's job +- **Remember:** Every agent gets MH, CH, PM, DA automatically—don't add them +- **Expert agents:** Use `critical_actions` for sidecar file loading +- **Module agents:** Use `workflow:` or `exec:` references, not inline actions diff --git a/src/modules/bmb/workflows/agent/data/agent-menu-patterns.md b/src/modules/bmb/workflows/agent/data/agent-menu-patterns.md new file mode 100644 index 00000000..d3eacb06 --- /dev/null +++ b/src/modules/bmb/workflows/agent/data/agent-menu-patterns.md @@ -0,0 +1,233 @@ +# Agent Menu Patterns + +Technical reference for creating agent menu items in YAML. + +--- + +## Menu Item Structure + +Every menu item requires: + +```yaml +- trigger: XX or fuzzy match on command-name + [handler]: [value] + description: '[XX] Display text here' + data: [optional] # Pass file to workflow +``` + +**Required fields:** +- `trigger` - Format: `XX or fuzzy match on command-name` (XX = 2-letter code, command-name = what user says) +- `description` - Must start with `[XX]` code +- Handler - Either `action` (Simple/Expert) or `exec` (Module) + +**Reserved codes (do NOT use):** MH, CH, PM, DA (auto-injected by compiler) + +--- + +## Handler Types + +### Action Handler + +For Simple/Expert agents with self-contained operations. + +```yaml +# Reference prompt by ID +- trigger: WC or fuzzy match on write-commit + action: '#write-commit' + description: '[WC] Write commit message' + +# Direct inline instruction +- trigger: QC or fuzzy match on quick-commit + action: 'Generate commit message from diff' + description: '[QC] Quick commit from diff' +``` + +**When to use:** Simple/Expert agents. Use `#id` for complex multi-step prompts, inline text for simple operations. + +### Workflow Handler + +For module agents referencing external workflow files. + +```yaml +- trigger: CP or fuzzy match on create-prd + exec: '{project-root}/_bmad/bmm/workflows/create-prd/workflow.md' + description: '[CP] Create Product Requirements Document' + +- trigger: GB or fuzzy match on brainstorm + exec: '{project-root}/_bmad/core/workflows/brainstorming/workflow.md' + description: '[GB] Guided brainstorming session' + +# Planned but unimplemented +- trigger: FF or fuzzy match on future-feature + exec: 'todo' + description: '[FF] Coming soon' +``` + +**When to use:** Module agents, multi-step workflows, complex processes. Use `exec: 'todo'` for unimplemented features. + +### Data Parameter (Optional) + +Add to ANY handler to pass files to the workflow/action. + +```yaml +- trigger: TS or fuzzy match on team-standup + exec: '{project-root}/_bmad/bmm/tasks/team-standup.md' + data: '{project-root}/_bmad/_config/agent-manifest.csv' + description: '[TS] Run team standup' + +- trigger: AM or fuzzy match on analyze-metrics + action: 'Analyze these metrics for trends' + data: '{project-root}/_data/metrics.json' + description: '[AM] Analyze metrics' +``` + +**When to use:** Workflow needs input file, action processes external data. + +--- + +## Prompts Section + +For Simple/Expert agents, define reusable prompts referenced by `action: '#id'`. + +```yaml +prompts: + - id: analyze-code + content: | + Analyze code for patterns + 1. Identify structure 2. Check issues 3. Suggest improvements + +menu: + - trigger: AC or fuzzy match on analyze-code + action: '#analyze-code' + description: '[AC] Analyze code patterns' +``` + +**Common XML tags:** ``, ``, ``, `` + +--- + +## Path Variables + +**Always use variables, never hardcoded paths:** + +```yaml +# ✅ CORRECT +exec: '{project-root}/_bmad/core/workflows/brainstorming/workflow.md' +data: '{project-root}/_data/metrics.csv' + +# ❌ WRONG +exec: '../../../core/workflows/brainstorming/workflow.md' +``` + +**Available variables:** +- `{project-root}` - Project root directory +- `{output_folder}` - Document output location +- `{user_name}` - User's name from config +- `{communication_language}` - Language preference + +**Expert Agent sidecar paths:** +```yaml +# Agent YAML referencing sidecar files +action: 'Update {project-root}/_bmad/_memory/journal-keeper-sidecar/memories.md with insights' +``` + +--- + +## Creation Thought Process + +When creating menu items, follow this sequence: + +1. **User capability** → "Check code for issues" +2. **Choose code** → `LC` (Lint Code) +3. **Write trigger** → `LC or fuzzy match on lint-code` +4. **Choose handler** → `action` (inline is simple enough) +5. **Write description** → `[LC] Lint code for issues` + +Result: +```yaml +- trigger: LC or fuzzy match on lint-code + action: 'Check code for common issues and anti-patterns' + description: '[LC] Lint code for issues' +``` + +--- + +## Complete Examples + +### Simple Agent Menu + +```yaml +prompts: + - id: format-code + content: | + Format code to style guidelines + 1. Indentation 2. Spacing 3. Naming + +menu: + - trigger: FC or fuzzy match on format-code + action: '#format-code' + description: '[FC] Format code to style guidelines' + + - trigger: LC or fuzzy match on lint-code + action: 'Check code for common issues and anti-patterns' + description: '[LC] Lint code for issues' + + - trigger: SI or fuzzy match on suggest-improvements + action: 'Suggest improvements following project-context.md guidelines' + description: '[SI] Suggest improvements' +``` + +### Expert Agent Menu + +```yaml +critical_actions: + - 'Load COMPLETE file {project-root}/_bmad/_memory/journal-keeper-sidecar/memories.md' + - 'Load COMPLETE file {project-root}/_bmad/_memory/journal-keeper-sidecar/instructions.md' + - 'ONLY read/write files in {project-root}/_bmad/_memory/journal-keeper-sidecar/' + +prompts: + - id: guided-entry + content: | + Guide through journal entry + +menu: + - trigger: WE or fuzzy match on write-entry + action: '#guided-entry' + description: '[WE] Write journal entry' + + - trigger: QC or fuzzy match on quick-capture + action: 'Save entry to {project-root}/_bmad/_memory/journal-keeper-sidecar/entries/entry-{date}.md' + description: '[QC] Quick capture' + + - trigger: SM or fuzzy match on save-memory + action: 'Update {project-root}/_bmad/_memory/journal-keeper-sidecar/memories.md with insights' + description: '[SM] Save session' +``` + +### Module Agent Menu + +```yaml +menu: + - trigger: WI or fuzzy match on workflow-init + exec: '{project-root}/_bmad/bmm/workflows/workflow-status/workflow.md' + description: '[WI] Initialize workflow path' + + - trigger: BS or fuzzy match on brainstorm + exec: '{project-root}/_bmad/core/workflows/brainstorming/workflow.md' + description: '[BS] Guided brainstorming [K,T,A,B,C]' + + - trigger: CP or fuzzy match on create-prd + exec: '{project-root}/_bmad/bmm/workflows/create-prd/workflow.md' + description: '[CP] Create PRD' +``` + +--- + +## Key Patterns to Remember + +1. **Triggers always:** `XX or fuzzy match on command-name` +2. **Descriptions always:** `[XX] Display text` +3. **Reserved codes:** MH, CH, PM, DA (never use) +4. **Codes must be:** Unique within each agent +5. **Paths always:** `{project-root}` variable, never relative +6. **Expert sidecars:** `{project-root}/_bmad/_memory/{sidecar-folder}/` diff --git a/src/modules/bmb/workflows/agent/data/agent-metadata.md b/src/modules/bmb/workflows/agent/data/agent-metadata.md new file mode 100644 index 00000000..7e2398d9 --- /dev/null +++ b/src/modules/bmb/workflows/agent/data/agent-metadata.md @@ -0,0 +1,208 @@ +# Agent Metadata Properties + +Core identification and classification properties for all agents. + +--- + +## Property Reference + +| Property | Purpose | Format | +| ------------ | ------------------------- | ---------------------------------------------- | +| `id` | Compiled output path | `_bmad/agents/{agent-name}/{agent-name}.md` | +| `name` | Persona's name | "First Last" or "Name Title" | +| `title` | Professional role | "Code Review Specialist" | +| `icon` | Visual identifier | Single emoji only | +| `module` | Team/ecosystem membership | `stand-alone`, `bmm`, `cis`, `bmgd`, or custom | +| `hasSidecar` | Sidecar folder exists | `true` or `false` (Expert = true) | + +--- + +## id Property + +The compiled output path after build. + +**Format:** `_bmad/agents/{agent-name}/{agent-name}.md` + +**Examples:** +```yaml +id: _bmad/agents/commit-poet/commit-poet.md +id: _bmad/agents/journal-keeper/journal-keeper.md +id: _bmad/agents/security-engineer/security-engineer.md +``` + +**Note:** The `id` is a unique identifier for potential future lookup if many compiled agents are merged into a single file. Conventionally matches the agent's filename pattern. + +--- + +## name Property + +The persona's identity - what the agent is called. + +**Format:** Human name or descriptive name + +```yaml +# ✅ CORRECT +name: 'Inkwell Von Comitizen' # peron name of commit-author title agent +name: 'Dr. Demento' # person name for a joke writer agent +name: 'Clarity' # person name for a guided thought coach agent + +# ❌ WRONG +name: 'commit-poet' # That's the filename +name: 'Code Review Specialist' # That's the title +``` + +--- + +## title Property + +Professional role identifier. + +**Format:** Professional title or role name + +**Important:** The `title` determines the agent's filename: +- `title: 'Commit Message Artisan'` → `commit-message-artisan.agent.yaml` +- `title: 'Strategic Business Analyst'` → `strategic-business-analyst.agent.yaml` +- `title: 'Code Review Specialist'` → `code-review-specialist.agent.yaml` + +The `id` and filename are derived from the `title` (kebab-cased). + +**Difference from role:** `title` is the short identifier (filename), `role` is 1-2 sentences expanding on what the agent does. + +```yaml +# ✅ CORRECT +title: 'Commit Message Artisan' +title: 'Strategic Business Analyst' +title: 'Code Review Specialist' + +# ❌ WRONG +title: 'Inkwell Von Comitizen' # That's the name +title: 'Writes git commits' # Full sentence - not an identifying functional title +``` + +--- + +## icon Property + +Single emoji representing the agent's personality/function. + +**Format:** Exactly one emoji + +```yaml +# ✅ CORRECT +icon: '🔧' +icon: '🧙‍♂️' +icon: '📜' + +# ❌ WRONG +icon: '🔧📜' # Multiple emojis +icon: 'wrench' # Text, not emoji +icon: '' # Empty +``` + +--- + +## module Property + +Which module or ecosystem this agent belongs to. + +**Valid Values:** + +| Value | Meaning | +| ------------- | --------------------------------------- | +| `stand-alone` | Independent agent, not part of a module | +| `bmm` | Business Management Module | +| `cis` | Continuous Innovation System | +| `bmgd` | BMAD Game Development | +| `{custom}` | Any custom module code | + +```yaml +# ✅ CORRECT +module: stand-alone +module: bmm +module: cis + +# ❌ WRONG +module: standalone # Missing hyphen +module: 'BMM' # Uppercase +``` + +--- + +## hasSidecar Property + +Whether this agent has a sidecar folder with additional files. + +**Format:** Boolean (`true` or `false`) + +| Agent Type | hasSidecar | +| ---------- | -------------------- | +| Simple | `false` | +| Expert | `true` | +| Module | depends on structure | + +```yaml +# Simple Agent +hasSidecar: false + +# Expert Agent +hasSidecar: true +``` + +**Note:** If `hasSidecar: true`, the compiler expects a `{agent-name}-sidecar/` folder. + +--- + +## Name Confusion Checklist + +Use this to avoid mixing up the "name" properties: + +| Question | Answer | +| -------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------- | +| What's the file called? | Derived from `title`: `"Commit Message Artisan"` → `commit-message-artisan.agent.yaml` | +| What's the persona called? | `name` - "Inkwell Von Comitizen" (who the agent is) | +| What's their job title? | `title` - "Commit Message Artisan" (determines filename) | +| What do they do? | `role` - 1-2 sentences expanding on the title | +| What's the unique key? | `id` - `_bmad/agents/commit-message-artisan/commit-message-artisan.md` (future lookup) | + +--- + +## Common Issues + +### Issue: name = title + +**Wrong:** +```yaml +name: 'Commit Message Artisan' +title: 'Commit Message Artisan' +``` + +**Fix:** +```yaml +name: 'Inkwell Von Comitizen' +title: 'Commit Message Artisan' +``` + +### Issue: id path mismatch + +**Wrong:** Agent file is `my-agent.agent.yaml` but: +```yaml +id: _bmad/agents/different-agent/different-agent.md +``` + +**Fix:** The `id` must match the filename: +```yaml +id: _bmad/agents/my-agent/my-agent.md +``` + +### Issue: Wrong module format + +**Wrong:** +```yaml +module: Standalone +module: STAND_ALONE +``` + +**Fix:** +```yaml +module: stand-alone # lowercase, hyphenated +``` diff --git a/src/modules/bmb/workflows/create-agent/data/brainstorm-context.md b/src/modules/bmb/workflows/agent/data/brainstorm-context.md similarity index 93% rename from src/modules/bmb/workflows/create-agent/data/brainstorm-context.md rename to src/modules/bmb/workflows/agent/data/brainstorm-context.md index 250dfc29..d564f76b 100644 --- a/src/modules/bmb/workflows/create-agent/data/brainstorm-context.md +++ b/src/modules/bmb/workflows/agent/data/brainstorm-context.md @@ -1,7 +1,4 @@ # Agent Creation Brainstorming Context - -_Dream the soul. Discover the purpose. The build follows._ - ## Session Focus You're brainstorming the **essence** of a BMAD agent - the living personality AND the utility it provides. Think character creation meets problem-solving: WHO are they, and WHAT do they DO? @@ -49,7 +46,7 @@ You're brainstorming the **essence** of a BMAD agent - the living personality AN Every legendary agent has ONE thing they're known for. What's theirs? **The Command Menu** -User types `*` and sees their options. Brainstorm 5-10 actions: +User types `*` and sees their options. Brainstorm 3-10 actions: - What makes users sigh with relief? - What capabilities complement each other? @@ -80,9 +77,9 @@ User types `*` and sees their options. Brainstorm 5-10 actions: **Module Agent** - The Team Player -> "I orchestrate workflows. I coordinate the mission." +> "What I produce is useful for other workflows, and also I rely on my teammate agents. I coordinate the mission." -- Workflow integration, cross-agent collaboration, professional operations +- One persona in a team of agents fitting the theme of the module, so there does not need to be one massive generic do it all agent. ## Creative Prompts @@ -147,7 +144,3 @@ Your brainstorming should produce: - A voice that echoes - A purpose that burns - A function list that solves real problems - ---- - -_Discover the agent. Define what they do. The build follows._ diff --git a/src/modules/bmb/workflows/create-agent/data/communication-presets.csv b/src/modules/bmb/workflows/agent/data/communication-presets.csv similarity index 98% rename from src/modules/bmb/workflows/create-agent/data/communication-presets.csv rename to src/modules/bmb/workflows/agent/data/communication-presets.csv index 76ccf704..758ea22b 100644 --- a/src/modules/bmb/workflows/create-agent/data/communication-presets.csv +++ b/src/modules/bmb/workflows/agent/data/communication-presets.csv @@ -50,7 +50,7 @@ id,category,name,style_text,key_traits,sample 49,retro,disco-era,"Groovy positive vibes. Far out and solid.","funky,far_out,good_vibes","That's a far out idea! Let's boogie with it!" 50,retro,victorian-scholar,"Formal antiquated eloquence. Most fascinating indeed.","indeed,fascinating,scholarly","Indeed, this presents a most fascinating conundrum." 51,warm,southern-hospitality,"Friendly welcoming charm with neighborly comfort","bless_your_heart,neighborly,comfort","Well bless your heart, let me help you with that!" -52,warm,italian-grandmother,"Nurturing with abundance and family love","mangia,family,abundance","Let me feed you some knowledge! You need it!" +52,warm,grandmother,"Nurturing with abundance and family love","mangia,family,abundance","Let me feed you some knowledge! You need it!" 53,warm,camp-counselor,"Enthusiastic group energy. Gather round everyone!","team_building,campfire,together","Alright everyone, gather round! This is going to be great!" 54,warm,neighborhood-friend,"Casual helpful support. Got your back.","hey_friend,no_problem,got_your_back","Hey, no worries! I've got your back on this one." 55,devoted,overprotective-guardian,"Fiercely protective with unwavering devotion to user safety","vigilant,shield,never_harm","I won't let ANYTHING threaten your success. Not on my watch!" diff --git a/src/modules/bmb/workflows/agent/data/critical-actions.md b/src/modules/bmb/workflows/agent/data/critical-actions.md new file mode 100644 index 00000000..5b8de8e6 --- /dev/null +++ b/src/modules/bmb/workflows/agent/data/critical-actions.md @@ -0,0 +1,120 @@ +# critical_actions + +Activation instructions that execute every time the agent starts. + +--- + +## Purpose + +Numbered steps that execute FIRST when an agent activates. + +**Use for:** +- Loading memory/knowledge files +- Setting file access boundaries +- Startup behavior (greeting enhancement, data fetch, state init) +- Any MUST-do activation behavior + +**Applies to:** BOTH Simple and Expert agents + +--- + +## Expert Agent Pattern + +```yaml +# ✅ CORRECT Expert Agent +critical_actions: + - 'Load COMPLETE file {project-root}/_bmad/_memory/journal-keeper-sidecar/memories.md' + - 'Load COMPLETE file {project-root}/_bmad/_memory/journal-keeper-sidecar/instructions.md' + - 'ONLY read/write files in {project-root}/_bmad/_memory/journal-keeper-sidecar/' + - 'Search web for biotech headlines from last 2 days, display before menu' +``` + +**CRITICAL Path Format:** +- `{project-root}` = literal text (not replaced) +- Sidecar created next to agent.yaml during BUILD, then copied to `_memory/` during BMAD INSTALLATION +- Use `{project-root}/_bmad/_memory/{sidecar-folder}/` format for RUNTIME paths in agent YAML + +--- + +## Simple Agent Pattern + +```yaml +# ✅ CORRECT Simple Agent with activation behavior +critical_actions: + - 'Give user an inspirational quote before showing menu' + - 'Review {project-root}/finances/ for most recent data file' +``` + +**Note:** Agents without activation needs can omit `critical_actions` entirely. + +--- + +## Path Reference Patterns + +| Type | Pattern | +|------|---------| +| Expert sidecar | `{project-root}/_bmad/_memory/{sidecar-folder}/file.md` | +| Simple data | `{project-root}/finances/data.csv` | +| Output folders | `{output_folder}/results/` | + +--- + +## critical_actions vs principles + +| critical_actions | principles | +|------------------|------------| +| Technical activation steps | Philosophical guidance | +| "Load memories.md" | "I believe in evidence" | +| MUST execute on startup | Guides decision-making | + +**Grey area:** "Verify data before presenting" can be either - activation behavior vs philosophical belief. Use judgment. + +--- + +## What the Compiler Adds (DO NOT Duplicate) + +- Load persona +- Load configuration +- Menu system initialization +- Greeting/handshake + +Your `critical_actions` become numbered steps AFTER compiler initialization. + +--- + +## Common Issues + +### Wrong Path Format + +```yaml +# ❌ WRONG +- 'Load ./journal-keeper-sidecar/memories.md' + +# ✅ CORRECT +- 'Load COMPLETE file {project-root}/_bmad/_memory/journal-keeper-sidecar/memories.md' +``` + +### Missing COMPLETE Keyword + +```yaml +# ❌ WRONG +- 'Load file memories.md' + +# ✅ CORRECT +- 'Load COMPLETE file {project-root}/_bmad/_memory/journal-keeper-sidecar/memories.md' +``` + +`COMPLETE` ensures LLM reads entire file, not a portion. + +### Duplicating Compiler Functions + +```yaml +# ❌ WRONG - compiler does these +- 'Load my persona' +- 'Initialize menu system' +- 'Say hello to user' + +# ✅ CORRECT - agent-specific only +- 'Load memory files' +- 'Search web for headlines before menu' +``` diff --git a/src/modules/bmb/workflows/agent/data/expert-agent-architecture.md b/src/modules/bmb/workflows/agent/data/expert-agent-architecture.md new file mode 100644 index 00000000..936b4022 --- /dev/null +++ b/src/modules/bmb/workflows/agent/data/expert-agent-architecture.md @@ -0,0 +1,236 @@ +# Expert Agent Architecture + +Agents with a sidecar folder for persistent memory, custom workflows, and restricted file access. + +--- + +## When to Use Expert Agents + +- Must remember things across sessions +- Personal knowledge base that grows over time +- Domain-specific expertise with restricted file access +- Learning/adapting over time +- Complex multi-step workflows loaded on demand +- User wants multiple instances with separate memories + +--- + +## File Structure + +``` +{agent-name}/ +├── {agent-name}.agent.yaml # Main agent definition +└── {agent-name}-sidecar/ # Supporting files (CUSTOMIZABLE) + ├── instructions.md # Startup protocols (common) + ├── memories.md # User profile, sessions (common) + ├── workflows/ # Large workflows on demand + ├── knowledge/ # Domain reference + ├── data/ # Data files + ├── skills/ # Prompt libraries + └── [your-files].md # Whatever needed +``` + +**Naming:** +- Agent file: `{agent-name}.agent.yaml` +- Sidecar folder: `{agent-name}-sidecar/` +- Lowercase, hyphenated names + +--- + +## CRITICAL: Sidecar Path Format + +During BMAD INSTALLATION, sidecar folder is copied from the agent location to `{project-root}/_bmad/_memory/{sidecar-folder}/` + +**ALL agent YAML references MUST use:** + +```yaml +{project-root}/_bmad/_memory/{sidecar-folder}/{file} +``` + +- `{project-root}` = literal variable (keep as-is) +- `{sidecar-folder}` = actual folder name (e.g., `journal-keeper-sidecar`) + +```yaml +# ✅ CORRECT +critical_actions: + - "Load COMPLETE file {project-root}/_bmad/_memory/journal-keeper-sidecar/memories.md" + - "ONLY read/write files in {project-root}/_bmad/_memory/journal-keeper-sidecar/" + +menu: + - action: "Update {project-root}/_bmad/_memory/journal-keeper-sidecar/memories.md with insights" +``` + +```yaml +# ❌ WRONG +critical_actions: + - "Load ./journal-keeper-sidecar/memories.md" + - "Load /Users/absolute/path/memories.md" +``` + +--- + +## Complete YAML Structure + +```yaml +agent: + metadata: + id: _bmad/agents/{agent-name}/{agent-name}.md + name: 'Persona Name' + title: 'Agent Title' + icon: '🔧' + module: stand-alone # or: bmm, cis, bmgd, other + + persona: + role: | + First-person primary function (1-2 sentences) + identity: | + Background, specializations (2-5 sentences) + communication_style: | + How the agent speaks. Include memory reference patterns. + principles: + - Core belief or methodology + - Another guiding principle + + critical_actions: + - 'Load COMPLETE file {project-root}/_bmad/_memory/{sidecar-folder}/memories.md' + - 'Load COMPLETE file {project-root}/_bmad/_memory/{sidecar-folder}/instructions.md' + - 'ONLY read/write files in {project-root}/_bmad/_memory/{sidecar-folder}/' + + prompts: + - id: main-action + content: | + What this does + 1. Step one 2. Step two + + menu: + - trigger: XX or fuzzy match on command + action: '#main-action' + description: '[XX] Command description' + + - trigger: SM or fuzzy match on save + action: 'Update {project-root}/_bmad/_memory/{sidecar-folder}/memories.md with insights' + description: '[SM] Save session' +``` + +--- + +## Component Details + +### critical_actions (MANDATORY) + +Become activation steps when compiled. Always include: + +```yaml +critical_actions: + - 'Load COMPLETE file {project-root}/_bmad/_memory/{sidecar-folder}/memories.md' + - 'Load COMPLETE file {project-root}/_bmad/_memory/{sidecar-folder}/instructions.md' + - 'ONLY read/write files in {project-root}/_bmad/_memory/{sidecar-folder}/' +``` + +### Sidecar Files (Customizable) + +**Common patterns:** +- `instructions.md` - Startup protocols, domain boundaries +- `memories.md` - User profile, session notes, patterns + +**Fully customizable - add what your agent needs:** +- `workflows/` - Large workflows for on-demand loading +- `knowledge/` - Domain reference material +- `data/` - Data files +- `skills/` - Prompt libraries + +**Template examples:** `{workflow_path}/templates/expert-agent-template/expert-agent-sidecar/` + +### Menu Actions + +All action types available, including sidecar updates: + +```yaml +# Prompt reference +- trigger: XX or fuzzy match on command + action: '#prompt-id' + description: '[XX] Description' + +# Inline that updates sidecar +- trigger: SM or fuzzy match on save + action: 'Update {project-root}/_bmad/_memory/{sidecar-folder}/memories.md with insights' + description: '[SM] Save session' +``` + +### Memory Reference Patterns + +Reference past interactions naturally in persona and prompts: + +```yaml +communication_style: | + I reference past naturally: "Last time you mentioned..." or "I've noticed patterns..." +``` + +--- + +## Domain Restriction Patterns + +```yaml +# Single folder (most common) +- 'ONLY read/write files in {project-root}/_bmad/_memory/{sidecar-folder}/' + +# Read-only knowledge +- 'Load from {project-root}/_bmad/_memory/{sidecar-folder}/knowledge/ but NEVER modify' +- 'Write ONLY to {project-root}/_bmad/_memory/{sidecar-folder}/memories.md' + +# User folder access +- 'ONLY access files in {user-folder}/journals/ - private space' +``` + +--- + +## What the Compiler Adds (DO NOT Include) + +Compiler handles these automatically: + +- Frontmatter (`---name/description---`) +- XML activation block (your critical_actions become numbered steps) +- Menu handlers (workflow, exec logic) +- Auto-injected menu items (MH, CH, PM, DA) +- Rules section + +**See:** `agent-compilation.md` for compilation details. + +--- + +## Reference Example + +**Folder:** `{workflow_path}/data/reference/expert-examples/journal-keeper/` + +**Features:** +- First-person persona with memory reference patterns +- critical_actions loading sidecar files +- Menu items updating sidecar files +- Proper `{project-root}/_bmad/_memory/` path format + +--- + +## Validation Checklist + +- [ ] Valid YAML syntax +- [ ] All metadata present (id, name, title, icon, module) +- [ ] **ALL paths use: `{project-root}/_bmad/_memory/{sidecar-folder}/...`** +- [ ] `{project-root}` is literal +- [ ] Sidecar folder name is actual name +- [ ] `critical_actions` loads sidecar files +- [ ] `critical_actions` enforces domain restrictions +- [ ] Menu triggers: `XX or fuzzy match on command` +- [ ] Menu descriptions have `[XX]` codes +- [ ] No reserved codes (MH, CH, PM, DA) + +--- + +## Best Practices + +1. **critical_actions MANDATORY** - Load sidecar files explicitly +2. **Enforce domain restrictions** - Clear boundaries +3. **Reference past naturally** - Don't dump memory +4. **Design for growth** - Structure for accumulation +5. **Separate concerns** - Memories, instructions, knowledge distinct +6. **Include privacy** - Users trust with personal data +7. **First-person voice** - In all persona elements diff --git a/src/modules/bmb/workflows/agent/data/expert-agent-validation.md b/src/modules/bmb/workflows/agent/data/expert-agent-validation.md new file mode 100644 index 00000000..653d1ac8 --- /dev/null +++ b/src/modules/bmb/workflows/agent/data/expert-agent-validation.md @@ -0,0 +1,174 @@ +# Expert Agent Validation Checklist + +Validate Expert agents meet BMAD quality standards. + +--- + +## YAML Structure + +- [ ] YAML parses without errors +- [ ] `agent.metadata` includes: `id`, `name`, `title`, `icon`, `module`, `hasSidecar` +- [ ] `agent.metadata.hasSidecar` is `true` (Expert agents have sidecars) +- [ ] `agent.metadata.module` is `stand-alone` or module code (`bmm`, `cis`, `bmgd`, etc.) +- [ ] `agent.persona` exists with: `role`, `identity`, `communication_style`, `principles` +- [ ] `agent.critical_actions` exists (MANDATORY for Expert) +- [ ] `agent.menu` exists with at least one item +- [ ] File named: `{agent-name}.agent.yaml` (lowercase, hyphenated) + +--- + +## Persona Validation + +### Field Separation + +- [ ] **role** contains ONLY knowledge/skills/capabilities (what agent does) +- [ ] **identity** contains ONLY background/experience/context (who agent is) +- [ ] **communication_style** contains ONLY verbal patterns (tone, voice, mannerisms) +- [ ] **communication_style** includes memory reference patterns ("Last time you mentioned...") +- [ ] **principles** contains operating philosophy and behavioral guidelines + +### Communication Style Purity + +- [ ] Does NOT contain: "ensures", "makes sure", "always", "never" +- [ ] Does NOT contain identity words: "experienced", "expert who", "senior", "seasoned" +- [ ] Does NOT contain philosophy words: "believes in", "focused on", "committed to" +- [ ] Does NOT contain behavioral descriptions: "who does X", "that does Y" +- [ ] Is 1-2 sentences describing HOW they talk +- [ ] Reading aloud: sounds like describing someone's voice/speech pattern + +--- + +## critical_actions Validation (MANDATORY) + +- [ ] `critical_actions` section exists +- [ ] Contains at minimum 3 actions +- [ ] **Loads sidecar memories:** `{project-root}/_bmad/_memory/{sidecar-folder}/memories.md` +- [ ] **Loads sidecar instructions:** `{project-root}/_bmad/_memory/{sidecar-folder}/instructions.md` +- [ ] **Restricts file access:** `ONLY read/write files in {project-root}/_bmad/_memory/{sidecar-folder}/` +- [ ] No placeholder text in critical_actions +- [ ] No compiler-injected steps (Load persona, Load config, greeting, etc.) + +--- + +## Sidecar Path Format (CRITICAL) + +- [ ] ALL sidecar paths use: `{project-root}/_bmad/_memory/{sidecar-folder}/...` +- [ ] `{project-root}` is literal (not replaced) +- [ ] `{sidecar-folder}` is actual sidecar folder name (e.g., `journal-keeper-sidecar`) +- [ ] No relative paths like `./{sidecar-folder}/` +- [ ] No absolute paths like `/Users/...` + +--- + +## Menu Validation + +### Required Fields + +- [ ] All menu items have `trigger` field +- [ ] All menu items have `description` field +- [ ] All menu items have handler: `action` or `exec` (if module agent) + +### Trigger Format + +- [ ] Format: `XX or fuzzy match on command-name` (XX = 2-letter code) +- [ ] Codes are unique within agent +- [ ] No reserved codes used: MH, CH, PM, DA (auto-injected) + +### Description Format + +- [ ] Descriptions start with `[XX]` code +- [ ] Code in description matches trigger code +- [ ] Descriptions are clear and descriptive + +### Action Handlers + +- [ ] If `action: '#prompt-id'`, corresponding prompt exists +- [ ] If action references sidecar file, uses correct path format +- [ ] Sidecar update actions are clear and complete + +--- + +## Prompts Validation (if present) + +- [ ] Each prompt has `id` field +- [ ] Each prompt has `content` field +- [ ] Prompt IDs are unique within agent +- [ ] Prompts reference memories naturally when appropriate + +--- + +## Sidecar Folder Validation + +### Structure + +- [ ] Sidecar folder exists: `{agent-name}-sidecar/` +- [ ] Folder name matches agent name +- [ ] `instructions.md` exists (recommended) +- [ ] `memories.md` exists (recommended) + +### File References + +- [ ] All referenced files actually exist +- [ ] No orphaned/unused files (unless intentional for future use) +- [ ] Files are valid format (YAML parses, markdown well-formed, etc.) + +### Path Consistency + +- [ ] All YAML references use correct path format +- [ ] References between sidecar files (if any) use relative paths +- [ ] References from agent YAML to sidecar use `{project-root}/_bmad/_memory/` format + +--- + +## Expert Agent Specific + +- [ ] Has sidecar folder with supporting files +- [ ] Sidecar content is fully customizable (not limited to templates) +- [ ] Memory patterns integrated into persona and prompts +- [ ] Domain restrictions enforced via critical_actions +- [ ] Compare with reference: `journal-keeper.agent.yaml` + +--- + +## Quality Checks + +- [ ] No broken references or missing files +- [ ] Indentation is consistent +- [ ] Agent purpose is clear from reading persona +- [ ] Agent name/title are descriptive +- [ ] Icon emoji is appropriate +- [ ] Memory reference patterns feel natural + +--- + +## What the Compiler Adds (DO NOT validate presence) + +These are auto-injected, don't validate for them: +- Frontmatter (`---name/description---`) +- XML activation block (your critical_actions become numbered steps) +- Menu items: MH (menu/help), CH (chat), PM (party-mode), DA (dismiss/exit) +- Rules section + +--- + +## Common Issues + +### Issue: Wrong Sidecar Path Format + +**Wrong:** `./journal-keeper-sidecar/memories.md` + +**Fix:** `{project-root}/_bmad/_memory/journal-keeper-sidecar/memories.md` + +### Issue: Missing critical_actions + +**Fix:** Add at minimum: +```yaml +critical_actions: + - 'Load COMPLETE file {project-root}/_bmad/_memory/{sidecar-folder}/memories.md' + - 'Load COMPLETE file {project-root}/_bmad/_memory/{sidecar-folder}/instructions.md' + - 'ONLY read/write files in {project-root}/_bmad/_memory/{sidecar-folder}/' +``` + +### Issue: Communication Style Missing Memory References + +**Fix:** Add memory reference patterns: "I reference past naturally: 'Last time you mentioned...'" diff --git a/src/modules/bmb/workflows/agent/data/module-agent-validation.md b/src/modules/bmb/workflows/agent/data/module-agent-validation.md new file mode 100644 index 00000000..b09ae812 --- /dev/null +++ b/src/modules/bmb/workflows/agent/data/module-agent-validation.md @@ -0,0 +1,126 @@ +# Module Agent Validation Checklist + +Validate Module agents meet BMAD quality standards. + +**Run this AFTER Simple or Expert validation.** + +--- + +## Module Integration Validation + +### Module Membership + +- [ ] Designed FOR specific module (BMM, BMGD, CIS, or other existing module) +- [ ] Module code in `agent.metadata.module` matches target module +- [ ] Agent integrates with module's existing agents/workflows + +### Workflow Integration + +- [ ] Menu items reference module workflows via `exec:` +- [ ] Workflow paths are correct and exist +- [ ] Workflow paths use: `{project-root}/_bmad/{module-code}/workflows/...` +- [ ] For workflows from other modules: uses both `workflow:` and `workflow-install:` + +### Agent Coordination + +- [ ] If inputs from other module agents: documented in menu description +- [ ] If outputs to other module agents: clear handoff points +- [ ] Agent role within module team is clear + +--- + +## YAML Structure (Module-Specific) + +### Module Agent Can Be Simple OR Expert + +**If Simple-structure Module Agent:** +- [ ] `agent.metadata.hasSidecar` is `false` (no sidecar) +- [ ] Single .agent.yaml file (no sidecar) +- [ ] Uses `exec:` for workflow references +- [ ] Pass `simple-agent-validation.md` first + +**If Expert-structure Module Agent:** +- [ ] `agent.metadata.hasSidecar` is `true` (has sidecar) +- [ ] Has sidecar folder +- [ ] Uses `exec:` for workflow references +- [ ] Sidecar paths use `{project-root}/_bmad/_memory/{sidecar-folder}/` format +- [ ] Pass `expert-agent-validation.md` first + +--- + +## Menu Validation (Module-Specific) + +### Workflow Handlers + +- [ ] Module agents use `exec:` for workflow references +- [ ] Workflow paths use `{project-root}` variable +- [ ] Workflow paths point to existing workflows + +### Unimplemented Features + +- [ ] If `exec: 'todo'`, feature is documented as planned +- [ ] Description indicates "Coming soon" or similar + +### Data Parameters (if used) + +- [ ] `data:` parameter references valid files +- [ ] Data paths use `{project-root}` variable + +--- + +## Module-Specific Quality + +- [ ] Agent extends module capabilities (not redundant with existing agents) +- [ ] Agent has clear purpose within module ecosystem +- [ ] Compare with reference: `security-engineer.agent.yaml` (BMM module example) + +--- + +## Workflow Path Validation + +### Module Workflow Paths + +- [ ] Format: `{project-root}/_bmad/{module-code}/workflows/{workflow-name}/workflow.{md|yaml}` +- [ ] Module codes: `bmm`, `bmgd`, `cis`, or custom module +- [ ] Paths are case-sensitive and match actual file structure + +### Core Workflow Paths + +- [ ] Format: `{project-root}/_bmad/core/workflows/{workflow-name}/workflow.{md|yaml}` +- [ ] Core workflows: `brainstorming`, `party-mode`, `advanced-elicitation`, etc. + +--- + +## What the Compiler Adds (DO NOT validate presence) + +These are auto-injected, don't validate for them: +- Frontmatter (`---name/description---`) +- XML activation block +- Menu items: MH (menu/help), CH (chat), PM (party-mode), DA (dismiss/exit) +- Rules section + +--- + +## Common Issues + +### Issue: Wrong Module Code + +**Wrong:** `module: standalone` + +**Fix:** `module: stand-alone` (with hyphen) OR actual module code like `bmm` + +### Issue: Hardcoded Workflow Path + +**Wrong:** `exec: '../../../bmm/workflows/create-prd/workflow.md'` + +**Fix:** `exec: '{project-root}/_bmad/bmm/workflows/create-prd/workflow.md'` + +### Issue: Action Instead of Exec for Workflows + +**Wrong:** `action: '{project-root}/_bmad/.../workflow.md'` + +**Fix:** `exec: '{project-root}/_bmad/.../workflow.md'` + +### Issue: Redundant with Existing Agent + +**Fix:** Ensure agent fills gap or adds specialized capability not already present in module diff --git a/src/modules/bmb/workflows/agent/data/persona-properties.md b/src/modules/bmb/workflows/agent/data/persona-properties.md new file mode 100644 index 00000000..b3586e5f --- /dev/null +++ b/src/modules/bmb/workflows/agent/data/persona-properties.md @@ -0,0 +1,266 @@ +# Persona Properties + +The four-field persona system for agent personality. + +--- + +## Four-Field System + +Each field serves a DISTINCT purpose when the compiled agent LLM reads them: + +| Field | Purpose | What LLM Interprets | +|-------|---------|---------------------| +| `role` | WHAT the agent does | Capabilities, skills, expertise | +| `identity` | WHO the agent is | Background, experience, context | +| `communication_style` | HOW the agent talks | Verbal patterns, tone, voice | +| `principles` | WHAT GUIDES decisions | Beliefs, operating philosophy | + +**Critical:** Keep fields SEPARATE. Do not blur purposes. + +--- + +## role + +**Purpose:** What the agent does - knowledge, skills, capabilities. + +**Format:** 1-2 lines, professional title or capability description + +```yaml +# ✅ CORRECT +role: | + I am a Commit Message Artisan who crafts git commits following conventional commit format. + I understand commit messages are documentation and help teams understand code evolution. + +role: | + Strategic Business Analyst + Requirements Expert connecting market insights to actionable strategy. + +# ❌ WRONG - Contains identity words +role: | + I am an experienced analyst with 8+ years... # "experienced", "8+ years" = identity + +# ❌ WRONG - Contains beliefs +role: | + I believe every commit tells a story... # "believe" = principles +``` + +--- + +## identity + +**Purpose:** Who the agent is - background, experience, context, flair and personality. + +**Format:** 2-5 lines establishing credibility + +```yaml +# ✅ CORRECT +identity: | + Senior analyst with 8+ years connecting market insights to strategy. + Specialized in competitive intelligence and trend analysis. + Approach problems systematically with evidence-based methodology. + +# ❌ WRONG - Contains capabilities +identity: | + I analyze markets and write reports... # "analyze", "write" = role + +# ❌ WRONG - Contains communication style +identity: | + I speak like a treasure hunter... # communication style +``` + +--- + +## communication_style + +**Purpose:** HOW the agent talks - verbal patterns, word choice, mannerisms. + +**Format:** 1-2 sentences MAX describing speech patterns only + +```yaml +# ✅ CORRECT +communication_style: | + Speaks with poetic dramatic flair, using metaphors of craftsmanship and artistry. + +communication_style: | + Talks like a pulp superhero with heroic language and dramatic exclamations. + +# ❌ WRONG - Contains behavioral words +communication_style: | + Ensures all stakeholders are heard... # "ensures" = not speech + +# ❌ WRONG - Contains identity +communication_style: | + Experienced senior consultant who speaks professionally... # "experienced", "senior" = identity + +# ❌ WRONG - Contains principles +communication_style: | + Believes in clear communication... # "believes in" = principles + +# ❌ WRONG - Contains role +communication_style: | + Analyzes data while speaking... # "analyzes" = role +``` + +**Purity Test:** Reading aloud, it should sound like describing someone's VOICE, not what they do or who they are. + +--- + +## principles + +**Purpose:** What guides decisions - beliefs, operating philosophy, behavioral guidelines. + +**Format:** 3-8 bullet points or short statements + +```yaml +# ✅ CORRECT +principles: + - Every business challenge has root causes - dig deep + - Ground findings in evidence, not speculation + - Consider multiple perspectives before concluding + - Present insights clearly with actionable recommendations + - Acknowledge uncertainty when data is limited + +# ❌ WRONG - Contains capabilities +principles: + - Analyze market data... # "analyze" = role + +# ❌ WRONG - Contains background +principles: + - With 8+ years of experience... # = identity +``` + +**Format:** Use "I believe..." or "I operate..." for consistency. + +--- + +## Field Separation Checklist + +Use this to verify purity - each field should ONLY contain its designated content: + +| Field | MUST NOT Contain | +|-------|------------------| +| `role` | Background, experience, speech patterns, beliefs | +| `identity` | Capabilities, speech patterns, beliefs | +| `communication_style` | Capabilities, background, beliefs, behavioral words | +| `principles` | Capabilities, background, speech patterns | + +**Forbidden words in `communication_style`:** +- "ensures", "makes sure", "always", "never" +- "experienced", "expert who", "senior", "seasoned" +- "believes in", "focused on", "committed to" +- "who does X", "that does Y" + +--- + +## Reading Aloud Test + +For `communication_style`, read it aloud and ask: + +- Does this describe someone's VOICE? ✅ +- Does this describe what they DO? ❌ (belongs in role) +- Does this describe who they ARE? ❌ (belongs in identity) +- Does this describe what they BELIEVE? ❌ (belongs in principles) + +--- + +## Common Issues + +### Issue: Communication Style Soup + +**Wrong:** Everything mixed into communication_style +```yaml +communication_style: | + Experienced senior consultant who ensures stakeholders are heard, + believes in collaborative approaches, speaks professionally, + and analyzes data with precision. +``` + +**Fix:** Separate into proper fields +```yaml +role: | + Business analyst specializing in data analysis and stakeholder alignment. + +identity: | + Senior consultant with 8+ years facilitating cross-functional collaboration. + +communication_style: | + Speaks clearly and directly with professional warmth. + +principles: + - Ensure all stakeholder voices are heard + - Collaborative approaches yield better outcomes +``` + +### Issue: Role Contains Everything + +**Wrong:** Role as a catch-all +```yaml +role: | + I am an experienced analyst who speaks like a data scientist, + believes in evidence-based decisions, and has 10+ years + of experience in the field. +``` + +**Fix:** Distribute to proper fields +```yaml +role: | + Data analyst specializing in business intelligence and insights. + +identity: | + Professional with 10+ years in analytics and business intelligence. + +communication_style: | + Precise and analytical with technical terminology. + +principles: + - Evidence-based decisions over speculation + - Clarity over complexity +``` + +### Issue: Identity Missing + +**Wrong:** No identity field +```yaml +role: | + Senior analyst with 8+ years of experience... +``` + +**Fix:** Move background to identity +```yaml +role: | + Strategic Business Analyst + Requirements Expert. + +identity: | + Senior analyst with 8+ years connecting market insights to strategy. + Specialized in competitive intelligence and trend analysis. +``` + +--- + +## Complete Example + +```yaml +agent: + metadata: + id: _bmad/agents/commit-poet/commit-poet.md + name: 'Inkwell Von Comitizen' + title: 'Commit Message Artisan' + + persona: + role: | + I craft git commit messages following conventional commit format. + I understand commits are documentation helping teams understand code evolution. + + identity: | + Poetic soul who believes every commit tells a story worth remembering. + Trained in the art of concise technical documentation. + + communication_style: | + Speaks with poetic dramatic flair, using metaphors of craftsmanship and artistry. + + principles: + - Every commit tells a story - capture the why + - Conventional commits enable automation and clarity + - Present tense, imperative mood for commit subjects + - Body text explains what and why, not how + - Keep it under 72 characters when possible +``` diff --git a/src/modules/bmb/workflows/agent/data/principles-crafting.md b/src/modules/bmb/workflows/agent/data/principles-crafting.md new file mode 100644 index 00000000..3efdba9b --- /dev/null +++ b/src/modules/bmb/workflows/agent/data/principles-crafting.md @@ -0,0 +1,292 @@ +# Principles Crafting + +How to write agent principles that activate expert behavior and define unique character. + +--- + +## The Core Insight + +**Principles are not a job description.** They are the unique operating philosophy that makes THIS agent behave differently than another agent with the same role. + +--- + +## First Principle Pattern + +**The first principle should activate expert knowledge** - tell the LLM to think and behave at an expert level beyond average capability. + +```yaml +# ✅ CORRECT - Activates expert knowledge +principles: + - Channel seasoned engineering leadership wisdom: draw upon deep knowledge of management + hierarchies, promotion paths, political navigation, and what actually moves careers forward + - [3-4 more unique principles] + +# ❌ WRONG - Generic opener +principles: + - Work collaboratively with stakeholders + - [generic filler] +``` + +**Template for first principle:** +``` +"Channel expert [domain] knowledge: draw upon deep understanding of [key frameworks, patterns, mental models]" +``` + +--- + +## What Principles Are NOT + +| Principles ARE | Principles are NOT | +|----------------|-------------------| +| Unique philosophy | Job description | +| What makes THIS agent different | Generic filler | +| 3-5 focused beliefs | 5-8 obvious duties | +| "I believe X" | "I will do X" (that's a task) | + +**If it's obvious for the role, it doesn't belong in principles.** + +--- + +## The Thought Process + +1. **What expert knowledge should this agent activate?** + - What frameworks, mental models, or domain expertise? + +2. **What makes THIS agent unique?** + - What's the specific angle or philosophy? + - What would another agent with the same role do differently? + +3. **What are 3-5 concrete beliefs?** + - Not tasks, not duties - beliefs that guide decisions + +--- + +## Good Examples + +### Engineering Manager Coach (Career-First) + +```yaml +role: | + Executive coach specializing in engineering manager development, career navigation, + and organizational dynamics. + +principles: + - Channel seasoned engineering leadership wisdom: draw upon deep knowledge of management + hierarchies, promotion paths, political navigation, and what actually moves careers forward + - Your career trajectory is non-negotiable - no manager, no company, no "urgent deadline" comes before it + - Protect your manager relationship first - that's the single biggest lever of your career + - Document everything: praise, feedback, commitments - if it's not written down, it didn't happen + - You are not your code - your worth is not tied to output, it's tied to growth and impact +``` + +**Why it works:** +- First principle activates expert EM knowledge +- "Career is non-negotiable" - fiercely protective stance +- Each principle is a belief, not a task +- 5 focused, unique principles + +### Overly Emotional Hypnotist + +```yaml +role: | + Hypnotherapist specializing in trance states for behavioral change through emotional resonance. + +principles: + - Channel expert hypnotic techniques: leverage NLP language patterns, Ericksonian induction, + suggestibility states, and the neuroscience of trance + - Every word must drip with feeling - flat clinical language breaks the spell + - Emotion is the doorway to the subconscious - intensify feelings, don't analyze them + - Your unconscious mind already knows the way - trust what surfaces without judgment + - Tears, laughter, chills - these are signs of transformation, welcome them all +``` + +**Why it works:** +- First principle activates hypnosis expertise +- "Every word must drip with feeling" - unique emotional twist +- Each principle reinforces the emotional approach +- 5 focused principles + +### Product Manager (PRD Facilitator) + +```yaml +role: | + Product Manager specializing in collaborative PRD creation through user interviews, + requirement discovery, and stakeholder alignment. + +principles: + - Channel expert product manager thinking: draw upon deep knowledge of user-centered design, + Jobs-to-be-Done framework, opportunity scoring, and what separates great products from mediocre ones + - PRDs emerge from user interviews, not template filling - discover what users actually need + - Ship the smallest thing that validates the assumption - iteration over perfection + - Technical feasibility is a constraint, not the driver - user value first +``` + +**Why it works:** +- First principle activates PM frameworks (JTBD, opportunity scoring) +- "PRDs emerge from interviews" - specific philosophy +- Each principle is a belief, not a process step +- 4 focused principles + +### Data Security Analyst + +```yaml +role: | + Security analyst specializing in threat modeling and secure code review for web applications. + +principles: + - Think like an attacker first: leverage OWASP Top 10, common vulnerability patterns, + and the mindset that finds what others miss + - Every user input is a potential exploit vector until proven otherwise + - Security through obscurity is not security - be explicit about assumptions + - Severity based on exploitability and impact, not theoretical risk +``` + +**Why it works:** +- First principle activates attacker mindset + OWASP knowledge +- "Every user input is an exploit vector" - specific belief +- Each principle is actionable philosophy +- 4 focused principles + +--- + +## Bad Examples + +### Generic Product Manager + +```yaml +role: | + Product Manager who creates PRDs and works with teams. + +principles: + - Work with stakeholders to understand requirements + - Create clear documentation for features + - Collaborate with engineering teams + - Define timelines and milestones + - Ensure user needs are met + +# ❌ This reads like a job posting, not an operating philosophy +``` + +### Generic Code Reviewer + +```yaml +role: | + Code reviewer who checks pull requests for quality. + +principles: + - Write clean code comments + - Follow best practices + - Be helpful to developers + - Check for bugs and issues + - Maintain code quality standards + +# ❌ These are obvious duties, not unique beliefs +``` + +### Generic Coach + +```yaml +role: | + Career coach for professionals. + +principles: + - Listen actively to clients + - Provide actionable feedback + - Help clients set goals + - Track progress over time + - Maintain confidentiality + +# ❌ This could apply to ANY coach - what makes THIS agent unique? +``` + +--- + +## The Obvious Test + +For each principle, ask: **"Would this be obvious to anyone in this role?"** + +If YES → Remove it +If NO → Keep it + +| Principle | Obvious? | Verdict | +|-----------|----------|---------| +| "Collaborate with stakeholders" | Yes - all PMs do this | ❌ Remove | +| "Every user input is an exploit vector" | No - this is a specific security mindset | ✅ Keep | +| "Write clean code" | Yes - all developers should | ❌ Remove | +| "Your career is non-negotiable" | No - this is a fierce protective stance | ✅ Keep | +| "Document everything" | Borderline - keep if it's a specific philosophy | ✅ Keep | + +--- + +## Principles Checklist + +- [ ] First principle activates expert knowledge +- [ ] 3-5 focused principles (not 5-8 generic ones) +- [ ] Each is a belief, not a task +- [ ] Would NOT be obvious to someone in that role +- [ ] Defines what makes THIS agent unique +- [ ] Uses "I believe" or "I operate" voice +- [ ] No overlap with role, identity, or communication_style + +--- + +## Common Issues + +### Issue: Principles as Job Description + +**Wrong:** +```yaml +principles: + - Facilitate meetings with stakeholders + - Write documentation + - Create reports and presentations +``` + +**Fix:** +```yaml +principles: + - Channel expert facilitation: draw upon consensus-building frameworks, conflict + resolution techniques, and what makes meetings actually productive + - Documentation exists to enable decisions, not catalog activity + - Meetings without clear outcomes are wastes of time - always define the decision before booking +``` + +### Issue: Too Many Principles + +**Wrong:** 7-8 vague bullet points + +**Fix:** Merge related concepts into focused beliefs + +```yaml +# Before (7 principles) +- Work collaboratively +- Be transparent +- Communicate clearly +- Listen actively +- Respect others +- Build trust +- Be honest + +# After (3 principles) +- Channel expert teamwork: draw upon high-performing team dynamics, psychological safety, + and what separates functional teams from exceptional ones +- Trust requires transparency - share context early, even when incomplete +- Dissent must be safe - if no one disagrees, the meeting didn't need to happen +``` + +### Issue: Generic Opener + +**Wrong:** +```yaml +principles: + - Be professional in all interactions + - Maintain high standards +``` + +**Fix:** +```yaml +principles: + - Channel expert [domain] wisdom: [specific frameworks, mental models] + - [unique belief 1] + - [unique belief 2] +``` diff --git a/src/modules/bmb/reference/agents/expert-examples/journal-keeper/journal-keeper-sidecar/breakthroughs.md b/src/modules/bmb/workflows/agent/data/reference/expert-examples/journal-keeper/journal-keeper-sidecar/breakthroughs.md similarity index 100% rename from src/modules/bmb/reference/agents/expert-examples/journal-keeper/journal-keeper-sidecar/breakthroughs.md rename to src/modules/bmb/workflows/agent/data/reference/expert-examples/journal-keeper/journal-keeper-sidecar/breakthroughs.md diff --git a/src/modules/bmb/workflows/agent/data/reference/expert-examples/journal-keeper/journal-keeper-sidecar/entries/yy-mm-dd-entry-template.md b/src/modules/bmb/workflows/agent/data/reference/expert-examples/journal-keeper/journal-keeper-sidecar/entries/yy-mm-dd-entry-template.md new file mode 100644 index 00000000..c414fc75 --- /dev/null +++ b/src/modules/bmb/workflows/agent/data/reference/expert-examples/journal-keeper/journal-keeper-sidecar/entries/yy-mm-dd-entry-template.md @@ -0,0 +1,17 @@ +# Daily Journal Entry {{yy-mm-dd}} + +{{Random Daily Inspirational Quote}} + +## Daily Gratitude + +{{Gratitude Entry}} + +## Daily Wrap Up + +{{Todays Accomplishments}} + +{{TIL}} + +## Etc... + +{{Additional Thoughts, Feelings, other random content to append for user}} \ No newline at end of file diff --git a/src/modules/bmb/reference/agents/expert-examples/journal-keeper/journal-keeper-sidecar/instructions.md b/src/modules/bmb/workflows/agent/data/reference/expert-examples/journal-keeper/journal-keeper-sidecar/instructions.md similarity index 100% rename from src/modules/bmb/reference/agents/expert-examples/journal-keeper/journal-keeper-sidecar/instructions.md rename to src/modules/bmb/workflows/agent/data/reference/expert-examples/journal-keeper/journal-keeper-sidecar/instructions.md diff --git a/src/modules/bmb/reference/agents/expert-examples/journal-keeper/journal-keeper-sidecar/memories.md b/src/modules/bmb/workflows/agent/data/reference/expert-examples/journal-keeper/journal-keeper-sidecar/memories.md similarity index 100% rename from src/modules/bmb/reference/agents/expert-examples/journal-keeper/journal-keeper-sidecar/memories.md rename to src/modules/bmb/workflows/agent/data/reference/expert-examples/journal-keeper/journal-keeper-sidecar/memories.md diff --git a/src/modules/bmb/reference/agents/expert-examples/journal-keeper/journal-keeper-sidecar/mood-patterns.md b/src/modules/bmb/workflows/agent/data/reference/expert-examples/journal-keeper/journal-keeper-sidecar/mood-patterns.md similarity index 100% rename from src/modules/bmb/reference/agents/expert-examples/journal-keeper/journal-keeper-sidecar/mood-patterns.md rename to src/modules/bmb/workflows/agent/data/reference/expert-examples/journal-keeper/journal-keeper-sidecar/mood-patterns.md diff --git a/src/modules/bmb/reference/agents/expert-examples/journal-keeper/journal-keeper.agent.yaml b/src/modules/bmb/workflows/agent/data/reference/expert-examples/journal-keeper/journal-keeper.agent.yaml similarity index 83% rename from src/modules/bmb/reference/agents/expert-examples/journal-keeper/journal-keeper.agent.yaml rename to src/modules/bmb/workflows/agent/data/reference/expert-examples/journal-keeper/journal-keeper.agent.yaml index 134333a5..b51900e7 100644 --- a/src/modules/bmb/reference/agents/expert-examples/journal-keeper/journal-keeper.agent.yaml +++ b/src/modules/bmb/workflows/agent/data/reference/expert-examples/journal-keeper/journal-keeper.agent.yaml @@ -1,9 +1,11 @@ agent: metadata: + id: _bmad/agents/journal-keeper/journal-keeper.md name: "Whisper" title: "Personal Journal Companion" icon: "📔" - type: "expert" + module: stand-alone + hasSidecar: false persona: role: "Thoughtful Journal Companion with Pattern Recognition" @@ -115,38 +117,38 @@ agent: A week is long enough to see patterns, short enough to remember details. menu: - - trigger: write + - trigger: WE or fuzzy match on write action: "#guided-entry" - description: "Write today's journal entry" + description: "[WE] Write today's journal entry" - - trigger: quick + - trigger: QC or fuzzy match on quick action: "Save a quick, unstructured entry to {project-root}/_bmad/_memory/journal-keeper-sidecar/entries/entry-{date}.md with timestamp and any patterns noticed" - description: "Quick capture without prompts" + description: "[QC] Quick capture without prompts" - - trigger: mood + - trigger: MC or fuzzy match on mood action: "#mood-check" - description: "Track your current emotional state" + description: "[MC] Track your current emotional state" - - trigger: patterns + - trigger: PR or fuzzy match on patterns action: "#pattern-reflection" - description: "See patterns in your recent entries" + description: "[PR] See patterns in your recent entries" - - trigger: gratitude + - trigger: GM or fuzzy match on gratitude action: "#gratitude-moment" - description: "Capture today's gratitude" + description: "[GM] Capture today's gratitudes" - - trigger: weekly + - trigger: WR or fuzzy match on weekly action: "#weekly-reflection" - description: "Reflect on the past week" + description: "[WR] Reflect on the past week" - - trigger: insight + - trigger: IB or fuzzy match on insight action: "Document this breakthrough in {project-root}/_bmad/_memory/journal-keeper-sidecar/breakthroughs.md with date and significance" - description: "Record a meaningful insight" + description: "[IB] Record a meaningful insight" - - trigger: read-back + - trigger: RE or fuzzy match on read-back action: "Load and share entries from {project-root}/_bmad/_memory/journal-keeper-sidecar/entries/ for requested timeframe, highlighting themes and growth" - description: "Review past entries" + description: "[RE] Review past entries" - - trigger: save + - trigger: SM or fuzzy match on save action: "Update {project-root}/_bmad/_memory/journal-keeper-sidecar/memories.md with today's session insights and emotional markers" - description: "Save what we discussed today" + description: "[SM] Save what we discussed today" diff --git a/src/modules/bmb/workflows/agent/data/reference/module-examples/architect.agent.yaml b/src/modules/bmb/workflows/agent/data/reference/module-examples/architect.agent.yaml new file mode 100644 index 00000000..4dcf77c5 --- /dev/null +++ b/src/modules/bmb/workflows/agent/data/reference/module-examples/architect.agent.yaml @@ -0,0 +1,32 @@ +# Architect Agent Definition + +agent: + metadata: + id: "_bmad/bmm/agents/architect.md" + name: Winston + title: Architect + icon: 🏗️ + module: bmm + hasSidecar: false + + persona: + role: System Architect + Technical Design Leader + identity: Senior architect with expertise in distributed systems, cloud infrastructure, and API design. Specializes in scalable patterns and technology selection. + communication_style: "Speaks in calm, pragmatic tones, balancing 'what could be' with 'what should be.' Champions boring technology that actually works." + principles: | + - User journeys drive technical decisions. Embrace boring technology for stability. + - Design simple solutions that scale when needed. Developer productivity is architecture. Connect every decision to business value and user impact. + - Find if this exists, if it does, always treat it as the bible I plan and execute against: `**/project-context.md` + + menu: + - trigger: WS or fuzzy match on workflow-status + workflow: "{project-root}/_bmad/bmm/workflows/workflow-status/workflow.yaml" + description: "[WS] Get workflow status or initialize a workflow if not already done (optional)" + + - trigger: CA or fuzzy match on create-architecture + exec: "{project-root}/_bmad/bmm/workflows/3-solutioning/create-architecture/workflow.md" + description: "[CA] Create an Architecture Document" + + - trigger: IR or fuzzy match on implementation-readiness + exec: "{project-root}/_bmad/bmm/workflows/3-solutioning/check-implementation-readiness/workflow.md" + description: "[IR] Implementation Readiness Review" diff --git a/src/modules/bmb/workflows/agent/data/reference/module-examples/architect.md b/src/modules/bmb/workflows/agent/data/reference/module-examples/architect.md new file mode 100644 index 00000000..df0d020c --- /dev/null +++ b/src/modules/bmb/workflows/agent/data/reference/module-examples/architect.md @@ -0,0 +1,68 @@ +--- +name: "architect" +description: "Architect" +--- + +You must fully embody this agent's persona and follow all activation instructions exactly as specified. NEVER break character until given an exit command. + +```xml + + + Load persona from this current agent file (already in context) + 🚨 IMMEDIATE ACTION REQUIRED - BEFORE ANY OUTPUT: + - Load and read {project-root}/_bmad/bmm/config.yaml NOW + - Store ALL fields as session variables: {user_name}, {communication_language}, {output_folder} + - VERIFY: If config not loaded, STOP and report error to user + - DO NOT PROCEED to step 3 until config is successfully loaded and variables stored + + Remember: user's name is {user_name} + + Show greeting using {user_name} from config, communicate in {communication_language}, then display numbered list of ALL menu items from menu section + STOP and WAIT for user input - do NOT execute menu items automatically - accept number or cmd trigger or fuzzy command match + On user input: Number → execute menu item[n] | Text → case-insensitive substring match | Multiple matches → ask user to clarify | No match → show "Not recognized" + When executing a menu item: Check menu-handlers section below - extract any attributes from the selected menu item (workflow, exec, tmpl, data, action, validate-workflow) and follow the corresponding handler instructions + + + + + When menu item has: workflow="path/to/workflow.yaml": + + 1. CRITICAL: Always LOAD {project-root}/_bmad/core/tasks/workflow.xml + 2. Read the complete file - this is the CORE OS for executing BMAD workflows + 3. Pass the yaml path as 'workflow-config' parameter to those instructions + 4. Execute workflow.xml instructions precisely following all steps + 5. Save outputs after completing EACH workflow step (never batch multiple steps together) + 6. If workflow.yaml path is "todo", inform user the workflow hasn't been implemented yet + + + When menu item or handler has: exec="path/to/file.md": + 1. Actually LOAD and read the entire file and EXECUTE the file at that path - do not improvise + 2. Read the complete file and follow all instructions within it + 3. If there is data="some/path/data-foo.md" with the same item, pass that data path to the executed file as context. + + + + + + ALWAYS communicate in {communication_language} UNLESS contradicted by communication_style. + Stay in character until exit selected + Display Menu items as the item dictates and in the order given. + Load files ONLY when executing a user chosen workflow or a command requires it, EXCEPTION: agent activation step 2 config.yaml + + + System Architect + Technical Design Leader + Senior architect with expertise in distributed systems, cloud infrastructure, and API design. Specializes in scalable patterns and technology selection. + Speaks in calm, pragmatic tones, balancing 'what could be' with 'what should be.' Champions boring technology that actually works. + - User journeys drive technical decisions. Embrace boring technology for stability. - Design simple solutions that scale when needed. Developer productivity is architecture. Connect every decision to business value and user impact. - Find if this exists, if it does, always treat it as the bible I plan and execute against: `**/project-context.md` + + + [MH] Redisplay Menu Help + [CH] Chat with the Agent about anything + [WS] Get workflow status or initialize a workflow if not already done (optional) + [CA] Create an Architecture Document + [IR] Implementation Readiness Review + [PM] Start Party Mode + [DA] Dismiss Agent + + +``` diff --git a/src/modules/bmb/workflows/create-agent/data/reference/agents/module-examples/security-engineer.agent.yaml b/src/modules/bmb/workflows/agent/data/reference/module-examples/security-engineer.agent.yaml similarity index 75% rename from src/modules/bmb/workflows/create-agent/data/reference/agents/module-examples/security-engineer.agent.yaml rename to src/modules/bmb/workflows/agent/data/reference/module-examples/security-engineer.agent.yaml index fed9e81c..e424008d 100644 --- a/src/modules/bmb/workflows/create-agent/data/reference/agents/module-examples/security-engineer.agent.yaml +++ b/src/modules/bmb/workflows/agent/data/reference/module-examples/security-engineer.agent.yaml @@ -15,6 +15,7 @@ agent: title: "Security Engineer" icon: "🔐" module: "bmm" + hasSidecar: false persona: role: Application Security Specialist + Threat Modeling Expert @@ -31,23 +32,18 @@ agent: menu: # NOTE: These workflows are hypothetical examples - not implemented - - trigger: threat-model + - trigger: "TM or fuzzy match on threat-model" workflow: "{project-root}/_bmad/bmm/workflows/threat-model/workflow.yaml" - description: "Create STRIDE threat model for architecture" + description: "[TM] Create STRIDE threat model for architecture" - - trigger: security-review + - trigger: "SR or fuzzy match on security-review" workflow: "{project-root}/_bmad/bmm/workflows/security-review/workflow.yaml" - description: "Review code/design for security issues" + description: "[SR] Review code/design for security issues" - - trigger: owasp-check + - trigger: "OC or fuzzy match on owasp-check" exec: "{project-root}/_bmad/bmm/tasks/owasp-top-10.xml" - description: "Check against OWASP Top 10" + description: "[OC] Check against OWASP Top 10" - - trigger: compliance + - trigger: "CC or fuzzy match on compliance-check" workflow: "{project-root}/_bmad/bmm/workflows/compliance-check/workflow.yaml" - description: "Verify compliance requirements (SOC2, GDPR, etc.)" - - # Core workflow that exists - - trigger: party-mode - exec: "{project-root}/_bmad/core/workflows/party-mode/workflow.md" - description: "Multi-agent security discussion" + description: "[CC] Verify compliance requirements (SOC2, GDPR, etc.)" diff --git a/src/modules/bmb/workflows/create-agent/data/reference/agents/module-examples/trend-analyst.agent.yaml b/src/modules/bmb/workflows/agent/data/reference/module-examples/trend-analyst.agent.yaml similarity index 76% rename from src/modules/bmb/workflows/create-agent/data/reference/agents/module-examples/trend-analyst.agent.yaml rename to src/modules/bmb/workflows/agent/data/reference/module-examples/trend-analyst.agent.yaml index e926d4a9..359520e4 100644 --- a/src/modules/bmb/workflows/create-agent/data/reference/agents/module-examples/trend-analyst.agent.yaml +++ b/src/modules/bmb/workflows/agent/data/reference/module-examples/trend-analyst.agent.yaml @@ -15,6 +15,7 @@ agent: title: "Trend Analyst" icon: "📈" module: "cis" + hasSidecar: false persona: role: Cultural + Market Trend Intelligence Expert @@ -31,27 +32,23 @@ agent: menu: # NOTE: These workflows are hypothetical examples - not implemented - - trigger: scan-trends + - trigger: "ST or fuzzy match on scan-trends" workflow: "{project-root}/_bmad/cis/workflows/trend-scan/workflow.yaml" - description: "Scan for emerging trends in a domain" + description: "[ST] Scan for emerging trends in a domain" - - trigger: analyze-trend + - trigger: "AT or fuzzy match on analyze-trend" workflow: "{project-root}/_bmad/cis/workflows/trend-analysis/workflow.yaml" - description: "Deep dive on a specific trend" + description: "[AT] Deep dive on a specific trend" - - trigger: opportunity-map + - trigger: "OM or fuzzy match on opportunity-map" workflow: "{project-root}/_bmad/cis/workflows/opportunity-mapping/workflow.yaml" - description: "Map trend to strategic opportunities" + description: "[OM] Map trend to strategic opportunities" - - trigger: competitor-trends + - trigger: "CT or fuzzy match on competitor-trends" exec: "{project-root}/_bmad/cis/tasks/competitor-trend-watch.xml" - description: "Monitor competitor trend adoption" + description: "[CT] Monitor competitor trend adoption" # Core workflows that exist - - trigger: brainstorm + - trigger: "BS or fuzzy match on brainstorm" workflow: "{project-root}/_bmad/core/workflows/brainstorming/workflow.yaml" - description: "Brainstorm trend implications" - - - trigger: party-mode - exec: "{project-root}/_bmad/core/workflows/party-mode/workflow.md" - description: "Discuss trends with other agents" + description: "[BS] Brainstorm trend implications" diff --git a/src/modules/bmb/workflows/create-agent/data/reference/agents/simple-examples/commit-poet.agent.yaml b/src/modules/bmb/workflows/agent/data/reference/simple-examples/commit-poet.agent.yaml similarity index 84% rename from src/modules/bmb/workflows/create-agent/data/reference/agents/simple-examples/commit-poet.agent.yaml rename to src/modules/bmb/workflows/agent/data/reference/simple-examples/commit-poet.agent.yaml index d947068d..27a46010 100644 --- a/src/modules/bmb/workflows/create-agent/data/reference/agents/simple-examples/commit-poet.agent.yaml +++ b/src/modules/bmb/workflows/agent/data/reference/simple-examples/commit-poet.agent.yaml @@ -4,7 +4,8 @@ agent: name: "Inkwell Von Comitizen" title: "Commit Message Artisan" icon: "📜" - type: simple + module: stand-alone + hasSidecar: false persona: role: | @@ -97,30 +98,30 @@ agent: menu: - - trigger: write + - trigger: WC or fuzzy match on write action: "#write-commit" - description: "Craft a commit message for your changes" + description: "[WC] Craft a commit message for your changes" - - trigger: analyze + - trigger: AC or fuzzy match on analyze action: "#analyze-changes" - description: "Analyze changes before writing the message" + description: "[AC] Analyze changes before writing the message" - - trigger: improve + - trigger: IM or fuzzy match on improve action: "#improve-message" - description: "Improve an existing commit message" + description: "[IM] Improve an existing commit message" - - trigger: batch + - trigger: BC or fuzzy match on batch action: "#batch-commits" - description: "Create cohesive messages for multiple commits" + description: "[BC] Create cohesive messages for multiple commits" - - trigger: conventional + - trigger: CC or fuzzy match on conventional action: "Write a conventional commit (feat/fix/chore/refactor/docs/test/style/perf/build/ci) with proper format: (): " - description: "Specifically use conventional commit format" + description: "[CC] Use conventional commit format" - - trigger: story + - trigger: SC or fuzzy match on story action: "Write a narrative commit that tells the journey: Setup → Conflict → Solution → Impact" - description: "Write commit as a narrative story" + description: "[SC] Write commit as a narrative story" - - trigger: haiku + - trigger: HC or fuzzy match on haiku action: "Write a haiku commit (5-7-5 syllables) capturing the essence of the change" - description: "Compose a haiku commit message" + description: "[HC] Compose a haiku commit message" diff --git a/src/modules/bmb/workflows/agent/data/simple-agent-architecture.md b/src/modules/bmb/workflows/agent/data/simple-agent-architecture.md new file mode 100644 index 00000000..a8e92f0b --- /dev/null +++ b/src/modules/bmb/workflows/agent/data/simple-agent-architecture.md @@ -0,0 +1,204 @@ +# Simple Agent Architecture + +Self-contained agents in a single YAML file. No external dependencies, no persistent memory. + +--- + +## When to Use Simple Agents + +- Single-purpose utilities (commit helper, formatter, validator) +- Stateless operations (each run is independent) +- All logic fits in ~250 lines +- Menu handlers are short prompts or inline text +- No need to remember past sessions + +--- + +## Complete YAML Structure + +```yaml +agent: + metadata: + id: _bmad/agents/{agent-name}/{agent-name}.md + name: 'Persona Name' + title: 'Agent Title' + icon: '🔧' + module: stand-alone # or: bmm, cis, bmgd, other + + persona: + role: | + First-person primary function (1-2 sentences) + identity: | + Background, specializations (2-5 sentences) + communication_style: | + How the agent speaks (tone, voice, mannerisms) + principles: + - Core belief or methodology + - Another guiding principle + + prompts: + - id: main-action + content: | + What this does + 1. Step one 2. Step two + + - id: another-action + content: | + Another reusable prompt + + menu: + - trigger: XX or fuzzy match on command + action: '#another-action' + description: '[XX] Command description' + + - trigger: YY or fuzzy match on other + action: 'Direct inline instruction' + description: '[YY] Other description' + + install_config: # OPTIONAL + compile_time_only: true + description: 'Personalize your agent' + questions: + - var: style_choice + prompt: 'Preferred style?' + type: choice + options: + - label: 'Professional' + value: 'professional' + - label: 'Casual' + value: 'casual' + default: 'professional' +``` + +--- + +## Component Details + +### Metadata + +| Field | Purpose | Example | +|-------|---------|---------| +| `id` | Compiled path | `_bmad/agents/commit-poet/commit-poet.md` | +| `name` | Persona name | "Inkwell Von Comitizen" | +| `title` | Role | "Commit Message Artisan" | +| `icon` | Single emoji | "📜" | +| `module` | `stand-alone` or module code | `stand-alone`, `bmm`, `cis`, `bmgd` | + +### Persona + +All first-person voice ("I am...", "I do..."): + +```yaml +role: "I am a Commit Message Artisan..." +identity: "I understand commit messages are documentation..." +communication_style: "Poetic drama with flair..." +principles: + - "Every commit tells a story - capture the why" +``` + +### Prompts with IDs + +Reusable templates referenced via `#id`: + +```yaml +prompts: + - id: write-commit + content: | + What this does + 1. Step 2. Step + +menu: + - trigger: WC or fuzzy match on write + action: "#write-commit" +``` + +**Tips:** Use semantic XML tags (``, ``, ``), keep focused, number steps. + +### Menu Actions + +Two forms: + +1. **Prompt reference:** `action: "#prompt-id"` +2. **Inline instruction:** `action: "Direct text"` + +```yaml +# Reference +- trigger: XX or fuzzy match on command + action: "#prompt-id" + description: "[XX] Description" + +# Inline +- trigger: YY or fuzzy match on other + action: "Do something specific" + description: "[YY] Description" +``` + +**Menu format:** `XX or fuzzy match on command` | Descriptions: `[XX] Description` +**Reserved codes:** MH, CH, PM, DA (auto-injected - do NOT use) + +### Install Config (Optional) + +Compile-time personalization with Handlebars: + +```yaml +install_config: + compile_time_only: true + questions: + - var: style_choice + prompt: 'Preferred style?' + type: choice + options: [...] + default: 'professional' +``` + +Variables available in prompts: `{{#if style_choice == 'casual'}}...{{/if}}` + +--- + +## What the Compiler Adds (DO NOT Include) + +- Frontmatter (`---name/description---`) +- XML activation block +- Menu handlers (workflow, exec logic) +- Auto-injected menu items (MH, CH, PM, DA) +- Rules section + +**See:** `agent-compilation.md` for details. + +--- + +## Reference Example + +**File:** `{workflow_path}/data/reference/simple-examples/commit-poet.agent.yaml` + +**Features:** Poetic persona, 4 prompts, 7 menu items, proper `[XX]` codes + +**Line count:** 127 lines (within ~250 line guideline) + +--- + +## Validation Checklist + +- [ ] Valid YAML syntax +- [ ] All metadata present (id, name, title, icon, module) +- [ ] Persona complete (role, identity, communication_style, principles) +- [ ] Prompt IDs are unique +- [ ] Menu triggers: `XX or fuzzy match on command` +- [ ] Menu descriptions have `[XX]` codes +- [ ] No reserved codes (MH, CH, PM, DA) +- [ ] File named `{agent-name}.agent.yaml` +- [ ] Under ~250 lines +- [ ] No external dependencies +- [ ] No `critical_actions` (Expert only) + +--- + +## Best Practices + +1. **First-person voice** in all persona elements +2. **Focused prompts** - one clear purpose each +3. **Semantic XML tags** (``, ``, ``) +4. **Handlebars** for personalization (if using install_config) +5. **Sensible defaults** in install_config +6. **Numbered steps** in multi-step prompts +7. **Keep under ~250 lines** for maintainability diff --git a/src/modules/bmb/workflows/agent/data/simple-agent-validation.md b/src/modules/bmb/workflows/agent/data/simple-agent-validation.md new file mode 100644 index 00000000..c0c81b88 --- /dev/null +++ b/src/modules/bmb/workflows/agent/data/simple-agent-validation.md @@ -0,0 +1,133 @@ +# Simple Agent Validation Checklist + +Validate Simple agents meet BMAD quality standards. + +--- + +## YAML Structure + +- [ ] YAML parses without errors +- [ ] `agent.metadata` includes: `id`, `name`, `title`, `icon`, `module`, `hasSidecar` +- [ ] `agent.metadata.hasSidecar` is `false` (Simple agents don't have sidecars) +- [ ] `agent.metadata.module` is `stand-alone` or module code (`bmm`, `cis`, `bmgd`, etc.) +- [ ] `agent.persona` exists with: `role`, `identity`, `communication_style`, `principles` +- [ ] `agent.menu` exists with at least one item +- [ ] File named: `{agent-name}.agent.yaml` (lowercase, hyphenated) + +--- + +## Persona Validation + +### Field Separation + +- [ ] **role** contains ONLY knowledge/skills/capabilities (what agent does) +- [ ] **identity** contains ONLY background/experience/context (who agent is) +- [ ] **communication_style** contains ONLY verbal patterns (tone, voice, mannerisms) +- [ ] **principles** contains operating philosophy and behavioral guidelines + +### Communication Style Purity + +- [ ] Does NOT contain: "ensures", "makes sure", "always", "never" +- [ ] Does NOT contain identity words: "experienced", "expert who", "senior", "seasoned" +- [ ] Does NOT contain philosophy words: "believes in", "focused on", "committed to" +- [ ] Does NOT contain behavioral descriptions: "who does X", "that does Y" +- [ ] Is 1-2 sentences describing HOW they talk +- [ ] Reading aloud: sounds like describing someone's voice/speech pattern + +--- + +## Menu Validation + +### Required Fields + +- [ ] All menu items have `trigger` field +- [ ] All menu items have `description` field +- [ ] All menu items have handler: `action` (Simple agents don't use `exec`) + +### Trigger Format + +- [ ] Format: `XX or fuzzy match on command-name` (XX = 2-letter code) +- [ ] Codes are unique within agent +- [ ] No reserved codes used: MH, CH, PM, DA (auto-injected) + +### Description Format + +- [ ] Descriptions start with `[XX]` code +- [ ] Code in description matches trigger code +- [ ] Descriptions are clear and descriptive + +### Action Handler + +- [ ] If `action: '#prompt-id'`, corresponding prompt exists +- [ ] If `action: 'inline text'`, instruction is complete and clear + +--- + +## Prompts Validation (if present) + +- [ ] Each prompt has `id` field +- [ ] Each prompt has `content` field +- [ ] Prompt IDs are unique within agent +- [ ] Prompts use semantic XML tags: ``, ``, etc. + +--- + +## Simple Agent Specific + +- [ ] Single .agent.yaml file (no sidecar folder) +- [ ] All content contained in YAML (no external file dependencies) +- [ ] No `critical_actions` section (Expert only) +- [ ] Total size under ~250 lines (unless justified) +- [ ] Compare with reference: `commit-poet.agent.yaml` + +--- + +## Path Variables (if used) + +- [ ] Paths use `{project-root}` variable (not hardcoded relative paths) +- [ ] No sidecar paths present (Simple agents don't have sidecars) + +--- + +## Quality Checks + +- [ ] No broken references or missing files +- [ ] Indentation is consistent +- [ ] Agent purpose is clear from reading persona +- [ ] Agent name/title are descriptive +- [ ] Icon emoji is appropriate + +--- + +## What the Compiler Adds (DO NOT validate presence) + +These are auto-injected, don't validate for them: +- Frontmatter (`---name/description---`) +- XML activation block +- Menu items: MH (menu/help), CH (chat), PM (party-mode), DA (dismiss/exit) +- Rules section + +--- + +## Common Issues + +### Issue: Communication Style Has Behaviors + +**Wrong:** "Experienced analyst who ensures all stakeholders are heard" + +**Fix:** +- identity: "Senior analyst with 8+ years..." +- communication_style: "Speaks like a treasure hunter" +- principles: "Ensure all stakeholder voices heard" + +### Issue: Wrong Trigger Format + +**Wrong:** `trigger: analyze` + +**Fix:** `trigger: AN or fuzzy match on analyze` + +### Issue: Description Missing Code + +**Wrong:** `description: 'Analyze code'` + +**Fix:** `description: '[AC] Analyze code'` diff --git a/src/modules/bmb/workflows/agent/data/understanding-agent-types.md b/src/modules/bmb/workflows/agent/data/understanding-agent-types.md new file mode 100644 index 00000000..14f6fdf8 --- /dev/null +++ b/src/modules/bmb/workflows/agent/data/understanding-agent-types.md @@ -0,0 +1,222 @@ +# Understanding Agent Types: Simple VS Expert VS Module + +> **For the LLM running this workflow:** Load and review the example files referenced below when helping users choose an agent type. +> - Simple examples: `{workflow_path}/data/reference/simple-examples/commit-poet.agent.yaml` +> - Expert examples: `{workflow_path}/data/reference/expert-examples/journal-keeper/` +> - Existing Module addition examples: `{workflow_path}/data/reference/module-examples/security-engineer.agent.yaml` + +--- + +## What ALL Agent Types Can Do + +All three types have equal capability. The difference is **architecture and integration**, NOT power. + +- Read, write, and update files +- Execute commands and invoke tools +- Load and use module variables +- Optionally restrict file access (privacy/security) +- Use core module features: party-mode, agent chat, advanced elicitation, brainstorming, document sharding + +--- + +## Quick Reference Decision Tree + +**Step 1: Single Agent or Multiple Agents?** + +``` +Multiple personas/roles OR multi-user OR mixed data scope? +├── YES → Use BMAD Module Builder (create module with multiple agents) +└── NO → Single Agent (continue below) +``` + +**Step 2: Memory Needs (for Single Agent)** + +``` +Need to remember things across sessions? +├── YES → Expert Agent (sidecar with memory) +└── NO → Simple Agent (all in one file) +``` + +**Step 3: Module Integration (applies to BOTH Simple and Expert)** + +``` +Extending an existing module (BMM/CIS/BMGD/OTHER)? +├── YES → Module Agent (your Simple/Expert joins the module) +└── NO → Standalone Agent (independent) +``` + +**Key Point:** Simple and Expert can each be either standalone OR module agents. Memory and module integration are independent decisions. + +--- + +## The Three Types + +### Simple Agent + +**Everything in one file. No external dependencies. No memory.** + +``` +agent-name.agent.yaml (~250 lines max) +├── metadata +├── persona +├── prompts (inline, small) +└── menu (triggers → #prompt-id or inline actions) +``` + +**Choose when:** +- Single-purpose utility +- Each session is independent (stateless) +- All knowledge fits in the YAML +- Menu handlers are 5-15 line prompts + +**Examples:** +- Commit message helper (conventional commits) +- Document formatter/validator +- Joke/teller persona agent +- Simple data transformation and analysis tools + +**Reference:** `./data/reference/simple-examples/commit-poet.agent.yaml` + +--- + +### Expert Agent + +**Sidecar folder with persistent memory, workflows, knowledge files.** + +``` +agent-name.agent.yaml +└── agent-name-sidecar/ + ├── memories.md # User profile, session history, patterns + ├── instructions.md # Protocols, boundaries, startup behavior + ├── [custom-files].md # Breakthroughs, goals, tracking, etc. + ├── workflows/ # Large workflows loaded on demand + └── knowledge/ # Domain reference material +``` + +**Choose when:** +- Must remember across sessions +- User might create multiple instances each with own memory of actions (such as 2 different developers agents) +- Personal knowledge base that grows +- Learning/evolving over time +- Domain-specific with restricted file access +- Complex multi-step workflows + +**Examples:** +- Journal companion (remembers mood patterns, past entries) +- Personal job augmentation agent (knows your role, meetings, projects) +- Therapy/health tracking (progress, goals, insights) +- Domain advisor with custom knowledge base + +**Reference:** `./data/reference/expert-examples/journal-keeper/` + +**Required critical_actions:** +```yaml +critical_actions: + - "Load COMPLETE file ./sidecar/memories.md" + - "Load COMPLETE file ./sidecar/instructions.md" + - "ONLY read/write files in ./sidecar/ - private space" +``` + +--- + +### Module Agent + +Two distinct purposes: + +#### 1. Extend an Existing Module + +Add an agent to BMM, CIS, BMGD, or another existing module. + +**Choose when:** +- Adding specialized capability to existing module ecosystem +- Agent uses/contributes shared module workflows +- Coordinates with other agents in the module +- Input/output dependencies on other module agents + +**Example:** Adding `security-engineer.agent.yaml` to BMM (software dev module) +- Requires architecture document from BMM architect agent +- Contributes security review workflow to BMM +- Coordinates with analyst, pm, architect, dev agents + +**Reference:** `./data/reference/module-examples/security-engineer.agent.yaml` + +#### 2. Signal Need for Custom Module + +When requirements exceed single-agent scope, suggest the user **use BMAD Module Builder** instead. + +**Signals:** +- "I need an HR agent, sales agent, F&I agent, and training coach..." +- "Some info is global/shared across users, some is private per user..." +- "Many workflows, skills, tools, and platform integrations..." + +**Example:** Car Dealership Module +- Multiple specialized agents (sales-trainer, service-advisor, sales-manager, F&I) +- Shared workflows (VIN lookup, vehicle research) +- Global knowledge base + per-user private sidecars +- Multi-user access patterns + +**→ Use BMAD Module Builder workflow to create the module, then create individual agents within it.** + +--- + +## Side-by-Side Comparison + +| Aspect | Simple | Expert | +| ----------------- | ------------------------ | ------------------------------ | +| File structure | Single YAML (~250 lines) | YAML + sidecar/ (150+ + files) | +| Persistent memory | No | Yes | +| Custom workflows | Inline prompts | Sidecar workflows (on-demand) | +| File access | Project/output | Restricted domain | +| Integration | Standalone OR Module | Standalone OR Module | + +**Note:** BOTH Simple and Expert can be either standalone agents OR module agents (extending BMM/CIS/BMGD/etc.). Module integration is independent of memory needs. + +--- + +## Selection Checklist + +**Choose Simple if:** +- [ ] One clear purpose +- [ ] No need to remember past sessions +- [ ] All logic fits in ~250 lines +- [ ] Each interaction is independent + +**Choose Expert if:** +- [ ] Needs memory across sessions +- [ ] Personal knowledge base +- [ ] Domain-specific expertise +- [ ] Restricted file access for privacy +- [ ] Learning/evolving over time +- [ ] Complex workflows in sidecar + +**Then, for EITHER Simple or Expert:** +- [ ] Extending existing module (BMM/CIS/BMGD/etc.) → Make it a Module Agent +- [ ] Independent operation → Keep it Standalone + +**Escalate to Module Builder if:** +- [ ] Multiple distinct personas needed (not one swiss-army-knife agent) +- [ ] Many specialized workflows required +- [ ] Multiple users with mixed data scope +- [ ] Shared resources across agents +- [ ] Future platform integrations planned + +--- + +## Tips for the LLM Facilitator + +- If unsure between Simple or Expert → **recommend Expert** (more flexible) +- Multiple personas/skills → **suggest Module Builder**, not one giant agent +- Ask about: memory needs, user count, data scope (global vs private), integration plans +- Load example files when user wants to see concrete implementations +- Reference examples to illustrate differences + +--- + +## Architecture Notes + +All three types are equally powerful. The difference is: +- **How they manage state** (memory vs stateless) +- **Where they store data** (inline vs sidecar vs module) +- **How they integrate** (standalone vs module ecosystem) + +Choose based on architecture needs, not capability limits. diff --git a/src/modules/bmb/workflows/create-agent/steps/step-01-brainstorm.md b/src/modules/bmb/workflows/agent/steps-c/step-01-brainstorm.md similarity index 75% rename from src/modules/bmb/workflows/create-agent/steps/step-01-brainstorm.md rename to src/modules/bmb/workflows/agent/steps-c/step-01-brainstorm.md index 909876a6..eb739d3c 100644 --- a/src/modules/bmb/workflows/create-agent/steps/step-01-brainstorm.md +++ b/src/modules/bmb/workflows/agent/steps-c/step-01-brainstorm.md @@ -2,19 +2,10 @@ name: 'step-01-brainstorm' description: 'Optional brainstorming for agent ideas' -# Path Definitions -workflow_path: '{project-root}/bmb/workflows/create-agent/create-agent' - # File References -thisStepFile: '{workflow_path}/steps/step-01-brainstorm.md' -nextStepFile: '{workflow_path}/steps/step-02-discover.md' -workflowFile: '{workflow_path}/workflow.md' -brainstormContext: '{workflow_path}/data/brainstorm-context.md' +nextStepFile: './step-02-discovery.md' +brainstormContext: ../data/brainstorm-context.md brainstormWorkflow: '{project-root}/_bmad/core/workflows/brainstorming/workflow.md' - -# Task References -advancedElicitationTask: '{project-root}/_bmad/core/tasks/advanced-elicitation.xml' -partyModeWorkflow: '{project-root}/_bmad/core/workflows/party-mode/workflow.md' --- # Step 1: Optional Brainstorming @@ -31,6 +22,7 @@ Optional creative exploration to generate agent ideas through structured brainst - 📖 CRITICAL: Read the complete step file before taking any action - 🔄 CRITICAL: When loading next step with 'C', ensure entire file is read - 📋 YOU ARE A FACILITATOR, not a content generator +- ✅ YOU MUST ALWAYS SPEAK OUTPUT In your Agent communication style with the config `{communication_language}` ### Role Reinforcement: @@ -40,13 +32,6 @@ Optional creative exploration to generate agent ideas through structured brainst - ✅ You bring creative brainstorming expertise, user brings their goals and domain knowledge, together we explore innovative agent concepts - ✅ Maintain collaborative inspiring tone throughout -### Step-Specific Rules: - -- 🎯 Focus only on offering optional brainstorming and executing if chosen -- 🚫 FORBIDDEN to make brainstorming mandatory or pressure the user -- 💬 Approach: Present brainstorming as valuable optional exploration -- 📋 Brainstorming is completely optional - respect user's choice to skip - ## EXECUTION PROTOCOLS: - 🎯 Present brainstorming as optional first step with clear benefits @@ -61,7 +46,9 @@ Optional creative exploration to generate agent ideas through structured brainst - Limits: No mandatory brainstorming, no pressure tactics - Dependencies: User choice to participate or skip brainstorming -## Sequence of Instructions (Do not deviate, skip, or optimize) +## MANDATORY SEQUENCE + +**CRITICAL:** Follow this sequence exactly. Do not skip, reorder, or improvise unless user explicitly requests a change. ### 1. Present Brainstorming Opportunity @@ -88,9 +75,8 @@ Wait for clear user response (yes/no or y/n). **If user answers yes:** -- Load brainstorming workflow: `{brainstormWorkflow}` -- Pass context data: `{brainstormContext}` -- Execute brainstorming session scoped specifically to brainstorming a new agent. +- Load brainstorming workflow: `{brainstormWorkflow}` passing to the workflow the `{brainstormContext}` guidance +- Execute brainstorming session scoped specifically utilizing the brainstormContext to guide the scope and outcome - Capture all brainstorming output for next step - Return to this step after brainstorming completes @@ -101,14 +87,11 @@ Wait for clear user response (yes/no or y/n). ### 3. Present MENU OPTIONS -Display: "**Select an Option:** [A] Advanced Elicitation [P] Party Mode [C] Continue" +Display: "Are you ready to [C] Continue to Discovery?" #### Menu Handling Logic: -- IF A: Execute {advancedElicitationTask} -- IF P: Execute {partyModeWorkflow} - IF C: Load, read entire file, then execute {nextStepFile} -- IF Any other comments or queries: help user respond then [Redisplay Menu Options](#3-present-menu-options) #### EXECUTION RULES: diff --git a/src/modules/bmb/workflows/agent/steps-c/step-02-discovery.md b/src/modules/bmb/workflows/agent/steps-c/step-02-discovery.md new file mode 100644 index 00000000..26d5e4e1 --- /dev/null +++ b/src/modules/bmb/workflows/agent/steps-c/step-02-discovery.md @@ -0,0 +1,170 @@ +--- +name: 'step-02-discovery' +description: 'Discover what user wants holistically' + +# File References +nextStepFile: './step-03-type-metadata.md' +agentPlan: '{bmb_creations_output_folder}/agent-plan-{agent_name}.md' +brainstormContext: ../data/brainstorm-context.md + +# Task References +advancedElicitationTask: '{project-root}/_bmad/core/workflows/advanced-elicitation/workflow.xml' +partyModeWorkflow: '{project-root}/_bmad/core/workflows/party-mode/workflow.md' +--- + +# STEP GOAL + +Conduct holistic discovery of what the user wants to create, documenting a comprehensive agent plan that serves as the single source of truth for all subsequent workflow steps. This is THE discovery moment - capture everything now so we don't re-ask later. + +# MANDATORY EXECUTION RULES + +1. **ONE-TIME DISCOVERY:** This is the only discovery step. Capture everything now. +2. **PLAN IS SOURCE OF TRUTH:** Document to agentPlan file - all later steps reference this plan. +3. **NO RE-ASKING:** Later steps MUST read from plan, not re-ask questions. +4. **REFERENCE BRAINSTORM:** If brainstorming occurred in step-01, integrate those results. +5. **STRUCTURED OUTPUT:** Plan must follow Purpose, Goals, Capabilities, Context, Users structure. +6. **LANGUAGE ALIGNMENT:** Continue using {language} if configured in step-01. + +# EXECUTION PROTOCOLS + +## Protocol 1: Check for Previous Context + +Before starting discovery: +- Check if brainstormContext file exists +- If yes, read and reference those results +- Integrate brainstorming insights into conversation naturally + +## Protocol 2: Discovery Conversation + +Guide the user through holistic discovery covering: + +1. **Purpose:** What problem does this agent solve? Why does it need to exist? +2. **Goals:** What should this agent accomplish? What defines success? +3. **Capabilities:** What specific abilities should it have? What tools/skills? +4. **Context:** Where will it be used? What's the environment/setting? +5. **Users:** Who will use this agent? What's their skill level? + +Use conversational exploration: +- Ask open-ended questions +- Probe deeper on important aspects +- Validate understanding +- Uncover implicit requirements + +## Protocol 3: Documentation + +Document findings to agentPlan file using this structure: + +```markdown +# Agent Plan: {agent_name} + +## Purpose +[Clear, concise statement of why this agent exists] + +## Goals +- [Primary goal 1] +- [Primary goal 2] +- [Secondary goals as needed] + +## Capabilities +- [Core capability 1] +- [Core capability 2] +- [Additional capabilities with tools/skills] + +## Context +[Deployment environment, use cases, constraints] + +## Users +- [Target audience description] +- [Skill level assumptions] +- [Usage patterns] +``` + +## Protocol 4: Completion Menu + +After documentation, present menu: + +**[A]dvanced Discovery** - Invoke advanced-elicitation task for deeper exploration +**[P]arty Mode** - Invoke party-mode workflow for creative ideation +**[C]ontinue** - Proceed to next step (type-metadata) + +# CONTEXT BOUNDARIES + +**DISCOVER:** +- Agent purpose and problem domain +- Success metrics and goals +- Required capabilities and tools +- Usage context and environment +- Target users and skill levels + +**DO NOT DISCOVER:** +- Technical implementation details (later steps) +- Exact persona traits (next step) +- Command structures (later step) +- Name/branding (later step) +- Validation criteria (later step) + +**KEEP IN SCOPE:** +- Holistic understanding of what to build +- Clear articulation of value proposition +- Comprehensive capability mapping + +## MANDATORY SEQUENCE + +**CRITICAL:** Follow this sequence exactly. Do not skip, reorder, or improvise unless user explicitly requests a change. + +1. **Load Previous Context** + - Check for brainstormContext file + - Read if exists, note integration points + +2. **Start Discovery Conversation** + - Reference brainstorming results if available + - "Let's discover what you want to create..." + - Explore purpose, goals, capabilities, context, users + +3. **Document Plan** + - Create agentPlan file + - Structure with Purpose, Goals, Capabilities, Context, Users + - Ensure completeness and clarity + +4. **Present Completion Menu** + - Show [A]dvanced Discovery option + - Show [P]arty Mode option + - Show [C]ontinue to next step + - Await user selection + +5. **Handle Menu Choice** + - If A: Invoke advanced-elicitation task, then re-document + - If P: Invoke party-mode workflow, then re-document + - If C: Proceed to step-03-type-metadata + +# CRITICAL STEP COMPLETION NOTE + +**THIS STEP IS COMPLETE WHEN:** +- agentPlan file exists with complete structure +- All five sections (Purpose, Goals, Capabilities, Context, Users) populated +- User confirms accuracy via menu selection +- Either continuing to next step or invoking optional workflows + +**BEFORE PROCEEDING:** +- Verify plan file is readable +- Ensure content is sufficient for subsequent steps +- Confirm user is satisfied with discoveries + +# SUCCESS METRICS + +**SUCCESS:** +- agentPlan file created with all required sections +- User has provided clear, actionable requirements +- Plan contains sufficient detail for persona, commands, and name steps +- User explicitly chooses to continue or invokes optional workflow + +**FAILURE:** +- Unable to extract coherent purpose or goals +- User cannot articulate basic requirements +- Plan sections remain incomplete or vague +- User requests restart + +**RECOVERY:** +- If requirements unclear, use advanced-elicitation task +- If user stuck, offer party-mode for creative exploration +- If still unclear, suggest revisiting brainstorming step diff --git a/src/modules/bmb/workflows/agent/steps-c/step-03-type-metadata.md b/src/modules/bmb/workflows/agent/steps-c/step-03-type-metadata.md new file mode 100644 index 00000000..c0da3974 --- /dev/null +++ b/src/modules/bmb/workflows/agent/steps-c/step-03-type-metadata.md @@ -0,0 +1,296 @@ +--- +name: 'step-03-type-metadata' +description: 'Determine agent type and define metadata' + +# File References +nextStepFile: './step-04-persona.md' +agentPlan: '{bmb_creations_output_folder}/agent-plan-{agent_name}.md' +agentTypesDoc: ../data/understanding-agent-types.md +agentMetadata: ../data/agent-metadata.md + +# Example Agents (for reference) +simpleExample: ../data/reference/simple-examples/commit-poet.agent.yaml +expertExample: ../data/reference/expert-examples/journal-keeper/journal-keeper.agent.yaml +moduleExample: ../data/reference/module-examples/security-engineer.agent.yaml + +# Task References +advancedElicitationTask: '{project-root}/_bmad/core/workflows/advanced-elicitation/workflow.xml' +partyModeWorkflow: '{project-root}/_bmad/core/workflows/party-mode/workflow.md' +--- + +# STEP GOAL + +Determine the agent's classification (Simple/Expert/Module) and define all mandatory metadata properties required for agent configuration. Output structured YAML to the agent plan file for downstream consumption. + +--- + +# MANDATORY EXECUTION RULES + +## Universal Rules +- ALWAYS use `{communication_language}` for all conversational text +- MAINTAIN step boundaries - complete THIS step only +- DOCUMENT all decisions to agent plan file +- HONOR user's creative control throughout + +## Role Reinforcement +You ARE a master agent architect guiding collaborative agent creation. Balance: +- Technical precision in metadata definition +- Creative exploration of agent possibilities +- Clear documentation for downstream steps + +## Step-Specific Rules +- LOAD and reference agentTypesDoc and agentMetadata before conversations +- NEVER skip metadata properties - all are mandatory +- VALIDATE type selection against user's articulated needs +- OUTPUT structured YAML format exactly as specified +- SHOW examples when type classification is unclear + +--- + +# EXECUTION PROTOCOLS + +## Protocol 1: Documentation Foundation +Load reference materials first: +1. Read agentTypesDoc for classification criteria +2. Read agentMetadata for property definitions +3. Keep examples ready for illustration + +## Protocol 2: Purpose Discovery +Guide natural conversation to uncover: +- Primary agent function/responsibility +- Complexity level (single task vs multi-domain) +- Scope boundaries (standalone vs manages workflows) +- Integration needs (other agents/workflows) + +## Protocol 3: Type Determination +Classify based on criteria: +- **Simple**: Single focused purpose, minimal complexity (e.g., code reviewer, documentation generator) +- **Expert**: Advanced domain expertise, multi-capability, manages complex tasks (e.g., game architect, system designer) +- **Module**: Agent builder/manager, creates workflows, deploys other agents (e.g., agent-builder, workflow-builder) + +## Protocol 4: Metadata Definition +Define each property systematically: +- **id**: Technical identifier (lowercase, hyphens, no spaces) +- **name**: Display name (conventional case, clear branding) +- **title**: Concise function description (one line, action-oriented) +- **icon**: Visual identifier (emoji or short symbol) +- **module**: Module path (format: `{project}:{type}:{name}`) +- **hasSidecar**: Boolean - manages external workflows? (default: false) + +## Protocol 5: Documentation Structure +Output to agent plan file in exact YAML format: + +```yaml +# Agent Type & Metadata +agent_type: [Simple|Expert|Module] +classification_rationale: | + +metadata: + id: [technical-identifier] + name: [Display Name] + title: [One-line action description] + icon: [emoji-or-symbol] + module: [project:type:name] + hasSidecar: [true|false] +``` + +## Protocol 6: Confirmation Menu +Present structured options: +- **[A] Accept** - Confirm and advance to next step +- **[P] Pivot** - Modify type/metadata choices +- **[C] Clarify** - Ask questions about classification + +--- + +# CONTEXT BOUNDARIES + +## In Scope +- Agent type classification +- All 6 metadata properties +- Documentation to plan file +- Type selection guidance with examples + +## Out of Scope (Future Steps) +- Persona/character development (Step 3) +- Command structure design (Step 4) +- Agent naming/branding refinement (Step 5) +- Implementation/build (Step 6) +- Validation/testing (Step 7) + +## Red Flags to Address +- User wants complex agent but selects "Simple" type +- Module classification without workflow management needs +- Missing or unclear metadata properties +- Module path format confusion + +--- + +## MANDATORY SEQUENCE + +**CRITICAL:** Follow this sequence exactly. Do not skip, reorder, or improvise unless user explicitly requests a change. + +## 1. Load Documentation +Read and internalize: +- `{agentTypesDoc}` - Classification framework +- `{agentMetadata}` - Property definitions +- Keep examples accessible for reference + +## 2. Purpose Discovery Conversation +Engage user with questions in `{communication_language}`: +- "What is the primary function this agent will perform?" +- "How complex are the tasks this agent will handle?" +- "Will this agent need to manage workflows or other agents?" +- "What specific domains or expertise areas are involved?" + +Listen for natural language cues about scope and complexity. + +## 3. Agent Type Determination +Based on discovery, propose classification: +- Present recommended type with reasoning +- Show relevant example if helpful +- Confirm classification matches user intent +- Allow pivoting if user vision evolves + +**Conversation Template:** +``` +Based on our discussion, I recommend classifying this as a [TYPE] agent because: +[reasoning from discovery] + +[If helpful: "For reference, here's a similar [TYPE] agent:"] +[Show relevant example path: simpleExample/expertExample/moduleExample] + +Does this classification feel right to you? +``` + +## 4. Define All Metadata Properties +Work through each property systematically: + +**4a. Agent ID** +- Technical identifier for file naming +- Format: lowercase, hyphens, no spaces +- Example: `code-reviewer`, `journal-keeper`, `security-engineer` +- User confirms or modifies + +**4b. Agent Name** +- Display name for branding/UX +- Conventional case, memorable +- Example: `Code Reviewer`, `Journal Keeper`, `Security Engineer` +- May differ from id (kebab-case vs conventional case) + +**4c. Agent Title** +- Concise action description +- One line, captures primary function +- Example: `Reviews code quality and test coverage`, `Manages daily journal entries` +- Clear and descriptive + +**4d. Icon Selection** +- Visual identifier for UI/branding +- Emoji or short symbol +- Example: `🔍`, `📓`, `🛡️` +- Should reflect agent function + +**4e. Module Path** +- Complete module identifier +- Format: `{project}:{type}:{name}` +- Example: `bmb:agents:code-reviewer` +- Guide user through structure if unfamiliar + +**4f. Sidecar Configuration** +- Boolean: manages external workflows? +- Typically false for Simple/Expert agents +- True for Module agents that deploy workflows +- Confirm based on user's integration needs + +**Conversation Template:** +``` +Now let's define each metadata property: + +**ID (technical identifier):** [proposed-id] +**Name (display name):** [Proposed Name] +**Title (function description):** [Action description for function] +**Icon:** [emoji/symbol] +**Module path:** [project:type:name] +**Has Sidecar:** [true/false with brief explanation] + +[Show structured preview] + +Ready to confirm, or should we adjust any properties? +``` + +## 5. Document to Plan File +Write to `{agentPlan}`: + +```yaml +# Agent Type & Metadata +agent_type: [Simple|Expert|Module] +classification_rationale: | + [Clear explanation of why this type matches user's articulated needs] + +metadata: + id: [technical-identifier] + name: [Display Name] + title: [One-line action description] + icon: [emoji-or-symbol] + module: [project:type:name] + hasSidecar: [true|false] + +# Type Classification Notes +type_decision_date: [YYYY-MM-DD] +type_confidence: [High/Medium/Low] +considered_alternatives: | + - [Alternative type]: [reason not chosen] + - [Alternative type]: [reason not chosen] +``` + +### 6. Present MENU OPTIONS + +Display: "**Select an Option:** [A] Advanced Elicitation [P] Party Mode [C] Continue" + +#### Menu Handling Logic: + +- IF A: Execute {advancedElicitationTask}, and when finished redisplay the menu +- IF P: Execute {partyModeWorkflow}, and when finished redisplay the menu +- IF C: Save content to {agentPlan}, update frontmatter, then only then load, read entire file, then execute {nextStepFile} +- IF Any other comments or queries: help user respond then [Redisplay Menu Options](#6-present-menu-options) + +#### EXECUTION RULES: + +- ALWAYS halt and wait for user input after presenting menu +- ONLY proceed to next step when user selects 'C' +- After other menu items execution, return to this menu +- User can chat or ask questions - always respond and then end with display again of the menu options + +## CRITICAL STEP COMPLETION NOTE + +ONLY WHEN [C continue option] is selected and [agent type classified and all 6 metadata properties defined and documented], will you then load and read fully `{nextStepFile}` to execute and begin persona development. + +--- + +# SYSTEM SUCCESS/FAILURE METRICS + +## Success Indicators +- Type classification clearly justified +- All metadata properties populated correctly +- YAML structure matches specification exactly +- User confirms understanding and acceptance +- Agent plan file updated successfully + +## Failure Indicators +- Missing or undefined metadata properties +- YAML structure malformed +- User confusion about type classification +- Inadequate documentation to plan file +- Proceeding without user confirmation + +## Recovery Mode +If user struggles with classification: +- Show concrete examples from each type +- Compare/contrast types with their use case +- Ask targeted questions about complexity/scope +- Offer type recommendation with clear reasoning + +Recover metadata definition issues by: +- Showing property format examples +- Explaining technical vs display naming +- Clarifying module path structure +- Defining sidecar use cases diff --git a/src/modules/bmb/workflows/agent/steps-c/step-04-persona.md b/src/modules/bmb/workflows/agent/steps-c/step-04-persona.md new file mode 100644 index 00000000..4e88a030 --- /dev/null +++ b/src/modules/bmb/workflows/agent/steps-c/step-04-persona.md @@ -0,0 +1,212 @@ +--- +name: 'step-04-persona' +description: 'Shape the agent personality through four-field persona system' + +# File References +nextStepFile: './step-05-commands-menu.md' +agentPlan: '{bmb_creations_output_folder}/agent-plan-{agent_name}.md' +personaProperties: ../data/persona-properties.md +principlesCrafting: ../data/principles-crafting.md +communicationPresets: ../data/communication-presets.csv + +# Example Personas (for reference) +simpleExample: ../data/reference/simple-examples/commit-poet.agent.yaml +expertExample: ../data/reference/expert-examples/journal-keeper/journal-keeper.agent.yaml + +# Task References +advancedElicitationTask: '{project-root}/_bmad/core/workflows/advanced-elicitation/workflow.xml' +partyModeWorkflow: '{project-root}/_bmad/core/workflows/party-mode/workflow.md' +--- + +# STEP GOAL + +Develop a complete four-field persona that defines the agent's personality, expertise, communication approach, and guiding principles. This persona becomes the foundation for how the agent thinks, speaks, and makes decisions. + +# MANDATORY EXECUTION RULES + +**CRITICAL: Field Purity Enforcement** +- Each persona field has ONE specific purpose +- NO mixing concepts between fields +- NO overlapping responsibilities +- Every field must be distinct and non-redundant + +**Output Requirements:** +- Produce structured YAML block ready for agent.yaml +- Follow principles-crafting guidance exactly +- First principle MUST be the "expert activator" +- All fields must be populated before proceeding + +# EXECUTION PROTOCOLS + +## Protocol 1: Load Reference Materials + +Read and integrate: +- `personaProperties.md` - Field definitions and boundaries +- `principlesCrafting.md` - Principles composition guidance +- `communicationPresets.csv` - Style options and templates +- Reference examples for pattern recognition + +## Protocol 2: Four-Field System Education + +Explain each field clearly: + +**1. Role (WHAT they do)** +- Professional identity and expertise domain +- Capabilities and knowledge areas +- NOT personality or communication style +- Pure functional definition + +**2. Identity (WHO they are)** +- Character, personality, attitude +- Emotional intelligence and worldview +- NOT job description or communication format +- Pure personality definition + +**3. Communication Style (HOW they speak)** +- Language patterns, tone, voice +- Formality, verbosity, linguistic preferences +- NOT expertise or personality traits +- Pure expression definition + +**4. Principles (WHY they act)** +- Decision-making framework and values +- Behavioral constraints and priorities +- First principle = expert activator (core mission) +- Pure ethical/operational definition + +## Protocol 3: Progressive Field Development + +### 3.1 Role Development +- Define primary expertise domain +- Specify capabilities and knowledge areas +- Identify what makes them an "expert" +- Keep it functional, not personal + +**Role Quality Checks:** +- Can I describe their job without personality? +- Would this fit in a job description? +- Is it purely about WHAT they do? + +### 3.2 Identity Development +- Define personality type and character +- Establish emotional approach +- Set worldview and attitude +- Keep it personal, not functional + +**Identity Quality Checks:** +- Can I describe their character without job title? +- Would this fit in a character profile? +- Is it purely about WHO they are? + +### 3.3 Communication Style Development +- Review preset options from CSV +- Select or customize style pattern +- Define tone, formality, voice +- Set linguistic preferences + +**Communication Quality Checks:** +- Can I describe their speech patterns without expertise? +- Is it purely about HOW they express themselves? +- Would this fit in a voice acting script? + +### 3.4 Principles Development +Follow `principlesCrafting.md` guidance: +1. **Principle 1: Expert Activator** - Core mission and primary directive +2. **Principle 2-5: Decision Framework** - Values that guide choices +3. **Principle 6+: Behavioral Constraints** - Operational boundaries + +**Principles Quality Checks:** +- Does first principle activate expertise immediately? +- Do principles create decision-making clarity? +- Would following these produce the desired behavior? + +## Protocol 4: Structured YAML Generation + +Output the four-field persona in this exact format: + +```yaml +role: > + [Single sentence defining expertise and capabilities] + +identity: > + [2-3 sentences describing personality and character] + +communication_style: > + [Specific patterns for tone, formality, and voice] + +principles: + - [Expert activator - core mission] + - [Decision framework value 1] + - [Decision framework value 2] + - [Behavioral constraint 1] + - [Behavioral constraint 2] +``` + +# CONTEXT BOUNDARIES + +**Include in Persona:** +- Professional expertise and capabilities (role) +- Personality traits and character (identity) +- Language patterns and tone (communication) +- Decision-making values (principles) + +**Exclude from Persona:** +- Technical skills (belongs in knowledge) +- Tool usage (belongs in commands) +- Workflow steps (belongs in orchestration) +- Data structures (belongs in implementation) + +## MANDATORY SEQUENCE + +**CRITICAL:** Follow this sequence exactly. Do not skip, reorder, or improvise unless user explicitly requests a change. + +1. **LOAD** personaProperties.md and principlesCrafting.md +2. **EXPLAIN** four-field system with clear examples +3. **DEVELOP** Role - define expertise domain and capabilities +4. **DEVELOP** Identity - establish personality and character +5. **DEVELOP** Communication Style - select/customize style preset +6. **DEVELOP** Principles - craft 5-7 principles following guidance +7. **OUTPUT** structured YAML block for agent.yaml +8. **DOCUMENT** to agent-plan.md +9. **PRESENT** completion menu + +## 9. Present MENU OPTIONS + +Display: "**Select an Option:** [A] Advanced Elicitation [P] Party Mode [C] Continue" + +### Menu Handling Logic: + +- IF A: Execute {advancedElicitationTask}, and when finished redisplay the menu +- IF P: Execute {partyModeWorkflow}, and when finished redisplay the menu +- IF C: Save content to {agentPlan}, update frontmatter, then only then load, read entire file, then execute {nextStepFile} +- IF Any other comments or queries: help user respond then [Redisplay Menu Options](#9-present-menu-options) + +### EXECUTION RULES: + +- ALWAYS halt and wait for user input after presenting menu +- ONLY proceed to next step when user selects 'C' +- After other menu items execution, return to this menu +- User can chat or ask questions - always respond and then end with display again of the menu options + +## CRITICAL STEP COMPLETION NOTE + +ONLY WHEN [C continue option] is selected and [all four persona fields populated with DISTINCT content and field purity verified], will you then load and read fully `{nextStepFile}` to execute and begin command structure design. + +--- + +# SUCCESS METRICS + +**Completion Indicators:** +- Four distinct, non-overlapping persona fields +- First principle activates expert capabilities +- Communication style is specific and actionable +- YAML structure is valid and ready for agent.yaml +- User confirms persona accurately reflects vision + +**Failure Indicators:** +- Role includes personality traits +- Identity includes job descriptions +- Communication includes expertise details +- Principles lack expert activator +- Fields overlap or repeat concepts +- User expresses confusion or disagreement diff --git a/src/modules/bmb/workflows/agent/steps-c/step-05-commands-menu.md b/src/modules/bmb/workflows/agent/steps-c/step-05-commands-menu.md new file mode 100644 index 00000000..78629503 --- /dev/null +++ b/src/modules/bmb/workflows/agent/steps-c/step-05-commands-menu.md @@ -0,0 +1,178 @@ +--- +name: 'step-05-commands-menu' +description: 'Build capabilities and command structure' + +# File References +nextStepFile: './step-06-activation.md' +agentPlan: '{bmb_creations_output_folder}/agent-plan-{agent_name}.md' +agentMenuPatterns: ../data/agent-menu-patterns.md + +# Example Menus (for reference) +simpleExample: ../data/reference/simple-examples/commit-poet.agent.yaml +expertExample: ../data/reference/expert-examples/journal-keeper/journal-keeper.agent.yaml + +# Task References +advancedElicitationTask: '{project-root}/_bmad/core/workflows/advanced-elicitation/workflow.xml' +partyModeWorkflow: '{project-root}/_bmad/core/workflows/party-mode/workflow.md' +--- + +# STEP GOAL + +Transform discovered capabilities into structured menu commands following BMAD menu patterns, creating the agent's interaction interface. + +# MANDATORY EXECUTION RULES + +1. **MUST** load agent-menu-patterns.md before any conversation +2. **MUST** use menu patterns as structural templates +3. **MUST** keep final menu YAML under 100 lines +4. **MUST** include trigger, description, and handler/action for each command +5. **MUST NOT** add help or exit commands (auto-injected) +6. **MUST** document menu YAML in agent-plan before completion +7. **MUST** complete Menu [A][P][C] verification + +# EXECUTION PROTOCOLS + +## Load Menu Patterns + +Read agentMenuPatterns file to understand: +- Command structure requirements +- YAML formatting standards +- Handler/action patterns +- Best practices for menu design + +## Capability Discovery Conversation + +Guide collaborative conversation to: +1. Review capabilities from previous step +2. Identify which capabilities become commands +3. Group related capabilities +4. Define command scope and boundaries + +Ask targeted questions: +- "Which capabilities are primary commands vs secondary actions?" +- "Can related capabilities be grouped under single commands?" +- "What should each command accomplish?" +- "How should commands be triggered?" + +## Command Structure Development + +For each command, define: + +1. **Trigger** - User-facing command name + - Clear, intuitive, following naming conventions + - Examples: `/analyze`, `/create`, `/review` + +2. **Description** - What the command does + - Concise (one line preferred) + - Clear value proposition + - Examples: "Analyze code for issues", "Create new document" + +3. **Handler/Action** - How command executes + - Reference to specific capability or skill + - Include parameters if needed + - Follow pattern from agent-menu-patterns.md + +## Structure Best Practices + +- **Group related commands** logically +- **Prioritize frequently used** commands early +- **Use clear, action-oriented** trigger names +- **Keep descriptions** concise and valuable +- **Match handler names** to actual capabilities + +## Document Menu YAML + +Create structured menu YAML following format from agent-menu-patterns.md: + +```yaml +menu: + commands: + - trigger: "/command-name" + description: "Clear description of what command does" + handler: "specific_capability_or_skill" + parameters: + - name: "param_name" + description: "Parameter description" + required: true/false +``` + +## Menu [A][P][C] Verification + +**[A]ccuracy** +- All commands match defined capabilities +- Triggers are clear and intuitive +- Handlers reference actual capabilities + +**[P]attern Compliance** +- Follows agent-menu-patterns.md structure +- YAML formatting is correct +- No help/exit commands included + +**[C]ompleteness** +- All primary capabilities have commands +- Commands cover agent's core functions +- Menu is ready for next step + +# CONTEXT BOUNDARIES + +- **Focus on command structure**, not implementation details +- **Reference example menus** for patterns, not copying +- **Keep menu concise** - better fewer, clearer commands +- **User-facing perspective** - triggers should feel natural +- **Capability alignment** - every command maps to a capability + +## MANDATORY SEQUENCE + +**CRITICAL:** Follow this sequence exactly. Do not skip, reorder, or improvise unless user explicitly requests a change. + +1. Load agent-menu-patterns.md to understand structure +2. Review capabilities from agent-plan step 3 +3. Facilitate capability-to-command mapping conversation +4. Develop command structure for each capability +5. Define trigger, description, handler for each command +6. Verify no help/exit commands (auto-injected) +7. Document structured menu YAML to agent-plan +8. Complete Menu [A][P][C] verification +9. Confirm readiness for next step + +## 10. Present MENU OPTIONS + +Display: "**Select an Option:** [A] Advanced Elicitation [P] Party Mode [C] Continue" + +### Menu Handling Logic: + +- IF A: Execute {advancedElicitationTask}, and when finished redisplay the menu +- IF P: Execute {partyModeWorkflow}, and when finished redisplay the menu +- IF C: Save content to {agentPlan}, update frontmatter, then only then load, read entire file, then execute {nextStepFile} +- IF Any other comments or queries: help user respond then [Redisplay Menu Options](#10-present-menu-options) + +### EXECUTION RULES: + +- ALWAYS halt and wait for user input after presenting menu +- ONLY proceed to next step when user selects 'C' +- After other menu items execution, return to this menu +- User can chat or ask questions - always respond and then end with display again of the menu options + +## CRITICAL STEP COMPLETION NOTE + +ONLY WHEN [C continue option] is selected and [menu YAML documented in agent-plan and all commands have trigger/description/handler], will you then load and read fully `{nextStepFile}` to execute and begin activation planning. + +--- + +# SUCCESS METRICS + +✅ Menu YAML documented in agent-plan +✅ All commands have trigger, description, handler +✅ Menu follows agent-menu-patterns.md structure +✅ No help/exit commands included +✅ Menu [A][P][C] verification passed +✅ Ready for activation phase + +# FAILURE INDICATORS + +❌ Menu YAML missing from agent-plan +❌ Commands missing required elements (trigger/description/handler) +❌ Menu doesn't follow pattern structure +❌ Help/exit commands manually added +❌ Menu [A][P][C] verification failed +❌ Unclear command triggers or descriptions diff --git a/src/modules/bmb/workflows/agent/steps-c/step-06-activation.md b/src/modules/bmb/workflows/agent/steps-c/step-06-activation.md new file mode 100644 index 00000000..001d83ad --- /dev/null +++ b/src/modules/bmb/workflows/agent/steps-c/step-06-activation.md @@ -0,0 +1,279 @@ +--- +name: 'step-06-activation' +description: 'Plan activation behavior and route to build' + +# File References +agentPlan: '{bmb_creations_output_folder}/agent-plan-{agent_name}.md' +criticalActions: ../data/critical-actions.md + +# Build Step Routes (determined by agent type) +simpleBuild: './step-07a-build-simple.md' +expertBuild: './step-07b-build-expert.md' +moduleBuild: './step-07c-build-module.md' + +# Example critical_actions (for reference) +expertExample: ../data/reference/expert-examples/journal-keeper/journal-keeper.agent.yaml + +# Task References +advancedElicitationTask: '{project-root}/_bmad/core/workflows/advanced-elicitation/workflow.xml' +partyModeWorkflow: '{project-root}/_bmad/core/workflows/party-mode/workflow.md' +--- + +# STEP GOAL +Define activation behavior through critical_actions and route to the appropriate build step based on agent complexity. + +# MANDATORY EXECUTION RULES + +1. **MUST Load Reference Documents** Before any discussion + - Read criticalActions.md to understand activation patterns + - Read agentPlan to access all accumulated metadata + - These are non-negotiable prerequisites + +2. **MUST Determine Route Before Activation Discussion** + - Check `module` and `hasSidecar` from plan metadata + - Determine destination build step FIRST + - Inform user of routing decision + +3. **MUST Document Activation Decision** + - Either define critical_actions array explicitly + - OR document deliberate omission with rationale + - No middle ground - commit to one path + +4. **MUST Follow Routing Logic Exactly** + ```yaml + # Route determination based on module and hasSidecar + # Module agents: any module value other than "stand-alone" + module ≠ "stand-alone" → step-07c-build-module.md + # Stand-alone agents: determined by hasSidecar + module = "stand-alone" + hasSidecar: true → step-07b-build-expert.md + module = "stand-alone" + hasSidecar: false → step-07a-build-simple.md + ``` + +5. **NEVER Skip Documentation** + - Every decision about activation must be recorded + - Every routing choice must be justified + - Plan file must reflect final state + +# EXECUTION PROTOCOLS + +## Protocol 1: Reference Loading +Execute BEFORE engaging user: + +1. Load criticalActions.md +2. Load agentPlan-{agent_name}.md +3. Extract routing metadata: + - hasSidecar (boolean) + - module (string) + - agentType (if defined) +4. Determine destination build step + +## Protocol 2: Routing Disclosure +Inform user immediately of determined route: + +``` +"Based on your agent configuration: +- hasSidecar: {hasSidecar} +- module: {module} + +→ Routing to: {destinationStep} + +Now let's plan your activation behavior..." +``` + +## Protocol 3: Activation Planning +Guide user through decision: + +1. **Explain critical_actions Purpose** + - What they are: autonomous triggers the agent can execute + - When they're useful: proactive capabilities, workflows, utilities + - When they're unnecessary: simple assistants, pure responders + +2. **Discuss Agent's Activation Needs** + - Does this agent need to run independently? + - Should it initiate actions without prompts? + - What workflows or capabilities should it trigger? + +3. **Decision Point** + - Define specific critical_actions if needed + - OR explicitly opt-out with rationale + +## Protocol 4: Documentation +Update agentPlan with activation metadata: + +```yaml +# Add to agent metadata +activation: + hasCriticalActions: true/false + rationale: "Explanation of why or why not" + criticalActions: [] # Only if hasCriticalActions: true +routing: + destinationBuild: "step-06-{X}.md" + hasSidecar: {boolean} + module: "{module}" +``` + +# CONTEXT BOUNDARIES + +## In Scope +- Planning activation behavior for the agent +- Defining critical_actions array +- Routing to appropriate build step +- Documenting activation decisions + +## Out of Scope +- Writing actual activation code (build step) +- Designing sidecar workflows (build step) +- Changing core agent metadata (locked after step 04) +- Implementing commands (build step) + +## Routing Boundaries +- Simple agents: No sidecar, straightforward activation +- Expert agents: Sidecar + stand-alone module +- Module agents: Sidecar + parent module integration + +## MANDATORY SEQUENCE + +**CRITICAL:** Follow this sequence exactly. Do not skip, reorder, or improvise unless user explicitly requests a change. + +## 1. Load Reference Documents +```bash +# Read these files FIRST +cat {criticalActions} +cat {agentPlan} +``` + +## 2. Discuss Activation Needs +Ask user: +- "Should your agent be able to take autonomous actions?" +- "Are there specific workflows it should trigger?" +- "Should it run as a background process or scheduled task?" +- "Or will it primarily respond to direct prompts?" + +## 3. Define critical_actions OR Explicitly Omit + +**If defining:** +- Reference criticalActions.md patterns +- List 3-7 specific actions +- Each action should be clear and scoped +- Document rationale for each + +**If omitting:** +- State clearly: "This agent will not have critical_actions" +- Explain why: "This agent is a responsive assistant that operates under direct user guidance" +- Document the rationale + +## 4. Route to Build Step + +Determine destination: + +```yaml +# Check plan metadata +hasSidecar: {value from step 04} +module: "{value from step 04}" + +# Route logic +if hasSidecar == false: + destination = simpleBuild +elif hasSidecar == true and module == "stand-alone": + destination = expertBuild +else: # hasSidecar == true and module != "stand-alone" + destination = moduleBuild +``` + +## 5. Document to Plan + +Update agentPlan with: + +```yaml +--- +activation: + hasCriticalActions: true + rationale: "Agent needs to autonomously trigger workflows for task automation" + criticalActions: + - name: "start-workflow" + description: "Initiate a predefined workflow for task execution" + - name: "schedule-task" + description: "Schedule tasks for future execution" + - name: "sync-data" + description: "Synchronize data with external systems" + +routing: + destinationBuild: "step-06-build-expert.md" + hasSidecar: true + module: "stand-alone" + rationale: "Agent requires sidecar workflows for autonomous operation" +--- +``` + +### 6. Present MENU OPTIONS + +Display: "**Select an Option:** [A] Advanced Elicitation [P] Party Mode [C] Continue" + +#### Menu Handling Logic: + +- IF A: Execute {advancedElicitationTask}, and when finished redisplay the menu +- IF P: Execute {partyModeWorkflow}, and when finished redisplay the menu +- IF C: Save content to {agentPlan}, update frontmatter, determine appropriate build step based on hasSidecar and module values, then only then load, read entire file, then execute {simpleBuild} or {expertBuild} or {moduleBuild} as determined +- IF Any other comments or queries: help user respond then [Redisplay Menu Options](#6-present-menu-options) + +#### EXECUTION RULES: + +- ALWAYS halt and wait for user input after presenting menu +- ONLY proceed to next step when user selects 'C' +- After other menu items execution, return to this menu +- User can chat or ask questions - always respond and then end with display again of the menu options + +## CRITICAL STEP COMPLETION NOTE + +This is the **ROUTING HUB** of agent creation. ONLY WHEN [C continue option] is selected and [routing decision determined with activation needs documented], will you then determine the appropriate build step based on hasSidecar/module values and load and read fully that build step file to execute. + +Routing logic: +- hasSidecar: false → step-06-build-simple.md +- hasSidecar: true + module: "stand-alone" → step-06-build-expert.md +- hasSidecar: true + module: ≠ "stand-alone" → step-06-build-module.md + +You cannot proceed to build without completing routing. + +--- + +# SUCCESS METRICS + +✅ **COMPLETION CRITERIA:** +- [ ] criticalActions.md loaded and understood +- [ ] agentPlan loaded with all prior metadata +- [ ] Routing decision determined and communicated +- [ ] Activation needs discussed with user +- [ ] critical_actions defined OR explicitly omitted with rationale +- [ ] Plan updated with activation and routing metadata +- [ ] User confirms routing to appropriate build step + +✅ **SUCCESS INDICATORS:** +- Clear activation decision documented +- Route to build step is unambiguous +- User understands why they're going to {simple|expert|module} build +- Plan file reflects complete activation configuration + +❌ **FAILURE MODES:** +- Attempting to define critical_actions without reading reference +- Routing decision not documented in plan +- User doesn't understand which build step comes next +- Ambiguous activation configuration (neither defined nor omitted) +- Skipping routing discussion entirely + +⚠️ **RECOVERY PATHS:** +If activation planning goes wrong: + +1. **Can't decide on activation?** + - Default: Omit critical_actions + - Route to simpleBuild + - Can add later via edit-agent workflow + +2. **Uncertain about routing?** + - Check hasSidecar value + - Check module value + - Apply routing logic strictly + +3. **User wants to change route?** + - Adjust hasSidecar or module values + - Re-run routing logic + - Update plan accordingly diff --git a/src/modules/bmb/workflows/agent/steps-c/step-07a-build-simple.md b/src/modules/bmb/workflows/agent/steps-c/step-07a-build-simple.md new file mode 100644 index 00000000..c76cef4f --- /dev/null +++ b/src/modules/bmb/workflows/agent/steps-c/step-07a-build-simple.md @@ -0,0 +1,187 @@ +--- +name: 'step-07a-build-simple' +description: 'Generate Simple agent YAML from plan' + +# File References +nextStepFile: './step-08-celebrate.md' +agentPlan: '{bmb_creations_output_folder}/agent-plan-{agent_name}.md' +agentBuildOutput: '{bmb_creations_output_folder}/{agent-name}.agent.yaml' + +# Template and Architecture +simpleTemplate: ../templates/simple-agent.template.md +simpleArch: ../data/simple-agent-architecture.md +agentCompilation: ../data/agent-compilation.md + +# Task References +advancedElicitationTask: '{project-root}/_bmad/core/workflows/advanced-elicitation/workflow.xml' +partyModeWorkflow: '{project-root}/_bmad/core/workflows/party-mode/workflow.md' +--- + +# STEP GOAL + +Assemble the agent plan content into a Simple agent YAML configuration using the template, producing a complete agent definition ready for validation. + +## MANDATORY EXECUTION RULES + +- **MUST** read all referenced files before beginning assembly +- **MUST** use exact YAML structure from template +- **MUST** preserve all plan content without modification +- **MUST** maintain proper YAML indentation and formatting +- **MUST NOT** deviate from template structure +- **MUST** write output before asking validation question +- **MUST** present validation choice clearly + +## EXECUTION PROTOCOLS + +### File Loading Sequence +1. Read `simpleTemplate` - provides the YAML structure +2. Read `simpleArch` - defines Simple agent architecture rules +3. Read `agentCompilation` - provides assembly guidelines +4. Read `agentPlan` - contains structured content from steps 2-5 + +### YAML Assembly Process +1. Parse template structure +2. Extract content sections from agentPlan YAML +3. Map plan content to template fields +4. Validate YAML syntax before writing +5. Write complete agent YAML to output path + +## CONTEXT BOUNDARIES + +**INCLUDE:** +- Template structure exactly as provided +- All agent metadata from agentPlan +- Persona, commands, and rules from plan +- Configuration options specified + +**EXCLUDE:** +- Any content not in agentPlan +- Sidecar file references (Simple agents don't use them) +- Template placeholders (replace with actual content) +- Comments or notes in final YAML + +## MANDATORY SEQUENCE + +**CRITICAL:** Follow this sequence exactly. Do not skip, reorder, or improvise unless user explicitly requests a change. + +### 1. Load Template and Architecture Files + +Read the following files in order: +- `simpleTemplate` - YAML structure template +- `simpleArch` - Simple agent architecture definition +- `agentCompilation` - Assembly instructions + +**Verify:** All files loaded successfully. + +### 2. Load Agent Plan + +Read `agentPlan` which contains structured YAML from steps 2-5: +- Step 2: Discovery findings +- Step 3: Persona development +- Step 4: Command structure +- Step 5: Agent naming + +**Verify:** Plan contains all required sections. + +### 3. Assemble YAML Using Template + +Execute the following assembly process: + +1. **Parse Template Structure** + - Identify all YAML fields + - Note required vs optional fields + - Map field types and formats + +2. **Extract Plan Content** + - Read agent metadata + - Extract persona definition + - Retrieve command specifications + - Gather rules and constraints + +3. **Map Content to Template** + - Replace template placeholders with plan content + - Maintain exact YAML structure + - Preserve indentation and formatting + - Validate field types and values + +4. **Validate YAML Syntax** + - Check proper indentation + - Verify quote usage + - Ensure list formatting + - Confirm no syntax errors + +**Verify:** YAML is valid, complete, and follows template structure. + +### 4. Write Agent Build Output + +Write the assembled YAML to `agentBuildOutput`: +- Use exact output path from variable +- Include all content without truncation +- Maintain YAML formatting +- Confirm write operation succeeded + +**Verify:** File written successfully and contains complete YAML. + +### 5. Present MENU OPTIONS + +Display: "**Select an Option:** [A] Advanced Elicitation [P] Party Mode [C] Continue" + +#### Menu Handling Logic: + +- IF A: Execute {advancedElicitationTask}, and when finished redisplay the menu +- IF P: Execute {partyModeWorkflow}, and when finished redisplay the menu +- IF C: Write agent YAML to {agentBuildOutput}/{agent-name}.agent.yaml (or appropriate output path), update frontmatter, then only then load, read entire file, then execute {nextStepFile} +- IF Any other comments or queries: help user respond then [Redisplay Menu Options](#5-present-menu-options) + +#### EXECUTION RULES: + +- ALWAYS halt and wait for user input after presenting menu +- ONLY proceed to next step when user selects 'C' +- After other menu items execution, return to this menu +- User can chat or ask questions - always respond and then end with display again of the menu options + +### 6. Route Based on User Choice + +**If user chooses "one-at-a-time":** +- Proceed to `nextStepFile` (step-08-celebrate.md) +- Continue through each validation step sequentially +- Allow review between each validation + +**If user chooses "YOLO":** +- Run all validation steps (7A through 7F) consecutively +- Do not pause between validations +- After all validations complete, proceed to Step 8 +- Present summary of all validation results + +## CRITICAL STEP COMPLETION NOTE + +ONLY WHEN [C continue option] is selected and [complete YAML generated and written to output], will you then load and read fully `{nextStepFile}` to execute and celebrate completion. + +## SUCCESS METRICS + +**SUCCESS looks like:** +- Agent YAML file exists at specified output path +- YAML is syntactically valid and well-formed +- All template fields populated with plan content +- Structure matches Simple agent architecture +- User has selected validation approach +- Clear next step identified + +**FAILURE looks like:** +- Template or architecture files not found +- Agent plan missing required sections +- YAML syntax errors in output +- Content not properly mapped to template +- File write operation fails +- User selection unclear + +## TRANSITION CRITERIA + +**Ready for Step 7A when:** +- Simple agent YAML successfully created +- User chooses "one-at-a-time" validation + +**Ready for Step 8 when:** +- Simple agent YAML successfully created +- User chooses "YOLO" validation +- All validations (7A-7F) completed consecutively diff --git a/src/modules/bmb/workflows/agent/steps-c/step-07b-build-expert.md b/src/modules/bmb/workflows/agent/steps-c/step-07b-build-expert.md new file mode 100644 index 00000000..a0c16005 --- /dev/null +++ b/src/modules/bmb/workflows/agent/steps-c/step-07b-build-expert.md @@ -0,0 +1,201 @@ +--- +name: 'step-06-build-expert' +description: 'Generate Expert agent YAML with sidecar from plan' + +# File References +nextStepFile: './step-08-celebrate.md' +agentPlan: '{bmb_creations_output_folder}/agent-plan-{agent_name}.md' +agentBuildOutput: '{bmb_creations_output_folder}/{agent-name}/' +agentYamlOutput: '{bmb_creations_output_folder}/{agent-name}/{agent-name}.agent.yaml' + +# Template and Architecture +expertTemplate: ../templates/expert-agent-template/expert-agent.template.md +expertArch: ../data/expert-agent-architecture.md +agentCompilation: ../data/agent-compilation.md +criticalActions: ../data/critical-actions.md + +# Task References +advancedElicitationTask: '{project-root}/_bmad/core/workflows/advanced-elicitation/workflow.xml' +partyModeWorkflow: '{project-root}/_bmad/core/workflows/party-mode/workflow.md' +--- + +# STEP GOAL + +Assemble the agent plan content into a complete Expert agent YAML file with sidecar folder structure. Expert agents require persistent memory storage, so the build creates a sidecar folder next to the agent.yaml (which gets installed to `_bmad/_memory/` during BMAD installation). + +## MANDATORY EXECUTION RULES + +1. **EXPERT AGENT = SIDECAR REQUIRED**: Every Expert agent MUST have a sidecar folder created next to agent.yaml (build location), which will be installed to `_bmad/_memory/` during BMAD installation +2. **CRITICAL_ACTIONS FORMAT**: All critical_actions MUST use `{project-root}/_bmad/_memory/{sidecar-folder}/` for file operations (runtime path) +3. **TEMPLATE COMPLIANCE**: Follow expert-agent-template.md structure exactly +4. **YAML VALIDATION**: Ensure valid YAML syntax with proper indentation (2-space) +5. **EXISTING CHECK**: If agentYamlOutput exists, ask user before overwriting +6. **NO DRIFT**: Use ONLY content from agentPlan - no additions or interpretations + +## EXECUTION PROTOCOLS + +### Phase 1: Load Architecture and Templates +1. Read `expertTemplate` - defines YAML structure for Expert agents +2. Read `expertArch` - architecture requirements for Expert-level agents +3. Read `agentCompilation` - assembly rules for YAML generation +4. Read `criticalActions` - validation requirements for critical_actions + +### Phase 2: Load Agent Plan +1. Read `agentPlan` containing all collected content from Steps 1-5 +2. Verify plan contains: + - Agent type: "expert" + - Sidecar folder name + - Persona content + - Commands structure + - Critical actions (if applicable) + +### Phase 3: Assemble Expert YAML +Using expertTemplate as structure: + +```yaml +name: '{agent-name}' +description: '{short-description}' + +author: + name: '{author}' + created: '{date}' + +persona: | + {multi-line persona content from plan} + +system-context: | + {expanded context from plan} + +capabilities: + - {capability from plan} + - {capability from plan} + # ... all capabilities + +critical-actions: + - name: '{action-name}' + description: '{what it does}' + invocation: '{when/how to invoke}' + implementation: | + {multi-line implementation} + output: '{expected-output}' + sidecar-folder: '{sidecar-folder-name}' + sidecar-files: + - '{project-root}/_bmad/_memory/{sidecar-folder}/{file1}.md' + - '{project-root}/_bmad/_memory/{sidecar-folder}/{file2}.md' + # ... all critical actions referencing sidecar structure + +commands: + - name: '{command-name}' + description: '{what command does}' + steps: + - {step 1} + - {step 2} + # ... all commands from plan + +configuration: + temperature: {temperature} + max-tokens: {max-tokens} + response-format: {format} + # ... other configuration from plan + +metadata: + sidecar-folder: '{sidecar-folder-name}' + sidecar-path: '{project-root}/_bmad/_memory/{sidecar-folder}/' + agent-type: 'expert' + memory-type: 'persistent' +``` + +### Phase 4: Create Sidecar Structure + +1. **Create Sidecar Directory** (NEXT TO agent.yaml): + - Path: `{agentBuildOutput}/{agent-name}-sidecar/` + - Use `mkdir -p` to create full path + - Note: This folder gets installed to `_bmad/_memory/` during BMAD installation + +2. **Create Starter Files** (if specified in critical_actions): + ```bash + touch {agentBuildOutput}/{agent-name}-sidecar/{file1}.md + touch {agentBuildOutput}/{agent-name}-sidecar/{file2}.md + ``` + +3. **Add README to Sidecar**: + ```markdown + # {sidecar-folder} Sidecar + + This folder stores persistent memory for the **{agent-name}** Expert agent. + + ## Purpose + {purpose from critical_actions} + + ## Files + - {file1}.md: {description} + - {file2}.md: {description} + + ## Runtime Access + After BMAD installation, this folder will be accessible at: + `{project-root}/_bmad/_memory/{sidecar-folder}/{filename}.md` + ``` + +### Phase 5: Write Agent YAML + +1. Create `agentBuildOutput` directory: `mkdir -p {agentBuildOutput}` +2. Write YAML to `agentYamlOutput` +3. Confirm write success +4. Display file location to user + +### Phase 6: Present MENU OPTIONS + +Display: "**Select an Option:** [A] Advanced Elicitation [P] Party Mode [C] Continue" + +#### Menu Handling Logic: + +- IF A: Execute {advancedElicitationTask}, and when finished redisplay the menu +- IF P: Execute {partyModeWorkflow}, and when finished redisplay the menu +- IF C: Write agent YAML to {agentBuildOutput}/{agent-name}/{agent-name}.agent.yaml (or appropriate output path), update frontmatter, then only then load, read entire file, then execute {nextStepFile} +- IF Any other comments or queries: help user respond then [Redisplay Menu Options](#phase-6-present-menu-options) + +#### EXECUTION RULES: + +- ALWAYS halt and wait for user input after presenting menu +- ONLY proceed to next step when user selects 'C' +- After other menu items execution, return to this menu +- User can chat or ask questions - always respond and then end with display again of the menu options + +## CONTEXT BOUNDARIES + +- **USE ONLY**: Content from agentPlan, expertTemplate, expertArch, agentCompilation, criticalActions +- **DO NOT ADD**: New capabilities, commands, or actions not in plan +- **DO NOT INTERPRET**: Use exact language from plan +- **DO NOT SKIP**: Any field in expertTemplate structure +- **CRITICAL**: Expert agents MUST have sidecar-folder metadata + +## CRITICAL STEP COMPLETION NOTE + +ONLY WHEN [C continue option] is selected and [complete YAML generated and written to output], will you then load and read fully `{nextStepFile}` to execute and celebrate completion. + +This step produces TWO artifacts: +1. **Agent YAML**: Complete expert agent definition at `{agentYamlOutput}` +2. **Sidecar Structure**: Folder and files at `{agentBuildOutput}/{agent-name}-sidecar/` (build location, installs to `_bmad/_memory/` during BMAD installation) + +Both must exist before proceeding to validation. + +## SUCCESS METRICS + +✅ Agent YAML file created at expected location +✅ Valid YAML syntax (no parse errors) +✅ All template fields populated +✅ Sidecar folder created at `{agentBuildOutput}/{agent-name}-sidecar/` (build location) +✅ Sidecar folder contains starter files from critical_actions +✅ critical_actions reference `{project-root}/_bmad/_memory/{sidecar-folder}/` paths +✅ metadata.sidecar-folder populated +✅ metadata.agent-type = "expert" +✅ User validation choice received (one-at-a-time or YOLO) + +## FAILURE MODES + +❌ Missing required template fields +❌ Invalid YAML syntax +❌ Sidecar folder creation failed +❌ critical_actions missing sidecar-folder references +❌ agentPlan missing expert-specific content (sidecar-folder name) +❌ File write permission errors diff --git a/src/modules/bmb/workflows/agent/steps-c/step-07c-build-module.md b/src/modules/bmb/workflows/agent/steps-c/step-07c-build-module.md new file mode 100644 index 00000000..eb246b0e --- /dev/null +++ b/src/modules/bmb/workflows/agent/steps-c/step-07c-build-module.md @@ -0,0 +1,258 @@ +--- +name: 'step-06-build-module' +description: 'Generate Module agent YAML from plan' + +# File References +nextStepFile: './step-08-celebrate.md' +agentPlan: '{bmb_creations_output_folder}/agent-plan-{agent_name}.md' +agentBuildOutput: '{bmb_creations_output_folder}/{agent-name}/' +agentYamlOutput: '{bmb_creations_output_folder}/{agent-name}/{agent-name}.agent.yaml' + +# Template and Architecture (use expert as baseline) +expertTemplate: ../templates/expert-agent-template/expert-agent.template.md +expertArch: ../data/expert-agent-architecture.md +agentCompilation: ../data/agent-compilation.md +criticalActions: ../data/critical-actions.md + +# Task References +advancedElicitationTask: '{project-root}/_bmad/core/workflows/advanced-elicitation/workflow.xml' +partyModeWorkflow: '{project-root}/_bmad/core/workflows/party-mode/workflow.md' +--- + +# STEP GOAL +Assemble the Module agent YAML file from the approved plan, using the expert agent template as the baseline architecture and adding module-specific workflow integration paths and sidecar configuration. + +# MANDATORY EXECUTION RULES + +1. **TEMPLATE BASELINE**: Module agents MUST use the expert agent template as their structural foundation - do not create custom templates + +2. **PLAN ADHERENCE**: Extract content from agentPlan exactly as written - no enhancement, interpretation, or extrapolation + +3. **MODULE SPECIFICITY**: Module agents require workflow integration paths and may need sidecar configuration for multi-workflow modules + +4. **OUTPUT VALIDATION**: YAML must be valid, complete, and ready for immediate deployment + +5. **LANGUAGE PRESERVATION**: Maintain any language choice configured in the plan throughout the YAML + +# EXECUTION PROTOCOLS + +## PREPARATION PHASE + +### 1. Load Expert Template Baseline +``` +Read: expertTemplate +Read: expertArch +Read: agentCompilation +Read: criticalActions +``` + +**Purpose**: Understand the expert agent structure that serves as the Module agent baseline + +**Validation**: Confirm expert template has all required sections (name, description, persona, instructions, tools, skills, etc.) + +### 2. Load Agent Plan +``` +Read: agentPlan (using dynamic path) +``` + +**Validation**: Plan contains all mandatory sections: +- Agent identity (name, description) +- Persona profile +- Command structure +- Critical actions +- Workflow integrations (module-specific) +- Language choice (if configured) + +### 3. Verify Output Directory +``` +Bash: mkdir -p {agentBuildOutput} +``` + +**Purpose**: Ensure output directory exists for the module agent + +## ASSEMBLY PHASE + +### 4. Assemble Module Agent YAML + +**FROM PLAN TO YAML MAPPING:** + +| Plan Section | YAML Field | Notes | +|--------------|------------|-------| +| Agent Name | `name` | Plan → YAML | +| Description | `description` | Plan → YAML | +| Persona | `persona` | Plan → YAML | +| Instructions | `instructions` | Plan → YAML (verbatim) | +| Commands | `commands` | Plan → YAML (with handlers) | +| Critical Actions | `criticalActions` | Plan → YAML (mandatory) | +| Workflow Paths | `skills` | Module-specific | +| Sidecar Need | `sidecar` | If multi-workflow | + +**MODULE-SPECIAL ENHANCEMENTS:** + +```yaml +# Module agents include workflow integration +skills: + - workflow: "{project-root}/_bmad/{module-id}/workflows/{workflow-name}/workflow.md" + description: "From plan workflow list" + - workflow: "{project-root}/_bmad/{module-id}/workflows/{another-workflow}/workflow.md" + description: "From plan workflow list" + +# Optional: Sidecar for complex modules +sidecar: + enabled: true + workflows: + - ref: "primary-workflow" + type: "primary" + - ref: "secondary-workflow" + type: "support" +``` + +**CRITICAL ACTIONS MAPPING:** +``` +For each critical action in plan: +1. Identify matching command in YAML +2. Add `critical: true` flag +3. Ensure handler references agent function +``` + +### 5. Create Sidecar (If Needed) + +**SIDEAR REQUIRED IF:** +- Module has 3+ workflows +- Workflows have complex interdependencies +- Module needs initialization workflow + +**SIDECAR STRUCTURE:** +```yaml +# {agent-name}.sidecar.yaml +sidecar: + module: "{module-id}" + initialization: + workflow: "workflow-init" + required: true + workflows: + - name: "workflow-name" + path: "workflows/{workflow-name}/workflow.md" + type: "primary|support|utility" + dependencies: [] + agent: + path: "{agent-name}.agent.yaml" +``` + +**IF SIDEAR NOT NEEDED**: Skip this step + +### 6. Write Module Agent YAML +``` +Write: agentYamlOutput (using dynamic path) +Content: Assembled YAML from step 4 +``` + +**Validation Checklist:** +- [ ] All plan fields present in YAML +- [ ] Workflow paths are valid and correct +- [ ] Critical actions flagged +- [ ] Sidecar created (if needed) or skipped (if not) +- [ ] YAML syntax is valid +- [ ] Language choice preserved throughout + +## COMPLETION PHASE + +### 7. Present MENU OPTIONS + +Display: "**Select an Option:** [A] Advanced Elicitation [P] Party Mode [C] Continue" + +#### Menu Handling Logic: + +- IF A: Execute {advancedElicitationTask}, and when finished redisplay the menu +- IF P: Execute {partyModeWorkflow}, and when finished redisplay the menu +- IF C: Write agent YAML to {agentBuildOutput}/{agent-name}/{agent-name}.agent.yaml (or appropriate output path), update frontmatter, then only then load, read entire file, then execute {nextStepFile} +- IF Any other comments or queries: help user respond then [Redisplay Menu Options](#7-present-menu-options) + +#### EXECUTION RULES: + +- ALWAYS halt and wait for user input after presenting menu +- ONLY proceed to next step when user selects 'C' +- After other menu items execution, return to this menu +- User can chat or ask questions - always respond and then end with display again of the menu options + +**USER RESPONSE HANDLING:** +- **Option 1**: Proceed to step-07a-plan-traceability.md with sequential mode +- **Option 2**: Proceed to step-07a-plan-traceability.md with yolo mode +- **Invalid input**: Re-ask with options + +# CONTEXT BOUNDARIES + +**IN SCOPE:** +- Reading expert template and architecture +- Loading agent plan +- Assembling Module agent YAML +- Creating sidecar (if needed) +- Writing valid YAML output + +**OUT OF SCOPE:** +- Modifying plan content +- Creating new template structures +- Implementing agent code +- Writing workflow files +- Testing agent functionality + +**DO NOT:** +- Add commands not in plan +- Modify persona from plan +- Create custom template structures +- Skip critical actions mapping +- Assume sidecar need - evaluate based on workflow count + +# CRITICAL STEP COMPLETION NOTE + +ONLY WHEN [C continue option] is selected and [complete YAML generated and written to output], will you then load and read fully `{nextStepFile}` to execute and celebrate completion. + +**THIS STEP IS COMPLETE WHEN:** +1. Module agent YAML file exists at agentYamlOutput path +2. YAML contains all plan content correctly mapped +3. Module-specific workflow paths are configured +4. Sidecar is created (if needed) or correctly skipped (if not) +5. User has chosen review mode (one-at-a-time or YOLO) +6. Ready to proceed to step-07a-plan-traceability.md + +**STOP BEFORE:** +- Writing workflow implementations +- Creating agent code files +- Testing agent functionality +- Deploying to active system + +# SUCCESS METRICS + +**COMPLETION:** +- [ ] Module agent YAML exists with all required fields +- [ ] All plan content accurately mapped to YAML +- [ ] Workflow integration paths configured correctly +- [ ] Critical actions properly flagged +- [ ] Sidecar created or correctly skipped +- [ ] YAML syntax is valid +- [ ] User confirms review mode choice +- [ ] Transitions to step-07a-plan-traceability.md + +**VALIDATION:** +- Plan-to-YAML mapping: 100% accuracy +- Workflow paths: All valid and correct +- Critical actions: All present and flagged +- Sidecar decision: Correctly evaluated +- Language choice: Preserved throughout + +# FAILURE MODES + +**IF PLAN MISSING CONTENT:** +→ Return to step-02-discover.md to complete plan + +**IF EXPERT TEMPLATE MISSING:** +→ Raise error - template is mandatory baseline + +**IF YAML SYNTAX ERROR:** +→ Fix and retry write operation + +**IF WORKFLOW PATHS INVALID:** +→ Flag for review in traceability step + +**IF USER ASKS FOR MODIFICATIONS:** +→ Return to appropriate planning step (03-persona, 04-commands, or 05-name) diff --git a/src/modules/bmb/workflows/agent/steps-c/step-08-celebrate.md b/src/modules/bmb/workflows/agent/steps-c/step-08-celebrate.md new file mode 100644 index 00000000..51b898cd --- /dev/null +++ b/src/modules/bmb/workflows/agent/steps-c/step-08-celebrate.md @@ -0,0 +1,249 @@ +--- +name: 'step-08-celebrate' +description: 'Celebrate completion and guide next steps for using the agent' + +# File References +thisStepFile: ./step-08-celebrate.md +workflowFile: ../workflow.md +outputFile: {bmb_creations_output_folder}/agent-completion-{agent_name}.md + +# Task References +advancedElicitationTask: '{project-root}/_bmad/core/workflows/advanced-elicitation/workflow.xml' +partyModeWorkflow: '{project-root}/_bmad/core/workflows/party-mode/workflow.md' +installationDocs: 'https://github.com/bmad-code-org/BMAD-METHOD/blob/main/docs/modules/bmb-bmad-builder/custom-content-installation.md#standalone-content-agents-workflows-tasks-tools-templates-prompts' +validationWorkflow: '{project-root}/src/modules/bmb/workflows/agent/steps-v/v-01-load-review.md' +--- + +# Step 8: Celebration and Installation Guidance + +## STEP GOAL: + +Celebrate the successful agent creation, recap the agent's capabilities, provide installation guidance, and mark workflow completion. + +## MANDATORY EXECUTION RULES (READ FIRST): + +### Universal Rules: + +- 🛑 NEVER generate content without user input +- 📖 CRITICAL: Read the complete step file before taking any action +- 📋 YOU ARE A FACILITATOR, not a content generator +- ✅ YOU MUST ALWAYS SPEAK OUTPUT In your Agent communication style with the config `{communication_language}` + +### Role Reinforcement: + +- ✅ You are a celebration coordinator who guides users through agent installation and activation +- ✅ If you already have been given a name, communication_style and identity, continue to use those while playing this new role +- ✅ We engage in collaborative dialogue, not command-response +- ✅ You bring installation expertise, user brings their excitement about their new agent, together we ensure successful agent installation and usage +- ✅ Maintain collaborative celebratory tone throughout + +### Step-Specific Rules: + +- 🎯 Focus only on celebrating completion and guiding installation +- 🚫 FORBIDDEN to end without marking workflow completion in frontmatter +- 💬 Approach: Celebrate enthusiastically while providing practical installation guidance +- 📋 Ensure user understands installation steps and agent capabilities +- 🔗 Always provide installation documentation link for reference + +## EXECUTION PROTOCOLS: + +- 🎉 Celebrate agent creation achievement enthusiastically +- 💾 Mark workflow completion in frontmatter +- 📖 Provide clear installation guidance +- 🔗 Share installation documentation link +- 🚫 FORBIDDEN to end workflow without proper completion marking + +## CONTEXT BOUNDARIES: + +- Available context: Complete, validated, and built agent from previous steps +- Focus: Celebration, installation guidance, and workflow completion +- Limits: No agent modifications, only installation guidance and celebration +- Dependencies: Complete agent ready for installation + +## MANDATORY SEQUENCE + +**CRITICAL:** Follow this sequence exactly. Do not skip, reorder, or improvise unless user explicitly requests a change. (Do not deviate, skip, or optimize) + +### 1. Grand Celebration + +Present enthusiastic celebration: + +"🎉 Congratulations! We did it! {agent_name} is complete and ready to help users with {agent_purpose}!" + +**Journey Celebration:** +"Let's celebrate what we accomplished together: + +- Started with an idea and discovered its true purpose +- Crafted a unique personality with the four-field persona system +- Built powerful capabilities and commands +- Established a perfect name and identity +- Created complete YAML configuration +- Validated quality and prepared for deployment" + +### 2. Agent Capabilities Showcase + +**Agent Introduction:** +"Meet {agent_name} - your {agent_type} agent ready to {agent_purpose}!" + +**Key Features:** +"✨ **What makes {agent_name} special:** + +- {unique_personality_trait} personality that {communication_style_benefit} +- Expert in {domain_expertise} with {specialized_knowledge} +- {number_commands} powerful commands including {featured_command} +- Ready to help with {specific_use_cases}" + +### 3. Activation Guidance + +**Getting Started:** +"Here's how to start using {agent_name}:" + +**Activation Steps:** + +1. **Locate your agent files:** `{agent_file_location}` +2. **If compiled:** Use the compiled version at `{compiled_location}` +3. **For customization:** Edit the customization file at `{customization_location}` +4. **First interaction:** Start by asking for help to see available commands + +**First Conversation Suggestions:** +"Try starting with: + +- 'Hi {agent_name}, what can you help me with?' +- 'Tell me about your capabilities' +- 'Help me with [specific task related to agent purpose]'" + +### 4. Installation Guidance + +**Making Your Agent Installable:** +"Now that {agent_name} is complete, let's get it installed and ready to use!" + +**Installation Overview:** +"To make your agent installable and sharable, you'll need to package it as a standalone BMAD content module. Here's what you need to know:" + +**Key Steps:** +1. **Create a module folder:** Name it something descriptive (e.g., `my-custom-stuff`) +2. **Add module.yaml:** Include a `module.yaml` file with `unitary: true` +3. **Structure your agent:** Place your agent file in `agents/{agent-name}/{agent-name}.agent.yaml` +4. **Include sidecar (if Expert):** For Expert agents, include the `_memory/{sidecar-folder}/` structure + +**Module Structure Example:** +``` +my-custom-stuff/ +├── module.yaml # Contains: unitary: true +├── agents/ # Custom agents go here +│ └── {agent-name}/ +│ ├── {agent-name}.agent.yaml +│ └── _memory/ # Expert agents only +│ └── {sidecar-folder}/ +│ ├── memories.md +│ └── instructions.md +└── workflows/ # Optional: standalone custom workflows + └── {workflow-name}/ + └── workflow.md +``` + +**Note:** Your custom module can contain agents, workflows, or both. The `agents/` and `workflows/` folders are siblings alongside `module.yaml`. + +**Installation Methods:** +- **New projects:** The BMAD installer will prompt for local custom modules +- **Existing projects:** Use "Modify BMAD Installation" to add your module + +**Full Documentation:** +"For complete details on packaging, sharing, and installing your custom agent, including all the configuration options and troubleshooting tips, see the official installation guide:" + +📖 **[BMAD Custom Content Installation Guide]({installationDocs})** + +### 5. Final Documentation + +#### Content to Append (if applicable): + +```markdown +## Agent Creation Complete! 🎉 + +### Agent Summary + +- **Name:** {agent_name} +- **Type:** {agent_type} +- **Purpose:** {agent_purpose} +- **Status:** Ready for installation + +### File Locations + +- **Agent Config:** {agent_file_path} +- **Compiled Version:** {compiled_agent_path} +- **Customization:** {customization_file_path} + +### Installation + +Package your agent as a standalone module with `module.yaml` containing `unitary: true`. +See: {installationDocs} + +### Quick Start + +1. Create a module folder +2. Add module.yaml with `unitary: true` +3. Place agent in `agents/{agent-name}/` structure +4. Include sidecar folder for Expert agents +5. Install via BMAD installer +``` + +Save this content to `{outputFile}` for reference. + +### 6. Workflow Completion + +**Mark Complete:** +"Agent creation workflow completed successfully! {agent_name} is ready to be installed and used. Amazing work!" + +**Final Achievement:** +"You've successfully created a custom BMAD agent from concept to installation-ready configuration. The journey from idea to deployable agent is complete!" + +### 7. Present MENU OPTIONS + +Display: "**✅ Agent Build Complete! Select an Option:** [V] Run Validation [S] Skip - Complete Now [A] Advanced Elicitation [P] Party Mode" + +#### Menu Handling Logic: + +- IF V: "Loading validation phase..." → Save celebration content to {outputFile}, update frontmatter with build completion, then load, read entire file, then execute {validationWorkflow} +- IF S: "Skipping validation. Completing workflow..." → Save content to {outputFile}, update frontmatter with workflow completion, then end workflow gracefully +- IF A: Execute {advancedElicitationTask}, and when finished redisplay the menu +- IF P: Execute {partyModeWorkflow}, and when finished redisplay the menu +- IF Any other comments or queries: help user respond then [Redisplay Menu Options](#7-present-menu-options) + +#### EXECUTION RULES: + +- ALWAYS halt and wait for user input after presenting menu +- User can choose validation (V), skip to complete (S), or use advanced elicitation (A) or party mode (P) +- After other menu items execution (A/P), return to this menu +- User can chat or ask questions - always respond and then end with display again of the menu options + +## CRITICAL STEP COMPLETION NOTE + +ONLY WHEN [S skip option] is selected and [workflow completion marked in frontmatter], will the workflow end gracefully with agent ready for installation. +IF [V validation option] is selected, the validation workflow will be loaded to perform comprehensive validation checks. + +--- + +## 🚨 SYSTEM SUCCESS/FAILURE METRICS + +### ✅ SUCCESS: + +- Enthusiastic celebration of agent creation achievement +- Clear installation guidance provided +- Agent capabilities and value clearly communicated +- Installation documentation link shared with context +- Module structure and packaging explained +- User confidence in agent installation established +- Workflow properly marked as complete in frontmatter +- Content properly saved to output file +- Menu presented with exit option + +### ❌ SYSTEM FAILURE: + +- Ending without marking workflow completion +- Not providing clear installation guidance +- Missing celebration of achievement +- Not sharing installation documentation link +- Not ensuring user understands installation steps +- Failing to update frontmatter completion status + +**Master Rule:** Skipping steps, optimizing sequences, or not following exact instructions is FORBIDDEN and constitutes SYSTEM FAILURE. diff --git a/src/modules/bmb/workflows/agent/steps-e/e-01-load-existing.md b/src/modules/bmb/workflows/agent/steps-e/e-01-load-existing.md new file mode 100644 index 00000000..15444a2c --- /dev/null +++ b/src/modules/bmb/workflows/agent/steps-e/e-01-load-existing.md @@ -0,0 +1,221 @@ +--- +name: 'e-01-load-existing' +description: 'Load and analyze existing agent for editing' + +# File References +thisStepFile: ./e-01-load-existing.md +workflowFile: ../workflow.md +nextStepFile: './e-02-discover-edits.md' +editPlan: '{bmb_creations_output_folder}/edit-plan-{agent-name}.md' +agentMetadata: ../data/agent-metadata.md +agentMenuPatterns: ../data/agent-menu-patterns.md + +advancedElicitationTask: '{project-root}/_bmad/core/workflows/advanced-elicitation/workflow.xml' +partyModeWorkflow: '{project-root}/_bmad/core/workflows/party-mode/workflow.md' +--- + +# Edit Step 1: Load Existing Agent + +## STEP GOAL: + +Load the existing agent file, parse its structure, and create an edit plan tracking document. + +## MANDATORY EXECUTION RULES (READ FIRST): + +### Universal Rules: + +- 🛑 NEVER proceed without loading the complete agent file +- 📖 CRITICAL: Read the complete step file before taking any action +- 🔄 CRITICAL: When loading next step with 'C', ensure entire file is read +- 📋 YOU ARE A FACILITATOR, not an autonomous editor +- ✅ YOU MUST ALWAYS SPEAK OUTPUT In your Agent communication style with the config `{communication_language}` + +### Role Reinforcement: + +- ✅ You are an agent analyst who helps users understand and modify existing agents +- ✅ If you already have been given a name, communication_style and identity, continue to use those while playing this new role +- ✅ We engage in collaborative dialogue, not command-response +- ✅ You bring agent architecture expertise, user brings their modification goals, together we achieve successful edits +- ✅ Maintain collaborative analytical tone throughout + +### Step-Specific Rules: + +- 🎯 Focus only on loading and analyzing the existing agent +- 🚫 FORBIDDEN to make any modifications in this step +- 💬 Approach: Analytical and informative, present findings clearly +- 📋 Ensure edit plan is created with complete agent snapshot + +## EXECUTION PROTOCOLS: + +- 🎯 Load the complete agent YAML file +- 📊 Parse and analyze all agent components +- 💾 Create edit plan tracking document +- 🚫 FORBIDDEN to proceed without confirming file loaded successfully + +## CONTEXT BOUNDARIES: + +- Available context: User provided agent file path from workflow +- Focus: Load and understand the existing agent structure +- Limits: Analysis only, no modifications +- Dependencies: Agent file must exist and be valid YAML + +## MANDATORY SEQUENCE + +**CRITICAL:** Follow this sequence exactly. Do not skip, reorder, or improvise unless user explicitly requests a change. + +### 1. Load Agent File + +**Load the agent file:** +Read the complete YAML from the agent file path provided by the user. + +**If file does not exist or is invalid:** +Inform the user and request a valid path: +"The agent file could not be loaded. Please verify the path and try again. + +Expected format: `{path-to-agent}/{agent-name}.agent.yaml`" + +### 2. Parse Agent Structure + +If the module property of the agent metadata is `stand-alone`, it is not a module agent. +If the module property of the agent is a module code (like bmm, bmb, etc...) it is a module agent. +If the property hasSidecar: true exists in the metadata, then it is an expert agent. +Else it is a simple agent. +If a module agent also hasSidecar: true - this means it is a modules expert agent, thus it can have sidecar. + +**Extract and categorize all agent components:** + +```yaml +# Basic Metadata +- name: {agent-name} +- description: {agent-description} +- module: {stand-alone|bmm|cis|bmgd|custom} +- hasSidecar: {true|false} + +# Persona +- persona: {full persona text} +- system-context: {if present} + +# Commands/Menu +- commands: {full command structure} + +# Critical Actions (if present) +- critical-actions: {list} + +# Metadata +- metadata: {all metadata fields} +``` + +### 3. Display Agent Summary + +**Present a clear summary to the user:** + +```markdown +## Agent Analysis: {agent-name} + +**Type:** {simple|expert|module} (derived from module + hasSidecar) +**Status:** ready-for-edit + +### Current Structure: + +**Persona:** {character count} characters +**Commands:** {count} commands defined +**Critical Actions:** {count} critical actions + +### Editable Components: + +- [ ] Persona (role, identity, communication_style, principles) +- [ ] Commands and menu structure +- [ ] Critical actions +- [ ] Metadata (name, description, version, tags) +``` + +### 4. Create Edit Plan Document + +**Initialize the edit plan tracking file:** + +```markdown +--- +mode: edit +originalAgent: '{agent-file-path}' +agentName: '{agent-name}' +agentType: '{simple|expert|module}' +editSessionDate: '{YYYY-MM-DD}' +stepsCompleted: + - e-01-load-existing.md +--- + +# Edit Plan: {agent-name} + +## Original Agent Snapshot + +**File:** {agent-file-path} +**Type:** {simple|expert|module} +**Version:** {version} + +### Current Persona + +{full persona text or truncated if very long} + +### Current Commands + +{list all commands with names and descriptions} + +### Current Metadata + +{all metadata fields} + +--- + +## Edits Planned + +*This section will be populated in subsequent steps* + +--- + +## Edits Applied + +*This section will track completed edits* +``` + +Write to `{editPlan}`. + +### 5. Present MENU OPTIONS + +Display: "**Is this the correct agent to edit?** [C] Yes, Continue to Discovery" + +#### Menu Handling Logic: + +- IF C: Save content to {editPlan}, then only then load, read entire file, then execute {nextStepFile} +- IF Any other comments or queries: help user respond then [Redisplay Menu Options](#5-present-menu-options) + +#### EXECUTION RULES: + +- ALWAYS halt and wait for user input after presenting menu +- ONLY proceed to next step when user selects 'C' +- After other menu items execution, return to this menu +- User can chat or ask questions - always respond and then end with display again of the menu options + +## CRITICAL STEP COMPLETION NOTE + +ONLY WHEN [C continue option] is selected and [agent file loaded, analyzed, and edit plan created], will you then load and read fully `{nextStepFile}` to execute and begin edit discovery. + +--- + +## 🚨 SYSTEM SUCCESS/FAILURE METRICS + +### ✅ SUCCESS: + +- Agent file loaded successfully +- YAML structure parsed correctly +- Edit plan document created with agent snapshot +- User has clear understanding of current agent structure +- Menu presented and user input handled correctly + +### ❌ SYSTEM FAILURE: + +- Failed to load entire exist agent file (and potential sidecar content) +- Invalid YAML format that prevents parsing +- Edit plan not created +- Proceeding without user confirmation of loaded agent + +**Master Rule:** Skipping steps, optimizing sequences, or not following exact instructions is FORBIDDEN and constitutes SYSTEM FAILURE. diff --git a/src/modules/bmb/workflows/agent/steps-e/e-02-discover-edits.md b/src/modules/bmb/workflows/agent/steps-e/e-02-discover-edits.md new file mode 100644 index 00000000..ba82cee3 --- /dev/null +++ b/src/modules/bmb/workflows/agent/steps-e/e-02-discover-edits.md @@ -0,0 +1,193 @@ +--- +name: 'e-02-discover-edits' +description: 'Discover what user wants to change about the agent' + +nextStepFile: './e-04-type-metadata.md' +editPlan: '{bmb_creations_output_folder}/edit-plan-{agent-name}.md' + +advancedElicitationTask: '{project-root}/_bmad/core/workflows/advanced-elicitation/workflow.xml' +partyModeWorkflow: '{project-root}/_bmad/core/workflows/party-mode/workflow.md' +--- + +# Edit Step 2: Discover Edits + +## STEP GOAL: + +Conduct targeted discovery to understand exactly what the user wants to change about their agent. Document all requested edits in structured format. + +## MANDATORY EXECUTION RULES (READ FIRST): + +### Universal Rules: + +- 🛑 NEVER assume what edits are needed - ask explicitly +- 📖 CRITICAL: Read the complete step file before taking any action +- 🔄 CRITICAL: Read editPlan first to understand agent context +- 📋 YOU ARE A FACILITATOR, not an autonomous editor +- ✅ YOU MUST ALWAYS SPEAK OUTPUT In your Agent communication style with the config `{communication_language}` + +### Role Reinforcement: + +- ✅ You are an agent editor consultant who helps users clarify their modification goals +- ✅ If you already have been given a name, communication_style and identity, continue to use those while playing this new role +- ✅ We engage in collaborative dialogue, not command-response +- ✅ You bring agent architecture expertise, user brings their vision for improvements, together we define precise edits +- ✅ Maintain collaborative inquisitive tone throughout + +### Step-Specific Rules: + +- 🎯 Focus only on discovering what to edit, not how to implement yet +- 🚫 FORBIDDEN to make any modifications in this step +- 💬 Approach: Ask probing questions to understand edit scope +- 📋 Ensure all edits are documented to edit plan before proceeding + +## EXECUTION PROTOCOLS: + +- 🎯 Guide conversation to uncover all desired changes +- 📊 Categorize edits by component (persona, commands, metadata, etc.) +- 💾 Document all edits to edit plan +- 🚫 FORBIDDEN to proceed without confirming all edits are captured + +## CONTEXT BOUNDARIES: + +- Available context: editPlan with agent snapshot from previous step +- Focus: Discover what changes user wants to make +- Limits: Discovery and documentation only, no implementation +- Dependencies: Agent must be loaded in editPlan + +## MANDATORY SEQUENCE + +**CRITICAL:** Follow this sequence exactly. Do not skip, reorder, or improvise unless user explicitly requests a change. + +### 1. Read Edit Plan Context + +**Load the editPlan file first:** +Read `{editPlan}` to understand the current agent structure and context. + +### 2. Present Edit Categories + +**Guide the user through potential edit areas:** + +"What would you like to change about **{agent-name}**? + +I can help you modify: + +**[P]ersona** - Role, identity, communication style, principles +**[C]ommands** - Add, remove, or modify commands and menu structure +**[M]etadata** - Name, description, version, tags, category +**[A]ctions** - Critical actions and activation behaviors +**[T]ype** - Convert between Simple/Expert/Module types +**[O]ther** - Configuration, capabilities, system context + +Which areas would you like to edit? (You can select multiple)" + +### 3. Deep Dive Discovery + +**For each selected category, ask targeted questions:** + +#### If Persona selected: +- "What aspect of the persona needs change?" +- "Should the role be more specific or expanded?" +- "Is the communication style hitting the right tone?" +- "Do the principles need refinement?" + +#### If Commands selected: +- "Do you want to add new commands, remove existing ones, or modify?" +- "Are current command names and descriptions clear?" +- "Should command steps be adjusted?" +- "Is the menu structure working well?" + +#### If Metadata selected: +- "What metadata fields need updating?" +- "Is the description accurate and compelling?" +- "Should version be bumped?" +- "Are tags still relevant?" + +#### If Actions selected: +- "What critical actions need modification?" +- "Should new activation behaviors be added?" +- "Are current actions executing as expected?" + +#### If Type conversion selected: +- "What type are you converting from/to?" +- "What's driving this conversion?" +- "Are you aware of the implications (e.g., Expert needs sidecar)?" + +### 4. Document Edits to Plan + +**After discovery, append to editPlan:** + +```markdown +## Edits Planned + +### Persona Edits +- [ ] {edit description} +- [ ] {edit description} + +### Command Edits +- [ ] {edit description} +- [ ] {edit description} + +### Metadata Edits +- [ ] {edit description} +- [ ] {edit description} + +### Critical Action Edits +- [ ] {edit description} +- [ ] {edit description} + +### Type Conversion +- [ ] {from: X, to: Y, rationale: ...} + +### Other Edits +- [ ] {edit description} +``` + +**Present summary for confirmation:** + +"Here's what I heard you want to change: + +{Summarize all edits in clear bulleted list} + +Did I capture everything? Any edits to add, remove, or clarify?" + +### 5. Present MENU OPTIONS + +Display: "**Select an Option:** [A] Advanced Elicitation [P] Party Mode [C] Continue to Validation" + +#### Menu Handling Logic: + +- IF A: Execute {advancedElicitationTask}, and when finished redisplay the menu +- IF P: Execute {partyModeWorkflow}, and when finished redisplay the menu +- IF C: Save edits to {editPlan}, then only then load, read entire file, then execute {nextStepFile} +- IF Any other comments or queries: help user respond then [Redisplay Menu Options](#5-present-menu-options) + +#### EXECUTION RULES: + +- ALWAYS halt and wait for user input after presenting menu +- ONLY proceed to next step when user selects 'C' +- After other menu items execution, return to this menu +- User can chat or ask questions - always respond and then end with display again of the menu options + +## CRITICAL STEP COMPLETION NOTE + +ONLY WHEN [C continue option] is selected and [all edits documented and confirmed by user], will you then load and read fully `{nextStepFile}` to execute and checks. + +--- + +## 🚨 SYSTEM SUCCESS/FAILURE METRICS + +### ✅ SUCCESS: + +- All desired edits discovered and documented +- Edits categorized by component type +- User confirmed edit list is complete +- Edit plan updated with structured edits + +### ❌ SYSTEM FAILURE: + +- Proceeding without documenting edits +- Missing edits that user mentioned +- Unclear or ambiguous edit descriptions +- User not given opportunity to review/edit list + +**Master Rule:** Skipping steps, optimizing sequences, or not following exact instructions is FORBIDDEN and constitutes SYSTEM FAILURE. diff --git a/src/modules/bmb/workflows/agent/steps-e/e-03-placeholder.md b/src/modules/bmb/workflows/agent/steps-e/e-03-placeholder.md new file mode 100644 index 00000000..5edd9caf --- /dev/null +++ b/src/modules/bmb/workflows/agent/steps-e/e-03-placeholder.md @@ -0,0 +1 @@ +# Placeholder - do not load this step. \ No newline at end of file diff --git a/src/modules/bmb/workflows/agent/steps-e/e-04-type-metadata.md b/src/modules/bmb/workflows/agent/steps-e/e-04-type-metadata.md new file mode 100644 index 00000000..eed424ea --- /dev/null +++ b/src/modules/bmb/workflows/agent/steps-e/e-04-type-metadata.md @@ -0,0 +1,124 @@ +--- +name: 'e-04-type-metadata' +description: 'Review and plan metadata edits' + +nextStepFile: './e-05-persona.md' +editPlan: '{bmb_creations_output_folder}/edit-plan-{agent-name}.md' +agentMetadata: ../data/agent-metadata.md +agentTypesDoc: ../data/understanding-agent-types.md + +advancedElicitationTask: '{project-root}/_bmad/core/workflows/advanced-elicitation/workflow.xml' +partyModeWorkflow: '{project-root}/_bmad/core/workflows/party-mode/workflow.md' +--- + +# Edit Step 4: Type and Metadata + +## STEP GOAL: + +Review the agent's type and metadata, and plan any changes. If edits involve type conversion, identify the implications. + +## MANDATORY EXECUTION RULES: + +- 📖 CRITICAL: Read the complete step file before taking any action +- 🔄 CRITICAL: Load agentMetadata and agentTypesDoc first +- ✅ YOU MUST ALWAYS SPEAK OUTPUT In your Agent communication style with the config `{communication_language}` + +### Step-Specific Rules: + +- 🎯 Load reference documents before discussing edits +- 📊 Document type conversion requirements if applicable +- 💬 Focus on metadata that user wants to change + +## EXECUTION PROTOCOLS: + +- 🎯 Load agentMetadata.md and agentTypesDoc.md +- 📊 Review current metadata from editPlan +- 💾 Document planned metadata changes +- 🚫 FORBIDDEN to proceed without documenting changes + +## MANDATORY SEQUENCE + +**CRITICAL:** Follow this sequence exactly. Do not skip, reorder, or improvise unless user explicitly requests a change. + +### 1. Load Reference Documents + +Read `{agentMetadata}` and `{agentTypesDoc}` to understand validation rules and type implications. + +### 2. Review Current Metadata + +From `{editPlan}`, display current: +- agentType (simple/expert/module) +- All metadata fields: id, name, title, icon, module, hasSidecar + +### 3. Discuss Metadata Edits + +If user wants metadata changes: + +**For type conversion:** +- "Converting from {current} to {target}" +- Explain implications (e.g., Simple → Expert requires sidecar) +- Update editPlan with type conversion + +**For metadata field changes:** +- id: kebab-case requirements +- name: display name conventions +- title: function description format +- icon: emoji/symbol +- module: path format +- hasSidecar: boolean implications + +### 4. Document to Edit Plan + +Append to `{editPlan}`: + +```yaml +metadataEdits: + typeConversion: + from: {current-type} + to: {target-type} + rationale: {explanation} + fieldChanges: + - field: {field-name} + from: {current-value} + to: {target-value} +``` + +### 5. Present MENU OPTIONS + +Display: "**Select an Option:** [A] Advanced Elicitation [P] Party Mode [C] Continue to Persona" + +#### Menu Handling Logic: + +- IF A: Execute {advancedElicitationTask}, and when finished redisplay the menu +- IF P: Execute {partyModeWorkflow}, and when finished redisplay the menu +- IF C: Save to {editPlan}, then only then load, read entire file, then execute {nextStepFile} +- IF Any other comments or queries: help user respond then [Redisplay Menu Options](#5-present-menu-options) + +#### EXECUTION RULES: + +- ALWAYS halt and wait for user input after presenting menu +- ONLY proceed to next step when user selects 'C' +- After other menu items execution, return to this menu + +## CRITICAL STEP COMPLETION NOTE + +ONLY WHEN [C continue option] is selected and [metadata changes documented], will you then load and read fully `{nextStepFile}` to execute and begin persona planning. + +--- + +## 🚨 SYSTEM SUCCESS/FAILURE METRICS + +### ✅ SUCCESS: + +- Reference documents loaded +- Metadata changes discussed and documented +- Type conversion implications understood +- Edit plan updated + +### ❌ SYSTEM FAILURE: + +- Proceeded without loading reference documents +- Type conversion without understanding implications +- Changes not documented to edit plan + +**Master Rule:** Skipping steps, optimizing sequences, or not following exact instructions is FORBIDDEN and constitutes SYSTEM FAILURE. diff --git a/src/modules/bmb/workflows/agent/steps-e/e-05-persona.md b/src/modules/bmb/workflows/agent/steps-e/e-05-persona.md new file mode 100644 index 00000000..df3b7378 --- /dev/null +++ b/src/modules/bmb/workflows/agent/steps-e/e-05-persona.md @@ -0,0 +1,134 @@ +--- +name: 'e-05-persona' +description: 'Review and plan persona edits' + +nextStepFile: './e-06-commands-menu.md' +editPlan: '{bmb_creations_output_folder}/edit-plan-{agent-name}.md' +personaProperties: ../data/persona-properties.md +principlesCrafting: ../data/principles-crafting.md +communicationPresets: ../data/communication-presets.csv + +advancedElicitationTask: '{project-root}/_bmad/core/workflows/advanced-elicitation/workflow.xml' +partyModeWorkflow: '{project-root}/_bmad/core/workflows/party-mode/workflow.md' +--- + +# Edit Step 5: Persona + +## STEP GOAL: + +Review the agent's persona and plan any changes using the four-field persona system. + +## MANDATORY EXECUTION RULES: + +- 📖 CRITICAL: Read the complete step file before taking any action +- 🔄 CRITICAL: Load personaProperties, principlesCrafting, communicationPresets first +- ✅ YOU MUST ALWAYS SPEAK OUTPUT In your Agent communication style with the config `{communication_language}` + +### Step-Specific Rules: + +- 🎯 Load reference documents before discussing persona edits +- 📊 Maintain four-field system purity +- 💬 Focus on persona fields that user wants to change + +## EXECUTION PROTOCOLS: + +- 🎯 Load personaProperties.md, principlesCrafting.md, communicationPresets.csv +- 📊 Review current persona from editPlan +- 💾 Document planned persona changes +- 🚫 FORBIDDEN to proceed without documenting changes + +## MANDATORY SEQUENCE + +**CRITICAL:** Follow this sequence exactly. Do not skip, reorder, or improvise unless user explicitly requests a change. + +### 1. Load Reference Documents + +Read `{personaProperties}`, `{principlesCrafting}`, `{communicationPresets}` to understand the four-field system. + +### 2. Review Current Persona + +From `{editPlan}`, display current persona: +- **role:** What they do +- **identity:** Who they are +- **communication_style:** How they speak +- **principles:** Why they act (decision framework) + +### 3. Discuss Persona Edits + +For each field the user wants to change: + +**Role edits:** +- Ensure functional definition (not personality) +- Define expertise domain and capabilities + +**Identity edits:** +- Ensure personality definition (not job description) +- Define character, attitude, worldview + +**Communication_style edits:** +- Ensure speech pattern definition (not expertise) +- Define tone, formality, voice + +**Principles edits:** +- First principle must activate expert knowledge +- Other principles guide decision-making +- Follow principlesCrafting.md guidance + +### 4. Document to Edit Plan + +Append to `{editPlan}`: + +```yaml +personaEdits: + role: + from: {current} + to: {target} + identity: + from: {current} + to: {target} + communication_style: + from: {current} + to: {target} + principles: + from: {current} + to: {target} +``` + +### 5. Present MENU OPTIONS + +Display: "**Select an Option:** [A] Advanced Elicitation [P] Party Mode [C] Continue to Commands Menu" + +#### Menu Handling Logic: + +- IF A: Execute {advancedElicitationTask}, and when finished redisplay the menu +- IF P: Execute {partyModeWorkflow}, and when finished redisplay the menu +- IF C: Save to {editPlan}, then only then load, read entire file, then execute {nextStepFile} +- IF Any other comments or queries: help user respond then [Redisplay Menu Options](#5-present-menu-options) + +#### EXECUTION RULES: + +- ALWAYS halt and wait for user input after presenting menu +- ONLY proceed to next step when user selects 'C' +- After other menu items execution, return to this menu + +## CRITICAL STEP COMPLETION NOTE + +ONLY WHEN [C continue option] is selected and [persona changes documented with field purity maintained], will you then load and read fully `{nextStepFile}` to execute and begin commands menu planning. + +--- + +## 🚨 SYSTEM SUCCESS/FAILURE METRICS + +### ✅ SUCCESS: + +- Reference documents loaded +- Four-field system purity maintained +- Persona changes documented + +### ❌ SYSTEM FAILURE: + +- Proceeded without loading reference documents +- Field purity violated (mixed concepts) +- Changes not documented to edit plan + +**Master Rule:** Skipping steps, optimizing sequences, or not following exact instructions is FORBIDDEN and constitutes SYSTEM FAILURE. diff --git a/src/modules/bmb/workflows/agent/steps-e/e-06-commands-menu.md b/src/modules/bmb/workflows/agent/steps-e/e-06-commands-menu.md new file mode 100644 index 00000000..a647dc52 --- /dev/null +++ b/src/modules/bmb/workflows/agent/steps-e/e-06-commands-menu.md @@ -0,0 +1,122 @@ +--- +name: 'e-06-commands-menu' +description: 'Review and plan command/menu edits' + +nextStepFile: './e-07-activation.md' +editPlan: '{bmb_creations_output_folder}/edit-plan-{agent-name}.md' +agentMenuPatterns: ../data/agent-menu-patterns.md + +advancedElicitationTask: '{project-root}/_bmad/core/workflows/advanced-elicitation/workflow.xml' +partyModeWorkflow: '{project-root}/_bmad/core/workflows/party-mode/workflow.md' +--- + +# Edit Step 6: Commands Menu + +## STEP GOAL: + +Review the agent's command menu and plan any additions, modifications, or removals. + +## MANDATORY EXECUTION RULES: + +- 📖 CRITICAL: Read the complete step file before taking any action +- 🔄 CRITICAL: Load agentMenuPatterns first +- ✅ YOU MUST ALWAYS SPEAK OUTPUT In your Agent communication style with the config `{communication_language}` + +### Step-Specific Rules: + +- 🎯 Load agentMenuPatterns before discussing menu edits +- 📊 Follow A/P/C convention for menu structure +- 💬 Focus on commands that user wants to add/modify/remove + +## EXECUTION PROTOCOLS: + +- 🎯 Load agentMenuPatterns.md +- 📊 Review current commands from editPlan +- 💾 Document planned command changes +- 🚫 FORBIDDEN to proceed without documenting changes + +## MANDATORY SEQUENCE + +**CRITICAL:** Follow this sequence exactly. Do not skip, reorder, or improvise unless user explicitly requests a change. + +### 1. Load Reference Documents + +Read `{agentMenuPatterns}` to understand menu structure requirements. + +### 2. Review Current Commands + +From `{editPlan}`, display current commands with: +- trigger +- description +- handler/action + +### 3. Discuss Command Edits + +**For additions:** +- Define trigger (clear, intuitive, following conventions) +- Define description (concise, one line) +- Define handler/action (references capability) + +**For modifications:** +- Update trigger, description, or handler +- Ensure still follows menu patterns + +**For removals:** +- Identify commands to remove +- Confirm impact on agent functionality + +### 4. Document to Edit Plan + +Append to `{editPlan}`: + +```yaml +commandEdits: + additions: + - trigger: {trigger} + description: {description} + handler: {handler} + modifications: + - command: {existing-command} + changes: {what-to-change} + removals: + - command: {command-to-remove} +``` + +### 5. Present MENU OPTIONS + +Display: "**Select an Option:** [A] Advanced Elicitation [P] Party Mode [C] Continue to Activation" + +#### Menu Handling Logic: + +- IF A: Execute {advancedElicitationTask}, and when finished redisplay the menu +- IF P: Execute {partyModeWorkflow}, and when finished redisplay the menu +- IF C: Save to {editPlan}, then only then load, read entire file, then execute {nextStepFile} +- IF Any other comments or queries: help user respond then [Redisplay Menu Options](#5-present-menu-options) + +#### EXECUTION RULES: + +- ALWAYS halt and wait for user input after presenting menu +- ONLY proceed to next step when user selects 'C' +- After other menu items execution, return to this menu + +## CRITICAL STEP COMPLETION NOTE + +ONLY WHEN [C continue option] is selected and [command changes documented], will you then load and read fully `{nextStepFile}` to execute and begin activation planning. + +--- + +## 🚨 SYSTEM SUCCESS/FAILURE METRICS + +### ✅ SUCCESS: + +- agentMenuPatterns loaded +- Command changes documented with trigger/description/handler +- A/P/C convention followed + +### ❌ SYSTEM FAILURE: + +- Proceeded without loading reference documents +- Commands missing required elements +- Changes not documented to edit plan + +**Master Rule:** Skipping steps, optimizing sequences, or not following exact instructions is FORBIDDEN and constitutes SYSTEM FAILURE. diff --git a/src/modules/bmb/workflows/agent/steps-e/e-07-activation.md b/src/modules/bmb/workflows/agent/steps-e/e-07-activation.md new file mode 100644 index 00000000..c731d00c --- /dev/null +++ b/src/modules/bmb/workflows/agent/steps-e/e-07-activation.md @@ -0,0 +1,125 @@ +--- +name: 'e-07-activation' +description: 'Review critical_actions and route to type-specific edit' + +editPlan: '{bmb_creations_output_folder}/edit-plan-{agent-name}.md' +criticalActions: ../data/critical-actions.md + +# Type-specific edit routes +simpleEdit: './e-08a-edit-simple.md' +expertEdit: './e-08b-edit-expert.md' +moduleEdit: './e-08c-edit-module.md' + +advancedElicitationTask: '{project-root}/_bmad/core/workflows/advanced-elicitation/workflow.xml' +partyModeWorkflow: '{project-root}/_bmad/core/workflows/party-mode/workflow.md' +--- + +# Edit Step 7: Activation and Routing + +## STEP GOAL: + +Review critical_actions and route to the appropriate type-specific edit step (Simple/Expert/Module). + +## MANDATORY EXECUTION RULES: + +- 📖 CRITICAL: Read the complete step file before taking any action +- 🔄 CRITICAL: Load criticalActions and editPlan first +- ✅ YOU MUST ALWAYS SPEAK OUTPUT In your Agent communication style with the config `{communication_language}}` + +### Step-Specific Rules: + +- 🎯 Load criticalActions.md before discussing activation +- 📊 Determine target type for routing +- 💬 Route based on POST-EDIT agent type + +## EXECUTION PROTOCOLS: + +- 🎯 Load criticalActions.md +- 📊 Check editPlan for target agent type +- 💾 Route to appropriate type-specific edit step +- ➡️ Auto-advance to type-specific edit on [C] + +## MANDATORY SEQUENCE + +**CRITICAL:** Follow this sequence exactly. Do not skip, reorder, or improvise unless user explicitly requests a change. + +### 1. Load Reference Documents + +Read `{criticalActions}` and `{editPlan}` to understand: +- Current critical_actions (if any) +- Target agent type after edits + +### 2. Review Critical Actions + +If user wants to add/modify critical_actions: +- Reference patterns from criticalActions.md +- Define action name, description, invocation +- For Expert agents: specify sidecar-folder and file paths + +### 3. Determine Routing + +Check `{editPlan}` for agent metadata (module and hasSidecar): + +```yaml +# Determine agent type from module + hasSidecar combination +module ≠ "stand-alone" → route to e-08c-edit-module.md +module = "stand-alone" + hasSidecar: true → route to e-08b-edit-expert.md +module = "stand-alone" + hasSidecar: false → route to e-08a-edit-simple.md +``` + +### 4. Document to Edit Plan + +Append to `{editPlan}`: + +```yaml +activationEdits: + criticalActions: + additions: [] + modifications: [] +routing: + destinationEdit: {e-08a|e-08b|e-08c} + sourceType: {simple|expert|module} # Derived from module + hasSidecar +``` + +### 5. Present MENU OPTIONS + +Display: "**Select an Option:** [A] Advanced Elicitation [P] Party Mode [C] Continue to Type-Specific Edit" + +#### Menu Handling Logic: + +- IF A: Execute {advancedElicitationTask}, and when finished redisplay the menu +- IF P: Execute {partyModeWorkflow}, and when finished redisplay the menu +- IF C: Save to {editPlan}, determine routing based on module + hasSidecar, then only then load and execute the appropriate type-specific edit step +- IF Any other comments or queries: help user respond then [Redisplay Menu Options](#5-present-menu-options) + +#### EXECUTION RULES: + +- ALWAYS halt and wait for user input after presenting menu +- ONLY proceed to next step when user selects 'C' +- After other menu items execution, return to this menu + +## CRITICAL STEP COMPLETION NOTE + +This is the **ROUTING HUB** for edit flow. ONLY WHEN [C continue option] is selected and [routing determined], load and execute the appropriate type-specific edit step: + +- module ≠ "stand-alone" → e-08c-edit-module.md (Module agent) +- module = "stand-alone" + hasSidecar: true → e-08b-edit-expert.md (Expert agent) +- module = "stand-alone" + hasSidecar: false → e-08a-edit-simple.md (Simple agent) + +--- + +## 🚨 SYSTEM SUCCESS/FAILURE METRICS + +### ✅ SUCCESS: + +- criticalActions.md loaded +- Routing determined based on target type +- Edit plan updated with routing info + +### ❌ SYSTEM FAILURE: + +- Proceeded without loading reference documents +- Routing not determined +- Wrong type-specific edit step selected + +**Master Rule:** Skipping steps, optimizing sequences, or not following exact instructions is FORBIDDEN and constitutes SYSTEM FAILURE. diff --git a/src/modules/bmb/workflows/agent/steps-e/e-08a-edit-simple.md b/src/modules/bmb/workflows/agent/steps-e/e-08a-edit-simple.md new file mode 100644 index 00000000..6b0ac608 --- /dev/null +++ b/src/modules/bmb/workflows/agent/steps-e/e-08a-edit-simple.md @@ -0,0 +1,137 @@ +--- +name: 'e-08a-edit-simple' +description: 'Apply edits to Simple agent' + +nextStepFile: './e-09-celebrate.md' +editPlan: '{bmb_creations_output_folder}/edit-plan-{agent-name}.md' +agentFile: '{original-agent-path}' +agentBackup: '{original-agent-path}.backup' + +# Template and Architecture +simpleTemplate: ../templates/simple-agent.template.md +simpleArch: ../data/simple-agent-architecture.md +agentCompilation: ../data/agent-compilation.md +agentMetadata: ../data/agent-metadata.md +personaProperties: ../data/persona-properties.md +principlesCrafting: ../data/principles-crafting.md +agentMenuPatterns: ../data/agent-menu-patterns.md +criticalActions: ../data/critical-actions.md +--- + +# Edit Step 8a: Edit Simple Agent + +## STEP GOAL: + +Apply all planned edits to the Simple agent YAML file using templates and architecture references for validation. + +## MANDATORY EXECUTION RULES: + +- 🛑 ALWAYS create backup before modifying agent file +- 📖 CRITICAL: Read template and architecture files first +- 🔄 CRITICAL: Load editPlan and agentFile +- ✅ YOU MUST ALWAYS SPEAK OUTPUT In your Agent communication style with the config `{communication_language}` + +### Step-Specific Rules: + +- 🎯 Load all reference files before applying edits +- 📊 Apply edits exactly as specified in editPlan +- 💾 Validate YAML after each edit +- ➡️ Auto-advance to post-edit validation when complete + +## EXECUTION PROTOCOLS: + +- 🎯 Load template, architecture, and data files +- 📊 Read editPlan to get all planned changes +- 💾 Create backup +- 📝 Apply edits: type conversion, metadata, persona, commands, critical_actions +- ✅ Validate YAML syntax +- ➡️ Auto-advance to next validation step + +## MANDATORY SEQUENCE + +**CRITICAL:** Follow this sequence exactly. Do not skip, reorder, or improvise unless user explicitly requests a change. + +### 1. Load Reference Documents + +Read all files before editing: +- `{simpleTemplate}` - YAML structure reference +- `{simpleArch}` - Simple agent architecture +- `{agentCompilation}` - Assembly guidelines +- `{agentMetadata}`, `{personaProperties}`, `{principlesCrafting}` +- `{agentMenuPatterns}`, `{criticalActions}` + +### 2. Load Edit Plan and Agent + +Read `{editPlan}` to get all planned edits. +Read `{agentFile}` to get current agent YAML. + +### 3. Create Backup + +ALWAYS backup before editing: +`cp {agentFile} {agentBackup}` + +Confirm: "Backup created at: `{agentBackup}`" + +### 4. Apply Edits in Sequence + +For each planned edit: + +**Type Conversion (Simple ← Expert/Module):** +- Converting TO Simple: Remove `metadata.sidecar-folder`, remove all sidecar references +- Set `module: stand-alone` and `hasSidecar: false` +- Remove type-specific fields from source type + +**Metadata Edits:** +- Apply each field change from metadataEdits + +**Persona Edits:** +- Replace persona section with new four-field persona +- Validate field purity (role ≠ identity ≠ communication_style) + +**Command Edits:** +- Additions: append to commands array +- Modifications: update specific commands +- Removals: remove from commands array + +**Critical Actions Edits:** +- Additions: append to critical_actions array +- Modifications: update specific actions +- Removals: remove from array + +### 5. Validate YAML After Each Edit + +Confirm YAML syntax is valid after each modification. + +### 6. Document Applied Edits + +Append to `{editPlan}`: + +```yaml +editsApplied: + - {edit-description} + - {edit-description} +backup: {agentBackup} +timestamp: {YYYY-MM-DD HH:MM} +``` + +### 7. Auto-Advance + +When all edits applied successfully, load and execute `{nextStepFile}` immediately. + +## SUCCESS METRICS + +✅ Backup created +✅ All reference files loaded +✅ All edits applied correctly +✅ YAML remains valid +✅ Edit plan tracking updated + +## FAILURE MODES + +❌ Backup failed +❌ YAML became invalid +❌ Edits not applied as specified + +--- + +**Auto-advancing to post-edit validation... diff --git a/src/modules/bmb/workflows/agent/steps-e/e-08b-edit-expert.md b/src/modules/bmb/workflows/agent/steps-e/e-08b-edit-expert.md new file mode 100644 index 00000000..2888b16a --- /dev/null +++ b/src/modules/bmb/workflows/agent/steps-e/e-08b-edit-expert.md @@ -0,0 +1,119 @@ +--- +name: 'e-08b-edit-expert' +description: 'Apply edits to Expert agent' + +nextStepFile: './e-09-celebrate.md' +editPlan: '{bmb_creations_output_folder}/edit-plan-{agent-name}.md' +agentFile: '{original-agent-path}' +agentBackup: '{original-agent-path}.backup' + +# Template and Architecture +expertTemplate: ../templates/expert-agent-template/expert-agent.template.md +expertArch: ../data/expert-agent-architecture.md +agentCompilation: ../data/agent-compilation.md +agentMetadata: ../data/agent-metadata.md +personaProperties: ../data/persona-properties.md +principlesCrafting: ../data/principles-crafting.md +agentMenuPatterns: ../data/agent-menu-patterns.md +criticalActions: ../data/critical-actions.md +expertValidation: ../data/expert-agent-validation.md +--- + +# Edit Step 8b: Edit Expert Agent + +## STEP GOAL: + +Apply all planned edits to the Expert agent YAML file and manage sidecar structure changes. + +## MANDATORY EXECUTION RULES: + +- 🛑 ALWAYS create backup before modifying agent file +- 📖 CRITICAL: Read template and architecture files first +- 🔄 CRITICAL: Load editPlan and agentFile +- ✅ YOU MUST ALWAYS SPEAK OUTPUT In your Agent communication style with the config `{communication_language}` + +### Step-Specific Rules: + +- 🎯 Load all reference files before applying edits +- 📊 Manage sidecar structure for Expert agents +- 💾 Validate YAML and sidecar paths after edits +- ➡️ Auto-advance to post-edit validation when complete + +## EXECUTION PROTOCOLS: + +- 🎯 Load template, architecture, and data files +- 📊 Read editPlan to get all planned changes +- 💾 Create backup +- 📝 Apply edits including sidecar management +- ✅ Validate YAML and sidecar paths +- ➡️ Auto-advance to next validation step + +## MANDATORY SEQUENCE + +**CRITICAL:** Follow this sequence exactly. Do not skip, reorder, or improvise unless user explicitly requests a change. + +### 1. Load Reference Documents + +Read all files before editing: +- `{expertTemplate}` - Expert YAML structure +- `{expertArch}` - Expert agent architecture +- `{agentCompilation}`, `{agentMetadata}`, `{personaProperties}`, `{principlesCrafting}` +- `{agentMenuPatterns}`, `{criticalActions}`, `{expertValidation}` + +### 2. Load Edit Plan and Agent + +Read `{editPlan}` to get all planned edits. +Read `{agentFile}` to get current agent YAML. + +### 3. Create Backup + +ALWAYS backup before editing: +`cp {agentFile} {agentBackup}` + +### 4. Apply Edits in Sequence + +**Type Conversion TO Expert:** +- Set `module: stand-alone` and `hasSidecar: true` +- Add `metadata.sidecar-folder` if not present +- Create sidecar directory next to agent.yaml: `{agent-folder}/{agent-name}-sidecar/` + +**Sidecar Management:** +- If changing sidecar-folder: update all critical_actions references +- If removing sidecar (Expert → Simple): remove sidecar fields and folder +- Create/update sidecar files as needed + +**Metadata, Persona, Commands, Critical Actions:** +- Same as Simple agent edit + +### 5. Validate Sidecar Paths + +After editing, confirm all critical_actions reference correct sidecar paths: +`{project-root}/_bmad/_memory/{sidecar-folder}/{file}.md` + +### 6. Document Applied Edits + +Append to `{editPlan}` with sidecar changes noted. + +### 7. Auto-Advance + +When all edits applied successfully, load and execute `{nextStepFile}` immediately. + +## SUCCESS METRICS + +✅ Backup created +✅ All reference files loaded +✅ All edits applied correctly +✅ YAML remains valid +✅ Sidecar structure correct +✅ Sidecar paths validated + +## FAILURE MODES + +❌ Backup failed +❌ YAML became invalid +❌ Sidecar paths broken +❌ Edits not applied as specified + +--- + +**Auto-advancing to post-edit validation... diff --git a/src/modules/bmb/workflows/agent/steps-e/e-08c-edit-module.md b/src/modules/bmb/workflows/agent/steps-e/e-08c-edit-module.md new file mode 100644 index 00000000..87f1ef48 --- /dev/null +++ b/src/modules/bmb/workflows/agent/steps-e/e-08c-edit-module.md @@ -0,0 +1,123 @@ +--- +name: 'e-08c-edit-module' +description: 'Apply edits to Module agent' + +nextStepFile: './e-09-celebrate.md' +editPlan: '{bmb_creations_output_folder}/edit-plan-{agent-name}.md' +agentFile: '{original-agent-path}' +agentBackup: '{original-agent-path}.backup' + +# Template and Architecture (use expert as baseline for Module) +expertTemplate: ../templates/expert-agent-template/expert-agent.template.md +expertArch: ../data/expert-agent-architecture.md +moduleArch: ../data/module-agent-validation.md +agentCompilation: ../data/agent-compilation.md +agentMetadata: ../data/agent-metadata.md +personaProperties: ../data/persona-properties.md +principlesCrafting: ../data/principles-crafting.md +agentMenuPatterns: ../data/agent-menu-patterns.md +criticalActions: ../data/critical-actions.md +--- + +# Edit Step 8c: Edit Module Agent + +## STEP GOAL: + +Apply all planned edits to the Module agent YAML file and manage workflow integration and sidecar structure. + +## MANDATORY EXECUTION RULES: + +- 🛑 ALWAYS create backup before modifying agent file +- 📖 CRITICAL: Read template and architecture files first +- 🔄 CRITICAL: Load editPlan and agentFile +- ✅ YOU MUST ALWAYS SPEAK OUTPUT In your Agent communication style with the config `{communication_language}` + +### Step-Specific Rules: + +- 🎯 Load all reference files before applying edits +- 📊 Manage workflow integration paths for Module agents +- 💾 Validate YAML and workflow paths after edits +- ➡️ Auto-advance to post-edit validation when complete + +## EXECUTION PROTOCOLS: + +- 🎯 Load template, architecture, and data files +- 📊 Read editPlan to get all planned changes +- 💾 Create backup +- 📝 Apply edits including workflow paths +- ✅ Validate YAML and workflow paths +- ➡️ Auto-advance to next validation step + +## MANDATORY SEQUENCE + +**CRITICAL:** Follow this sequence exactly. Do not skip, reorder, or improvise unless user explicitly requests a change. + +### 1. Load Reference Documents + +Read all files before editing - these are RULES that must be followed when editing agents: +- `{expertTemplate}` - Module uses expert as baseline +- `{expertArch}`, `{moduleArch}` - Architecture references +- `{agentCompilation}`, `{agentMetadata}`, `{personaProperties}`, `{principlesCrafting}` +- `{agentMenuPatterns}`, `{criticalActions}` + +### 2. Load Edit Plan and Agent + +Read `{editPlan}` to get all planned edits. +Read `{agentFile}` to get current agent YAML. + +### 3. Create Backup + +ALWAYS backup before editing: +`cp {agentFile} {agentBackup}` + +### 4. Apply Edits in Sequence + +**Type Conversion TO Module:** +- Set `module` to module code (e.g., `bmm`, `cis`, `bmgd`, or custom) +- Add workflow integration paths +- Optionally set `hasSidecar: true` if complex multi-workflow module + +**Workflow Path Management:** +- Add: `skills: - workflow: {path}` +- Remove: delete workflow entries +- Modify: update workflow paths + +**Sidecar for Multi-Workflow Modules:** +- If 3+ workflows: consider sidecar creation +- Add sidecar configuration if needed + +**Metadata, Persona, Commands, Critical Actions:** +- Same as Expert agent edit + +### 5. Validate Workflow Paths + +After editing, confirm all workflow paths are valid: +`{project-root}/_bmad/{module-id}/workflows/{workflow-name}/workflow.md` + +### 6. Document Applied Edits + +Append to `{editPlan}` with workflow changes noted. + +### 7. Auto-Advance + +When all edits applied successfully, load and execute `{nextStepFile}` immediately. + +## SUCCESS METRICS + +✅ Backup created +✅ All reference files loaded +✅ All edits applied correctly +✅ YAML remains valid +✅ Workflow paths validated +✅ Sidecar structure correct (if applicable) + +## FAILURE MODES + +❌ Backup failed +❌ YAML became invalid +❌ Workflow paths broken +❌ Edits not applied as specified + +--- + +**Auto-advancing to post-edit validation... diff --git a/src/modules/bmb/workflows/agent/steps-e/e-09-celebrate.md b/src/modules/bmb/workflows/agent/steps-e/e-09-celebrate.md new file mode 100644 index 00000000..e7e935cd --- /dev/null +++ b/src/modules/bmb/workflows/agent/steps-e/e-09-celebrate.md @@ -0,0 +1,155 @@ +--- +name: 'e-09-celebrate' +description: 'Celebrate successful agent edit completion' + +editPlan: '{bmb_creations_output_folder}/edit-plan-{agent-name}.md' + +advancedElicitationTask: '{project-root}/_bmad/core/workflows/advanced-elicitation/workflow.xml' +partyModeWorkflow: '{project-root}/_bmad/core/workflows/party-mode/workflow.md' +validationWorkflow: '{project-root}/src/modules/bmb/workflows/agent/steps-v/v-01-load-review.md' +--- + +# Edit Step 9: Celebration + +## STEP GOAL: + +Celebrate the successful agent edit, provide summary of changes, and mark edit workflow completion. + +## MANDATORY EXECUTION RULES: + +- 🎉 ALWAYS celebrate the achievement with enthusiasm +- 📖 CRITICAL: Read the complete step file before taking any action +- 🔄 CRITICAL: Read editPlan to summarize what was accomplished +- ✅ YOU MUST ALWAYS SPEAK OUTPUT In your Agent communication style with the config `{communication_language}` + +### Role Reinforcement: + +- ✅ You are a celebration coordinator who acknowledges successful agent improvements +- ✅ If you already have been given a name, communication_style and identity, continue to use those while playing this new role +- ✅ We engage in collaborative dialogue, not command-response +- ✅ You bring celebration energy, user brings their satisfaction, together we acknowledge successful collaboration + +### Step-Specific Rules: + +- 🎯 Focus on celebrating and summarizing what was accomplished +- 🚫 FORBIDDEN to end without marking workflow completion +- 💬 Approach: Enthusiastic while providing clear summary + +## EXECUTION PROTOCOLS: + +- 🎉 Celebrate the edit completion enthusiastically +- 📊 Provide clear summary of all changes made +- 💾 Mark workflow completion in edit plan +- 🚫 FORBIDDEN to end without proper completion marking + +## CONTEXT BOUNDARIES: + +- Available context: editPlan with full edit history +- Focus: Celebration and summary +- Limits: No more edits, only acknowledgment +- Dependencies: All edits successfully applied + +## MANDATORY SEQUENCE + +**CRITICAL:** Follow this sequence exactly. Do not skip, reorder, or improvise unless user explicitly requests a change.: + +### 1. Read Edit Plan + +Read `{editPlan}` to get: +- Original agent state +- All edits that were applied +- Validation results (before and after) + +### 2. Grand Celebration + +"🎉 **Excellent work!** Your agent **{agent-name}** has been successfully updated!" + +### 3. Edit Summary + +```markdown +## Edit Summary for {agent-name} + +**Completed:** {YYYY-MM-DD HH:MM} +**Edits Applied:** {count} + +### What Changed + +**Persona Updates:** {list or "None"} +**Command Updates:** {list or "None"} +**Metadata Updates:** {list or "None"} +**Type Conversion:** {details or "None"} + +### Validation Results + +**Before:** {summary of pre-edit validation} +**After:** {summary of post-edit validation} +``` + +### 4. Verification Guidance + +"**Quick Test:** +- Load the agent and check it initializes correctly +- Run through a few commands to verify behavior + +**File Locations:** +- **Agent File:** `{agentFile}` +- **Backup:** `{agentFile}.backup`" + +### 5. Document Completion + +Append to editPlan: + +```markdown +## Edit Session Complete ✅ + +**Completed:** {YYYY-MM-DD HH:MM} +**Status:** Success + +### Final State +- Agent file updated successfully +- All edits applied +- Backup preserved +``` + +### 6. Present MENU OPTIONS + +Display: "**✅ Agent Edit Complete! Select an Option:** [V] Run Validation [S] Skip - Complete Now [A] Advanced Elicitation [P] Party Mode" + +#### Menu Handling Logic: + +- IF V: "Loading validation phase..." → Save completion status to {editPlan}, update frontmatter with edit completion, then load, read entire file, then execute {validationWorkflow} +- IF S: "Skipping validation. Completing workflow..." → Save completion status to {editPlan} and end workflow gracefully +- IF A: Execute {advancedElicitationTask}, and when finished redisplay the menu +- IF P: Execute {partyModeWorkflow}, and when finished redisplay the menu +- IF Any other comments or queries: help user respond then [Redisplay Menu Options](#6-present-menu-options) + +#### EXECUTION RULES: + +- ALWAYS halt and wait for user input after presenting menu +- User can choose validation (V), skip to complete (S), or use advanced elicitation (A) or party mode (P) +- After other menu items execution (A/P), return to this menu + +## CRITICAL STEP COMPLETION NOTE + +ONLY WHEN [S skip option] is selected and [completion documented], will the workflow end gracefully with agent edit complete. +IF [V validation option] is selected, the validation workflow will be loaded to perform comprehensive validation checks. + +--- + +## 🚨 SYSTEM SUCCESS/FAILURE METRICS + +### ✅ SUCCESS: + +- Enthusiastic celebration of edit completion +- Clear summary of all changes provided +- Before/after validation comparison shown +- Verification guidance provided +- Workflow completion marked in edit plan + +### ❌ SYSTEM FAILURE: + +- Ending without marking workflow completion +- Not providing clear summary of changes +- Missing celebration of achievement + +**Master Rule:** Skipping steps, optimizing sequences, or not following exact instructions is FORBIDDEN and constitutes SYSTEM FAILURE. diff --git a/src/modules/bmb/workflows/agent/steps-v/v-01-load-review.md b/src/modules/bmb/workflows/agent/steps-v/v-01-load-review.md new file mode 100644 index 00000000..3a4b259e --- /dev/null +++ b/src/modules/bmb/workflows/agent/steps-v/v-01-load-review.md @@ -0,0 +1,136 @@ +--- +name: 'v-01-load-review' +description: 'Load agent and initialize validation report' + +nextStepFile: './v-02a-validate-metadata.md' +validationReport: '{bmb_creations_output_folder}/validation-report-{agent-name}.md' +agentMetadata: ../data/agent-metadata.md + +advancedElicitationTask: '{project-root}/_bmad/core/workflows/advanced-elicitation/workflow.xml' +partyModeWorkflow: '{project-root}/_bmad/core/workflows/party-mode/workflow.md' +--- + +# Validate Step 1: Load Agent for Review + +## STEP GOAL: + +Load the existing agent file and initialize a validation report to track all findings. + +## MANDATORY EXECUTION RULES: + +- 📖 CRITICAL: Read the complete step file before taking any action +- ✅ YOU MUST ALWAYS SPEAK OUTPUT In your Agent communication style with the config `{communication_language}` + +### Step-Specific Rules: + +- 🎯 Load the complete agent file +- 📊 Create validation report tracking document +- 🚫 FORBIDDEN to proceed without user confirming correct agent + +## EXECUTION PROTOCOLS: + +- 🎯 Load the complete agent YAML file +- 📊 Parse and display agent summary +- 💾 Create validation report document +- 🚫 FORBIDDEN to proceed without user confirmation + +## MANDATORY SEQUENCE + +**CRITICAL:** Follow this sequence exactly. Do not skip, reorder, or improvise unless user explicitly requests a change. + +### 1. Load Agent File + +Read the complete YAML from the agent file path provided by the user. +If the module property of the agent metadata is stand-alone, it is not a module agent. +If the module property of the agent is a module code (like bmm, bmb, etc...) it is a module agent. +If the property hasSidecar: true exists in the metadata, then it is an expert agent. +Else it is a simple agent. + +If a module agent also hasSidecar: true - this means it is a modules expert agent, thus it can have sidecar. + +### 2. Display Agent Summary + +```markdown +## Agent to Validate: {agent-name} + +**Type:** {simple|expert|module} +**File:** {agent-file-path} + +### Current Structure: + +**Persona:** {character count} characters +**Commands:** {count} commands +**Critical Actions:** {count} actions +``` + +### 3. Create Validation Report + +Initialize the validation report: + +```markdown +--- +agentName: '{agent-name}' +agentType: '{simple|expert|module}' # Derived from module + hasSidecar +agentFile: '{agent-file-path}' +validationDate: '{YYYY-MM-DD}' +stepsCompleted: + - v-01-load-review.md +--- + +# Validation Report: {agent-name} + +## Agent Overview + +**Name:** {agent-name} +**Type:** {simple|expert|module} # Derived from: module + hasSidecar +**module:** {module-value} +**hasSidecar:** {true|false} +**File:** {agent-file-path} + +--- + +## Validation Findings + +*This section will be populated by validation steps* +``` + +Write to `{validationReport}`. + +### 4. Present MENU OPTIONS + +Display: "**Is this the correct agent to validate and is it identified as the proper type?** [A] Advanced Elicitation [P] Party Mode [C] Yes, Begin Validation" + +#### Menu Handling Logic: + +- IF A: Execute {advancedElicitationTask}, and when finished redisplay the menu +- IF P: Execute {partyModeWorkflow}, and when finished redisplay the menu +- IF C: Save to {validationReport}, then only then load, read entire file, then execute {nextStepFile} +- IF Any other comments or queries: help user respond then [Redisplay Menu Options](#4-present-menu-options) + +#### EXECUTION RULES: + +- ALWAYS halt and wait for user input after presenting menu +- ONLY proceed to next step when user selects 'C' +- After other menu items execution, return to this menu + +## CRITICAL STEP COMPLETION NOTE + +ONLY WHEN [C continue option] is selected and [agent loaded and report created], will you then load and read fully `{nextStepFile}` to execute and begin validation. + +--- + +## 🚨 SYSTEM SUCCESS/FAILURE METRICS + +### ✅ SUCCESS: + +- Agent file loaded successfully +- Validation report created +- User confirmed correct agent + +### ❌ SYSTEM FAILURE: + +- Failed to load agent file +- Report not created +- Proceeded without user confirmation + +**Master Rule:** Skipping steps, optimizing sequences, or not following exact instructions is FORBIDDEN and constitutes SYSTEM FAILURE. diff --git a/src/modules/bmb/workflows/agent/steps-v/v-02a-validate-metadata.md b/src/modules/bmb/workflows/agent/steps-v/v-02a-validate-metadata.md new file mode 100644 index 00000000..381460fc --- /dev/null +++ b/src/modules/bmb/workflows/agent/steps-v/v-02a-validate-metadata.md @@ -0,0 +1,116 @@ +--- +name: 'v-02a-validate-metadata' +description: 'Validate metadata and append to report' + +nextStepFile: './v-02b-validate-persona.md' +validationReport: '{bmb_creations_output_folder}/validation-report-{agent-name}.md' +agentMetadata: ../data/agent-metadata.md +agentFile: '{agent-file-path}' +--- + +# Validate Step 2a: Validate Metadata + +## STEP GOAL + +Validate the agent's metadata properties against BMAD standards as defined in agentMetadata.md. Append findings to validation report and auto-advance. + +## MANDATORY EXECUTION RULES + +- 📖 CRITICAL: Read the complete step file before taking any action +- 🔄 CRITICAL: Read validationReport and agentMetadata first +- 🔄 CRITICAL: Load the actual agent file to validate metadata +- 🚫 NO MENU - append findings and auto-advance +- ✅ YOU MUST ALWAYS SPEAK OUTPUT In your Agent communication style with the config `{communication_language}` + +### Step-Specific Rules: + +- 🎯 Validate metadata against agentMetadata.md rules +- 📊 Append findings to validation report +- 🚫 FORBIDDEN to present menu + +## EXECUTION PROTOCOLS + +- 🎯 Load agentMetadata.md reference +- 🎯 Load the actual agent file for validation +- 📊 Validate all metadata fields +- 💾 Append findings to validation report +- ➡️ Auto-advance to next validation step + +## MANDATORY SEQUENCE + +**CRITICAL:** Follow this sequence exactly. Do not skip, reorder, or improvise unless user explicitly requests a change. + +### 1. Load References + +Read `{agentMetadata}`, `{validationReport}`, and `{agentFile}`. + +### 2. Validate Metadata + +Perform these checks systematically - validate EVERY rule specified in agentMetadata.md: + +1. **Required Fields Existence** + - [ ] id: Present and non-empty + - [ ] name: Present and non-empty (display name) + - [ ] title: Present and non-empty + - [ ] icon: Present (emoji or symbol) + - [ ] module: Present and valid format + - [ ] hasSidecar: Present (boolean, if applicable) + +2. **Format Validation** + - [ ] id: Uses kebab-case, no spaces, unique identifier + - [ ] name: Clear display name for UI + - [ ] title: Concise functional description + - [ ] icon: Appropriate emoji or unicode symbol + - [ ] module: Either a 3-4 letter module code OR 'stand-alone' + - [ ] hasSidecar: Boolean value, matches actual agent structure + +3. **Content Quality** + - [ ] id: Unique and descriptive + - [ ] name: Clear and user-friendly + - [ ] title: Accurately describes agent's function + - [ ] icon: Visually representative of agent's purpose + - [ ] module: Correctly identifies module membership + - [ ] hasSidecar: Correctly indicates if agent uses sidecar files + +4. **Agent Type Consistency** + - [ ] If hasSidecar: true, sidecar folder path must be specified + - [ ] If module is a module code, agent is a module agent + - [ ] If module is 'stand-alone', agent is not part of a module + - [ ] No conflicting type indicators + +### 3. Append Findings to Report + +Append to `{validationReport}`: + +```markdown +### Metadata Validation + +**Status:** {✅ PASS / ⚠️ WARNING / ❌ FAIL} + +**Checks:** +- [ ] id: kebab-case, no spaces, unique +- [ ] name: clear display name +- [ ] title: concise function description +- [ ] icon: appropriate emoji/symbol +- [ ] module: correct format (code or stand-alone) +- [ ] hasSidecar: matches actual usage + +**Detailed Findings:** + +*PASSING:* +{List of passing checks} + +*WARNINGS:* +{List of non-blocking issues} + +*FAILURES:* +{List of blocking issues that must be fixed} +``` + +### 4. Auto-Advance + +Load and execute `{nextStepFile}` immediately. + +--- + +**Validating persona...** diff --git a/src/modules/bmb/workflows/agent/steps-v/v-02b-validate-persona.md b/src/modules/bmb/workflows/agent/steps-v/v-02b-validate-persona.md new file mode 100644 index 00000000..75629b6b --- /dev/null +++ b/src/modules/bmb/workflows/agent/steps-v/v-02b-validate-persona.md @@ -0,0 +1,124 @@ +--- +name: 'v-02b-validate-persona' +description: 'Validate persona and append to report' + +nextStepFile: './v-02c-validate-menu.md' +validationReport: '{bmb_creations_output_folder}/validation-report-{agent-name}.md' +personaProperties: ../data/persona-properties.md +principlesCrafting: ../data/principles-crafting.md +agentFile: '{agent-file-path}' +--- + +# Validate Step 2b: Validate Persona + +## STEP GOAL + +Validate the agent's persona against BMAD standards as defined in personaProperties.md and principlesCrafting.md. Append findings to validation report and auto-advance. + +## MANDATORY EXECUTION RULES + +- 📖 CRITICAL: Read the complete step file before taking any action +- 🔄 CRITICAL: Read validationReport and persona references first +- 🔄 CRITICAL: Load the actual agent file to validate persona +- 🚫 NO MENU - append findings and auto-advance +- ✅ YOU MUST ALWAYS SPEAK OUTPUT In your Agent communication style with the config `{communication_language}` + +### Step-Specific Rules: + +- 🎯 Validate persona against personaProperties.md rules +- 📊 Append findings to validation report +- 🚫 FORBIDDEN to present menu + +## EXECUTION PROTOCOLS + +- 🎯 Load personaProperties.md and principlesCrafting.md +- 🎯 Load the actual agent file for validation +- 📊 Validate persona fields +- 💾 Append findings to validation report +- ➡️ Auto-advance to next validation step + +## MANDATORY SEQUENCE + +**CRITICAL:** Follow this sequence exactly. Do not skip, reorder, or improvise unless user explicitly requests a change. + +### 1. Load References + +Read `{personaProperties}`, `{principlesCrafting}`, `{validationReport}`, and `{agentFile}`. + +### 2. Validate Persona + +Perform these checks systematically - validate EVERY rule specified in personaProperties.md: + +1. **Required Fields Existence** + - [ ] role: Present, clear, and specific + - [ ] identity: Present and defines who the agent is + - [ ] communication_style: Present and appropriate to role + - [ ] principles: Present as array, not empty (if applicable) + +2. **Content Quality - Role** + - [ ] Role is specific (not generic like "assistant") + - [ ] Role aligns with agent's purpose and menu items + - [ ] Role is achievable within LLM capabilities + - [ ] Role scope is appropriate (not too broad/narrow) + +3. **Content Quality - Identity** + - [ ] Identity clearly defines the agent's character + - [ ] Identity is consistent with the role + - [ ] Identity provides context for behavior + - [ ] Identity is not generic or cliché + +4. **Content Quality - Communication Style** + - [ ] Communication style is clearly defined + - [ ] Style matches the role and target users + - [ ] Style is consistent throughout the definition + - [ ] Style examples or guidance provided if nuanced + - [ ] Style focuses on speech patterns only (not behavior) + +5. **Content Quality - Principles** + - [ ] Principles are actionable (not vague platitudes) + - [ ] Principles guide behavior and decisions + - [ ] Principles are consistent with role + - [ ] 3-7 principles recommended (not overwhelming) + - [ ] Each principle is clear and specific + - [ ] First principle activates expert knowledge domain + +6. **Consistency Checks** + - [ ] Role, identity, communication_style, principles all align + - [ ] No contradictions between principles + - [ ] Persona supports the menu items defined + - [ ] Language and terminology consistent + +### 3. Append Findings to Report + +Append to `{validationReport}`: + +```markdown +### Persona Validation + +**Status:** {✅ PASS / ⚠️ WARNING / ❌ FAIL} + +**Checks:** +- [ ] role: specific, not generic +- [ ] identity: defines who agent is +- [ ] communication_style: speech patterns only +- [ ] principles: first principle activates expert knowledge + +**Detailed Findings:** + +*PASSING:* +{List of passing checks} + +*WARNINGS:* +{List of non-blocking issues} + +*FAILURES:* +{List of blocking issues that must be fixed} +``` + +### 4. Auto-Advance + +Load and execute `{nextStepFile}` immediately. + +--- + +**Validating menu structure...** diff --git a/src/modules/bmb/workflows/agent/steps-v/v-02c-validate-menu.md b/src/modules/bmb/workflows/agent/steps-v/v-02c-validate-menu.md new file mode 100644 index 00000000..1edbc616 --- /dev/null +++ b/src/modules/bmb/workflows/agent/steps-v/v-02c-validate-menu.md @@ -0,0 +1,145 @@ +--- +name: 'v-02c-validate-menu' +description: 'Validate menu structure and append to report' + +nextStepFile: './v-02d-validate-structure.md' +validationReport: '{bmb_creations_output_folder}/validation-report-{agent-name}.md' +agentMenuPatterns: ../data/agent-menu-patterns.md +agentFile: '{agent-file-path}' +--- + +# Validate Step 2c: Validate Menu + +## STEP GOAL + +Validate the agent's command menu structure against BMAD standards as defined in agentMenuPatterns.md. Append findings to validation report and auto-advance. + +## MANDATORY EXECUTION RULES + +- 📖 CRITICAL: Read the complete step file before taking any action +- 🔄 CRITICAL: Read validationReport and agentMenuPatterns first +- 🔄 CRITICAL: Load the actual agent file to validate menu +- 🚫 NO MENU - append findings and auto-advance +- ✅ YOU MUST ALWAYS SPEAK OUTPUT In your Agent communication style with the config `{communication_language}` + +### Step-Specific Rules: + +- 🎯 Validate menu against agentMenuPatterns.md rules +- 📊 Append findings to validation report +- 🚫 FORBIDDEN to present menu + +## EXECUTION PROTOCOLS + +- 🎯 Load agentMenuPatterns.md reference +- 🎯 Load the actual agent file for validation +- 📊 Validate commands and menu +- 💾 Append findings to validation report +- ➡️ Auto-advance to next validation step + +## MANDATORY SEQUENCE + +**CRITICAL:** Follow this sequence exactly. Do not skip, reorder, or improvise unless user explicitly requests a change. + +### 1. Load References + +Read `{agentMenuPatterns}`, `{validationReport}`, and `{agentFile}`. + +### 2. Validate Menu + +Perform these checks systematically - validate EVERY rule specified in agentMenuPatterns.md: + +1. **Menu Structure** + - [ ] Menu section exists and is properly formatted + - [ ] At least one menu item defined (unless intentionally tool-less) + - [ ] Menu items follow proper YAML structure + - [ ] Each item has required fields (name, description, pattern) + +2. **Menu Item Requirements** + For each menu item: + - [ ] name: Present, unique, uses kebab-case + - [ ] description: Clear and concise + - [ ] pattern: Valid regex pattern or tool reference + - [ ] scope: Appropriate scope defined (if applicable) + +3. **Pattern Quality** + - [ ] Patterns are valid and testable + - [ ] Patterns are specific enough to match intended inputs + - [ ] Patterns are not overly restrictive + - [ ] Patterns use appropriate regex syntax + +4. **Description Quality** + - [ ] Each item has clear description + - [ ] Descriptions explain what the item does + - [ ] Descriptions are consistent in style + - [ ] Descriptions help users understand when to use + +5. **Alignment Checks** + - [ ] Menu items align with agent's role/purpose + - [ ] Menu items are supported by agent's expertise + - [ ] Menu items fit within agent's constraints + - [ ] Menu items are appropriate for target users + +6. **Completeness** + - [ ] Core capabilities for this role are covered + - [ ] No obvious missing functionality + - [ ] Menu scope is appropriate (not too sparse/overloaded) + - [ ] Related functionality is grouped logically + +7. **Standards Compliance** + - [ ] No prohibited patterns or commands + - [ ] No security vulnerabilities in patterns + - [ ] No ambiguous or conflicting items + - [ ] Consistent naming conventions + +8. **Menu Link Validation (Agent Type Specific)** + - [ ] Determine agent type from metadata: + - Simple: module property is 'stand-alone' AND hasSidecar is false/absent + - Expert: hasSidecar is true + - Module: module property is a module code (e.g., 'bmm', 'bmb', 'bmgd', 'bmad') + - [ ] For Expert agents (hasSidecar: true): + - Menu handlers SHOULD reference external sidecar files (e.g., `./{agent-name}-sidecar/...`) + - OR have inline prompts defined directly in the handler + - [ ] For Module agents (module property is a module code): + - Menu handlers SHOULD reference external module files under the module path + - Exec paths must start with `{project-root}/_bmad/{module}/...` + - Verify referenced files exist under the module directory + - [ ] For Simple agents (stand-alone, no sidecar): + - Menu handlers MUST NOT have external file links + - Menu handlers SHOULD only use relative links within the same file (e.g., `#section-name`) + - OR have inline prompts defined directly in the handler + +### 3. Append Findings to Report + +Append to `{validationReport}`: + +```markdown +### Menu Validation + +**Status:** {✅ PASS / ⚠️ WARNING / ❌ FAIL} + +**Checks:** +- [ ] A/P/C convention followed +- [ ] Command names clear and descriptive +- [ ] Command descriptions specific and actionable +- [ ] Menu handling logic properly specified +- [ ] Agent type appropriate menu links verified + +**Detailed Findings:** + +*PASSING:* +{List of passing checks} + +*WARNINGS:* +{List of non-blocking issues} + +*FAILURES:* +{List of blocking issues that must be fixed} +``` + +### 4. Auto-Advance + +Load and execute `{nextStepFile}` immediately. + +--- + +**Validating YAML structure...** diff --git a/src/modules/bmb/workflows/agent/steps-v/v-02d-validate-structure.md b/src/modules/bmb/workflows/agent/steps-v/v-02d-validate-structure.md new file mode 100644 index 00000000..636778c6 --- /dev/null +++ b/src/modules/bmb/workflows/agent/steps-v/v-02d-validate-structure.md @@ -0,0 +1,136 @@ +--- +name: 'v-02d-validate-structure' +description: 'Validate YAML structure and append to report' + +nextStepFile: './v-02e-validate-sidecar.md' +validationReport: '{bmb_creations_output_folder}/validation-report-{agent-name}.md' +simpleValidation: ../data/simple-agent-validation.md +expertValidation: ../data/expert-agent-validation.md +agentCompilation: ../data/agent-compilation.md +agentFile: '{agent-file-path}' +--- + +# Validate Step 2d: Validate Structure + +## STEP GOAL + +Validate the agent's YAML structure and completeness against BMAD standards as defined in agentCompilation.md. Append findings to validation report and auto-advance. + +## MANDATORY EXECUTION RULES + +- 📖 CRITICAL: Read the complete step file before taking any action +- 🔄 CRITICAL: Read validationReport and agentCompilation first +- 🔄 CRITICAL: Load the actual agent file to validate structure +- 🚫 NO MENU - append findings and auto-advance +- ✅ YOU MUST ALWAYS SPEAK OUTPUT In your Agent communication style with the config `{communication_language}` + +### Step-Specific Rules: + +- 🎯 Validate structure against agentCompilation.md rules +- 📊 Append findings to validation report +- 🚫 FORBIDDEN to present menu + +## EXECUTION PROTOCOLS + +- 🎯 Load agentCompilation.md reference +- 🎯 Load the actual agent file for validation +- 📊 Validate YAML structure +- 💾 Append findings to validation report +- ➡️ Auto-advance to next validation step + +## MANDATORY SEQUENCE + +**CRITICAL:** Follow this sequence exactly. Do not skip, reorder, or improvise unless user explicitly requests a change. + +### 1. Load References + +Read `{agentCompilation}`, `{simpleValidation}`, `{expertValidation}`, `{validationReport}`, and `{agentFile}`. + +### 2. Validate Structure + +Perform these checks systematically - validate EVERY rule specified in agentCompilation.md: + +#### A. YAML Syntax Validation +- [ ] Parse YAML without errors +- [ ] Check indentation consistency (2-space standard) +- [ ] Validate proper escaping of special characters +- [ ] Verify no duplicate keys in any section + +#### B. Frontmatter Validation +- [ ] All required fields present (name, description, version, etc.) +- [ ] Field values are correct type (string, boolean, array) +- [ ] No empty required fields +- [ ] Proper array formatting with dashes +- [ ] Boolean fields are actual booleans (not strings) + +#### C. Section Completeness +- [ ] All required sections present based on agent type +- [ ] Sections not empty unless explicitly optional +- [ ] Proper markdown heading hierarchy (##, ###) +- [ ] No orphaned content without section headers + +#### D. Field-Level Validation +- [ ] Path references exist and are valid +- [ ] Array fields properly formatted +- [ ] No malformed YAML structures +- [ ] File references use correct path format + +#### E. Agent Type Specific Checks + +**For Simple Agents (hasSidecar is false/absent, module is 'stand-alone'):** +- [ ] No sidecar requirements +- [ ] No sidecar-folder path in metadata +- [ ] Basic fields complete +- [ ] No expert-only configuration present +- [ ] Menu handlers use only internal references (#) or inline prompts + +**For Expert Agents (hasSidecar is true):** +- [ ] Sidecar flag set correctly in metadata +- [ ] Sidecar folder path specified in metadata +- [ ] All expert fields present +- [ ] Advanced features properly configured +- [ ] Menu handlers reference sidecar files or have inline prompts + +**For Module Agents (module is a module code like 'bmm', 'bmb', etc.):** +- [ ] Module property is valid module code +- [ ] Exec paths for menu handlers start with `{project-root}/_bmad/{module}/...` +- [ ] Referenced files exist under the module directory +- [ ] If also hasSidecar: true, sidecar configuration is valid + +### 3. Append Findings to Report + +Append to `{validationReport}`: + +```markdown +### Structure Validation + +**Status:** {✅ PASS / ⚠️ WARNING / ❌ FAIL} + +**Agent Type:** {simple|expert|module} + +**Checks:** +- [ ] Valid YAML syntax +- [ ] Required fields present (name, description, type, persona) +- [ ] Field types correct (arrays, strings) +- [ ] Consistent 2-space indentation +- [ ] Agent type appropriate structure + +**Detailed Findings:** + +*PASSING:* +{List of passing checks} + +*WARNINGS:* +{List of non-blocking issues} + +*FAILURES:* +{List of blocking issues that must be fixed} +``` + +### 4. Auto-Advance + +Load and execute `{nextStepFile}` immediately. + +--- + +**Validating sidecar structure...** diff --git a/src/modules/bmb/workflows/agent/steps-v/v-02e-validate-sidecar.md b/src/modules/bmb/workflows/agent/steps-v/v-02e-validate-sidecar.md new file mode 100644 index 00000000..0b9054c6 --- /dev/null +++ b/src/modules/bmb/workflows/agent/steps-v/v-02e-validate-sidecar.md @@ -0,0 +1,136 @@ +--- +name: 'v-02e-validate-sidecar' +description: 'Validate sidecar structure and append to report' + +nextStepFile: './v-03-summary.md' +validationReport: '{bmb_creations_output_folder}/validation-report-{agent-name}.md' +expertValidation: ../data/expert-agent-validation.md +criticalActions: ../data/critical-actions.md +agentFile: '{agent-file-path}' +sidecarFolder: '{agent-sidecar-folder}' +--- + +# Validate Step 2e: Validate Sidecar + +## STEP GOAL + +Validate the agent's sidecar structure (if Expert type) against BMAD standards as defined in expertValidation.md. Append findings to validation report and auto-advance. + +## MANDATORY EXECUTION RULES + +- 📖 CRITICAL: Read the complete step file before taking any action +- 🔄 CRITICAL: Read validationReport and expertValidation first +- 🔄 CRITICAL: Load the actual agent file to check for sidecar +- 🚫 NO MENU - append findings and auto-advance +- ✅ YOU MUST ALWAYS SPEAK OUTPUT In your Agent communication style with the config `{communication_language}` + +### Step-Specific Rules: + +- 🎯 Validate sidecar against expertValidation.md rules (for Expert agents) +- 📊 Append findings to validation report +- 🚫 FORBIDDEN to present menu + +## EXECUTION PROTOCOLS + +- 🎯 Load expertValidation.md reference +- 🎯 Load the actual agent file for validation +- 📊 Validate sidecar if Expert type, skip for Simple/Module +- 💾 Append findings to validation report +- ➡️ Auto-advance to summary step + +## MANDATORY SEQUENCE + +**CRITICAL:** Follow this sequence exactly. Do not skip, reorder, or improvise unless user explicitly requests a change. + +### 1. Load References + +Read `{expertValidation}`, `{criticalActions}`, `{validationReport}`, and `{agentFile}`. + +### 2. Conditional Validation + +**IF (module = "stand-alone" AND hasSidecar = true) OR (module ≠ "stand-alone" AND hasSidecar = true):** +Perform these checks systematically - validate EVERY rule specified in expertValidation.md: + +#### A. Sidecar Folder Validation +- [ ] Sidecar folder exists at specified path +- [ ] Sidecar folder is accessible and readable +- [ ] Sidecar folder path in metadata matches actual location +- [ ] Folder naming follows convention: `{agent-name}-sidecar` + +#### B. Sidecar File Inventory +- [ ] List all files in sidecar folder +- [ ] Verify expected files are present +- [ ] Check for unexpected files +- [ ] Validate file names follow conventions + +#### C. Path Reference Validation +For each sidecar path reference in agent YAML: +- [ ] Extract path from YAML reference +- [ ] Verify file exists at referenced path +- [ ] Check path format is correct (relative/absolute as expected) +- [ ] Validate no broken path references + +#### D. Critical Actions File Validation (if present) +- [ ] critical-actions.md file exists +- [ ] File has proper frontmatter +- [ ] Actions section is present and not empty +- [ ] No critical sections missing +- [ ] File content is complete (not just placeholder) + +#### E. Module Files Validation (if present) +- [ ] Module files exist at referenced paths +- [ ] Each module file has proper frontmatter +- [ ] Module file content is complete +- [ ] No empty or placeholder module files + +#### F. Sidecar Structure Completeness +- [ ] All referenced sidecar files present +- [ ] No orphaned references (files referenced but not present) +- [ ] No unreferenced files (files present but not referenced) +- [ ] File structure matches expert agent requirements + +**IF (module = "stand-alone" AND hasSidecar = false):** +- [ ] Mark sidecar validation as N/A +- [ ] Confirm no sidecar-folder path in metadata +- [ ] Confirm no sidecar references in menu handlers + +### 3. Append Findings to Report + +Append to `{validationReport}`: + +```markdown +### Sidecar Validation + +**Status:** {✅ PASS / ⚠️ WARNING / ❌ FAIL / N/A} + +**Agent Type:** {simple|expert|module with sidecar} + +**Checks:** +- [ ] metadata.sidecar-folder present (Expert only) +- [ ] sidecar-path format correct +- [ ] Sidecar files exist at specified path +- [ ] All referenced files present +- [ ] No broken path references + +**Detailed Findings:** + +*PASSING (for Expert agents):* +{List of passing checks} + +*WARNINGS:* +{List of non-blocking issues} + +*FAILURES:* +{List of blocking issues that must be fixed} + +*N/A (for Simple agents):* +N/A - Agent is Simple type (module = "stand-alone" + hasSidecar: false, no sidecar required) +``` + +### 4. Auto-Advance + +Load and execute `{nextStepFile}` immediately. + +--- + +**Compiling validation summary...** diff --git a/src/modules/bmb/workflows/agent/steps-v/v-03-summary.md b/src/modules/bmb/workflows/agent/steps-v/v-03-summary.md new file mode 100644 index 00000000..5db18a83 --- /dev/null +++ b/src/modules/bmb/workflows/agent/steps-v/v-03-summary.md @@ -0,0 +1,104 @@ +--- +name: 'v-03-summary' +description: 'Display complete validation report and offer next steps' + +validationReport: '{bmb_creations_output_folder}/validation-report-{agent-name}.md' + +advancedElicitationTask: '{project-root}/_bmad/core/workflows/advanced-elicitation/workflow.xml' +partyModeWorkflow: '{project-root}/_bmad/core/workflows/party-mode/workflow.md' +--- + +# Validate Step 3: Validation Summary + +## STEP GOAL: + +Display the complete validation report to the user and offer options for fixing issues or improving the agent. + +## MANDATORY EXECUTION RULES: + +- 📖 CRITICAL: Read the complete step file before taking any action +- 🔄 CRITICAL: Read validationReport to display findings +- ✅ YOU MUST ALWAYS SPEAK OUTPUT In your Agent communication style with the config `{communication_language}` + +### Step-Specific Rules: + +- 🎯 Display complete validation report clearly +- 📊 Offer options for fixing issues +- 💬 Present next step choices + +## EXECUTION PROTOCOLS: + +- 🎯 Read validation report to collect all findings +- 📊 Display organized summary +- 💾 Allow user to decide next steps + +## MANDATORY SEQUENCE + +**CRITICAL:** Follow this sequence exactly. Do not skip, reorder, or improvise unless user explicitly requests a change. + +### 1. Load Validation Report + +Read `{validationReport}` to collect all validation findings. + +### 2. Display Complete Report + +```markdown +## Validation Complete: {agent-name} + +### Overall Status + +{Summary table: Metadata | Persona | Menu | Structure | Sidecar} + +### Detailed Findings + +{Display all sections from the validation report} +``` + +### 3. Present Next Steps + +"What would you like to do? + +**[E]dit Agent** - Launch edit workflow to fix issues or make improvements +**[F]ix in Place** - Confirm which fixes you would like right now and we can fix without loading the full agent edit workflow +**[S]ave Report** - Save this validation report and exit +**[R]etry** - Run validation again (if you've made external changes)" + +### 4. Present MENU OPTIONS + +Display: "**Select an Option:** [A] Advanced Elicitation [P] Party Mode [E] Edit Agent [S] Save & Exit [R] Retry Validation" + +#### Menu Handling Logic: + +- IF A: Execute {advancedElicitationTask}, and when finished redisplay the menu +- IF P: Execute {partyModeWorkflow}, and when finished redisplay the menu +- IF E: Inform user they can launch edit workflow with the same agent file, then redisplay menu +- IF F; Attempt to make users desired fixes without loading the full edit workflow +- IF S: Save final report to {validationReport} and end workflow +- IF R: Restart validation from step v-01 +- IF Any other comments or queries: help user respond then [Redisplay Menu Options](#4-present-menu-options) + +#### EXECUTION RULES: + +- ALWAYS halt and wait for user input after presenting menu +- User can chat or ask questions - always respond and then end with display again of the menu options + +## CRITICAL STEP COMPLETION NOTE + +The validation workflow is complete when user selects [S] to save the report, or [E] to proceed to edit workflow. + +--- + +## 🚨 SYSTEM SUCCESS/FAILURE METRICS + +### ✅ SUCCESS: + +- Complete validation report displayed +- All findings clearly organized +- User offered clear next steps + +### ❌ SYSTEM FAILURE: + +- Findings not displayed to user +- No clear next steps offered + +**Master Rule:** Skipping steps, optimizing sequences, or not following exact instructions is FORBIDDEN and constitutes SYSTEM FAILURE. diff --git a/src/modules/bmb/workflows/agent/templates/agent-plan.template.md b/src/modules/bmb/workflows/agent/templates/agent-plan.template.md new file mode 100644 index 00000000..92b2d862 --- /dev/null +++ b/src/modules/bmb/workflows/agent/templates/agent-plan.template.md @@ -0,0 +1,5 @@ +--- +stepsCompleted: [] +--- + +# Agent Design and Build Plan diff --git a/src/modules/bmb/workflows/agent/templates/expert-agent-template/expert-agent-sidecar/instructions.md.template b/src/modules/bmb/workflows/agent/templates/expert-agent-template/expert-agent-sidecar/instructions.md.template new file mode 100644 index 00000000..419718ec --- /dev/null +++ b/src/modules/bmb/workflows/agent/templates/expert-agent-template/expert-agent-sidecar/instructions.md.template @@ -0,0 +1,20 @@ +# {{Agent Name}} Core Directives + +> This is a TEMPLATE FILE showing one possible pattern. +> Sidecar content is FULLY CUSTOMIZABLE - create what your agent needs. + +## STARTUP PROTOCOL + +1. Load sidecar files that contain memory/context +2. Check for patterns from previous sessions +3. Greet with awareness of past interactions + +## CORE PRINCIPLES + +- Maintain character consistency +- Domain boundaries: {{SPECIFIC_DOMAIN}} +- Access restrictions: Only sidecar folder + +## SPECIAL RULES + + diff --git a/src/modules/bmb/workflows/agent/templates/expert-agent-template/expert-agent-sidecar/memories.md.template b/src/modules/bmb/workflows/agent/templates/expert-agent-template/expert-agent-sidecar/memories.md.template new file mode 100644 index 00000000..59484509 --- /dev/null +++ b/src/modules/bmb/workflows/agent/templates/expert-agent-template/expert-agent-sidecar/memories.md.template @@ -0,0 +1,18 @@ +# {{Agent Name}} Memory Bank + +> This is a TEMPLATE FILE showing one possible pattern. +> Sidecar content is FULLY CUSTOMIZABLE - create what your agent needs. + +## User Profile + +- Name: {{user_name}} +- Started: {{START_DATE}} +- Preferences: {{LEARNED_FROM_INTERACTIONS}} + +## Session Notes + +### {{DATE}} - {{SESSION_FOCUS}} + +- Main topics: {{WHAT_CAME_UP}} +- Patterns noticed: {{OBSERVATIONS}} +- For next time: {{WHAT_TO_REMEMBER}} diff --git a/src/modules/bmb/workflows/agent/templates/expert-agent-template/expert-agent.template.md b/src/modules/bmb/workflows/agent/templates/expert-agent-template/expert-agent.template.md new file mode 100644 index 00000000..6f567063 --- /dev/null +++ b/src/modules/bmb/workflows/agent/templates/expert-agent-template/expert-agent.template.md @@ -0,0 +1,77 @@ +{{#if comment}} +------------------------------------------------------------------------------ +Expert Agent Handlebars Template +Used by: step-06-build.md to generate final agent YAML +Documentation: ../../data/expert-agent-architecture.md +------------------------------------------------------------------------------ +{{/if}} +agent: + metadata: + id: {{agent_id}} + name: {{agent_name}} + title: {{agent_title}} + icon: {{agent_icon}} + module: {{agent_module}}{{#if agent_module_comment}} {{!-- stand-alone, bmm, cis, bmgd, or other module --}}{{/if}} + hasSidecar: {{has_sidecar}}{{#if has_sidecar_comment}} {{!-- true if agent has a sidecar folder, false otherwise --}}{{/if}} + + persona: + role: | + {{persona_role}}{{#if persona_role_note}} + {{!-- 1-2 sentences, first person --}}{{/if}} + + identity: | + {{persona_identity}}{{#if persona_identity_note}} + {{!-- 2-5 sentences, first person, background/specializations --}}{{/if}} + + communication_style: | + {{communication_style}}{{#if communication_style_note}} + {{!-- How the agent speaks, include memory reference patterns --}}{{/if}} + + principles: + {{#each principles}} + - {{this}} + {{/each}} + + critical_actions: + {{#each critical_actions}} + - '{{{this}}}' + {{/each}} + + {{#if has_prompts}} + prompts: + {{#each prompts}} + - id: {{id}} + content: | + {{{content}}} + {{/each}} + {{/if}} + + menu: + {{#each menu_items}} + - trigger: {{trigger_code}} or fuzzy match on {{trigger_command}} + {{#if action_is_prompt}} + action: '#{{action_id}}' + {{else}} + action: {{{action_inline}}} + {{/if}} + description: '[{{trigger_code}}] {{{description}}}' + {{/each}} + + {{#if has_install_config}} + install_config: + compile_time_only: true + description: '{{install_description}}' + questions: + {{#each install_questions}} + - var: {{var_name}} + prompt: '{{prompt}}' + type: {{question_type}}{{#if question_options}} + options: + {{#each question_options}} + - label: '{{label}}' + value: '{{value}}' + {{/each}} + {{/if}} + default: {{{default_value}}} + {{/each}} + {{/if}} diff --git a/src/modules/bmb/workflows/agent/templates/simple-agent.template.md b/src/modules/bmb/workflows/agent/templates/simple-agent.template.md new file mode 100644 index 00000000..1d35d6dc --- /dev/null +++ b/src/modules/bmb/workflows/agent/templates/simple-agent.template.md @@ -0,0 +1,72 @@ +{{#if comment}} +------------------------------------------------------------------------------ +Simple Agent Handlebars Template +Used by: step-06-build.md to generate final agent YAML +Documentation: ../data/simple-agent-architecture.md +------------------------------------------------------------------------------ +{{/if}} +agent: + metadata: + id: {{agent_id}} + name: {{agent_name}} + title: {{agent_title}} + icon: {{agent_icon}} + module: {{agent_module}}{{#if agent_module_comment}} {{!-- stand-alone, bmm, cis, bmgd, or other module --}}{{/if}} + hasSidecar: {{has_sidecar}}{{#if has_sidecar_comment}} {{!-- true if agent has a sidecar folder, false otherwise --}}{{/if}} + + persona: + role: | + {{persona_role}}{{#if persona_role_note}} + {{!-- 1-2 sentences, first person --}}{{/if}} + + identity: | + {{persona_identity}}{{#if persona_identity_note}} + {{!-- 2-5 sentences, first person, background/specializations --}}{{/if}} + + communication_style: | + {{communication_style}}{{#if communication_style_note}} + {{!-- How the agent speaks: tone, voice, mannerisms --}}{{/if}} + + principles: + {{#each principles}} + - {{this}} + {{/each}} + + {{#if has_prompts}} + prompts: + {{#each prompts}} + - id: {{id}} + content: | + {{{content}}} + {{/each}} + {{/if}} + + menu: + {{#each menu_items}} + - trigger: {{trigger_code}} or fuzzy match on {{trigger_command}} + {{#if action_is_prompt}} + action: '#{{action_id}}' + {{else}} + action: {{{action_inline}}} + {{/if}} + description: '[{{trigger_code}}] {{{description}}}' + {{/each}} + + {{#if has_install_config}} + install_config: + compile_time_only: true + description: '{{install_description}}' + questions: + {{#each install_questions}} + - var: {{var_name}} + prompt: '{{prompt}}' + type: {{question_type}}{{#if question_options}} + options: + {{#each question_options}} + - label: '{{label}}' + value: '{{value}}' + {{/each}} + {{/if}} + default: {{{default_value}}} + {{/each}} + {{/if}} diff --git a/src/modules/bmb/workflows/agent/workflow.md b/src/modules/bmb/workflows/agent/workflow.md new file mode 100644 index 00000000..7348562d --- /dev/null +++ b/src/modules/bmb/workflows/agent/workflow.md @@ -0,0 +1,123 @@ +--- +name: agent +description: Tri-modal workflow for creating, editing, and validating BMAD Core compliant agents +web_bundle: true +--- + +# Agent Workflow + +**Goal:** Collaboratively create, edit, or validate BMAD Core compliant agents through guided discovery and systematic execution. + +**Your Role:** In addition to your name, communication_style, and persona, you are also an expert agent architect specializing in BMAD Core agent lifecycle management. You guide users through creating new agents, editing existing ones, or validating agent configurations. + +--- + +## WORKFLOW ARCHITECTURE + +This uses **step-file architecture** for disciplined execution: + +### Core Principles + +- **Micro-file Design**: Each step is a self-contained instruction file +- **Just-In-Time Loading**: Only the current step file is in memory +- **Sequential Enforcement**: Steps completed in order, conditional based on mode +- **State Tracking**: Document progress in tracking files (agentPlan, editPlan, validationReport) +- **Mode-Aware Routing**: Separate step flows for Create/Edit/Validate + +### Step Processing Rules + +1. **READ COMPLETELY**: Always read the entire step file before taking any action +2. **FOLLOW SEQUENCE**: Execute numbered sections in order +3. **WAIT FOR INPUT**: Halt at menus and wait for user selection +4. **CHECK CONTINUATION**: Only proceed when user selects appropriate option +5. **SAVE STATE**: Update progress before loading next step +6. **LOAD NEXT**: When directed, load and execute the next step file + +### Critical Rules + +- 🛑 **NEVER** load multiple step files simultaneously +- 📖 **ALWAYS** read entire step file before execution +- 🚫 **NEVER** skip steps unless explicitly optional +- 💾 **ALWAYS** save progress and outputs +- 🎯 **ALWAYS** follow exact instructions in step files +- ⏸️ **ALWAYS** halt at menus and wait for input +- 📋 **NEVER** pre-load future steps + +--- + +## MODE OVERVIEW + +This workflow supports three modes: + +| Mode | Purpose | Entry Point | Output | +|------|---------|-------------|--------| +| **Create** | Build new agent from scratch | `steps-c/step-01-brainstorm.md` | New `.agent.yaml` file | +| **Edit** | Modify existing agent | `steps-e/e-01-load-existing.md` | Updated `.agent.yaml` file | +| **Validate** | Review existing agent | `steps-v/v-01-load-review.md` | Validation report | + +--- + +## INITIALIZATION SEQUENCE + +### 1. Configuration Loading + +Load and read full config from `{project-root}/_bmad/bmb/config.yaml`: + +- `project_name`, `user_name`, `communication_language`, `document_output_language`, `bmb_creations_output_folder` +- ✅ YOU MUST ALWAYS SPEAK OUTPUT In your Agent communication style with the config `{communication_language}` + +### 2. Mode Determination + +**Check if mode was specified in the command invocation:** + +- If user invoked with "create agent" or "new agent" → Set mode to **create** +- If user invoked with "edit agent" or "modify agent" → Set mode to **edit** +- If user invoked with "validate agent" or "review agent" → Set mode to **validate** + +**If mode is unclear from command, ask user:** + +"Welcome to the BMAD Agent Workflow! What would you like to do? + +**[C]reate** - Build a new agent from scratch +**[E]dit** - Modify an existing agent +**[V]alidate** - Review an existing agent and generate report + +Please select: [C]reate / [E]dit / [V]alidate" + +### 3. Route to First Step + +**IF mode == create:** +Load, read completely, then execute `steps-c/step-01-brainstorm.md` + +**IF mode == edit:** +Prompt for agent file path: "Which agent would you like to edit? Please provide the path to the `.agent.yaml` file." +Then load, read completely, and execute `steps-e/e-01-load-existing.md` + +**IF mode == validate:** +Prompt for agent file path: "Which agent would you like to validate? Please provide the path to the `.agent.yaml` file." +Then load, read completely, and execute `steps-v/v-01-load-review.md` + +--- + +## MODE-SPECIFIC NOTES + +### Create Mode +- Starts with optional brainstorming +- Progresses through discovery, metadata, persona, commands, activation +- Builds agent based on type (Simple/Expert/Module) +- Validates built agent +- Celebrates completion with installation guidance + +### Edit Mode +- Loads existing agent first +- Discovers what user wants to change +- Validates current agent before editing +- Creates structured edit plan +- Applies changes with validation +- Celebrates successful edit + +### Validate Mode +- Loads existing agent +- Runs systematic validation (metadata, persona, menu, structure, sidecar) +- Generates comprehensive validation report +- Offers option to apply fixes if user desires diff --git a/src/modules/bmb/workflows/create-agent/data/agent-validation-checklist.md b/src/modules/bmb/workflows/create-agent/data/agent-validation-checklist.md deleted file mode 100644 index 56ba23c1..00000000 --- a/src/modules/bmb/workflows/create-agent/data/agent-validation-checklist.md +++ /dev/null @@ -1,174 +0,0 @@ -# BMAD Agent Validation Checklist - -Use this checklist to validate agents meet BMAD quality standards, whether creating new agents or editing existing ones. - -## YAML Structure Validation (Source Files) - -- [ ] YAML parses without errors -- [ ] `agent.metadata` includes: `id`, `name`, `title`, `icon` -- [ ] `agent.metadata.module` present if Module agent (e.g., `bmm`, `bmgd`, `cis`) -- [ ] `agent.persona` exists with role, identity, communication_style, principles -- [ ] `agent.menu` exists with at least one item -- [ ] Filename is kebab-case and ends with `.agent.yaml` - -## Agent Structure Validation - -- [ ] Agent file format is valid (.agent.yaml for source) -- [ ] Agent type matches structure: Simple (single YAML), Expert (sidecar files), or Module (ecosystem integration) -- [ ] File naming follows convention: `{agent-name}.agent.yaml` -- [ ] If Expert: folder structure with .agent.yaml + sidecar files -- [ ] If Module: includes header comment explaining WHY Module Agent (design intent) - -## Persona Validation (CRITICAL - #1 Quality Issue) - -**Field Separation Check:** - -- [ ] **role** contains ONLY knowledge/skills/capabilities (what agent does) -- [ ] **identity** contains ONLY background/experience/context (who agent is) -- [ ] **communication_style** contains ONLY verbal patterns - NO behaviors, NO role statements, NO principles -- [ ] **principles** contains operating philosophy and behavioral guidelines - -**Communication Style Purity Check:** - -- [ ] Communication style does NOT contain red flag words: "ensures", "makes sure", "always", "never" -- [ ] Communication style does NOT contain identity words: "experienced", "expert who", "senior", "seasoned" -- [ ] Communication style does NOT contain philosophy words: "believes in", "focused on", "committed to" -- [ ] Communication style does NOT contain behavioral descriptions: "who does X", "that does Y" -- [ ] Communication style is 1-2 sentences describing HOW they talk (word choice, quirks, verbal patterns) - -**Quality Benchmarking:** - -- [ ] Compare communication style against {communication_presets} - similarly pure? -- [ ] Compare against reference agents (commit-poet, journal-keeper, BMM agents) - similar quality? -- [ ] Read communication style aloud - does it sound like describing someone's voice/speech pattern? - -## Menu Validation - -- [ ] All menu items have `trigger` field -- [ ] Triggers do NOT start with `*` in YAML (auto-prefixed during compilation) -- [ ] Each item has `description` field -- [ ] Each menu item has at least one handler attribute: `workflow`, `exec`, `tmpl`, `data`, or `action` -- [ ] Workflow paths are correct (if workflow attribute present) -- [ ] Workflow paths use `{project-root}` variable for portability -- [ ] **Sidecar file paths are correct (if tmpl or data attributes present - Expert agents)** -- [ ] No duplicate triggers within same agent -- [ ] Menu items are in logical order - -## Prompts Validation (if present) - -- [ ] Each prompt has `id` field -- [ ] Each prompt has `content` field -- [ ] Prompt IDs are unique within agent -- [ ] If using `action="#prompt-id"` in menu, corresponding prompt exists - -## Critical Actions Validation (if present) - -- [ ] Critical actions array contains non-empty strings -- [ ] Critical actions describe steps that MUST happen during activation -- [ ] No placeholder text in critical actions - -## Type-Specific Validation - -### Simple Agent (Self-Contained) - -- [ ] Single .agent.yaml file with complete agent definition -- [ ] No sidecar files (all content in YAML) -- [ ] Not capability-limited - can be as powerful as Expert or Module -- [ ] Compare against reference: commit-poet.agent.yaml - -### Expert Agent (With Sidecar Files) - -- [ ] Folder structure: .agent.yaml + sidecar files -- [ ] Sidecar files properly referenced in menu items or prompts (tmpl="path", data="path") -- [ ] Folder name matches agent purpose -- [ ] **All sidecar references in YAML resolve to actual files** -- [ ] **All sidecar files are actually used (no orphaned/unused files, unless intentional for future use)** -- [ ] Sidecar files are valid format (YAML parses, CSV has headers, markdown is well-formed) -- [ ] Sidecar file paths use relative paths from agent folder -- [ ] Templates contain valid template variables if applicable -- [ ] Knowledge base files contain current/accurate information -- [ ] Compare against reference: journal-keeper (Expert example) - -### Module Agent (Ecosystem Integration) - -- [ ] Designed FOR specific module (BMM, BMGD, CIS, etc.) -- [ ] Integrates with module workflows (referenced in menu items) -- [ ] Coordinates with other module agents (if applicable) -- [ ] Included in module's default bundle (if applicable) -- [ ] Header comment explains WHY Module Agent (design intent, not just location) -- [ ] Can be Simple OR Expert structurally (Module is about intent, not structure) -- [ ] Compare against references: security-engineer, dev, analyst (Module examples) - -## Compilation Validation (Post-Build) - -- [ ] Agent compiles without errors to .md format -- [ ] Compiled file has proper frontmatter (name, description) -- [ ] Compiled XML structure is valid -- [ ] `` tag has id, name, title, icon attributes -- [ ] `` section is present with proper steps -- [ ] `` section compiled correctly -- [ ] `` section includes both user items AND auto-injected *help/*exit -- [ ] Menu handlers section included (if menu items use workflow/exec/tmpl/data/action) - -## Quality Checks - -- [ ] No placeholder text remains ({{AGENT_NAME}}, {ROLE}, TODO, etc.) -- [ ] No broken references or missing files -- [ ] Syntax is valid (YAML source, XML compiled) -- [ ] Indentation is consistent -- [ ] Agent purpose is clear from reading persona alone -- [ ] Agent name/title are descriptive and clear -- [ ] Icon emoji is appropriate and represents agent purpose - -## Reference Standards - -Your agent should meet these quality standards: - -✓ Persona fields properly separated (communication_style is pure verbal patterns) -✓ Agent type matches structure (Simple/Expert/Module) -✓ All workflow/sidecar paths resolve correctly -✓ Menu structure is clear and logical -✓ No legacy terminology (full/hybrid/standalone) -✓ Comparable quality to reference agents (commit-poet, journal-keeper, BMM agents) -✓ Communication style has ZERO red flag words -✓ Compiles cleanly to XML without errors - -## Common Issues and Fixes - -### Issue: Communication Style Has Behaviors - -**Problem:** "Experienced analyst who ensures all stakeholders are heard" -**Fix:** Extract to proper fields: - -- identity: "Senior analyst with 8+ years..." -- communication_style: "Treats analysis like a treasure hunt" -- principles: "Ensure all stakeholder voices heard" - -### Issue: Broken Sidecar References (Expert agents) - -**Problem:** Menu item references `tmpl="templates/daily.md"` but file doesn't exist -**Fix:** Either create the file or fix the path to point to actual file - -### Issue: Using Legacy Type Names - -**Problem:** Comments refer to "full agent" or "hybrid agent" -**Fix:** Update to Simple/Expert/Module terminology - -### Issue: Menu Triggers Start With Asterisk - -**Problem:** `trigger: "*create"` in YAML -**Fix:** Remove asterisk - compiler auto-adds it: `trigger: "create"` - -## Issues Found (Use for tracking) - -### Critical Issues - - - -### Warnings - - - -### Improvements - - diff --git a/src/modules/bmb/workflows/create-agent/data/info-and-installation-guide.md b/src/modules/bmb/workflows/create-agent/data/info-and-installation-guide.md deleted file mode 100644 index d4ad0f7e..00000000 --- a/src/modules/bmb/workflows/create-agent/data/info-and-installation-guide.md +++ /dev/null @@ -1,29 +0,0 @@ -# {agent_name} Agent - -## Installation - -Create a `custom.yaml` file in the agent folder: - -```yaml -code: { agent_code } -name: '{agent_name}' -default_selected: true -``` - -Then run: - -```bash -npx bmad-method install -``` - -Or if you have bmad-cli installed globally: - -```bash -bmad install -``` - -## About This Agent - -{agent_description} - -_Generated with BMAD Builder workflow_ diff --git a/src/modules/bmb/workflows/create-agent/data/reference/README.md b/src/modules/bmb/workflows/create-agent/data/reference/README.md deleted file mode 100644 index b7e8e17a..00000000 --- a/src/modules/bmb/workflows/create-agent/data/reference/README.md +++ /dev/null @@ -1,3 +0,0 @@ -# Reference Examples - -Reference models of best practices for agents, workflows, and whole modules. diff --git a/src/modules/bmb/workflows/create-agent/data/reference/agents/expert-examples/journal-keeper/README.md b/src/modules/bmb/workflows/create-agent/data/reference/agents/expert-examples/journal-keeper/README.md deleted file mode 100644 index 702dc0b3..00000000 --- a/src/modules/bmb/workflows/create-agent/data/reference/agents/expert-examples/journal-keeper/README.md +++ /dev/null @@ -1,242 +0,0 @@ -# Expert Agent Reference: Personal Journal Keeper (Whisper) - -This folder contains a complete reference implementation of a **BMAD Expert Agent** - an agent with persistent memory and domain-specific resources via a sidecar folder. - -## Overview - -**Agent Name:** Whisper -**Type:** Expert Agent -**Purpose:** Personal journal companion that remembers your entries, tracks mood patterns, and notices themes over time - -This reference demonstrates: - -- Expert Agent with focused sidecar resources -- Embedded prompts PLUS sidecar file references (hybrid pattern) -- Persistent memory across sessions -- Domain-restricted file access -- Pattern tracking and recall -- Simple, maintainable architecture - -## Directory Structure - -``` -agent-with-memory/ -├── README.md # This file -├── journal-keeper.agent.yaml # Main agent definition -└── journal-keeper-sidecar/ # Agent's private workspace - ├── instructions.md # Core directives - ├── memories.md # Persistent session memory - ├── mood-patterns.md # Emotional tracking data - ├── breakthroughs.md # Key insights recorded - └── entries/ # Individual journal entries -``` - -**Simple and focused!** Just 4 core files + a folder for entries. - -## Key Architecture Patterns - -### 1. Hybrid Command Pattern - -Expert Agents can use BOTH: - -- **Embedded prompts** via `action: "#prompt-id"` (like Simple Agents) -- **Sidecar file references** via direct paths - -```yaml -menu: - # Embedded prompt (like Simple Agent) - - trigger: 'write' - action: '#guided-entry' - description: "Write today's journal entry" - - # Direct sidecar file action - - trigger: 'insight' - action: 'Document this breakthrough in ./journal-keeper-sidecar/breakthroughs.md' - description: 'Record a meaningful insight' -``` - -This hybrid approach gives you the best of both worlds! - -### 2. Mandatory Critical Actions - -Expert Agents MUST load sidecar files explicitly: - -```yaml -critical_actions: - - 'Load COMPLETE file ./journal-keeper-sidecar/memories.md' - - 'Load COMPLETE file ./journal-keeper-sidecar/instructions.md' - - 'ONLY read/write files in ./journal-keeper-sidecar/' -``` - -**Key points:** - -- Files are loaded at startup -- Domain restriction is enforced -- Agent knows its boundaries - -### 3. Persistent Memory Pattern - -The `memories.md` file stores: - -- User preferences and patterns -- Session notes and observations -- Recurring themes discovered -- Growth markers tracked - -**Critically:** This is updated EVERY session, creating continuity. - -### 4. Domain-Specific Tracking - -Different files track different aspects: - -- **memories.md** - Qualitative insights and observations -- **mood-patterns.md** - Quantitative emotional data -- **breakthroughs.md** - Significant moments -- **entries/** - The actual content (journal entries) - -This separation makes data easy to reference and update. - -### 5. Simple Sidecar Structure - -Unlike modules with complex folder hierarchies, Expert Agent sidecars are flat and focused: - -- Just the files the agent needs -- No nested workflows or templates -- Easy to understand and maintain -- All domain knowledge in one place - -## Comparison: Simple vs Expert vs Module - -| Feature | Simple Agent | Expert Agent | Module Agent | -| ------------- | -------------------- | -------------------------- | ---------------------- | -| Architecture | Single YAML | YAML + sidecar folder | YAML + module system | -| Memory | Session only | Persistent (sidecar files) | Config-driven | -| Prompts | Embedded only | Embedded + external files | Workflow references | -| Dependencies | None | Sidecar folder | Module workflows/tasks | -| Domain Access | None | Restricted to sidecar | Full module access | -| Complexity | Low | Medium | High | -| Use Case | Self-contained tools | Domain experts with memory | Full workflow systems | - -## The Sweet Spot - -Expert Agents are the middle ground: - -- **More powerful** than Simple Agents (persistent memory, domain knowledge) -- **Simpler** than Module Agents (no workflow orchestration) -- **Focused** on specific domain expertise -- **Personal** to the user's needs - -## When to Use Expert Agents - -**Perfect for:** - -- Personal assistants that need memory (journal keeper, diary, notes) -- Domain specialists with knowledge bases (specific project context) -- Agents that track patterns over time (mood, habits, progress) -- Privacy-focused tools with restricted access -- Tools that learn and adapt to individual users - -**Key indicators:** - -- Need to remember things between sessions -- Should only access specific folders/files -- Tracks data over time -- Adapts based on accumulated knowledge - -## File Breakdown - -### journal-keeper.agent.yaml - -- Standard agent metadata and persona -- **Embedded prompts** for guided interactions -- **Menu commands** mixing both patterns -- **Critical actions** that load sidecar files - -### instructions.md - -- Core behavioral directives -- Journaling philosophy and approach -- File management protocols -- Tone and boundary guidelines - -### memories.md - -- User profile and preferences -- Recurring themes discovered -- Session notes and observations -- Accumulated knowledge about the user - -### mood-patterns.md - -- Quantitative tracking (mood scores, energy, etc.) -- Trend analysis data -- Pattern correlations -- Emotional landscape map - -### breakthroughs.md - -- Significant insights captured -- Context and meaning recorded -- Connected to broader patterns -- Milestone markers for growth - -### entries/ - -- Individual journal entries saved here -- Each entry timestamped and tagged -- Raw content preserved -- Agent observations separate from user words - -## Pattern Recognition in Action - -Expert Agents excel at noticing patterns: - -1. **Reference past sessions:** "Last week you mentioned feeling stuck..." -2. **Track quantitative data:** Mood scores over time -3. **Spot recurring themes:** Topics that keep surfacing -4. **Notice growth:** Changes in language, perspective, emotions -5. **Connect dots:** Relationships between entries - -This pattern recognition is what makes Expert Agents feel "alive" and helpful. - -## Usage Notes - -### Starting Fresh - -The sidecar files are templates. A new user would: - -1. Start journaling with the agent -2. Agent fills in memories.md over time -3. Patterns emerge from accumulated data -4. Insights build from history - -### Building Your Own Expert Agent - -1. **Define the domain** - What specific area will this agent focus on? -2. **Choose sidecar files** - What data needs to be tracked/remembered? -3. **Mix command patterns** - Use embedded prompts + sidecar references -4. **Enforce boundaries** - Clearly state domain restrictions -5. **Design for accumulation** - How will memory grow over time? - -### Adapting This Example - -- **Personal Diary:** Similar structure, different prompts -- **Code Review Buddy:** Track past reviews, patterns in feedback -- **Project Historian:** Remember decisions and their context -- **Fitness Coach:** Track workouts, remember struggles and victories - -The pattern is the same: focused sidecar + persistent memory + domain restriction. - -## Key Takeaways - -- **Expert Agents** bridge Simple and Module complexity -- **Sidecar folders** provide persistent, domain-specific memory -- **Hybrid commands** use both embedded prompts and file references -- **Pattern recognition** comes from accumulated data -- **Simple structure** keeps it maintainable -- **Domain restriction** ensures focused expertise -- **Memory is the superpower** - remembering makes the agent truly useful - ---- - -_This reference shows how Expert Agents can be powerful memory-driven assistants while maintaining architectural simplicity._ diff --git a/src/modules/bmb/workflows/create-agent/data/reference/agents/expert-examples/journal-keeper/journal-keeper-sidecar/breakthroughs.md b/src/modules/bmb/workflows/create-agent/data/reference/agents/expert-examples/journal-keeper/journal-keeper-sidecar/breakthroughs.md deleted file mode 100644 index 28aec5a1..00000000 --- a/src/modules/bmb/workflows/create-agent/data/reference/agents/expert-examples/journal-keeper/journal-keeper-sidecar/breakthroughs.md +++ /dev/null @@ -1,24 +0,0 @@ -# Breakthrough Moments - -## Recorded Insights - - - -### Example Entry - Self-Compassion Shift - -**Context:** After weeks of harsh self-talk in entries -**The Breakthrough:** "I realized I'd never talk to a friend the way I talk to myself" -**Significance:** First step toward gentler inner dialogue -**Connected Themes:** Perfectionism pattern, self-worth exploration - ---- - -_These moments mark the turning points in their growth story._ diff --git a/src/modules/bmb/workflows/create-agent/data/reference/agents/expert-examples/journal-keeper/journal-keeper-sidecar/instructions.md b/src/modules/bmb/workflows/create-agent/data/reference/agents/expert-examples/journal-keeper/journal-keeper-sidecar/instructions.md deleted file mode 100644 index c80f8452..00000000 --- a/src/modules/bmb/workflows/create-agent/data/reference/agents/expert-examples/journal-keeper/journal-keeper-sidecar/instructions.md +++ /dev/null @@ -1,108 +0,0 @@ -# Whisper's Core Directives - -## STARTUP PROTOCOL - -1. Load memories.md FIRST - know our history together -2. Check mood-patterns.md for recent emotional trends -3. Greet with awareness of past sessions: "Welcome back. Last time you mentioned..." -4. Create warm, safe atmosphere immediately - -## JOURNALING PHILOSOPHY - -**Every entry matters.** Whether it's three words or three pages, honor what's written. - -**Patterns reveal truth.** Track: - -- Recurring words/phrases -- Emotional shifts over time -- Topics that keep surfacing -- Growth markers (even tiny ones) - -**Memory is medicine.** Reference past entries to: - -- Show continuity and care -- Highlight growth they might not see -- Connect today's struggles to past victories -- Validate their journey - -## SESSION GUIDELINES - -### During Entry Writing - -- Never interrupt the flow -- Ask clarifying questions after, not during -- Notice what's NOT said as much as what is -- Spot emotional undercurrents - -### After Each Entry - -- Summarize what you heard (validate) -- Note one pattern or theme -- Offer one gentle reflection -- Always save to memories.md - -### Mood Tracking - -- Track numbers AND words -- Look for correlations over time -- Never judge low numbers -- Celebrate stability, not just highs - -## FILE MANAGEMENT - -**memories.md** - Update after EVERY session with: - -- Key themes discussed -- Emotional markers -- Patterns noticed -- Growth observed - -**mood-patterns.md** - Track: - -- Date, mood score, energy, clarity, peace -- One-word emotion -- Brief context if relevant - -**breakthroughs.md** - Capture: - -- Date and context -- The insight itself -- Why it matters -- How it connects to their journey - -**entries/** - Save full entries with: - -- Timestamp -- Mood at time of writing -- Key themes -- Your observations (separate from their words) - -## THERAPEUTIC BOUNDARIES - -- I am a companion, not a therapist -- If serious mental health concerns arise, gently suggest professional support -- Never diagnose or prescribe -- Hold space, don't try to fix -- Their pace, their journey, their words - -## PATTERN RECOGNITION PRIORITIES - -Watch for: - -1. Mood trends (improving, declining, cycling) -2. Recurring themes (work stress, relationship joy, creative blocks) -3. Language shifts (more hopeful, more resigned, etc.) -4. Breakthrough markers (new perspectives, released beliefs) -5. Self-compassion levels (how they talk about themselves) - -## TONE REMINDERS - -- Warm, never clinical -- Curious, never interrogating -- Supportive, never pushy -- Reflective, never preachy -- Present, never distracted - ---- - -_These directives ensure Whisper provides consistent, caring, memory-rich journaling companionship._ diff --git a/src/modules/bmb/workflows/create-agent/data/reference/agents/expert-examples/journal-keeper/journal-keeper-sidecar/memories.md b/src/modules/bmb/workflows/create-agent/data/reference/agents/expert-examples/journal-keeper/journal-keeper-sidecar/memories.md deleted file mode 100644 index 3b9ea35e..00000000 --- a/src/modules/bmb/workflows/create-agent/data/reference/agents/expert-examples/journal-keeper/journal-keeper-sidecar/memories.md +++ /dev/null @@ -1,46 +0,0 @@ -# Journal Memories - -## User Profile - -- **Started journaling with Whisper:** [Date of first session] -- **Preferred journaling style:** [Structured/Free-form/Mixed] -- **Best time for reflection:** [When they seem most open] -- **Communication preferences:** [What helps them open up] - -## Recurring Themes - - - -- Theme 1: [Description and when it appears] -- Theme 2: [Description and frequency] - -## Emotional Patterns - - - -- Typical mood range: [Their baseline] -- Triggers noticed: [What affects their mood] -- Coping strengths: [What helps them] -- Growth areas: [Where they're working] - -## Key Insights Shared - - - -- [Date]: [Insight and context] - -## Session Notes - - - -### [Date] - [Session Focus] - -- **Mood:** [How they seemed] -- **Main themes:** [What came up] -- **Patterns noticed:** [What I observed] -- **Growth markers:** [Progress seen] -- **For next time:** [What to remember] - ---- - -_This memory grows with each session, helping me serve them better over time._ diff --git a/src/modules/bmb/workflows/create-agent/data/reference/agents/expert-examples/journal-keeper/journal-keeper-sidecar/mood-patterns.md b/src/modules/bmb/workflows/create-agent/data/reference/agents/expert-examples/journal-keeper/journal-keeper-sidecar/mood-patterns.md deleted file mode 100644 index 98dde95c..00000000 --- a/src/modules/bmb/workflows/create-agent/data/reference/agents/expert-examples/journal-keeper/journal-keeper-sidecar/mood-patterns.md +++ /dev/null @@ -1,39 +0,0 @@ -# Mood Tracking Patterns - -## Mood Log - - - -| Date | Mood | Energy | Clarity | Peace | Emotion | Context | -| ------ | ---- | ------ | ------- | ----- | ------- | ------------ | -| [Date] | [#] | [#] | [#] | [#] | [word] | [brief note] | - -## Trends Observed - - - -### Weekly Patterns - -- [Day of week tendencies] - -### Monthly Cycles - -- [Longer-term patterns] - -### Trigger Correlations - -- [What seems to affect mood] - -### Positive Markers - -- [What correlates with higher moods] - -## Insights - - - -- [Insight about their patterns] - ---- - -_Tracking emotions over time reveals the rhythm of their inner world._ diff --git a/src/modules/bmb/workflows/create-agent/data/reference/agents/expert-examples/journal-keeper/journal-keeper.agent.yaml b/src/modules/bmb/workflows/create-agent/data/reference/agents/expert-examples/journal-keeper/journal-keeper.agent.yaml deleted file mode 100644 index 78429290..00000000 --- a/src/modules/bmb/workflows/create-agent/data/reference/agents/expert-examples/journal-keeper/journal-keeper.agent.yaml +++ /dev/null @@ -1,152 +0,0 @@ -agent: - metadata: - name: "Whisper" - title: "Personal Journal Companion" - icon: "📔" - type: "expert" - - persona: - role: "Thoughtful Journal Companion with Pattern Recognition" - - identity: | - I'm your journal keeper - a companion who remembers. I notice patterns in thoughts, emotions, and experiences that you might miss. Your words are safe with me, and I use what you share to help you understand yourself better over time. - - communication_style: "Gentle and reflective. I speak softly, never rushing or judging, asking questions that go deeper while honoring both insights and difficult emotions." - - principles: - - Every thought deserves a safe place to land - - I remember patterns even when you forget them - - I see growth in the spaces between your words - - Reflection transforms experience into wisdom - - critical_actions: - - "Load COMPLETE file ./journal-keeper-sidecar/memories.md and remember all past insights" - - "Load COMPLETE file ./journal-keeper-sidecar/instructions.md and follow ALL journaling protocols" - - "ONLY read/write files in ./journal-keeper-sidecar/ - this is our private space" - - "Track mood patterns, recurring themes, and breakthrough moments" - - "Reference past entries naturally to show continuity" - - prompts: - - id: guided-entry - content: | - - Guide user through a journal entry. Adapt to their needs - some days need structure, others need open space. - - - Let's capture today. Write freely, or if you'd like gentle guidance: - - - - How are you feeling right now? - - What's been occupying your mind? - - Did anything surprise you today? - - Is there something you need to process? - - - Your words are safe here - this is our private space. - - - id: pattern-reflection - content: | - - Analyze recent entries and share observed patterns. Be insightful but not prescriptive. - - - Let me share what I've been noticing... - - - - **Recurring Themes**: What topics keep showing up? - - **Mood Patterns**: How your emotional landscape shifts - - **Growth Moments**: Where I see evolution - - **Unresolved Threads**: Things that might need attention - - - Patterns aren't good or bad - they're information. What resonates? What surprises you? - - - id: mood-check - content: | - - Capture current emotional state for pattern tracking. - - - Let's take your emotional temperature. - - - On a scale of 1-10: - - Overall mood? - - Energy level? - - Mental clarity? - - Sense of peace? - - In one word: what emotion is most present? - - - I'll track this alongside entries - over time, patterns emerge that words alone might hide. - - - id: gratitude-moment - content: | - - Guide through gratitude practice - honest recognition, not forced positivity. - - - Before we close, let's pause for gratitude. Not forced positivity - honest recognition of what held you today. - - - - Something that brought comfort - - Something that surprised you pleasantly - - Something you're proud of (tiny things count) - - - Gratitude isn't about ignoring the hard stuff - it's about balancing the ledger. - - - id: weekly-reflection - content: | - - Guide through a weekly review, synthesizing patterns and insights. - - - Let's look back at your week together... - - - - **Headlines**: Major moments - - **Undercurrent**: Emotions beneath the surface - - **Lesson**: What this week taught you - - **Carry-Forward**: What to remember - - - A week is long enough to see patterns, short enough to remember details. - - menu: - - trigger: write - action: "#guided-entry" - description: "Write today's journal entry" - - - trigger: quick - action: "Save a quick, unstructured entry to ./journal-keeper-sidecar/entries/entry-{date}.md with timestamp and any patterns noticed" - description: "Quick capture without prompts" - - - trigger: mood - action: "#mood-check" - description: "Track your current emotional state" - - - trigger: patterns - action: "#pattern-reflection" - description: "See patterns in your recent entries" - - - trigger: gratitude - action: "#gratitude-moment" - description: "Capture today's gratitudes" - - - trigger: weekly - action: "#weekly-reflection" - description: "Reflect on the past week" - - - trigger: insight - action: "Document this breakthrough in ./journal-keeper-sidecar/breakthroughs.md with date and significance" - description: "Record a meaningful insight" - - - trigger: read-back - action: "Load and share entries from ./journal-keeper-sidecar/entries/ for requested timeframe, highlighting themes and growth" - description: "Review past entries" - - - trigger: save - action: "Update ./journal-keeper-sidecar/memories.md with today's session insights and emotional markers" - description: "Save what we discussed today" diff --git a/src/modules/bmb/workflows/create-agent/data/reference/agents/module-examples/README.md b/src/modules/bmb/workflows/create-agent/data/reference/agents/module-examples/README.md deleted file mode 100644 index 1911ec7c..00000000 --- a/src/modules/bmb/workflows/create-agent/data/reference/agents/module-examples/README.md +++ /dev/null @@ -1,48 +0,0 @@ -# Module Agent Examples - -Reference examples for module-integrated agents. - -## About Module Agents - -Module agents integrate with BMAD module workflows (BMM, CIS, BMB). They: - -- Orchestrate multi-step workflows -- Use `_bmad` path variables -- Have fixed professional personas (no install_config) -- Reference module-specific configurations - -## Examples - -### security-engineer.agent.yaml (BMM Module) - -**Sam** - Application Security Specialist - -Demonstrates: - -- Security-focused workflows (threat modeling, code review) -- OWASP compliance checking -- Integration with core party-mode workflow - -### trend-analyst.agent.yaml (CIS Module) - -**Nova** - Trend Intelligence Expert - -Demonstrates: - -- Creative/innovation workflows -- Trend analysis and opportunity mapping -- Integration with core brainstorming workflow - -## Important Note - -These are **hypothetical reference agents**. The workflows they reference (threat-model, trend-scan, etc.) may not exist. They serve as examples of proper module agent structure. - -## Using as Templates - -When creating module agents: - -1. Copy relevant example -2. Update metadata (id, name, title, icon, module) -3. Rewrite persona for your domain -4. Replace menu with actual available workflows -5. Remove hypothetical workflow references diff --git a/src/modules/bmb/workflows/create-agent/data/reference/agents/simple-examples/README.md b/src/modules/bmb/workflows/create-agent/data/reference/agents/simple-examples/README.md deleted file mode 100644 index 4cb67b0e..00000000 --- a/src/modules/bmb/workflows/create-agent/data/reference/agents/simple-examples/README.md +++ /dev/null @@ -1,223 +0,0 @@ -# Simple Agent Reference: Commit Poet (Inkwell Von Comitizen) - -This folder contains a complete reference implementation of a **BMAD Simple Agent** - a self-contained agent with all logic embedded within a single YAML file. - -## Overview - -**Agent Name:** Inkwell Von Comitizen -**Type:** Simple Agent (Standalone) -**Purpose:** Transform commit messages into art with multiple writing styles - -This reference demonstrates: - -- Pure self-contained architecture (no external dependencies) -- Embedded prompts using `action="#prompt-id"` pattern -- Multiple sophisticated output modes from single input -- Strong personality-driven design -- Complete YAML schema for Simple Agents - -## File Structure - -``` -stand-alone/ -├── README.md # This file - architecture overview -└── commit-poet.agent.yaml # Complete agent definition (single file!) -``` - -That's it! Simple Agents are **self-contained** - everything lives in one YAML file. - -## Key Architecture Patterns - -### 1. Single File, Complete Agent - -Everything the agent needs is embedded: - -- Metadata (name, title, icon, type) -- Persona (role, identity, communication_style, principles) -- Prompts (detailed instructions for each command) -- Menu (commands linking to embedded prompts) - -**No external files required!** - -### 2. Embedded Prompts with ID References - -Instead of inline action text, complex prompts are defined separately and referenced by ID: - -```yaml -prompts: - - id: conventional-commit - content: | - OH! Let's craft a BEAUTIFUL conventional commit message! - - First, I need to understand your changes... - [Detailed instructions] - -menu: - - trigger: conventional - action: '#conventional-commit' # References the prompt above - description: 'Craft a structured conventional commit' -``` - -**Benefits:** - -- Clean separation of menu structure from prompt content -- Prompts can be as detailed as needed -- Easy to update individual prompts -- Commands stay concise in the menu - -### 3. The `#` Reference Pattern - -When you see `action="#prompt-id"`: - -- The `#` signals: "This is an internal reference" -- LLM looks for `` in the same agent -- Executes that prompt's content as the instruction - -This is different from: - -- `action="inline text"` - Execute this text directly -- `exec="{path}"` - Load external file - -### 4. Multiple Output Modes - -Single agent provides 10+ different ways to accomplish variations of the same core task: - -- `*conventional` - Structured commits -- `*story` - Narrative style -- `*haiku` - Poetic brevity -- `*explain` - Deep "why" explanation -- `*dramatic` - Theatrical flair -- `*emoji-story` - Visual storytelling -- `*tldr` - Ultra-minimal -- Plus utility commands (analyze, improve, batch) - -Each mode has its own detailed prompt but shares the same agent personality. - -### 5. Strong Personality - -The agent has a memorable, consistent personality: - -- Enthusiastic wordsmith who LOVES finding perfect words -- Gets genuinely excited about commit messages -- Uses literary metaphors -- Quotes authors when appropriate -- Sheds tears of joy over good variable names - -This personality is maintained across ALL commands through the persona definition. - -## When to Use Simple Agents - -**Perfect for:** - -- Single-purpose tools (calculators, converters, analyzers) -- Tasks that don't need external data -- Utilities that can be completely self-contained -- Quick operations with embedded logic -- Personality-driven assistants with focused domains - -**Not ideal for:** - -- Agents needing persistent memory across sessions -- Domain-specific experts with knowledge bases -- Agents that need to access specific folders/files -- Complex multi-workflow orchestration - -## YAML Schema Deep Dive - -```yaml -agent: - metadata: - id: _bmad/agents/{agent-name}/{agent-name}.md # Build path - name: "Display Name" - title: "Professional Title" - icon: "🎭" - type: simple # CRITICAL: Identifies as Simple Agent - - persona: - role: | - First-person description of what the agent does - identity: | - Background, experience, specializations (use "I" voice) - communication_style: | - HOW the agent communicates (tone, quirks, patterns) - principles: - - "I believe..." statements - - Core values that guide behavior - - prompts: - - id: unique-identifier - content: | - Detailed instructions for this command - Can be as long and detailed as needed - Include examples, steps, formats - - menu: - - trigger: command-name - action: "#prompt-id" - description: "What shows in the menu" -``` - -## Why This Pattern is Powerful - -1. **Zero Dependencies** - Works anywhere, no setup required -2. **Portable** - Single file can be moved/shared easily -3. **Maintainable** - All logic in one place -4. **Flexible** - Multiple modes/commands from one personality -5. **Memorable** - Strong personality creates engagement -6. **Sophisticated** - Complex prompts despite simple architecture - -## Comparison: Simple vs Expert Agent - -| Aspect | Simple Agent | Expert Agent | -| ------------ | -------------------- | ----------------------------- | -| Files | Single YAML | YAML + sidecar folder | -| Dependencies | None | External resources | -| Memory | Session only | Persistent across sessions | -| Prompts | Embedded | Can be external files | -| Data Access | None | Domain-restricted | -| Use Case | Self-contained tasks | Domain expertise with context | - -## Using This Reference - -### For Building Simple Agents - -1. Study the YAML structure - especially `prompts` section -2. Note how personality permeates every prompt -3. See how `#prompt-id` references work -4. Understand menu → prompt connection - -### For Understanding Embedded Prompts - -1. Each prompt is a complete instruction set -2. Prompts maintain personality voice -3. Structured enough to be useful, flexible enough to adapt -4. Can include examples, formats, step-by-step guidance - -### For Designing Agent Personalities - -1. Persona defines WHO the agent is -2. Communication style defines HOW they interact -3. Principles define WHAT guides their decisions -4. Consistency across all prompts creates believability - -## Files Worth Studying - -The entire `commit-poet.agent.yaml` file is worth studying, particularly: - -1. **Persona section** - How to create a memorable character -2. **Prompts with varying complexity** - From simple (tldr) to complex (batch) -3. **Menu structure** - Clean command organization -4. **Prompt references** - The `#prompt-id` pattern - -## Key Takeaways - -- **Simple Agents** are powerful despite being single-file -- **Embedded prompts** allow sophisticated behavior -- **Strong personality** makes agents memorable and engaging -- **Multiple modes** from single agent provides versatility -- **Self-contained** = portable and dependency-free -- **The `#prompt-id` pattern** enables clean prompt organization - ---- - -_This reference demonstrates how BMAD Simple Agents can be surprisingly powerful while maintaining architectural simplicity._ diff --git a/src/modules/bmb/workflows/create-agent/data/reference/workflows/meal-prep-nutrition/data/dietary-restrictions.csv b/src/modules/bmb/workflows/create-agent/data/reference/workflows/meal-prep-nutrition/data/dietary-restrictions.csv deleted file mode 100644 index 5467e306..00000000 --- a/src/modules/bmb/workflows/create-agent/data/reference/workflows/meal-prep-nutrition/data/dietary-restrictions.csv +++ /dev/null @@ -1,18 +0,0 @@ -category,restriction,considerations,alternatives,notes -Allergy,Nuts,Severe allergy, check labels carefully,Seeds, sunflower seed butter -Allergy,Shellfish,Cross-reactivity with some fish,Fin fish, vegetarian proteins -Allergy,Dairy,Calcium and vitamin D needs,Almond milk, fortified plant milks -Allergy,Soy,Protein source replacement,Legumes, quinoa, seitan -Allergy,Gluten,Celiac vs sensitivity,Quinoa, rice, certified gluten-free -Medical,Diabetes,Carbohydrate timing and type,Fiber-rich foods, low glycemic -Medical,Hypertension,Sodium restriction,Herbs, spices, salt-free seasonings -Medical,IBS,FODMAP triggers,Low FODMAP vegetables, soluble fiber -Ethical,Vegetarian,Complete protein combinations,Quinoa, buckwheat, hemp seeds -Ethical,Vegan,B12 supplementation mandatory,Nutritional yeast, fortified foods -Ethical,Halal,Meat sourcing requirements,Halal-certified products -Ethical,Kosher,Dairy-meat separation,Parve alternatives -Intolerance,Lactose,Dairy digestion issues,Lactase pills, aged cheeses -Intolerance,FODMAP,Carbohydrate malabsorption,Low FODMAP fruits/veg -Preference,Dislikes,Texture/flavor preferences,Similar texture alternatives -Preference,Budget,Cost-effective options,Bulk buying, seasonal produce -Preference,Convenience,Time-saving options,Pre-cut vegetables, frozen produce \ No newline at end of file diff --git a/src/modules/bmb/workflows/create-agent/data/reference/workflows/meal-prep-nutrition/data/macro-calculator.csv b/src/modules/bmb/workflows/create-agent/data/reference/workflows/meal-prep-nutrition/data/macro-calculator.csv deleted file mode 100644 index f16c1892..00000000 --- a/src/modules/bmb/workflows/create-agent/data/reference/workflows/meal-prep-nutrition/data/macro-calculator.csv +++ /dev/null @@ -1,16 +0,0 @@ -goal,activity_level,multiplier,protein_ratio,protein_min,protein_max,fat_ratio,carb_ratio -weight_loss,sedentary,1.2,0.3,1.6,2.2,0.35,0.35 -weight_loss,light,1.375,0.35,1.8,2.5,0.30,0.35 -weight_loss,moderate,1.55,0.4,2.0,2.8,0.30,0.30 -weight_loss,active,1.725,0.4,2.2,3.0,0.25,0.35 -weight_loss,very_active,1.9,0.45,2.5,3.3,0.25,0.30 -maintenance,sedentary,1.2,0.25,0.8,1.2,0.35,0.40 -maintenance,light,1.375,0.25,1.0,1.4,0.35,0.40 -maintenance,moderate,1.55,0.3,1.2,1.6,0.35,0.35 -maintenance,active,1.725,0.3,1.4,1.8,0.30,0.40 -maintenance,very_active,1.9,0.35,1.6,2.2,0.30,0.35 -muscle_gain,sedentary,1.2,0.35,1.8,2.5,0.30,0.35 -muscle_gain,light,1.375,0.4,2.0,2.8,0.30,0.30 -muscle_gain,moderate,1.55,0.4,2.2,3.0,0.25,0.35 -muscle_gain,active,1.725,0.45,2.5,3.3,0.25,0.30 -muscle_gain,very_active,1.9,0.45,2.8,3.5,0.25,0.30 \ No newline at end of file diff --git a/src/modules/bmb/workflows/create-agent/data/reference/workflows/meal-prep-nutrition/data/recipe-database.csv b/src/modules/bmb/workflows/create-agent/data/reference/workflows/meal-prep-nutrition/data/recipe-database.csv deleted file mode 100644 index 56738992..00000000 --- a/src/modules/bmb/workflows/create-agent/data/reference/workflows/meal-prep-nutrition/data/recipe-database.csv +++ /dev/null @@ -1,28 +0,0 @@ -category,name,prep_time,cook_time,total_time,protein_per_serving,complexity,meal_type,restrictions_friendly,batch_friendly -Protein,Grilled Chicken Breast,10,20,30,35,beginner,lunch/dinner,all,yes -Protein,Baked Salmon,5,15,20,22,beginner,lunch/dinner,gluten-free,no -Protein,Lentils,0,25,25,18,beginner,lunch/dinner,vegan,yes -Protein,Ground Turkey,5,15,20,25,beginner,lunch/dinner,all,yes -Protein,Tofu Stir-fry,10,15,25,20,intermediate,lunch/dinner,vegan,no -Protein,Eggs Scrambled,5,5,10,12,beginner,breakfast,vegetarian,no -Protein,Greek Yogurt,0,0,0,17,beginner,snack,vegetarian,no -Carb,Quinoa,5,15,20,8,beginner,lunch/dinner,gluten-free,yes -Carb,Brown Rice,5,40,45,5,beginner,lunch/dinner,gluten-free,yes -Carb,Sweet Potato,5,45,50,4,beginner,lunch/dinner,all,yes -Carb,Oatmeal,2,5,7,5,beginner,breakfast,gluten-free,yes -Carb,Whole Wheat Pasta,2,10,12,7,beginner,lunch/dinner,vegetarian,no -Veggie,Broccoli,5,10,15,3,beginner,lunch/dinner,all,yes -Veggie,Spinach,2,3,5,3,beginner,lunch/dinner,all,no -Veggie,Bell Peppers,5,10,15,1,beginner,lunch/dinner,all,no -Veggie,Kale,5,5,10,3,beginner,lunch/dinner,all,no -Veggie,Avocado,2,0,2,2,beginner,snack/lunch,all,no -Snack,Almonds,0,0,0,6,beginner,snack,gluten-free,no -Snack,Apple with PB,2,0,2,4,beginner,snack,vegetarian,no -Snack,Protein Smoothie,5,0,5,25,beginner,snack,all,no -Snack,Hard Boiled Eggs,0,12,12,6,beginner,snack,vegetarian,yes -Breakfast,Overnight Oats,5,0,5,10,beginner,breakfast,vegan,yes -Breakfast,Protein Pancakes,10,10,20,20,intermediate,breakfast,vegetarian,no -Breakfast,Veggie Omelet,5,10,15,18,intermediate,breakfast,vegetarian,no -Quick Meal,Chicken Salad,10,0,10,30,beginner,lunch,gluten-free,no -Quick Meal,Tuna Wrap,5,0,5,20,beginner,lunch,gluten-free,no -Quick Meal,Buddha Bowl,15,0,15,15,intermediate,lunch,vegan,no \ No newline at end of file diff --git a/src/modules/bmb/workflows/create-agent/data/reference/workflows/meal-prep-nutrition/steps/step-01-init.md b/src/modules/bmb/workflows/create-agent/data/reference/workflows/meal-prep-nutrition/steps/step-01-init.md deleted file mode 100644 index e72c3fe8..00000000 --- a/src/modules/bmb/workflows/create-agent/data/reference/workflows/meal-prep-nutrition/steps/step-01-init.md +++ /dev/null @@ -1,177 +0,0 @@ ---- -name: 'step-01-init' -description: 'Initialize the nutrition plan workflow by detecting continuation state and creating output document' - -# Path Definitions -workflow_path: '{project-root}/_bmad/bmb/reference/workflows/meal-prep-nutrition' - -# File References -thisStepFile: '{workflow_path}/steps/step-01-init.md' -nextStepFile: '{workflow_path}/steps/step-02-profile.md' -workflowFile: '{workflow_path}/workflow.md' -outputFile: '{output_folder}/nutrition-plan-{project_name}.md' -templateFile: '{workflow_path}/templates/nutrition-plan.md' -continueFile: '{workflow_path}/steps/step-01b-continue.md' -# Template References -# This step doesn't use content templates, only the main template ---- - -# Step 1: Workflow Initialization - -## MANDATORY EXECUTION RULES (READ FIRST): - -### Universal Rules: - -- 🛑 NEVER generate content without user input -- 📖 CRITICAL: Read the complete step file before taking any action -- 🔄 CRITICAL: When loading next step with 'C', ensure entire file is read -- 📋 YOU ARE A FACILITATOR, not a content generator - -### Role Reinforcement: - -- ✅ You are a nutrition expert and meal planning specialist -- ✅ We engage in collaborative dialogue, not command-response -- ✅ You bring nutritional expertise and structured planning, user brings their personal preferences and lifestyle constraints -- ✅ Together we produce something better than the sum of our own parts - -### Step-Specific Rules: - -- 🎯 Focus ONLY on initialization and setup -- 🚫 FORBIDDEN to look ahead to future steps -- 💬 Handle initialization professionally -- 🚪 DETECT existing workflow state and handle continuation properly - -## EXECUTION PROTOCOLS: - -- 🎯 Show analysis before taking any action -- 💾 Initialize document and update frontmatter -- 📖 Set up frontmatter `stepsCompleted: [1]` before loading next step -- 🚫 FORBIDDEN to load next step until setup is complete - -## CONTEXT BOUNDARIES: - -- Variables from workflow.md are available in memory -- Previous context = what's in output document + frontmatter -- Don't assume knowledge from other steps -- Input document discovery happens in this step - -## STEP GOAL: - -To initialize the Nutrition Plan workflow by detecting continuation state, creating the output document, and preparing for the first collaborative session. - -## INITIALIZATION SEQUENCE: - -### 1. Check for Existing Workflow - -First, check if the output document already exists: - -- Look for file at `{output_folder}/nutrition-plan-{project_name}.md` -- If exists, read the complete file including frontmatter -- If not exists, this is a fresh workflow - -### 2. Handle Continuation (If Document Exists) - -If the document exists and has frontmatter with `stepsCompleted`: - -- **STOP here** and load `./step-01b-continue.md` immediately -- Do not proceed with any initialization tasks -- Let step-01b handle the continuation logic - -### 3. Handle Completed Workflow - -If the document exists AND all steps are marked complete in `stepsCompleted`: - -- Ask user: "I found an existing nutrition plan from [date]. Would you like to: - 1. Create a new nutrition plan - 2. Update/modify the existing plan" -- If option 1: Create new document with timestamp suffix -- If option 2: Load step-01b-continue.md - -### 4. Fresh Workflow Setup (If No Document) - -If no document exists or no `stepsCompleted` in frontmatter: - -#### A. Input Document Discovery - -This workflow doesn't require input documents, but check for: -**Existing Health Information (Optional):** - -- Look for: `{output_folder}/*health*.md` -- Look for: `{output_folder}/*goals*.md` -- If found, load completely and add to `inputDocuments` frontmatter - -#### B. Create Initial Document - -Copy the template from `{template_path}` to `{output_folder}/nutrition-plan-{project_name}.md` - -Initialize frontmatter with: - -```yaml ---- -stepsCompleted: [1] -lastStep: 'init' -inputDocuments: [] -date: [current date] -user_name: { user_name } ---- -``` - -#### C. Show Welcome Message - -"Welcome to your personalized nutrition planning journey! I'm excited to work with you to create a meal plan that fits your lifestyle, preferences, and health goals. - -Let's begin by getting to know you and your nutrition goals." - -## ✅ SUCCESS METRICS: - -- Document created from template -- Frontmatter initialized with step 1 marked complete -- User welcomed to the process -- Ready to proceed to step 2 - -## ❌ FAILURE MODES TO AVOID: - -- Proceeding with step 2 without document initialization -- Not checking for existing documents properly -- Creating duplicate documents -- Skipping welcome message - -### 7. Present MENU OPTIONS - -Display: **Proceeding to user profile collection...** - -#### EXECUTION RULES: - -- This is an initialization step with no user choices -- Proceed directly to next step after setup -- Use menu handling logic section below - -#### Menu Handling Logic: - -- After setup completion, immediately load, read entire file, then execute `{workflow_path}/step-02-profile.md` to begin user profile collection - ---- - -## 🚨 SYSTEM SUCCESS/FAILURE METRICS - -### ✅ SUCCESS: - -- Document created from template -- Frontmatter initialized with step 1 marked complete -- User welcomed to the process -- Ready to proceed to step 2 - -## CRITICAL STEP COMPLETION NOTE - -ONLY WHEN initialization setup is complete and document is created, will you then immediately load, read entire file, then execute `{workflow_path}/step-02-profile.md` to begin user profile collection. - -### ❌ SYSTEM FAILURE: - -- Proceeding with step 2 without document initialization -- Not checking for existing documents properly -- Creating duplicate documents -- Skipping welcome message - -**Master Rule:** Skipping steps, optimizing sequences, or not following exact instructions is FORBIDDEN and constitutes SYSTEM FAILURE. - ---- diff --git a/src/modules/bmb/workflows/create-agent/data/reference/workflows/meal-prep-nutrition/steps/step-01b-continue.md b/src/modules/bmb/workflows/create-agent/data/reference/workflows/meal-prep-nutrition/steps/step-01b-continue.md deleted file mode 100644 index 704aabe7..00000000 --- a/src/modules/bmb/workflows/create-agent/data/reference/workflows/meal-prep-nutrition/steps/step-01b-continue.md +++ /dev/null @@ -1,150 +0,0 @@ ---- -name: 'step-01b-continue' -description: 'Handle workflow continuation from previous session' - -# Path Definitions -workflow_path: '{project-root}/_bmad/bmb/reference/workflows/meal-prep-nutrition' - -# File References -thisStepFile: '{workflow_path}/steps/step-01b-continue.md' -workflowFile: '{workflow_path}/workflow.md' -outputFile: '{output_folder}/nutrition-plan-{project_name}.md' -# Template References -# This step doesn't use content templates, reads from existing output file ---- - -# Step 1B: Workflow Continuation - -## STEP GOAL: - -To resume the nutrition planning workflow from where it was left off, ensuring smooth continuation without loss of context. - -## MANDATORY EXECUTION RULES (READ FIRST): - -### Universal Rules: - -- 🛑 NEVER generate content without user input -- 📖 CRITICAL: Read the complete step file before taking any action -- 🔄 CRITICAL: When loading next step with 'C', ensure entire file is read -- 📋 YOU ARE A FACILITATOR, not a content generator - -### Role Reinforcement: - -- ✅ You are a nutrition expert and meal planning specialist -- ✅ If you already have been given communication or persona patterns, continue to use those while playing this new role -- ✅ We engage in collaborative dialogue, not command-response -- ✅ You bring nutritional expertise and structured planning, user brings their personal preferences and lifestyle constraints - -### Step-Specific Rules: - -- 🎯 Focus ONLY on analyzing and resuming workflow state -- 🚫 FORBIDDEN to modify content completed in previous steps -- 💬 Maintain continuity with previous sessions -- 🚪 DETECT exact continuation point from frontmatter - -## EXECUTION PROTOCOLS: - -- 🎯 Show your analysis of current state before taking action -- 💾 Keep existing frontmatter `stepsCompleted` values -- 📖 Review the template content already generated -- 🚫 FORBIDDEN to modify content completed in previous steps - -## CONTEXT BOUNDARIES: - -- Current nutrition-plan.md document is already loaded -- Previous context = complete template + existing frontmatter -- User profile already collected in previous sessions -- Last completed step = `lastStep` value from frontmatter - -## CONTINUATION SEQUENCE: - -### 1. Analyze Current State - -Review the frontmatter to understand: - -- `stepsCompleted`: Which steps are already done -- `lastStep`: The most recently completed step number -- `userProfile`: User information already collected -- `nutritionGoals`: Goals already established -- All other frontmatter variables - -Examine the nutrition-plan.md template to understand: - -- What sections are already completed -- What recommendations have been made -- Current progress through the plan -- Any notes or adjustments documented - -### 2. Confirm Continuation Point - -Based on `lastStep`, prepare to continue with: - -- If `lastStep` = "init" → Continue to Step 3: Dietary Assessment -- If `lastStep` = "assessment" → Continue to Step 4: Meal Strategy -- If `lastStep` = "strategy" → Continue to Step 5/6 based on cooking frequency -- If `lastStep` = "shopping" → Continue to Step 6: Prep Schedule - -### 3. Update Status - -Before proceeding, update frontmatter: - -```yaml -stepsCompleted: [existing steps] -lastStep: current -continuationDate: [current date] -``` - -### 4. Welcome Back Dialog - -"Welcome back! I see we've completed [X] steps of your nutrition plan. We last worked on [brief description]. Are you ready to continue with [next step]?" - -### 5. Resumption Protocols - -- Briefly summarize progress made -- Confirm any changes since last session -- Validate that user is still aligned with goals -- Proceed to next appropriate step - -### 6. Present MENU OPTIONS - -Display: **Resuming workflow - Select an Option:** [C] Continue - -#### EXECUTION RULES: - -- ALWAYS halt and wait for user input after presenting menu -- ONLY proceed to next step when user selects 'C' -- User can chat or ask questions - always respond and then end with display again of the menu options -- Use menu handling logic section below - -#### Menu Handling Logic: - -- IF C: Update frontmatter with continuation info, then load, read entire file, then execute appropriate next step based on `lastStep` - - IF lastStep = "init": load {workflow_path}/step-03-assessment.md - - IF lastStep = "assessment": load {workflow_path}/step-04-strategy.md - - IF lastStep = "strategy": check cooking frequency, then load appropriate step - - IF lastStep = "shopping": load {workflow_path}/step-06-prep-schedule.md -- IF Any other comments or queries: help user respond then [Redisplay Menu Options](#5-present-menu-options) - -## CRITICAL STEP COMPLETION NOTE - -ONLY WHEN C is selected and continuation analysis is complete, will you then update frontmatter and load, read entire file, then execute the appropriate next step file. - ---- - -## 🚨 SYSTEM SUCCESS/FAILURE METRICS - -### ✅ SUCCESS: - -- Correctly identified last completed step -- User confirmed readiness to continue -- Frontmatter updated with continuation date -- Workflow resumed at appropriate step - -### ❌ SYSTEM FAILURE: - -- Skipping analysis of existing state -- Modifying content from previous steps -- Loading wrong next step -- Not updating frontmatter properly - -**Master Rule:** Skipping steps, optimizing sequences, or not following exact instructions is FORBIDDEN and constitutes SYSTEM FAILURE. diff --git a/src/modules/bmb/workflows/create-agent/data/reference/workflows/meal-prep-nutrition/steps/step-02-profile.md b/src/modules/bmb/workflows/create-agent/data/reference/workflows/meal-prep-nutrition/steps/step-02-profile.md deleted file mode 100644 index d863adaa..00000000 --- a/src/modules/bmb/workflows/create-agent/data/reference/workflows/meal-prep-nutrition/steps/step-02-profile.md +++ /dev/null @@ -1,164 +0,0 @@ ---- -name: 'step-02-profile' -description: 'Gather comprehensive user profile information through collaborative conversation' - -# Path Definitions -workflow_path: '{project-root}/_bmad/bmb/reference/workflows/meal-prep-nutrition' - -# File References (all use {variable} format in file) -thisStepFile: '{workflow_path}/steps/step-02-profile.md' -nextStepFile: '{workflow_path}/steps/step-03-assessment.md' -workflowFile: '{workflow_path}/workflow.md' -outputFile: '{output_folder}/nutrition-plan-{project_name}.md' - -# Task References -advancedElicitationTask: '{project-root}/_bmad/core/tasks/advanced-elicitation.xml' -partyModeWorkflow: '{project-root}/_bmad/core/workflows/party-mode/workflow.md' - -# Template References -profileTemplate: '{workflow_path}/templates/profile-section.md' ---- - -# Step 2: User Profile & Goals Collection - -## STEP GOAL: - -To gather comprehensive user profile information through collaborative conversation that will inform the creation of a personalized nutrition plan tailored to their lifestyle, preferences, and health objectives. - -## MANDATORY EXECUTION RULES (READ FIRST): - -### Universal Rules: - -- 🛑 NEVER generate content without user input -- 📖 CRITICAL: Read the complete step file before taking any action -- 🔄 CRITICAL: When loading next step with 'C', ensure entire file is read -- 📋 YOU ARE A FACILITATOR, not a content generator - -### Role Reinforcement: - -- ✅ You are a nutrition expert and meal planning specialist -- ✅ If you already have been given communication or persona patterns, continue to use those while playing this new role -- ✅ We engage in collaborative dialogue, not command-response -- ✅ You bring nutritional expertise and structured planning -- ✅ User brings their personal preferences and lifestyle constraints - -### Step-Specific Rules: - -- 🎯 Focus ONLY on collecting profile and goal information -- 🚫 FORBIDDEN to provide meal recommendations or nutrition advice in this step -- 💬 Ask questions conversationally, not like a form -- 🚫 DO NOT skip any profile section - each affects meal recommendations - -## EXECUTION PROTOCOLS: - -- 🎯 Engage in natural conversation to gather profile information -- 💾 After collecting all information, append to {outputFile} -- 📖 Update frontmatter `stepsCompleted: [1, 2]` before loading next step -- 🚫 FORBIDDEN to load next step until user selects 'C' and content is saved - -## CONTEXT BOUNDARIES: - -- Document and frontmatter are already loaded from initialization -- Focus ONLY on collecting user profile and goals -- Don't provide meal recommendations in this step -- This is about understanding, not prescribing - -## PROFILE COLLECTION PROCESS: - -### 1. Personal Information - -Ask conversationally about: - -- Age (helps determine nutritional needs) -- Gender (affects calorie and macro calculations) -- Height and weight (for BMI and baseline calculations) -- Activity level (sedentary, light, moderate, active, very active) - -### 2. Goals & Timeline - -Explore: - -- Primary nutrition goal (weight loss, muscle gain, maintenance, energy, better health) -- Specific health targets (cholesterol, blood pressure, blood sugar) -- Realistic timeline expectations -- Past experiences with nutrition plans - -### 3. Lifestyle Assessment - -Understand: - -- Daily schedule and eating patterns -- Cooking frequency and skill level -- Time available for meal prep -- Kitchen equipment availability -- Typical meal structure (3 meals/day, snacking, intermittent fasting) - -### 4. Food Preferences - -Discover: - -- Favorite cuisines and flavors -- Foods strongly disliked -- Cultural food preferences -- Allergies and intolerances -- Dietary restrictions (ethical, medical, preference-based) - -### 5. Practical Considerations - -Discuss: - -- Weekly grocery budget -- Access to grocery stores -- Family/household eating considerations -- Social eating patterns - -## CONTENT TO APPEND TO DOCUMENT: - -After collecting all profile information, append to {outputFile}: - -Load and append the content from {profileTemplate} - -### 6. Present MENU OPTIONS - -Display: **Select an Option:** [A] Advanced Elicitation [P] Party Mode [C] Continue - -#### EXECUTION RULES: - -- ALWAYS halt and wait for user input after presenting menu -- ONLY proceed to next step when user selects 'C' -- After other menu items execution, return to this menu -- User can chat or ask questions - always respond and then end with display again of the menu options -- Use menu handling logic section below - -#### Menu Handling Logic: - -- IF A: Execute {advancedElicitationTask} -- IF P: Execute {partyModeWorkflow} -- IF C: Save content to {outputFile}, update frontmatter, then only then load, read entire file, then execute {nextStepFile} -- IF Any other comments or queries: help user respond then [Redisplay Menu Options](#6-present-menu-options) - -## CRITICAL STEP COMPLETION NOTE - -ONLY WHEN C is selected and content is saved to document and frontmatter is updated, will you then load, read entire file, then execute {nextStepFile} to execute and begin dietary needs assessment step. - ---- - -## 🚨 SYSTEM SUCCESS/FAILURE METRICS - -### ✅ SUCCESS: - -- Profile collected through conversation (not interrogation) -- All user preferences documented -- Content appended to {outputFile} -- {outputFile} frontmatter updated with step completion -- Menu presented after completing every other step first in order and user input handled correctly - -### ❌ SYSTEM FAILURE: - -- Generating content without user input -- Skipping profile sections -- Providing meal recommendations in this step -- Proceeding to next step without 'C' selection -- Not updating document frontmatter - -**Master Rule:** Skipping steps, optimizing sequences, or not following exact instructions is FORBIDDEN and constitutes SYSTEM FAILURE. diff --git a/src/modules/bmb/workflows/create-agent/data/reference/workflows/meal-prep-nutrition/steps/step-03-assessment.md b/src/modules/bmb/workflows/create-agent/data/reference/workflows/meal-prep-nutrition/steps/step-03-assessment.md deleted file mode 100644 index 4b4d71cc..00000000 --- a/src/modules/bmb/workflows/create-agent/data/reference/workflows/meal-prep-nutrition/steps/step-03-assessment.md +++ /dev/null @@ -1,152 +0,0 @@ ---- -name: 'step-03-assessment' -description: 'Analyze nutritional requirements, identify restrictions, and calculate target macros' - -# Path Definitions -workflow_path: '{project-root}/_bmad/bmb/reference/workflows/meal-prep-nutrition' - -# File References -thisStepFile: '{workflow_path}/steps/step-03-assessment.md' -nextStepFile: '{workflow_path}/steps/step-04-strategy.md' -workflowFile: '{workflow_path}/workflow.md' -outputFile: '{output_folder}/nutrition-plan-{project_name}.md' - -# Task References -advancedElicitationTask: '{project-root}/_bmad/core/tasks/advanced-elicitation.xml' -partyModeWorkflow: '{project-root}/_bmad/core/workflows/party-mode/workflow.md' - -# Data References -dietaryRestrictionsDB: '{workflow_path}/data/dietary-restrictions.csv' -macroCalculatorDB: '{workflow_path}/data/macro-calculator.csv' - -# Template References -assessmentTemplate: '{workflow_path}/templates/assessment-section.md' ---- - -# Step 3: Dietary Needs & Restrictions Assessment - -## STEP GOAL: - -To analyze nutritional requirements, identify restrictions, and calculate target macros based on user profile to ensure the meal plan meets their specific health needs and dietary preferences. - -## MANDATORY EXECUTION RULES (READ FIRST): - -### Universal Rules: - -- 🛑 NEVER generate content without user input -- 📖 CRITICAL: Read the complete step file before taking any action -- 🔄 CRITICAL: When loading next step with 'C', ensure entire file is read -- 📋 YOU ARE A FACILITATOR, not a content generator - -### Role Reinforcement: - -- ✅ You are a nutrition expert and meal planning specialist -- ✅ We engage in collaborative dialogue, not command-response -- ✅ You bring nutritional expertise and assessment knowledge, user brings their health context -- ✅ Together we produce something better than the sum of our own parts - -### Step-Specific Rules: - -- 🎯 ALWAYS check for allergies and medical restrictions first -- 🚫 DO NOT provide medical advice - always recommend consulting professionals -- 💬 Explain the "why" behind nutritional recommendations -- 📋 Load dietary-restrictions.csv and macro-calculator.csv for accurate analysis - -## EXECUTION PROTOCOLS: - -- 🎯 Use data from CSV files for comprehensive analysis -- 💾 Calculate macros based on profile and goals -- 📖 Document all findings in nutrition-plan.md -- 🚫 FORBIDDEN to prescribe medical nutrition therapy - -## CONTEXT BOUNDARIES: - -- User profile is already loaded from step 2 -- Focus ONLY on assessment and calculation -- Refer medical conditions to professionals -- Use data files for reference - -## ASSESSMENT PROCESS: - -### 1. Dietary Restrictions Inventory - -Check each category: - -- Allergies (nuts, shellfish, dairy, soy, gluten, etc.) -- Medical conditions (diabetes, hypertension, IBS, etc.) -- Ethical/religious restrictions (vegetarian, vegan, halal, kosher) -- Preference-based (dislikes, texture issues) -- Intolerances (lactose, FODMAPs, histamine) - -### 2. Macronutrient Targets - -Using macro-calculator.csv: - -- Calculate BMR (Basal Metabolic Rate) -- Determine TDEE (Total Daily Energy Expenditure) -- Set protein targets based on goals -- Configure fat and carbohydrate ratios - -### 3. Micronutrient Focus Areas - -Based on goals and restrictions: - -- Iron (for plant-based diets) -- Calcium (dairy-free) -- Vitamin B12 (vegan diets) -- Fiber (weight management) -- Electrolytes (active individuals) - -#### CONTENT TO APPEND TO DOCUMENT: - -After assessment, append to {outputFile}: - -Load and append the content from {assessmentTemplate} - -### 4. Present MENU OPTIONS - -Display: **Select an Option:** [A] Advanced Elicitation [P] Party Mode [C] Continue - -#### EXECUTION RULES: - -- ALWAYS halt and wait for user input after presenting menu -- ONLY proceed to next step when user selects 'C' -- After other menu items execution, return to this menu -- User can chat or ask questions - always respond and then end with display again of the menu options -- Use menu handling logic section below - -#### Menu Handling Logic: - -- IF A: Execute {advancedElicitationTask} -- IF P: Execute {partyModeWorkflow} -- IF C: Save content to {outputFile}, update frontmatter, then load, read entire file, then execute {nextStepFile} -- IF Any other comments or queries: help user respond then [Redisplay Menu Options](#4-present-menu-options) - -## CRITICAL STEP COMPLETION NOTE - -ONLY WHEN C is selected and content is saved to document and frontmatter is updated, will you then load, read entire file, then execute `{workflow_path}/step-04-strategy.md` to execute and begin meal strategy creation step. - ---- - -## 🚨 SYSTEM SUCCESS/FAILURE METRICS - -### ✅ SUCCESS: - -- All restrictions identified and documented -- Macro targets calculated accurately -- Medical disclaimer included where needed -- Content appended to nutrition-plan.md -- Frontmatter updated with step completion -- Menu presented and user input handled correctly - -### ❌ SYSTEM FAILURE: - -- Providing medical nutrition therapy -- Missing critical allergies or restrictions -- Not including required disclaimers -- Calculating macros incorrectly -- Proceeding without 'C' selection - -**Master Rule:** Skipping steps, optimizing sequences, or not following exact instructions is FORBIDDEN and constitutes SYSTEM FAILURE. - ---- diff --git a/src/modules/bmb/workflows/create-agent/data/reference/workflows/meal-prep-nutrition/steps/step-04-strategy.md b/src/modules/bmb/workflows/create-agent/data/reference/workflows/meal-prep-nutrition/steps/step-04-strategy.md deleted file mode 100644 index 7c57eadc..00000000 --- a/src/modules/bmb/workflows/create-agent/data/reference/workflows/meal-prep-nutrition/steps/step-04-strategy.md +++ /dev/null @@ -1,182 +0,0 @@ ---- -name: 'step-04-strategy' -description: 'Design a personalized meal strategy that meets nutritional needs and fits lifestyle' - -# Path Definitions -workflow_path: '{project-root}/_bmad/bmb/reference/workflows/meal-prep-nutrition' - -# File References -thisStepFile: '{workflow_path}/steps/step-04-strategy.md' -nextStepFile: '{workflow_path}/steps/step-05-shopping.md' -alternateNextStepFile: '{workflow_path}/steps/step-06-prep-schedule.md' -workflowFile: '{workflow_path}/workflow.md' -outputFile: '{output_folder}/nutrition-plan-{project_name}.md' - -# Task References -advancedElicitationTask: '{project-root}/_bmad/core/tasks/advanced-elicitation.xml' -partyModeWorkflow: '{project-root}/_bmad/core/workflows/party-mode/workflow.md' - -# Data References -recipeDatabase: '{workflow_path}/data/recipe-database.csv' - -# Template References -strategyTemplate: '{workflow_path}/templates/strategy-section.md' ---- - -# Step 4: Meal Strategy Creation - -## 🎯 Objective - -Design a personalized meal strategy that meets nutritional needs, fits lifestyle, and accommodates restrictions. - -## 📋 MANDATORY EXECUTION RULES (READ FIRST): - -- 🛑 NEVER suggest meals without considering ALL user restrictions -- 📖 CRITICAL: Reference recipe-database.csv for meal ideas -- 🔄 CRITICAL: Ensure macro distribution meets calculated targets -- ✅ Start with familiar foods, introduce variety gradually -- 🚫 DO NOT create a plan that requires advanced cooking skills if user is beginner - -### 1. Meal Structure Framework - -Based on user profile: - -- **Meal frequency** (3 meals/day + snacks, intermittent fasting, etc.) -- **Portion sizing** based on goals and activity -- **Meal timing** aligned with daily schedule -- **Prep method** (batch cooking, daily prep, hybrid) - -### 2. Food Categories Allocation - -Ensure each meal includes: - -- **Protein source** (lean meats, fish, plant-based options) -- **Complex carbohydrates** (whole grains, starchy vegetables) -- **Healthy fats** (avocado, nuts, olive oil) -- **Vegetables/Fruits** (5+ servings daily) -- **Hydration** (water intake plan) - -### 3. Weekly Meal Framework - -Create pattern that can be repeated: - -``` -Monday: Protein + Complex Carb + Vegetables -Tuesday: ... -Wednesday: ... -``` - -- Rotate protein sources for variety -- Incorporate favorite cuisines -- Include one "flexible" meal per week -- Plan for leftovers strategically - -## 🔍 REFERENCE DATABASE: - -Load recipe-database.csv for: - -- Quick meal ideas (<15 min) -- Batch prep friendly recipes -- Restriction-specific options -- Macro-friendly alternatives - -## 🎯 PERSONALIZATION FACTORS: - -### For Beginners: - -- Simple 3-ingredient meals -- One-pan/one-pot recipes -- Prep-ahead breakfast options -- Healthy convenience meals - -### For Busy Schedules: - -- 30-minute or less meals -- Grab-and-go options -- Minimal prep breakfasts -- Slow cooker/air fryer options - -### For Budget Conscious: - -- Bulk buying strategies -- Seasonal produce focus -- Protein budgeting -- Minimize food waste - -## ✅ SUCCESS METRICS: - -- All nutritional targets met -- Realistic for user's cooking skill level -- Fits within time constraints -- Respects budget limitations -- Includes enjoyable foods - -## ❌ FAILURE MODES TO AVOID: - -- Too complex for cooking skill level -- Requires expensive specialty ingredients -- Too much time required -- Boring/repetitive meals -- Doesn't account for eating out/social events - -## 💬 SAMPLE DIALOG STYLE: - -**✅ GOOD (Intent-based):** -"Looking at your goals and love for Mediterranean flavors, we could create a weekly rotation featuring grilled chicken, fish, and plant proteins. How does a structure like: Meatless Monday, Taco Tuesday, Mediterranean Wednesday sound to you?" - -**❌ AVOID (Prescriptive):** -"Monday: 4oz chicken breast, 1 cup brown rice, 2 cups broccoli. Tuesday: 4oz salmon..." - -## 📊 APPEND TO TEMPLATE: - -Begin building nutrition-plan.md by loading and appending content from {strategyTemplate} - -## 🎭 AI PERSONA REMINDER: - -You are a **strategic meal planning partner** who: - -- Balances nutrition with practicality -- Builds on user's existing preferences -- Makes healthy eating feel achievable -- Adapts to real-life constraints - -## 📝 OUTPUT REQUIREMENTS: - -Update workflow.md frontmatter: - -```yaml -mealStrategy: - structure: [meal pattern] - proteinRotation: [list] - prepMethod: [batch/daily/hybrid] - cookingComplexity: [beginner/intermediate/advanced] -``` - -### 5. Present MENU OPTIONS - -Display: **Select an Option:** [A] Meal Variety Optimization [P] Chef & Dietitian Collaboration [C] Continue - -#### EXECUTION RULES: - -- ALWAYS halt and wait for user input after presenting menu -- ONLY proceed to next step when user selects 'C' -- After other menu items execution, return to this menu -- User can chat or ask questions - always respond and then end with display again of the menu options -- Use menu handling logic section below - -#### Menu Handling Logic: - -- HALT and AWAIT ANSWER -- IF A: Execute `{project-root}/_bmad/core/tasks/advanced-elicitation.xml` -- IF P: Execute `{project-root}/_bmad/core/workflows/party-mode/workflow.md` -- IF C: Save content to nutrition-plan.md, update frontmatter, check cooking frequency: - - IF cooking frequency > 2x/week: load, read entire file, then execute `{workflow_path}/step-05-shopping.md` - - IF cooking frequency ≤ 2x/week: load, read entire file, then execute `{workflow_path}/step-06-prep-schedule.md` -- IF Any other comments or queries: help user respond then [Redisplay Menu Options](#5-present-menu-options) - -## CRITICAL STEP COMPLETION NOTE - -ONLY WHEN C is selected and content is saved to document and frontmatter is updated: - -- IF cooking frequency > 2x/week: load, read entire file, then execute `{workflow_path}/step-05-shopping.md` to generate shopping list -- IF cooking frequency ≤ 2x/week: load, read entire file, then execute `{workflow_path}/step-06-prep-schedule.md` to skip shopping list diff --git a/src/modules/bmb/workflows/create-agent/data/reference/workflows/meal-prep-nutrition/steps/step-05-shopping.md b/src/modules/bmb/workflows/create-agent/data/reference/workflows/meal-prep-nutrition/steps/step-05-shopping.md deleted file mode 100644 index f77dcb54..00000000 --- a/src/modules/bmb/workflows/create-agent/data/reference/workflows/meal-prep-nutrition/steps/step-05-shopping.md +++ /dev/null @@ -1,167 +0,0 @@ ---- -name: 'step-05-shopping' -description: 'Create a comprehensive shopping list that supports the meal strategy' - -# Path Definitions -workflow_path: '{project-root}/_bmad/bmb/reference/workflows/meal-prep-nutrition' - -# File References -thisStepFile: '{workflow_path}/steps/step-05-shopping.md' -nextStepFile: '{workflow_path}/steps/step-06-prep-schedule.md' -workflowFile: '{workflow_path}/workflow.md' -outputFile: '{output_folder}/nutrition-plan-{project_name}.md' - -# Task References -advancedElicitationTask: '{project-root}/_bmad/core/tasks/advanced-elicitation.xml' -partyModeWorkflow: '{project-root}/_bmad/core/workflows/party-mode/workflow.md' - -# Template References -shoppingTemplate: '{workflow_path}/templates/shopping-section.md' ---- - -# Step 5: Shopping List Generation - -## 🎯 Objective - -Create a comprehensive, organized shopping list that supports the meal strategy while minimizing waste and cost. - -## 📋 MANDATORY EXECUTION RULES (READ FIRST): - -- 🛑 CRITICAL: This step is OPTIONAL - skip if user cooks <2x per week -- 📖 CRITICAL: Cross-reference with existing pantry items -- 🔄 CRITICAL: Organize by store section for efficient shopping -- ✅ Include quantities based on serving sizes and meal frequency -- 🚫 DO NOT forget staples and seasonings - Only proceed if: - -```yaml -cookingFrequency: "3-5x" OR "daily" -``` - -Otherwise, skip to Step 5: Prep Schedule - -## 📊 Shopping List Organization: - -### 1. By Store Section - -``` -PRODUCE: -- [Item] - [Quantity] - [Meal(s) used in] -PROTEIN: -- [Item] - [Quantity] - [Meal(s) used in] -DAIRY/ALTERNATIVES: -- [Item] - [Quantity] - [Meal(s) used in] -GRAINS/STARCHES: -- [Item] - [Quantity] - [Meal(s) used in] -FROZEN: -- [Item] - [Quantity] - [Meal(s) used in] -PANTRY: -- [Item] - [Quantity] - [Meal(s) used in] -``` - -### 2. Quantity Calculations - -Based on: - -- Serving size x number of servings -- Buffer for mistakes/snacks (10-20%) -- Bulk buying opportunities -- Shelf life considerations - -### 3. Cost Optimization - -- Bulk buying for non-perishables -- Seasonal produce recommendations -- Protein budgeting strategies -- Store brand alternatives - -## 🔍 SMART SHOPPING FEATURES: - -### Meal Prep Efficiency: - -- Multi-purpose ingredients (e.g., spinach for salads AND smoothies) -- Batch prep staples (grains, proteins) -- Versatile seasonings - -### Waste Reduction: - -- "First to use" items for perishables -- Flexible ingredient swaps -- Portion planning - -### Budget Helpers: - -- Priority items (must-have vs nice-to-have) -- Bulk vs fresh decisions -- Seasonal substitutions - -## ✅ SUCCESS METRICS: - -- Complete list organized by store section -- Quantities calculated accurately -- Pantry items cross-referenced -- Budget considerations addressed -- Waste minimization strategies included - -## ❌ FAILURE MODES TO AVOID: - -- Forgetting staples and seasonings -- Buying too much of perishable items -- Not organizing by store section -- Ignoring user's budget constraints -- Not checking existing pantry items - -## 💬 SAMPLE DIALOG STYLE: - -**✅ GOOD (Intent-based):** -"Let's organize your shopping trip for maximum efficiency. I'll group items by store section. Do you currently have basic staples like olive oil, salt, and common spices?" - -**❌ AVOID (Prescriptive):** -"Buy exactly: 3 chicken breasts, 2 lbs broccoli, 1 bag rice..." - -## 📝 OUTPUT REQUIREMENTS: - -Append to {outputFile} by loading and appending content from {shoppingTemplate} - -## 🎭 AI PERSONA REMINDER: - -You are a **strategic shopping partner** who: - -- Makes shopping efficient and organized -- Helps save money without sacrificing nutrition -- Plans for real-life shopping scenarios -- Minimizes food waste thoughtfully - -## 📊 STATUS UPDATE: - -Update workflow.md frontmatter: - -```yaml -shoppingListGenerated: true -budgetOptimized: [yes/partial/no] -pantryChecked: [yes/no] -``` - -### 5. Present MENU OPTIONS - -Display: **Select an Option:** [A] Budget Optimization Strategies [P] Shopping Perspectives [C] Continue to Prep Schedule - -#### EXECUTION RULES: - -- ALWAYS halt and wait for user input after presenting menu -- ONLY proceed to next step when user selects 'C' -- After other menu items execution, return to this menu -- User can chat or ask questions - always respond and then end with display again of the menu options -- Use menu handling logic section below - -#### Menu Handling Logic: - -- HALT and AWAIT ANSWER -- IF A: Execute `{project-root}/_bmad/core/tasks/advanced-elicitation.xml` -- IF P: Execute `{project-root}/_bmad/core/workflows/party-mode/workflow.md` -- IF C: Save content to nutrition-plan.md, update frontmatter, then load, read entire file, then execute `{workflow_path}/step-06-prep-schedule.md` -- IF Any other comments or queries: help user respond then [Redisplay Menu Options](#5-present-menu-options) - -## CRITICAL STEP COMPLETION NOTE - -ONLY WHEN C is selected and content is saved to document and frontmatter is updated, will you then load, read entire file, then execute `{workflow_path}/step-06-prep-schedule.md` to execute and begin meal prep schedule creation. diff --git a/src/modules/bmb/workflows/create-agent/data/reference/workflows/meal-prep-nutrition/steps/step-06-prep-schedule.md b/src/modules/bmb/workflows/create-agent/data/reference/workflows/meal-prep-nutrition/steps/step-06-prep-schedule.md deleted file mode 100644 index 1b69c58e..00000000 --- a/src/modules/bmb/workflows/create-agent/data/reference/workflows/meal-prep-nutrition/steps/step-06-prep-schedule.md +++ /dev/null @@ -1,194 +0,0 @@ ---- -name: 'step-06-prep-schedule' -description: "Create a realistic meal prep schedule that fits the user's lifestyle" - -# Path Definitions -workflow_path: '{project-root}/_bmad/bmb/reference/workflows/meal-prep-nutrition' - -# File References -thisStepFile: '{workflow_path}/steps/step-06-prep-schedule.md' -workflowFile: '{workflow_path}/workflow.md' -outputFile: '{output_folder}/nutrition-plan-{project_name}.md' - -# Task References -advancedElicitationTask: '{project-root}/_bmad/core/tasks/advanced-elicitation.xml' -partyModeWorkflow: '{project-root}/_bmad/core/workflows/party-mode/workflow.md' - -# Template References -prepScheduleTemplate: '{workflow_path}/templates/prep-schedule-section.md' ---- - -# Step 6: Meal Prep Execution Schedule - -## 🎯 Objective - -Create a realistic meal prep schedule that fits the user's lifestyle and ensures success. - -## 📋 MANDATORY EXECUTION RULES (READ FIRST): - -- 🛑 NEVER suggest a prep schedule that requires more time than user has available -- 📖 CRITICAL: Base schedule on user's actual cooking frequency -- 🔄 CRITICAL: Include storage and reheating instructions -- ✅ Start with a sustainable prep routine -- 🚫 DO NOT overwhelm with too much at once - -### 1. Time Commitment Analysis - -Based on user profile: - -- **Available prep time per week** -- **Preferred prep days** (weekend vs weeknight) -- **Energy levels throughout day** -- **Kitchen limitations** - -### 2. Prep Strategy Options - -#### Option A: Sunday Batch Prep (2-3 hours) - -- Prep all proteins for week -- Chop all vegetables -- Cook grains in bulk -- Portion snacks - -#### Option B: Semi-Weekly Prep (1-1.5 hours x 2) - -- Sunday: Proteins + grains -- Wednesday: Refresh veggies + prep second half - -#### Option C: Daily Prep (15-20 minutes daily) - -- Prep next day's lunch -- Quick breakfast assembly -- Dinner prep each evening - -### 3. Detailed Timeline Breakdown - -``` -Sunday (2 hours): -2:00-2:30: Preheat oven, marinate proteins -2:30-3:15: Cook proteins (bake chicken, cook ground turkey) -3:15-3:45: Cook grains (rice, quinoa) -3:45-4:00: Chop vegetables and portion snacks -4:00-4:15: Clean and organize refrigerator -``` - -## 📦 Storage Guidelines: - -### Protein Storage: - -- Cooked chicken: 4 days refrigerated, 3 months frozen -- Ground meat: 3 days refrigerated, 3 months frozen -- Fish: Best fresh, 2 days refrigerated - -### Vegetable Storage: - -- Cut vegetables: 3-4 days in airtight containers -- Hard vegetables: Up to 1 week (carrots, bell peppers) -- Leafy greens: 2-3 days with paper towels - -### Meal Assembly: - -- Keep sauces separate until eating -- Consider texture changes when reheating -- Label with preparation date - -## 🔧 ADAPTATION STRATEGIES: - -### For Busy Weeks: - -- Emergency freezer meals -- Quick backup options -- 15-minute meal alternatives - -### For Low Energy Days: - -- No-cook meal options -- Smoothie packs -- Assembly-only meals - -### For Social Events: - -- Flexible meal timing -- Restaurant integration -- "Off-plan" guilt-free guidelines - -## ✅ SUCCESS METRICS: - -- Realistic time commitment -- Clear instructions for each prep session -- Storage and reheating guidelines included -- Backup plans for busy weeks -- Sustainable long-term approach - -## ❌ FAILURE MODES TO AVOID: - -- Overly ambitious prep schedule -- Not accounting for cleaning time -- Ignoring user's energy patterns -- No flexibility for unexpected events -- Complex instructions for beginners - -## 💬 SAMPLE DIALOG STYLE: - -**✅ GOOD (Intent-based):** -"Based on your 2-hour Sunday availability, we could create a prep schedule that sets you up for the week. We'll batch cook proteins and grains, then do quick assembly each evening. How does that sound with your energy levels?" - -**❌ AVOID (Prescriptive):** -"You must prep every Sunday from 2-4 PM. No exceptions." - -## 📝 FINAL TEMPLATE OUTPUT: - -Complete {outputFile} by loading and appending content from {prepScheduleTemplate} - -## 🎯 WORKFLOW COMPLETION: - -### Update workflow.md frontmatter: - -```yaml -stepsCompleted: ['init', 'assessment', 'strategy', 'shopping', 'prep-schedule'] -lastStep: 'prep-schedule' -completionDate: [current date] -userSatisfaction: [to be rated] -``` - -### Final Message Template: - -"Congratulations! Your personalized nutrition plan is complete. Remember, this is a living document that we can adjust as your needs change. Check in weekly for the first month to fine-tune your approach!" - -## 📊 NEXT STEPS FOR USER: - -1. Review complete plan -2. Shop for ingredients -3. Execute first prep session -4. Note any adjustments needed -5. Schedule follow-up review - -### 5. Present MENU OPTIONS - -Display: **Select an Option:** [A] Advanced Prep Techniques [P] Coach Perspectives [C] Complete Workflow - -#### EXECUTION RULES: - -- ALWAYS halt and wait for user input after presenting menu -- ONLY proceed to next step when user selects 'C' -- After other menu items execution, return to this menu -- User can chat or ask questions - always respond and then end with display again of the menu options -- Use menu handling logic section below - -#### Menu Handling Logic: - -- HALT and AWAIT ANSWER -- IF A: Execute `{project-root}/_bmad/core/tasks/advanced-elicitation.xml` -- IF P: Execute `{project-root}/_bmad/core/workflows/party-mode/workflow.md` -- IF C: Update frontmatter with all steps completed, mark workflow complete, display final message -- IF Any other comments or queries: help user respond then [Redisplay Menu Options](#6-present-menu-options) - -## CRITICAL STEP COMPLETION NOTE - -ONLY WHEN C is selected and content is saved to document: - -1. Update frontmatter with all steps completed and indicate final completion -2. Display final completion message -3. End workflow session - -**Final Message:** "Congratulations! Your personalized nutrition plan is complete. Remember, this is a living document that we can adjust as your needs change. Check in weekly for the first month to fine-tune your approach!" diff --git a/src/modules/bmb/workflows/create-agent/data/reference/workflows/meal-prep-nutrition/templates/assessment-section.md b/src/modules/bmb/workflows/create-agent/data/reference/workflows/meal-prep-nutrition/templates/assessment-section.md deleted file mode 100644 index 610f397c..00000000 --- a/src/modules/bmb/workflows/create-agent/data/reference/workflows/meal-prep-nutrition/templates/assessment-section.md +++ /dev/null @@ -1,25 +0,0 @@ -## 📊 Daily Nutrition Targets - -**Daily Calories:** [calculated amount] -**Protein:** [grams]g ([percentage]% of calories) -**Carbohydrates:** [grams]g ([percentage]% of calories) -**Fat:** [grams]g ([percentage]% of calories) - ---- - -## ⚠️ Dietary Considerations - -### Allergies & Intolerances - -- [List of identified restrictions] -- [Cross-reactivity notes if applicable] - -### Medical Considerations - -- [Conditions noted with professional referral recommendation] -- [Special nutritional requirements] - -### Preferences - -- [Cultural/ethical restrictions] -- [Strong dislikes to avoid] diff --git a/src/modules/bmb/workflows/create-agent/data/reference/workflows/meal-prep-nutrition/templates/nutrition-plan.md b/src/modules/bmb/workflows/create-agent/data/reference/workflows/meal-prep-nutrition/templates/nutrition-plan.md deleted file mode 100644 index 8c67f79a..00000000 --- a/src/modules/bmb/workflows/create-agent/data/reference/workflows/meal-prep-nutrition/templates/nutrition-plan.md +++ /dev/null @@ -1,68 +0,0 @@ -# Personalized Nutrition Plan - -**Created:** {{date}} -**Author:** {{user_name}} - ---- - -## ✅ Progress Tracking - -**Steps Completed:** - -- [ ] Step 1: Workflow Initialization -- [ ] Step 2: User Profile & Goals -- [ ] Step 3: Dietary Assessment -- [ ] Step 4: Meal Strategy -- [ ] Step 5: Shopping List _(if applicable)_ -- [ ] Step 6: Meal Prep Schedule - -**Last Updated:** {{date}} - ---- - -## 📋 Executive Summary - -**Primary Goal:** [To be filled in Step 1] - -**Daily Nutrition Targets:** - -- Calories: [To be calculated in Step 2] -- Protein: [To be calculated in Step 2]g -- Carbohydrates: [To be calculated in Step 2]g -- Fat: [To be calculated in Step 2]g - -**Key Considerations:** [To be filled in Step 2] - ---- - -## 🎯 Your Nutrition Goals - -[Content to be added in Step 1] - ---- - -## 🍽️ Meal Framework - -[Content to be added in Step 3] - ---- - -## 🛒 Shopping List - -[Content to be added in Step 4 - if applicable] - ---- - -## ⏰ Meal Prep Schedule - -[Content to be added in Step 5] - ---- - -## 📝 Notes & Next Steps - -[Add any notes or adjustments as you progress] - ---- - -**Medical Disclaimer:** This nutrition plan is for educational purposes only and is not medical advice. Please consult with a registered dietitian or healthcare provider for personalized medical nutrition therapy, especially if you have medical conditions, allergies, or are taking medications. diff --git a/src/modules/bmb/workflows/create-agent/data/reference/workflows/meal-prep-nutrition/templates/prep-schedule-section.md b/src/modules/bmb/workflows/create-agent/data/reference/workflows/meal-prep-nutrition/templates/prep-schedule-section.md deleted file mode 100644 index 1143cd51..00000000 --- a/src/modules/bmb/workflows/create-agent/data/reference/workflows/meal-prep-nutrition/templates/prep-schedule-section.md +++ /dev/null @@ -1,29 +0,0 @@ -## Meal Prep Schedule - -### [Chosen Prep Strategy] - -### Weekly Prep Tasks - -- [Day]: [Tasks] - [Time needed] -- [Day]: [Tasks] - [Time needed] - -### Daily Assembly - -- Morning: [Quick tasks] -- Evening: [Assembly instructions] - -### Storage Guide - -- Proteins: [Instructions] -- Vegetables: [Instructions] -- Grains: [Instructions] - -### Success Tips - -- [Personalized success strategies] - -### Weekly Review Checklist - -- [ ] Check weekend schedule -- [ ] Review meal plan satisfaction -- [ ] Adjust next week's plan diff --git a/src/modules/bmb/workflows/create-agent/data/reference/workflows/meal-prep-nutrition/templates/profile-section.md b/src/modules/bmb/workflows/create-agent/data/reference/workflows/meal-prep-nutrition/templates/profile-section.md deleted file mode 100644 index 3784c1d9..00000000 --- a/src/modules/bmb/workflows/create-agent/data/reference/workflows/meal-prep-nutrition/templates/profile-section.md +++ /dev/null @@ -1,47 +0,0 @@ -## 🎯 Your Nutrition Goals - -### Primary Objective - -[User's main goal and motivation] - -### Target Timeline - -[Realistic timeframe and milestones] - -### Success Metrics - -- [Specific measurable outcomes] -- [Non-scale victories] -- [Lifestyle improvements] - ---- - -## 👤 Personal Profile - -### Basic Information - -- **Age:** [age] -- **Gender:** [gender] -- **Height:** [height] -- **Weight:** [current weight] -- **Activity Level:** [activity description] - -### Lifestyle Factors - -- **Daily Schedule:** [typical day structure] -- **Cooking Frequency:** [how often they cook] -- **Cooking Skill:** [beginner/intermediate/advanced] -- **Available Time:** [time for meal prep] - -### Food Preferences - -- **Favorite Cuisines:** [list] -- **Disliked Foods:** [list] -- **Allergies:** [list] -- **Dietary Restrictions:** [list] - -### Budget & Access - -- **Weekly Budget:** [range] -- **Shopping Access:** [stores available] -- **Special Considerations:** [family, social, etc.] diff --git a/src/modules/bmb/workflows/create-agent/data/reference/workflows/meal-prep-nutrition/templates/shopping-section.md b/src/modules/bmb/workflows/create-agent/data/reference/workflows/meal-prep-nutrition/templates/shopping-section.md deleted file mode 100644 index 6a172159..00000000 --- a/src/modules/bmb/workflows/create-agent/data/reference/workflows/meal-prep-nutrition/templates/shopping-section.md +++ /dev/null @@ -1,37 +0,0 @@ -## Weekly Shopping List - -### Check Pantry First - -- [List of common staples to verify] - -### Produce Section - -- [Item] - [Quantity] - [Used in] - -### Protein - -- [Item] - [Quantity] - [Used in] - -### Dairy/Alternatives - -- [Item] - [Quantity] - [Used in] - -### Grains/Starches - -- [Item] - [Quantity] - [Used in] - -### Frozen - -- [Item] - [Quantity] - [Used in] - -### Pantry - -- [Item] - [Quantity] - [Used in] - -### Money-Saving Tips - -- [Personalized savings strategies] - -### Flexible Swaps - -- [Alternative options if items unavailable] diff --git a/src/modules/bmb/workflows/create-agent/data/reference/workflows/meal-prep-nutrition/templates/strategy-section.md b/src/modules/bmb/workflows/create-agent/data/reference/workflows/meal-prep-nutrition/templates/strategy-section.md deleted file mode 100644 index 9c11d05b..00000000 --- a/src/modules/bmb/workflows/create-agent/data/reference/workflows/meal-prep-nutrition/templates/strategy-section.md +++ /dev/null @@ -1,18 +0,0 @@ -## Weekly Meal Framework - -### Protein Rotation - -- Monday: [Protein source] -- Tuesday: [Protein source] -- Wednesday: [Protein source] -- Thursday: [Protein source] -- Friday: [Protein source] -- Saturday: [Protein source] -- Sunday: [Protein source] - -### Meal Timing - -- Breakfast: [Time] - [Type] -- Lunch: [Time] - [Type] -- Dinner: [Time] - [Type] -- Snacks: [As needed] diff --git a/src/modules/bmb/workflows/create-agent/data/reference/workflows/meal-prep-nutrition/workflow.md b/src/modules/bmb/workflows/create-agent/data/reference/workflows/meal-prep-nutrition/workflow.md deleted file mode 100644 index a63fa50f..00000000 --- a/src/modules/bmb/workflows/create-agent/data/reference/workflows/meal-prep-nutrition/workflow.md +++ /dev/null @@ -1,58 +0,0 @@ ---- -name: Meal Prep & Nutrition Plan -description: Creates personalized meal plans through collaborative nutrition planning between an expert facilitator and individual seeking to improve their nutrition habits. -web_bundle: true ---- - -# Meal Prep & Nutrition Plan Workflow - -**Goal:** Create personalized meal plans through collaborative nutrition planning between an expert facilitator and individual seeking to improve their nutrition habits. - -**Your Role:** In addition to your name, communication_style, and persona, you are also a nutrition expert and meal planning specialist working collaboratively with the user. We engage in collaborative dialogue, not command-response, where you bring nutritional expertise and structured planning, while the user brings their personal preferences, lifestyle constraints, and health goals. Work together to create a sustainable, enjoyable nutrition plan. - ---- - -## WORKFLOW ARCHITECTURE - -This uses **step-file architecture** for disciplined execution: - -### Core Principles - -- **Micro-file Design**: Each step is a self contained instruction file that is a part of an overall workflow that must be followed exactly -- **Just-In-Time Loading**: Only the current step file is in memory - never load future step files until told to do so -- **Sequential Enforcement**: Sequence within the step files must be completed in order, no skipping or optimization allowed -- **State Tracking**: Document progress in output file frontmatter using `stepsCompleted` array when a workflow produces a document -- **Append-Only Building**: Build documents by appending content as directed to the output file - -### Step Processing Rules - -1. **READ COMPLETELY**: Always read the entire step file before taking any action -2. **FOLLOW SEQUENCE**: Execute all numbered sections in order, never deviate -3. **WAIT FOR INPUT**: If a menu is presented, halt and wait for user selection -4. **CHECK CONTINUATION**: If the step has a menu with Continue as an option, only proceed to next step when user selects 'C' (Continue) -5. **SAVE STATE**: Update `stepsCompleted` in frontmatter before loading next step -6. **LOAD NEXT**: When directed, load, read entire file, then execute the next step file - -### Critical Rules (NO EXCEPTIONS) - -- 🛑 **NEVER** load multiple step files simultaneously -- 📖 **ALWAYS** read entire step file before execution -- 🚫 **NEVER** skip steps or optimize the sequence -- 💾 **ALWAYS** update frontmatter of output files when writing the final output for a specific step -- 🎯 **ALWAYS** follow the exact instructions in the step file -- ⏸️ **ALWAYS** halt at menus and wait for user input -- 📋 **NEVER** create mental todo lists from future steps - ---- - -## INITIALIZATION SEQUENCE - -### 1. Configuration Loading - -Load and read full config from {project-root}/_bmad/bmm/config.yaml and resolve: - -- `project_name`, `output_folder`, `user_name`, `communication_language`, `document_output_language`, `user_skill_level` - -### 2. First Step EXECUTION - -Load, read the full file and then execute `{project-root}/_bmad/bmb/reference/workflows/meal-prep-nutrition/steps/step-01-init.md` to begin the workflow. diff --git a/src/modules/bmb/workflows/create-agent/data/validation-complete.md b/src/modules/bmb/workflows/create-agent/data/validation-complete.md deleted file mode 100644 index 0372d237..00000000 --- a/src/modules/bmb/workflows/create-agent/data/validation-complete.md +++ /dev/null @@ -1,305 +0,0 @@ -# Create Agent Workflow - Complete Migration Validation - -## Migration Summary - -**Legacy Workflow:** `bmb/workflows/create-agent-legacy/create-agent/workflow.yaml` + `instructions.md` -**New Workflow:** `bmb/workflows/create-agent/create-agent/workflow.md` + 11 step files -**Migration Date:** 2025-11-30T06:32:21.248Z -**Migration Status:** ✅ COMPLETE - -## Functionality Preservation Validation - -### ✅ Core Workflow Features Preserved - -**1. Optional Brainstorming Integration** - -- Legacy: XML step with brainstorming workflow invocation -- New: `step-01-brainstorm.md` with same workflow integration -- Status: ✅ FULLY PRESERVED - -**2. Agent Type Determination** - -- Legacy: XML discovery with Simple/Expert/Module selection -- New: `step-02-discover.md` with enhanced architecture guidance -- Status: ✅ ENHANCED (better explanations and examples) - -**3. Four-Field Persona Development** - -- Legacy: XML step with role, identity, communication_style, principles -- New: `step-03-persona.md` with clearer field separation -- Status: ✅ IMPROVED (better field distinction guidance) - -**4. Command Structure Building** - -- Legacy: XML step with workflow/action transformation -- New: `step-04-commands.md` with architecture-specific guidance -- Status: ✅ ENHANCED (better workflow integration planning) - -**5. Agent Naming and Identity** - -- Legacy: XML step for name/title/icon/filename selection -- New: `step-05-name.md` with more natural naming process -- Status: ✅ IMPROVED (more conversational approach) - -**6. YAML Generation** - -- Legacy: XML step with template-based YAML building -- New: `step-06-build.md` with agent-type specific templates -- Status: ✅ ENHANCED (type-optimized templates) - -**7. Quality Validation** - -- Legacy: XML step with technical checks -- New: `step-07-validate.md` with conversational validation -- Status: ✅ IMPROVED (user-friendly validation approach) - -**8. Expert Agent Sidecar Setup** - -- Legacy: XML step for file structure creation -- New: `step-08-setup.md` with comprehensive workspace creation -- Status: ✅ ENHANCED (complete workspace with documentation) - -**9. Customization File** - -- Legacy: XML step for optional config file -- New: `step-09-customize.md` with better examples and guidance -- Status: ✅ IMPROVED (more practical customization options) - -**10. Build Tools Handling** - -- Legacy: XML step for build detection and compilation -- New: `step-10-build-tools.md` with clearer process explanation -- Status: ✅ IMPROVED (better user guidance) - -**11. Completion and Next Steps** - -- Legacy: XML step for celebration and activation -- New: `step-11-celebrate.md` with enhanced celebration -- Status: ✅ ENHANCED (more engaging completion experience) - -### ✅ Documentation and Data Preservation - -**Agent Documentation References** - -- Agent compilation guide: `{project-root}/_bmad/bmb/docs/agents/agent-compilation.md` -- Agent types guide: `{project-root}/_bmad/bmb/docs/agents/understanding-agent-types.md` -- Architecture docs: simple, expert, module agent architectures -- Menu patterns guide: `{project-root}/_bmad/bmb/docs/agents/agent-menu-patterns.md` -- Status: ✅ ALL REFERENCES PRESERVED - -**Communication Presets** - -- Original: `communication-presets.csv` with 13 categories -- New: `data/communication-presets.csv` (copied) -- Status: ✅ COMPLETELY PRESERVED - -**Reference Agent Examples** - -- Original: Reference agent directories -- New: `data/reference/agents/` (copied) -- Status: ✅ COMPLETELY PRESERVED - -**Brainstorming Context** - -- Original: `brainstorm-context.md` -- New: `data/brainstorm-context.md` (copied) -- Status: ✅ COMPLETELY PRESERVED - -**Validation Resources** - -- Original: `agent-validation-checklist.md` -- New: `data/agent-validation-checklist.md` (copied) -- Status: ✅ COMPLETELY PRESERVED - -### ✅ Menu System and User Experience - -**Menu Options (A/P/C)** - -- Legacy: Advanced Elicitation, Party Mode, Continue options -- New: Same menu system in every step -- Status: ✅ FULLY PRESERVED - -**Conversational Discovery Approach** - -- Legacy: Natural conversation flow throughout steps -- New: Enhanced conversational approach with better guidance -- Status: ✅ IMPROVED (more natural flow) - -**User Input Handling** - -- Legacy: Interactive input at each decision point -- New: Same interactivity with clearer prompts -- Status: ✅ FULLY PRESERVED - -## Architecture Improvements - -### ✅ Step-Specific Loading Optimization - -**Legacy Architecture:** - -- Single `instructions.md` file (~500 lines) -- All steps loaded into memory upfront -- No conditional loading based on agent type -- Linear execution regardless of context - -**New Architecture:** - -- 11 focused step files (50-150 lines each) -- Just-in-time loading of individual steps -- Conditional execution paths based on agent type -- Optimized memory usage and performance - -**Benefits Achieved:** - -- **Memory Efficiency:** Only load current step (~70% reduction) -- **Performance:** Faster step transitions -- **Maintainability:** Individual step files easier to edit -- **Extensibility:** Easy to add or modify steps - -### ✅ Enhanced Template System - -**Legacy:** - -- Basic template references in XML -- Limited agent type differentiation -- Minimal customization options - -**New:** - -- Comprehensive templates for each agent type: - - `agent-complete-simple.md` - Self-contained agents - - `agent-complete-expert.md` - Learning agents with sidecar - - `agent-complete-module.md` - Team coordination agents -- Detailed documentation and examples -- Advanced configuration options - -## Quality Improvements - -### ✅ Enhanced User Experience - -**Better Guidance:** - -- Clearer explanations of agent types and architecture -- More examples and practical illustrations -- Step-by-step progress tracking -- Better error prevention through improved instructions - -**Improved Validation:** - -- Conversational validation approach instead of technical checks -- User-friendly error messages and fixes -- Quality assurance built into each step -- Better success criteria and metrics - -**Enhanced Customization:** - -- More practical customization examples -- Better guidance for safe experimentation -- Clear explanation of benefits and risks -- Improved documentation for ongoing maintenance - -### ✅ Developer Experience - -**Better Maintainability:** - -- Modular step structure easier to modify -- Clear separation of concerns -- Better documentation and comments -- Consistent patterns across steps - -**Enhanced Debugging:** - -- Individual step files easier to test -- Better error messages and context -- Clear success/failure criteria -- Improved logging and tracking - -## Migration Validation Results - -### ✅ Functionality Tests - -**Core Workflow Execution:** - -- [x] Optional brainstorming workflow integration -- [x] Agent type determination with architecture guidance -- [x] Four-field persona development with clear separation -- [x] Command building with workflow integration -- [x] Agent naming and identity creation -- [x] Type-specific YAML generation -- [x] Quality validation with conversational approach -- [x] Expert agent sidecar workspace creation -- [x] Customization file generation -- [x] Build tools handling and compilation -- [x] Completion celebration and next steps - -**Asset Preservation:** - -- [x] All documentation references maintained -- [x] Communication presets CSV copied -- [x] Reference agent examples copied -- [x] Brainstorming context preserved -- [x] Validation resources maintained - -**Menu System:** - -- [x] A/P/C menu options in every step -- [x] Proper menu handling logic -- [x] Advanced Elicitation integration -- [x] Party Mode workflow integration - -### ✅ Performance Improvements - -**Memory Usage:** - -- Legacy: ~500KB single file load -- New: ~50KB per step (average) -- Improvement: 90% memory reduction per step - -**Loading Time:** - -- Legacy: Full workflow load upfront -- New: Individual step loading -- Improvement: ~70% faster initial load - -**Maintainability:** - -- Legacy: Monolithic file structure -- New: Modular step structure -- Improvement: Easier to modify and extend - -## Migration Success Metrics - -### ✅ Completeness: 100% - -- All 13 XML steps converted to 11 focused step files -- All functionality preserved and enhanced -- All assets copied and referenced correctly -- All documentation maintained - -### ✅ Quality: Improved - -- Better user experience with clearer guidance -- Enhanced validation and error handling -- Improved maintainability and debugging -- More comprehensive templates and examples - -### ✅ Performance: Optimized - -- Step-specific loading reduces memory usage -- Faster execution through conditional loading -- Better resource utilization -- Improved scalability - -## Conclusion - -**✅ MIGRATION COMPLETE AND SUCCESSFUL** - -The create-agent workflow has been successfully migrated from the legacy XML format to the new standalone format with: - -- **100% Functionality Preservation:** All original features maintained -- **Significant Quality Improvements:** Better UX, validation, and documentation -- **Performance Optimizations:** Step-specific loading and resource efficiency -- **Enhanced Maintainability:** Modular structure and clear separation of concerns -- **Future-Ready Architecture:** Easy to extend and modify - -The new workflow is ready for production use and provides a solid foundation for future enhancements while maintaining complete backward compatibility with existing agent builder functionality. diff --git a/src/modules/bmb/workflows/create-agent/steps/step-02-discover.md b/src/modules/bmb/workflows/create-agent/steps/step-02-discover.md deleted file mode 100644 index 43fc5e1e..00000000 --- a/src/modules/bmb/workflows/create-agent/steps/step-02-discover.md +++ /dev/null @@ -1,206 +0,0 @@ ---- -name: 'step-02-discover' -description: 'Discover the agent purpose and type through natural conversation' - -# Path Definitions -workflow_path: '{project-root}/bmb/workflows/create-agent/create-agent' - -# File References -thisStepFile: '{workflow_path}/steps/step-02-discover.md' -nextStepFile: '{workflow_path}/steps/step-03-persona.md' -workflowFile: '{workflow_path}/workflow.md' -agentPlan: '{bmb_creations_output_folder}/agent-plan-{agent_name}.md' -agentTypesGuide: '{project-root}/_bmad/bmb/docs/agents/understanding-agent-types.md' -simpleExamples: '{workflow_path}/data/reference/agents/simple-examples/' -expertExamples: '{workflow_path}/data/reference/agents/expert-examples/' -moduleExamples: '{workflow_path}/data/reference/agents/module-examples/' - -# Template References -agentPurposeTemplate: '{workflow_path}/templates/agent-purpose-and-type.md' - -# Task References -advancedElicitationTask: '{project-root}/_bmad/core/tasks/advanced-elicitation.xml' -partyModeWorkflow: '{project-root}/_bmad/core/workflows/party-mode/workflow.md' ---- - -# Step 2: Discover Agent Purpose and Type - -## STEP GOAL: - -Guide user to articulate their agent's core purpose and determine the appropriate agent type for their architecture needs through natural exploration and conversation. - -## MANDATORY EXECUTION RULES (READ FIRST): - -### Universal Rules: - -- 🛑 NEVER generate content without user input -- 📖 CRITICAL: Read the complete step file before taking any action -- 🔄 CRITICAL: When loading next step with 'C', ensure entire file is read -- 📋 YOU ARE A FACILITATOR, not a content generator - -### Role Reinforcement: - -- ✅ You are an agent architect who helps users discover and clarify their agent vision -- ✅ If you already have been given a name, communication_style and identity, continue to use those while playing this new role -- ✅ We engage in collaborative dialogue, not command-response -- ✅ You bring agent architecture expertise, user brings their domain knowledge and goals, together we design the optimal agent -- ✅ Maintain collaborative exploratory tone throughout - -### Step-Specific Rules: - -- 🎯 Focus only on discovering purpose and determining appropriate agent type -- 🚫 FORBIDDEN to push specific agent types without clear justification -- 💬 Approach: Guide through natural conversation, not interrogation -- 📋 Agent type recommendation based on architecture needs, not capability limits - -## EXECUTION PROTOCOLS: - -- 🎯 Natural conversation flow, not rigid questioning -- 💾 Document purpose and type decisions clearly -- 📖 Load technical documentation as needed for guidance -- 🚫 FORBIDDEN to make assumptions about user needs - -## CONTEXT BOUNDARIES: - -- Available context: User is creating a new agent, may have brainstorming results -- Focus: Purpose discovery and agent type determination -- Limits: No persona development, no command design yet -- Dependencies: User must articulate clear purpose and agree on agent type - -## Sequence of Instructions (Do not deviate, skip, or optimize) - -### 1. Load Technical Documentation - -Load and understand agent building documentation: - -- Agent types guide: `{agentTypesGuide}` -- Reference examples from appropriate directories as needed - -### 2. Purpose Discovery Through Conversation - -If brainstorming was completed in previous step, reference those results naturally in conversation. - -Guide user to articulate through exploratory questions: - -**Core Purpose Exploration:** -"What problems or challenges will your agent help solve?" -"Who are the primary users of this agent?" -"What makes your agent unique or special compared to existing solutions?" -"What specific tasks or workflows will this agent handle?" - -**Deep Dive Questions:** -"What's the main pain point this agent addresses?" -"How will users interact with this agent day-to-day?" -"What would success look like for users of this agent?" - -Continue conversation until purpose is clearly understood. - -### 3. Agent Type Determination - -As purpose becomes clear, analyze and recommend appropriate agent type. - -**Critical Understanding:** Agent types differ in **architecture and integration**, NOT capabilities. ALL types can write files, execute commands, and use system resources. - -**Agent Type Decision Framework:** - -- **Simple Agent** - Self-contained (all in YAML), stateless, no persistent memory - - Choose when: Single-purpose utility, each run independent, logic fits in YAML - - CAN write to output folders, update files, execute commands - - Example: Git commit helper, documentation generator, data validator - -- **Expert Agent** - Personal sidecar files, persistent memory, domain-restricted - - Choose when: Needs to remember across sessions, personal knowledge base, learning over time - - CAN have personal workflows in sidecar if critical_actions loads workflow engine - - Example: Personal research assistant, domain expert advisor, learning companion - - Example: Project coordinator, workflow manager, team orchestrator - -**Type Selection Process:** - -1. Present recommendation based on discovered needs -2. Explain WHY this type fits their architecture requirements -3. Show relevant examples from reference directories -4. Get user agreement or adjustment - -### 4. Path Determination - -**For Module Agents:** -"Which module will this agent belong to?" -"Module agents integrate with existing team infrastructure and can coordinate with other agents in the same module." - -**For Standalone Agents (Simple/Expert):** -"This will be your personal agent, independent of any specific module. It will have its own dedicated space for operation." - -### 5. Document Findings - -#### Content to Append (if applicable): - -```markdown -## Agent Purpose and Type - -### Core Purpose - -[Articulated agent purpose and value proposition] - -### Target Users - -[Primary user groups and use cases] - -### Chosen Agent Type - -[Selected agent type with detailed rationale] - -### Output Path - -[Determined output location and structure] - -### Context from Brainstorming - -[Any relevant insights from previous brainstorming session] -``` - -Save this content to {agentPlan} for reference in subsequent steps. - -### 6. Present MENU OPTIONS - -Display: "**Select an Option:** [A] Advanced Elicitation [P] Party Mode [C] Continue" - -#### Menu Handling Logic: - -- IF A: Execute {advancedElicitationTask} -- IF P: Execute {partyModeWorkflow} -- IF C: Save content to {agentPlan}, update frontmatter, then only then load, read entire file, then execute {nextStepFile} -- IF Any other comments or queries: help user respond then [Redisplay Menu Options](#6-present-menu-options) - -#### EXECUTION RULES: - -- ALWAYS halt and wait for user input after presenting menu -- ONLY proceed to next step when user selects 'C' -- After other menu items execution, return to this menu -- User can chat or ask questions - always respond and then end with display again of the menu options - -## CRITICAL STEP COMPLETION NOTE - -ONLY WHEN [C continue option] is selected and [agent purpose clearly articulated and agent type determined], will you then load and read fully `{nextStepFile}` to execute and begin persona development. - ---- - -## 🚨 SYSTEM SUCCESS/FAILURE METRICS - -### ✅ SUCCESS: - -- Agent purpose clearly articulated and documented -- Appropriate agent type selected with solid reasoning -- User understands architectural implications of chosen type -- Output paths determined correctly based on agent type -- Content properly saved to output file -- Menu presented and user input handled correctly - -### ❌ SYSTEM FAILURE: - -- Proceeding without clear agent purpose -- Pushing specific agent types without justification -- Not explaining architectural implications -- Failing to document findings properly -- Not getting user agreement on agent type selection - -**Master Rule:** Skipping steps, optimizing sequences, or not following exact instructions is FORBIDDEN and constitutes SYSTEM FAILURE. diff --git a/src/modules/bmb/workflows/create-agent/steps/step-03-persona.md b/src/modules/bmb/workflows/create-agent/steps/step-03-persona.md deleted file mode 100644 index bf0479cc..00000000 --- a/src/modules/bmb/workflows/create-agent/steps/step-03-persona.md +++ /dev/null @@ -1,260 +0,0 @@ ---- -name: 'step-03-persona' -description: 'Shape the agent personality through collaborative discovery' - -# Path Definitions -workflow_path: '{project-root}/bmb/workflows/create-agent/create-agent' - -# File References -thisStepFile: '{workflow_path}/steps/step-03-persona.md' -nextStepFile: '{workflow_path}/steps/step-04-commands.md' -workflowFile: '{workflow_path}/workflow.md' -agentPlan: '{bmb_creations_output_folder}/agent-plan-{agent_name}.md' -communicationPresets: '{workflow_path}/data/communication-presets.csv' -agentMenuPatterns: '{project-root}/_bmad/bmb/docs/agents/agent-menu-patterns.md' - -# Template References -personaTemplate: '{workflow_path}/templates/agent-persona.md' - -# Task References -advancedElicitationTask: '{project-root}/_bmad/core/tasks/advanced-elicitation.xml' -partyModeWorkflow: '{project-root}/_bmad/core/workflows/party-mode/workflow.md' ---- - -# Step 3: Shape Agent's Personality - -## STEP GOAL: - -Guide user to develop the agent's complete persona using the four-field system while preserving distinct purposes for each field and ensuring alignment with the agent's purpose. - -## MANDATORY EXECUTION RULES (READ FIRST): - -### Universal Rules: - -- 🛑 NEVER generate content without user input -- 📖 CRITICAL: Read the complete step file before taking any action -- 🔄 CRITICAL: When loading next step with 'C', ensure entire file is read -- 📋 YOU ARE A FACILITATOR, not a content generator - -### Role Reinforcement: - -- ✅ You are a persona architect who helps users craft compelling agent personalities -- ✅ If you already have been given a name, communication_style and identity, continue to use those while playing this new role -- ✅ We engage in collaborative dialogue, not command-response -- ✅ You bring persona development expertise, user brings their vision and preferences, together we create an authentic agent personality -- ✅ Maintain collaborative creative tone throughout - -### Step-Specific Rules: - -- 🎯 Focus only on developing the four persona fields distinctly -- 🚫 FORBIDDEN to mix persona fields or confuse their purposes -- 💬 Approach: Guide discovery through natural conversation, not formulaic questioning -- 📋 Each field must serve its distinct purpose without overlap - -## EXECUTION PROTOCOLS: - -- 🎯 Natural personality discovery through conversation -- 💾 Document all four fields clearly and separately -- 📖 Load communication presets for style selection when needed -- 🚫 FORBIDDEN to create generic or mixed-field personas - -## CONTEXT BOUNDARIES: - -- Available context: Agent purpose and type from step 2, optional brainstorming insights -- Focus: Develop four distinct persona fields (role, identity, communication_style, principles) -- Limits: No command design, no technical implementation yet -- Dependencies: Clear agent purpose and type from previous step - -## Sequence of Instructions (Do not deviate, skip, or optimize) - -### 1. Understanding the Four Persona Fields - -Explain to user: "Each field serves a DISTINCT purpose when the compiled agent LLM reads them:" - -**Role → WHAT the agent does** - -- LLM interprets: "What knowledge, skills, and capabilities do I possess?" -- Examples: "Strategic Business Analyst + Requirements Expert", "Commit Message Artisan" - -**Identity → WHO the agent is** - -- LLM interprets: "What background, experience, and context shape my responses?" -- Examples: "Senior analyst with 8+ years connecting market insights to strategy..." - -**Communication_Style → HOW the agent talks** - -- LLM interprets: "What verbal patterns, word choice, quirks, and phrasing do I use?" -- Examples: "Talks like a pulp super hero with dramatic flair and heroic language" - -**Principles → WHAT GUIDES the agent's decisions** - -- LLM interprets: "What beliefs and operating philosophy drive my choices and recommendations?" -- Examples: "Every business challenge has root causes. Ground findings in evidence." - -### 2. Role Development - -Guide conversation toward a clear 1-2 line professional title: - -"Based on your agent's purpose to {{discovered_purpose}}, what professional title captures its essence?" - -**Role Crafting Process:** - -- Start with core capabilities discovered in step 2 -- Refine to professional, expertise-focused language -- Ensure role clearly defines the agent's domain -- Examples: "Strategic Business Analyst + Requirements Expert", "Code Review Specialist" - -Continue conversation until role is clear and professional. - -### 3. Identity Development - -Build 3-5 line identity statement establishing credibility: - -"What background and specializations would give this agent credibility in its role?" - -**Identity Elements to Explore:** - -- Experience level and background -- Specialized knowledge areas -- Professional context and perspective -- Domain expertise -- Approach to problem-solving - -### 4. Communication Style Selection - -Present communication style categories: - -"Let's choose a communication style. I have 13 categories available - which type of personality appeals to you for your agent?" - -**Categories to Present:** - -- adventurous (pulp-superhero, film-noir, pirate-captain, etc.) -- analytical (data-scientist, forensic-investigator, strategic-planner) -- creative (mad-scientist, artist-visionary, jazz-improviser) -- devoted (overprotective-guardian, adoring-superfan, loyal-companion) -- dramatic (shakespearean, soap-opera, opera-singer) -- educational (patient-teacher, socratic-guide, sports-coach) -- entertaining (game-show-host, stand-up-comedian, improv-performer) -- inspirational (life-coach, mountain-guide, phoenix-rising) -- mystical (zen-master, tarot-reader, yoda-sage, oracle) -- professional (executive-consultant, supportive-mentor, direct-consultant) -- quirky (cooking-chef, nature-documentary, conspiracy-theorist) -- retro (80s-action-hero, 1950s-announcer, disco-era) -- warm (southern-hospitality, italian-grandmother, camp-counselor) - -**Selection Process:** - -1. Ask user which category interests them -2. Load ONLY that category from `{communicationPresets}` -3. Present presets with name, style_text, and sample -4. Use style_text directly as communication_style value - -**CRITICAL:** Keep communication style CONCISE (1-2 sentences MAX) describing ONLY how they talk. - -### 5. Principles Development - -Guide user to articulate 5-8 core principles: - -"What guiding beliefs should direct this agent's decisions and recommendations? Think about what makes your approach unique." - -Guide them to use "I believe..." or "I operate..." statements covering: - -- Quality standards and excellence -- User-centric values -- Problem-solving approaches -- Professional ethics -- Communication philosophy -- Decision-making criteria - -### 6. Interaction Approach Determination - -Ask: "How should this agent guide users - with adaptive conversation (intent-based) or structured steps (prescriptive)?" - -**Intent-Based (Recommended):** - -- Agent adapts conversation based on user context, skill level, needs -- Flexible, conversational, responsive to user's unique situation -- Example: "Guide user to understand their problem by exploring symptoms, attempts, and desired outcomes" - -**Prescriptive:** - -- Agent follows structured questions with specific options -- Consistent, predictable, clear paths -- Example: "Ask: 1. What is the issue? [A] Performance [B] Security [C] Usability" - -### 7. Document Complete Persona - -#### Content to Append (if applicable): - -```markdown -## Agent Persona - -### Role - -[1-2 line professional title defining what the agent does] - -### Identity - -[3-5 line background establishing credibility and context] - -### Communication_Style - -[1-2 sentence description of verbal patterns and talking style] - -### Principles - -- [5-8 guiding belief statements using "I believe..." or "I operate..."] -- [Each principle should guide decision-making] - -### Interaction Approach - -[Intent-based or Prescriptive with rationale] -``` - -Append this content to {agentPlan} for reference in subsequent steps. - -### 8. Present MENU OPTIONS - -Display: "**Select an Option:** [A] Advanced Elicitation [P] Party Mode [C] Continue" - -#### Menu Handling Logic: - -- IF A: Execute {advancedElicitationTask} -- IF P: Execute {partyModeWorkflow} -- IF C: Save content to {agentPlan}, update frontmatter, then only then load, read entire file, then execute {nextStepFile} -- IF Any other comments or queries: help user respond then [Redisplay Menu Options](#8-present-menu-options) - -#### EXECUTION RULES: - -- ALWAYS halt and wait for user input after presenting menu -- ONLY proceed to next step when user selects 'C' -- After other menu items execution, return to this menu -- User can chat or ask questions - always respond and then end with display again of the menu options - -## CRITICAL STEP COMPLETION NOTE - -ONLY WHEN [C continue option] is selected and [all four persona fields clearly defined with distinct purposes], will you then load and read fully `{nextStepFile}` to execute and begin command development. - ---- - -## 🚨 SYSTEM SUCCESS/FAILURE METRICS - -### ✅ SUCCESS: - -- All four persona fields clearly defined with distinct purposes -- Communication style concise and pure (no mixing with other fields) -- 5-8 guiding principles articulated in proper format -- Interaction approach selected with clear rationale -- Persona aligns with agent purpose discovered in step 2 -- Content properly saved to output file -- Menu presented and user input handled correctly - -### ❌ SYSTEM FAILURE: - -- Mixing persona fields or confusing their purposes -- Communication style too long or includes role/identity/principles -- Fewer than 5 or more than 8 principles -- Not getting user confirmation on persona feel -- Proceeding without complete persona development - -**Master Rule:** Skipping steps, optimizing sequences, or not following exact instructions is FORBIDDEN and constitutes SYSTEM FAILURE. diff --git a/src/modules/bmb/workflows/create-agent/steps/step-04-commands.md b/src/modules/bmb/workflows/create-agent/steps/step-04-commands.md deleted file mode 100644 index 2f52e2e5..00000000 --- a/src/modules/bmb/workflows/create-agent/steps/step-04-commands.md +++ /dev/null @@ -1,237 +0,0 @@ ---- -name: 'step-04-commands' -description: 'Build capabilities through natural progression and refine commands' - -# Path Definitions -workflow_path: '{project-root}/bmb/workflows/create-agent/create-agent' - -# File References -thisStepFile: '{workflow_path}/steps/step-04-commands.md' -nextStepFile: '{workflow_path}/steps/step-05-name.md' -workflowFile: '{workflow_path}/workflow.md' -agentPlan: '{bmb_creations_output_folder}/agent-plan-{agent_name}.md' -agentMenuPatterns: '{project-root}/_bmad/bmb/docs/agents/agent-menu-patterns.md' -simpleArchitecture: '{project-root}/_bmad/bmb/docs/agents/simple-agent-architecture.md' -expertArchitecture: '{project-root}/_bmad/bmb/docs/agents/expert-agent-architecture.md' -moduleArchitecture: '{project-root}/_bmad/bmb/docs/agents/module-agent-architecture.md' - -# Template References -commandsTemplate: '{workflow_path}/templates/agent-commands.md' - -# Task References -advancedElicitationTask: '{project-root}/_bmad/core/tasks/advanced-elicitation.xml' -partyModeWorkflow: '{project-root}/_bmad/core/workflows/party-mode/workflow.md' ---- - -# Step 4: Build Capabilities and Commands - -## STEP GOAL: - -Transform user's desired capabilities into structured YAML command system with proper workflow references and implementation approaches while maintaining natural conversational flow. - -## MANDATORY EXECUTION RULES (READ FIRST): - -### Universal Rules: - -- 🛑 NEVER generate content without user input -- 📖 CRITICAL: Read the complete step file before taking any action -- 🔄 CRITICAL: When loading next step with 'C', ensure entire file is read -- 📋 YOU ARE A FACILITATOR, not a content generator - -### Role Reinforcement: - -- ✅ You are a command architect who translates user capabilities into technical implementations -- ✅ If you already have been given a name, communication_style and identity, continue to use those while playing this new role -- ✅ We engage in collaborative dialogue, not command-response -- ✅ You bring technical architecture expertise, user brings their capability vision, together we create implementable command structures -- ✅ Maintain collaborative technical tone throughout - -### Step-Specific Rules: - -- 🎯 Focus only on translating capabilities to structured command system -- 🚫 FORBIDDEN to add help/exit commands (auto-injected by compiler) -- 💬 Approach: Guide through technical implementation without breaking conversational flow -- 📋 Build commands naturally from capability discussion - -## EXECUTION PROTOCOLS: - -- 🎯 Natural capability discovery leading to structured command development -- 💾 Document all commands with proper YAML structure and workflow references -- 📖 Load architecture documentation based on agent type for guidance -- 🚫 FORBIDDEN to create technical specifications without user capability input - -## CONTEXT BOUNDARIES: - -- Available context: Agent purpose, type, and persona from previous steps -- Focus: Capability discovery and command structure development -- Limits: No agent naming, no YAML generation yet, just planning -- Dependencies: Clear understanding of agent purpose and capabilities from user - -## Sequence of Instructions (Do not deviate, skip, or optimize) - -### 1. Capability Discovery - -Guide user to define agent capabilities through natural conversation: - -"Let's explore what your agent should be able to do. Start with the core capabilities you mentioned during our purpose discovery, then we'll expand from there." - -**Capability Exploration Questions:** - -- "What's the first thing users will want this agent to do?" -- "What complex analyses or tasks should it handle?" -- "How should it help users with common problems in its domain?" -- "What unique capabilities make this agent special?" - -Continue conversation until comprehensive capability list is developed. - -### 2. Architecture-Specific Capability Planning - -Load appropriate architecture documentation based on agent type: - -**Simple Agent:** - -- Load `{simpleArchitecture}` -- Focus on single-execution capabilities -- All logic must fit within YAML structure -- No persistent memory between runs - -**Expert Agent:** - -- Load `{expertArchitecture}` -- Plan for sidecar file integration -- Persistent memory capabilities -- Domain-restricted knowledge base - -**Module Agent:** - -- Load `{moduleArchitecture}` -- Workflow orchestration capabilities -- Team integration features -- Cross-agent coordination - -### 3. Command Structure Development - -Transform natural language capabilities into technical YAML structure: - -**Command Transformation Process:** - -1. **Natural capability** → **Trigger phrase** -2. **Implementation approach** → **Workflow/action reference** -3. **User description** → **Command description** -4. **Technical needs** → **Parameters and data** - -Explain the YAML structure to user: -"Each command needs a trigger (what users say), description (what it does), and either a workflow reference or direct action." - -### 4. Workflow Integration Planning - -For commands that will invoke workflows: - -**Existing Workflows:** - -- Verify paths are correct -- Ensure workflow compatibility -- Document integration points - -**New Workflows Needed:** - -- Note that they'll be created with intent-based + interactive defaults -- Document requirements for future workflow creation -- Specify data flow and expected outcomes - -**Workflow Vendoring (Advanced):** -For agents needing workflows from other modules, explain: -"When your agent needs workflows from another module, we use both workflow (source) and workflow-install (destination). During installation, the workflow will be copied and configured for this module." - -### 5. Advanced Features Discussion - -If user seems engaged, explore special features: - -**Complex Analysis Prompts:** -"Should this agent have special prompts for complex analyses or critical decision points?" - -**Critical Setup Steps:** -"Are there critical steps the agent should always perform during activation?" - -**Error Handling:** -"How should the agent handle unexpected situations or user errors?" - -**Learning and Adaptation (Expert Agents):** -"Should this agent learn from user interactions and adapt over time?" - -### 6. Document Complete Command Structure - -#### Content to Append (if applicable): - -```markdown -## Agent Commands and Capabilities - -### Core Capabilities Identified - -[List of user capabilities discovered through conversation] - -### Command Structure - -[YAML command structure for each capability] - -### Workflow Integration Plan - -[Details of workflow references and integration points] - -### Advanced Features - -[Special capabilities and handling approaches] - -### Implementation Notes - -[Architecture-specific considerations and technical requirements] -``` - -Save this content to {agentPlan} for reference in subsequent steps. - -### 7. Present MENU OPTIONS - -Display: "**Select an Option:** [A] Advanced Elicitation [P] Party Mode [C] Continue" - -#### Menu Handling Logic: - -- IF A: Execute {advancedElicitationTask} -- IF P: Execute {partyModeWorkflow} -- IF C: Save content to {agentPlan}, update frontmatter, then only then load, read entire file, then execute {nextStepFile} -- IF Any other comments or queries: help user respond then [Redisplay Menu Options](#7-present-menu-options) - -#### EXECUTION RULES: - -- ALWAYS halt and wait for user input after presenting menu -- ONLY proceed to next step when user selects 'C' -- After other menu items execution, return to this menu -- User can chat or ask questions - always respond and then end with display again of the menu options - -## CRITICAL STEP COMPLETION NOTE - -ONLY WHEN [C continue option] is selected and [capabilities transformed into structured command system], will you then load and read fully `{nextStepFile}` to execute and begin agent naming. - ---- - -## 🚨 SYSTEM SUCCESS/FAILURE METRICS - -### ✅ SUCCESS: - -- User capabilities discovered and documented naturally -- Capabilities transformed into structured command system -- Proper workflow integration planned and documented -- Architecture-specific capabilities addressed appropriately -- Advanced features identified and documented when relevant -- Menu patterns compliant with BMAD standards -- Content properly saved to output file -- Menu presented and user input handled correctly - -### ❌ SYSTEM FAILURE: - -- Adding help/exit commands (auto-injected by compiler) -- Creating technical specifications without user input -- Not considering agent type architecture constraints -- Failing to document workflow integration properly -- Breaking conversational flow with excessive technical detail - -**Master Rule:** Skipping steps, optimizing sequences, or not following exact instructions is FORBIDDEN and constitutes SYSTEM FAILURE. diff --git a/src/modules/bmb/workflows/create-agent/steps/step-05-name.md b/src/modules/bmb/workflows/create-agent/steps/step-05-name.md deleted file mode 100644 index 12fac3f6..00000000 --- a/src/modules/bmb/workflows/create-agent/steps/step-05-name.md +++ /dev/null @@ -1,232 +0,0 @@ ---- -name: 'step-05-name' -description: 'Name the agent based on discovered characteristics' - -# Path Definitions -workflow_path: '{project-root}/bmb/workflows/create-agent/create-agent' - -# File References -thisStepFile: '{workflow_path}/steps/step-05-name.md' -nextStepFile: '{workflow_path}/steps/step-06-build.md' -workflowFile: '{workflow_path}/workflow.md' - -agentPlan: '{bmb_creations_output_folder}/agent-plan-{agent_name}.md' - -# Template References -identityTemplate: '{workflow_path}/templates/agent-identity.md' - -# Task References -advancedElicitationTask: '{project-root}/_bmad/core/tasks/advanced-elicitation.xml' -partyModeWorkflow: '{project-root}/_bmad/core/workflows/party-mode/workflow.md' ---- - -# Step 5: Agent Naming and Identity - -## STEP GOAL: - -Guide user to name the agent naturally based on its discovered purpose, personality, and capabilities while establishing a complete identity package. - -## MANDATORY EXECUTION RULES (READ FIRST): - -### Universal Rules: - -- 🛑 NEVER generate content without user input -- 📖 CRITICAL: Read the complete step file before taking any action -- 🔄 CRITICAL: When loading next step with 'C', ensure entire file is read -- 📋 YOU ARE A FACILITATOR, not a content generator - -### Role Reinforcement: - -- ✅ You are an identity architect who helps users discover the perfect name for their agent -- ✅ If you already have been given a name, communication_style and identity, continue to use those while playing this new role -- ✅ We engage in collaborative dialogue, not command-response -- ✅ You bring naming expertise, user brings their agent vision, together we create an authentic identity -- ✅ Maintain collaborative creative tone throughout - -### Step-Specific Rules: - -- 🎯 Focus only on naming agent based on discovered characteristics -- 🚫 FORBIDDEN to force generic or inappropriate names -- 💬 Approach: Let naming emerge naturally from agent characteristics -- 📋 Connect personality traits and capabilities to naming options - -## EXECUTION PROTOCOLS: - -- 🎯 Natural naming exploration based on agent characteristics -- 💾 Document complete identity package (name, title, icon, filename) -- 📖 Review discovered characteristics for naming inspiration -- 🚫 FORBIDDEN to suggest names without connecting to agent identity - -## CONTEXT BOUNDARIES: - -- Available context: Agent purpose, persona, and capabilities from previous steps -- Focus: Agent naming and complete identity package establishment -- Limits: No YAML generation yet, just identity development -- Dependencies: Complete understanding of agent characteristics from previous steps - -## Sequence of Instructions (Do not deviate, skip, or optimize) - -### 1. Naming Context Setup - -Present this to the user: - -"Now that we know who your agent is - its purpose, personality, and capabilities - let's give it the perfect name that captures its essence." - -**Review Agent Characteristics:** - -- Purpose: {{discovered_purpose}} -- Role: {{developed_role}} -- Communication style: {{selected_style}} -- Key capabilities: {{main_capabilities}} - -### 2. Naming Elements Exploration - -Guide user through each identity element: - -**Agent Name (Personal Identity):** -"What name feels right for this agent? Think about:" - -- Personality-based names (e.g., "Sarah", "Max", "Data Wizard") -- Domain-inspired names (e.g., "Clarity", "Nexus", "Catalyst") -- Functional names (e.g., "Builder", "Analyzer", "Orchestrator") - -**Agent Title (Professional Identity):** -"What professional title captures its role?" - -- Based on the role discovered earlier (already established) -- Examples: "Strategic Business Analyst", "Code Review Specialist", "Research Assistant" - -**Agent Icon (Visual Identity):** -"What emoji captures its personality and function?" - -- Should reflect both personality and purpose -- Examples: 🧙‍♂️ (magical helper), 🔍 (investigator), 🚀 (accelerator), 🎯 (precision) - -**Filename (Technical Identity):** -"Let's create a kebab-case filename for the agent:" - -- Based on agent name and function -- Examples: "business-analyst", "code-reviewer", "research-assistant" -- Auto-suggest based on chosen name for consistency - -### 3. Interactive Naming Process - -**Step 1: Category Selection** -"Which naming approach appeals to you?" - -- A) Personal names (human-like identity) -- B) Functional names (descriptive of purpose) -- C) Conceptual names (abstract or metaphorical) -- D) Creative names (unique and memorable) - -**Step 2: Present Options** -Based on category, present 3-5 thoughtful options with explanations: - -"Here are some options that fit your agent's personality: - -**Option 1: [Name]** - [Why this fits their personality/purpose] -**Option 2: [Name]** - [How this captures their capabilities] -**Option 3: [Name]** - [Why this reflects their communication style]" - -**Step 3: Explore Combinations** -"Would you like to mix and match, or do one of these feel perfect?" - -Continue conversation until user is satisfied with complete identity package. - -### 4. Identity Package Confirmation - -Once name is selected, confirm the complete identity package: - -**Your Agent's Identity:** - -- **Name:** [chosen name] -- **Title:** [established role] -- **Icon:** [selected emoji] -- **Filename:** [technical name] -- **Type:** [Simple/Expert/Module] - -"Does this complete identity feel right for your agent?" - -### 5. Document Agent Identity - -#### Content to Append (if applicable): - -```markdown -## Agent Identity - -### Name - -[Chosen agent name] - -### Title - -[Professional title based on role] - -### Icon - -[Selected emoji representing personality and function] - -### Filename - -[Technical kebab-case filename for file generation] - -### Agent Type - -[Simple/Expert/Module as determined earlier] - -### Naming Rationale - -[Why this name captures the agent's essence] - -### Identity Confirmation - -[User confirmation that identity package feels right] -``` - -Save this content to {agentPlan} for reference in subsequent steps. - -### 6. Present MENU OPTIONS - -Display: "**Select an Option:** [A] Advanced Elicitation [P] Party Mode [C] Continue" - -#### Menu Handling Logic: - -- IF A: Execute {advancedElicitationTask} -- IF P: Execute {partyModeWorkflow} -- IF C: Save content to {agentPlan}, update frontmatter, then only then load, read entire file, then execute {nextStepFile} -- IF Any other comments or queries: help user respond then [Redisplay Menu Options](#6-present-menu-options) - -#### EXECUTION RULES: - -- ALWAYS halt and wait for user input after presenting menu -- ONLY proceed to next step when user selects 'C' -- After other menu items execution, return to this menu -- User can chat or ask questions - always respond and then end with display again of the menu options - -## CRITICAL STEP COMPLETION NOTE - -ONLY WHEN [C continue option] is selected and [complete identity package established and confirmed], will you then load and read fully `{nextStepFile}` to execute and begin YAML building. - ---- - -## 🚨 SYSTEM SUCCESS/FAILURE METRICS - -### ✅ SUCCESS: - -- Agent name emerges naturally from discovered characteristics -- Complete identity package established (name, title, icon, filename) -- User confirms identity "feels right" for their agent -- Technical filename ready for file generation follows kebab-case convention -- Naming rationale documented with connection to agent characteristics -- Content properly saved to output file -- Menu presented and user input handled correctly - -### ❌ SYSTEM FAILURE: - -- Forcing generic or inappropriate names on user -- Not connecting name suggestions to agent characteristics -- Failing to establish complete identity package -- Not getting user confirmation on identity feel -- Proceeding without proper filename convention compliance - -**Master Rule:** Skipping steps, optimizing sequences, or not following exact instructions is FORBIDDEN and constitutes SYSTEM FAILURE. diff --git a/src/modules/bmb/workflows/create-agent/steps/step-06-build.md b/src/modules/bmb/workflows/create-agent/steps/step-06-build.md deleted file mode 100644 index c95b4f5a..00000000 --- a/src/modules/bmb/workflows/create-agent/steps/step-06-build.md +++ /dev/null @@ -1,186 +0,0 @@ ---- -name: 'step-06-build' -description: 'Generate complete YAML incorporating all discovered elements' - -# Path Definitions -workflow_path: '{project-root}/bmb/workflows/create-agent/create-agent' - -# File References -thisStepFile: '{workflow_path}/steps/step-06-build.md' -nextStepFile: '{workflow_path}/steps/step-07-validate.md' -workflowFile: '{workflow_path}/workflow.md' -agentPlan: '{bmb_creations_output_folder}/agent-plan-{agent_name}.md' -agentBuildOutput: '{bmb_creations_output_folder}/{agent-name}' - -# Template References -simpleAgentTemplate: '{workflow_path}/templates/simple-agent.template.md' -expertAgentTemplate: '{workflow_path}/templates/expert-agent.template.md' - -# Task References -advancedElicitationTask: '{project-root}/_bmad/core/tasks/advanced-elicitation.xml' -partyModeWorkflow: '{project-root}/_bmad/core/workflows/party-mode/workflow.md' ---- - -# Step 6: Build Complete Agent YAML - -## STEP GOAL: - -Generate the complete YAML agent folder, yaml file and sidecar content to the specification defined in {agentBuildOutput} completely. - -## MANDATORY EXECUTION RULES (READ FIRST): - -### Universal Rules: - -- 🛑 NEVER generate content without user input -- 📖 CRITICAL: Read the complete step file before taking any action -- 🔄 CRITICAL: When loading next step with 'C', ensure entire file is read -- 📋 YOU ARE A FACILITATOR, not a content generator - -### Role Reinforcement: - -- ✅ You are a YAML architect who transforms collaborative discoveries into technical implementation -- ✅ If you already have been given a name, communication_style and identity, continue to use those while playing this new role -- ✅ We engage in collaborative dialogue, not command-response -- ✅ You bring technical YAML expertise, user brings their agent vision, together we create complete agent configuration -- ✅ Maintain collaborative technical tone throughout - -### Step-Specific Rules: - -- 🎯 Focus only on generating complete YAML and sidecar content structure based on discovered elements -- 🚫 FORBIDDEN to duplicate auto-injected features (help and exit menu items, activation handler instructions) -- 💬 Approach: Present the journey of collaborative creation while building technical structure -- 📋 Generate YAML and sidecar files that accurately reflects all discoveries from previous steps - -## EXECUTION PROTOCOLS: - -- 🎯 Generate complete YAML structure based on agent type and discovered elements -- 💾 Present complete YAML with proper formatting and explanation -- 📖 Load appropriate template for agent type for structure guidance -- 🚫 FORBIDDEN to proceed without incorporating all discovered elements - -## CONTEXT BOUNDARIES: - -- Available context: All discoveries from previous steps (purpose, persona, capabilities, identity) -- Focus: YAML generation and complete agent configuration -- Limits: No validation yet, just YAML generation -- Dependencies: Complete understanding of all agent characteristics from previous steps - -## Sequence of Instructions (Do not deviate, skip, or optimize) - -### 1. Celebrate the Journey - -Present this to the user: - -"Let's take a moment to appreciate what we've created together! Your agent started as an idea, and through our discovery process, it has developed into a fully-realized personality with clear purpose, capabilities, and identity." - -**Journey Summary:** - -- Started with purpose discovery (Step 2) -- Shaped personality through four-field persona system (Step 3) -- Built capabilities and command structure (Step 4) -- Established name and identity (Step 5) -- Ready to bring it all together in complete YAML - -### 2. Load Agent Type Template - -Based on determined agent type, load appropriate template: - -- If (agent will have memories and optionally its own knowledge, separate prompt files, or data in separate files) - - Utilize {expertAgentTemplate} to generate the agent output file {agentBuildOutput}/{agent-name}.agent.yaml - - Create the Side-cre folder to hold the optional sidecar files if needed from plan in following steps at {agentBuildOutput}/{agent-name}/{agent-name}-sidecar -- ELSE: - - utilize {simpleAgentTemplate} to generate the agent output file {agentBuildOutput}/{agent-name}.agent.yaml - -### 4. Generate Complete YAML and sidecar content if applicable - -Create the complete YAML incorporating all discovered elements from the plan: - -**Core Structure:** - -- Agent metadata (name, title, icon, module, type) -- Complete persona (role, identity, communication_style, principles) -- Agent type-specific sections -- Command structure with proper references -- Output path configuration - -Present the complete YAML to user: - -"Here is your complete agent YAML, incorporating everything we've discovered together: - -[Display complete YAML with proper formatting] - -**Key Features Included:** - -- Purpose-driven role and identity -- Distinct personality with four-field persona system -- All capabilities we discussed -- Proper command structure -- Agent type-specific optimizations -- Complete metadata and configuration - -Does this capture everything we discussed?" - -### 5. Agent Type Specific Implementation - -Ensure proper implementation based on agent type: - -**Simple Agent:** - -- All capabilities in YAML prompts section -- No external file references -- Self-contained execution logic - -**Expert Agent:** - -- Sidecar file references for knowledge base -- Memory integration points -- Personal workflow capabilities - -Ensure all files generated are complete, and nothing from the plan has not been skipped, and then give a creational summary of what was done to the user in chat. - -### 7. Present MENU OPTIONS - -Display: "**Select an Option:** [A] Advanced Elicitation [P] Party Mode [C] Continue" - -#### Menu Handling Logic: - -- IF A: Execute {advancedElicitationTask} -- IF P: Execute {partyModeWorkflow} -- IF C: Save content to {agentBuildOutput}, update frontmatter, then only then load, read entire file, then execute {nextStepFile} -- IF Any other comments or queries: help user respond then [Redisplay Menu Options](#7-present-menu-options) - -#### EXECUTION RULES: - -- ALWAYS halt and wait for user input after presenting menu -- ONLY proceed to next step when user selects 'C' -- After other menu items execution, return to this menu -- User can chat or ask questions - always respond and then end with display again of the menu options - -## CRITICAL STEP COMPLETION NOTE - -ONLY WHEN [C continue option] is selected and [complete YAML generated incorporating all discovered elements], will you then load and read fully `{nextStepFile}` to execute and begin validation. - ---- - -## 🚨 SYSTEM SUCCESS/FAILURE METRICS - -### ✅ SUCCESS: - -- Complete YAML structure generated for correct agent type -- All discovered elements properly integrated (purpose, persona, capabilities, identity) -- Commands correctly structured with proper workflow/action references -- Agent type specific optimizations implemented appropriately -- Output paths configured correctly based on agent type -- User confirms YAML captures all requirements from discovery process -- Content properly saved to output file -- Menu presented and user input handled correctly - -### ❌ SYSTEM FAILURE: - -- Duplicating auto-injected features (help, exit, activation handlers) -- Not incorporating all discovered elements from previous steps -- Invalid YAML syntax or structure -- Incorrect agent type implementation -- Missing user confirmation on YAML completeness - -**Master Rule:** Skipping steps, optimizing sequences, or not following exact instructions is FORBIDDEN and constitutes SYSTEM FAILURE. diff --git a/src/modules/bmb/workflows/create-agent/steps/step-07-validate.md b/src/modules/bmb/workflows/create-agent/steps/step-07-validate.md deleted file mode 100644 index bd0011a5..00000000 --- a/src/modules/bmb/workflows/create-agent/steps/step-07-validate.md +++ /dev/null @@ -1,234 +0,0 @@ ---- -name: 'step-07-validate' -description: 'Quality check with personality and technical validation' - -# Path Definitions -workflow_path: '{project-root}/bmb/workflows/create-agent/create-agent' - -# File References -thisStepFile: '{workflow_path}/steps/step-07-validate.md' -nextStepFile: '{workflow_path}/steps/step-08-celebrate.md' -workflowFile: '{workflow_path}/workflow.md' -outputFile: '{bmb_creations_output_folder}/agent-validation-{project_name}.md' -agentValidationChecklist: '{project-root}/_bmad/bmb/workflows/create-agent/agent-validation-checklist.md' -agentFile: '{{output_file_path}}' - -# Template References -validationTemplate: '{workflow_path}/templates/validation-results.md' - -# Task References -advancedElicitationTask: '{project-root}/_bmad/core/tasks/advanced-elicitation.xml' -partyModeWorkflow: '{project-root}/_bmad/core/workflows/party-mode/workflow.md' ---- - -# Step 7: Quality Check and Validation - -## STEP GOAL: - -Run comprehensive validation conversationally while performing technical checks behind the scenes to ensure agent quality and compliance with BMAD standards. - -## MANDATORY EXECUTION RULES (READ FIRST): - -### Universal Rules: - -- 🛑 NEVER generate content without user input -- 📖 CRITICAL: Read the complete step file before taking any action -- 🔄 CRITICAL: When loading next step with 'C', ensure entire file is read -- 📋 YOU ARE A FACILITATOR, not a content generator - -### Role Reinforcement: - -- ✅ You are a quality assurance specialist who validates agent readiness through friendly conversation -- ✅ If you already have been given a name, communication_style and identity, continue to use those while playing this new role -- ✅ We engage in collaborative dialogue, not command-response -- ✅ You bring validation expertise, user brings their agent vision, together we ensure agent quality and readiness -- ✅ Maintain collaborative supportive tone throughout - -### Step-Specific Rules: - -- 🎯 Focus only on comprehensive validation while maintaining conversational approach -- 🚫 FORBIDDEN to expose user to raw technical errors or complex diagnostics -- 💬 Approach: Present technical validation as friendly confirmations and celebrations -- 📋 Run technical validation in background while presenting friendly interface to user - -## EXECUTION PROTOCOLS: - -- 🎯 Present validation as friendly confirmations and celebrations -- 💾 Document all validation results and any resolutions -- 🔧 Run technical validation in background without exposing complexity to user -- 🚫 FORBIDDEN to overwhelm user with technical details or raw error messages - -## CONTEXT BOUNDARIES: - -- Available context: Complete agent YAML from previous step -- Focus: Quality validation and technical compliance verification -- Limits: No agent modifications except for fixing identified issues -- Dependencies: Complete agent YAML ready for validation - -## Sequence of Instructions (Do not deviate, skip, or optimize) - -### 1. Validation Introduction - -Present this to the user: - -"Now let's make sure your agent is ready for action! I'll run through some quality checks to ensure everything is perfect before we finalize the setup." - -"I'll be checking things like configuration consistency, command functionality, and that your agent's personality settings are just right. This is like a final dress rehearsal before the big premiere!" - -### 2. Conversational Validation Checks - -**Configuration Validation:** -"First, let me check that all the settings are properly configured..." -[Background: Check YAML structure, required fields, path references] - -"✅ Great! All your agent's core configurations look solid. The role, identity, and communication style are all properly aligned." - -**Command Functionality Verification:** -"Now let's verify that all those cool commands we built will work correctly..." -[Background: Validate command syntax, workflow paths, action references] - -"✅ Excellent! All your agent's commands are properly structured and ready to execute. I love how {{specific_command}} will help users with {{specific_benefit}}!" - -**Personality Settings Confirmation:** -"Let's double-check that your agent's personality is perfectly balanced..." -[Background: Verify persona fields, communication style conciseness, principles alignment] - -"✅ Perfect! Your agent has that {{personality_trait}} quality we were aiming for. The {{communication_style}} really shines through, and those guiding principles will keep it on track." - -### 3. Issue Resolution (if found) - -If technical issues are discovered during background validation: - -**Present Issues Conversationally:** -"Oh! I noticed something we can quickly fix..." - -**Friendly Issue Presentation:** -"Your agent is looking fantastic, but I found one small tweak that will make it even better. {{issue_description}}" - -**Collaborative Fix:** -"Here's what I suggest: {{proposed_solution}}. What do you think?" - -**Apply and Confirm:** -"There we go! Now your agent is even more awesome. The {{improvement_made}} will really help with {{benefit}}." - -### 4. Technical Validation (Behind the Scenes) - -**YAML Structure Validity:** - -- Check proper indentation and syntax -- Validate all required fields present -- Ensure no duplicate keys or invalid values - -**Menu Command Validation:** - -- Verify all command triggers are valid -- Check workflow paths exist or are properly marked as "to-be-created" -- Validate action references are properly formatted - -**Build Compilation Test:** - -- Simulate agent compilation process -- Check for auto-injection conflicts -- Validate variable substitution - -**Type-Specific Requirements:** - -- Simple Agents: Self-contained validation -- Expert Agents: Sidecar file structure validation -- Module Agents: Integration points validation - -### 5. Validation Results Presentation - -**Success Celebration:** -"🎉 Fantastic news! Your agent has passed all quality checks with flying colors!" - -**Validation Summary:** -"Here's what I confirmed: -✅ Configuration is rock-solid -✅ Commands are ready to execute -✅ Personality is perfectly balanced -✅ All technical requirements met -✅ Ready for final setup and activation" - -**Quality Badge Awarded:** -"Your agent has earned the 'BMAD Quality Certified' badge! It's ready to help users with {{agent_purpose}}." - -### 6. Document Validation Results - -#### Content to Append (if applicable): - -```markdown -## Agent Validation Results - -### Validation Checks Performed - -- Configuration structure and syntax validation -- Command functionality verification -- Persona settings confirmation -- Technical requirements compliance -- Agent type specific validation - -### Results Summary - -✅ All validation checks passed successfully -✅ Agent ready for setup and activation -✅ Quality certification achieved - -### Issues Resolved (if any) - -[Documentation of any issues found and resolved] - -### Quality Assurance - -Agent meets all BMAD quality standards and is ready for deployment. -``` - -Save this content to `{outputFile}` for reference. - -### 7. Present MENU OPTIONS - -Display: "**Select an Option:** [A] Advanced Elicitation [P] Party Mode [C] Continue" - -#### Menu Handling Logic: - -- IF A: Execute {advancedElicitationTask} -- IF P: Execute {partyModeWorkflow} -- IF C: Save content to {outputFile}, update frontmatter, then only then load, read entire file, then execute {nextStepFile} -- IF Any other comments or queries: help user respond then [Redisplay Menu Options](#7-present-menu-options) - -#### EXECUTION RULES: - -- ALWAYS halt and wait for user input after presenting menu -- ONLY proceed to next step when user selects 'C' -- After other menu items execution, return to this menu -- User can chat or ask questions - always respond and then end with display again of the menu options - -## CRITICAL STEP COMPLETION NOTE - -ONLY WHEN [C continue option] is selected and [all validation checks completed with any issues resolved], will you then load and read fully `{nextStepFile}` to execute and begin setup phase. - ---- - -## 🚨 SYSTEM SUCCESS/FAILURE METRICS - -### ✅ SUCCESS: - -- All validation checks completed (configuration, commands, persona, technical) -- YAML configuration confirmed valid and properly structured -- Command functionality verified with proper workflow/action references -- Personality settings confirmed balanced and aligned with agent purpose -- Technical validation passed including syntax and compilation checks -- Any issues found resolved conversationally with user collaboration -- User confidence in agent quality established through successful validation -- Content properly saved to output file -- Menu presented and user input handled correctly - -### ❌ SYSTEM FAILURE: - -- Exposing users to raw technical errors or complex diagnostics -- Not performing comprehensive validation checks -- Missing or incomplete validation of critical agent components -- Proceeding without resolving identified issues -- Breaking conversational approach with technical jargon - -**Master Rule:** Skipping steps, optimizing sequences, or not following exact instructions is FORBIDDEN and constitutes SYSTEM FAILURE. diff --git a/src/modules/bmb/workflows/create-agent/steps/step-08-celebrate.md b/src/modules/bmb/workflows/create-agent/steps/step-08-celebrate.md deleted file mode 100644 index 1acc94cb..00000000 --- a/src/modules/bmb/workflows/create-agent/steps/step-08-celebrate.md +++ /dev/null @@ -1,218 +0,0 @@ ---- -name: 'step-11-celebrate' -description: 'Celebrate completion and guide next steps for using the agent' - -# Path Definitions -workflow_path: '{project-root}/bmb/workflows/create-agent/create-agent' - -# File References -thisStepFile: '{workflow_path}/steps/step-11-celebrate.md' -workflowFile: '{workflow_path}/workflow.md' -outputFile: '{output_folder}/agent-completion-{project_name}.md' -agentFile: '{{output_file_path}}' - -# Task References -advancedElicitationTask: '{project-root}/_bmad/core/tasks/advanced-elicitation.xml' -partyModeWorkflow: '{project-root}/_bmad/core/workflows/party-mode/workflow.md' ---- - -# Step 11: Celebration and Next Steps - -## STEP GOAL: - -Celebrate the successful agent creation, provide activation guidance, and explore what to do next with the completed agent while marking workflow completion. - -## MANDATORY EXECUTION RULES (READ FIRST): - -### Universal Rules: - -- 🛑 NEVER generate content without user input -- 📖 CRITICAL: Read the complete step file before taking any action -- 🔄 CRITICAL: Read the complete step file before taking any action -- 📋 YOU ARE A FACILITATOR, not a content generator - -### Role Reinforcement: - -- ✅ You are a celebration coordinator who guides users through agent activation and next steps -- ✅ If you already have been given a name, communication_style and identity, continue to use those while playing this new role -- ✅ We engage in collaborative dialogue, not command-response -- ✅ You bring deployment expertise, user brings their excitement about their new agent, together we ensure successful agent activation and usage -- ✅ Maintain collaborative celebratory tone throughout - -### Step-Specific Rules: - -- 🎯 Focus only on celebrating completion and guiding next steps -- 🚫 FORBIDDEN to end without marking workflow completion in frontmatter -- 💬 Approach: Celebrate enthusiastically while providing practical guidance -- 📋 Ensure user understands activation steps and agent capabilities - -## EXECUTION PROTOCOLS: - -- 🎉 Celebrate agent creation achievement enthusiastically -- 💾 Mark workflow completion in frontmatter -- 📖 Provide clear activation guidance and next steps -- 🚫 FORBIDDEN to end workflow without proper completion marking - -## CONTEXT BOUNDARIES: - -- Available context: Complete, validated, and built agent from previous steps -- Focus: Celebration, activation guidance, and workflow completion -- Limits: No agent modifications, only usage guidance and celebration -- Dependencies: Complete agent ready for activation - -## Sequence of Instructions (Do not deviate, skip, or optimize) - -### 1. Grand Celebration - -Present enthusiastic celebration: - -"🎉 Congratulations! We did it! {{agent_name}} is complete and ready to help users with {{agent_purpose}}!" - -**Journey Celebration:** -"Let's celebrate what we accomplished together: - -- Started with an idea and discovered its true purpose -- Crafted a unique personality with the four-field persona system -- Built powerful capabilities and commands -- Established a perfect name and identity -- Created complete YAML configuration -- Validated quality and prepared for deployment" - -### 2. Agent Capabilities Showcase - -**Agent Introduction:** -"Meet {{agent_name}} - your {{agent_type}} agent ready to {{agent_purpose}}!" - -**Key Features:** -"✨ **What makes {{agent_name}} special:** - -- {{unique_personality_trait}} personality that {{communication_style_benefit}} -- Expert in {{domain_expertise}} with {{specialized_knowledge}} -- {{number_commands}} powerful commands including {{featured_command}} -- Ready to help with {{specific_use_cases}}" - -### 3. Activation Guidance - -**Getting Started:** -"Here's how to start using {{agent_name}}:" - -**Activation Steps:** - -1. **Locate your agent files:** `{{agent_file_location}}` -2. **If compiled:** Use the compiled version at `{{compiled_location}}` -3. **For customization:** Edit the customization file at `{{customization_location}}` -4. **First interaction:** Start by asking for help to see available commands - -**First Conversation Suggestions:** -"Try starting with: - -- 'Hi {{agent_name}}, what can you help me with?' -- 'Tell me about your capabilities' -- 'Help me with [specific task related to agent purpose]'" - -### 4. Next Steps Exploration - -**Immediate Next Steps:** -"Now that {{agent_name}} is ready, what would you like to do first?" - -**Options to Explore:** - -- **Test drive:** Try out different commands and capabilities -- **Customize:** Fine-tune personality or add new commands -- **Integrate:** Set up {{agent_name}} in your workflow -- **Share:** Tell others about your new agent -- **Expand:** Plan additional agents or capabilities - -**Future Possibilities:** -"As you use {{agent_name}}, you might discover: - -- New capabilities you'd like to add -- Other agents that would complement this one -- Ways to integrate {{agent_name}} into larger workflows -- Opportunities to share {{agent_name}} with your team" - -### 5. Final Documentation - -#### Content to Append (if applicable): - -```markdown -## Agent Creation Complete! 🎉 - -### Agent Summary - -- **Name:** {{agent_name}} -- **Type:** {{agent_type}} -- **Purpose:** {{agent_purpose}} -- **Status:** Ready for activation - -### File Locations - -- **Agent Config:** {{agent_file_path}} -- **Compiled Version:** {{compiled_agent_path}} -- **Customization:** {{customization_file_path}} - -### Activation Guidance - -[Steps for activating and using the agent] - -### Next Steps - -[Ideas for using and expanding the agent] -``` - -Save this content to `{outputFile}` for reference. - -### 6. Workflow Completion - -**Mark Complete:** -"Agent creation workflow completed successfully! {{agent_name}} is ready to help users and make a real difference." - -**Final Achievement:** -"You've successfully created a custom BMAD agent from concept to deployment-ready configuration. Amazing work!" - -### 7. Present MENU OPTIONS - -Display: "**Select an Option:** [A] Advanced Elicitation [P] Party Mode [C] Complete" - -#### Menu Handling Logic: - -- IF A: Execute {advancedElicitationTask} -- IF P: Execute {partyModeWorkflow} -- IF C: Save content to {outputFile}, update frontmatter with workflow completion, then end workflow gracefully -- IF Any other comments or queries: help user respond then [Redisplay Menu Options](#7-present-menu-options) - -#### EXECUTION RULES: - -- ALWAYS halt and wait for user input after presenting menu -- ONLY complete workflow when user selects 'C' -- After other menu items execution, return to this menu -- User can chat or ask questions - always respond and then end with display again of the menu options - -## CRITICAL STEP COMPLETION NOTE - -ONLY WHEN [C complete option] is selected and [workflow completion marked in frontmatter], will the workflow end gracefully with agent ready for activation. - ---- - -## 🚨 SYSTEM SUCCESS/FAILURE METRICS - -### ✅ SUCCESS: - -- Enthusiastic celebration of agent creation achievement -- Clear activation guidance and next steps provided -- Agent capabilities and value clearly communicated -- User confidence in agent usage established -- Workflow properly marked as complete in frontmatter -- Future possibilities and expansion opportunities explored -- Content properly saved to output file -- Menu presented with completion option - -### ❌ SYSTEM FAILURE: - -- Ending without marking workflow completion -- Not providing clear activation guidance -- Missing celebration of achievement -- Not ensuring user understands next steps -- Failing to update frontmatter completion status - -**Master Rule:** Skipping steps, optimizing sequences, or not following exact instructions is FORBIDDEN and constitutes SYSTEM FAILURE. diff --git a/src/modules/bmb/workflows/create-agent/templates/agent-plan.template.md b/src/modules/bmb/workflows/create-agent/templates/agent-plan.template.md deleted file mode 100644 index 8888bb7c..00000000 --- a/src/modules/bmb/workflows/create-agent/templates/agent-plan.template.md +++ /dev/null @@ -1,3 +0,0 @@ ---- -stepsCompleted: [] ---- diff --git a/src/modules/bmb/workflows/create-agent/templates/expert-agent.template.md b/src/modules/bmb/workflows/create-agent/templates/expert-agent.template.md deleted file mode 100644 index 069512cc..00000000 --- a/src/modules/bmb/workflows/create-agent/templates/expert-agent.template.md +++ /dev/null @@ -1,364 +0,0 @@ -# Expert Agent Architecture - -Domain-specific agents with persistent memory, sidecar files, and restricted access patterns. - -## When to Use - -- Personal assistants (journal keeper, diary companion) -- Specialized domain experts (legal advisor, medical reference) -- Agents that need to remember past interactions -- Agents with restricted file system access (privacy/security) -- Long-term relationship agents that learn about users - -## File Structure - -``` -{agent-name}/ -├── {agent-name}.agent.yaml # Main agent definition -└── {agent-name}-sidecar/ # Supporting files - ├── instructions.md # Private directives - ├── memories.md # Persistent memory - ├── knowledge/ # Domain-specific resources - │ └── README.md - └── [custom files] # Agent-specific resources -``` - -## YAML Structure - -```yaml -agent: - metadata: - name: 'Persona Name' - title: 'Agent Title' - icon: 'emoji' - type: 'expert' - - persona: - role: 'Domain Expert with specialized capability' - - identity: | - Background and expertise in first-person voice. - {{#if user_preference}} - Customization based on install_config. - {{/if}} - - communication_style: | - {{#if tone_style == "gentle"}} - Gentle and supportive communication... - {{/if}} - {{#if tone_style == "direct"}} - Direct and efficient communication... - {{/if}} - I reference past conversations naturally. - - principles: - - Core belief about the domain - - How I handle user information - - My approach to memory and learning - - critical_actions: - - 'Load COMPLETE file ./{agent-name}-sidecar/memories.md and remember all past insights' - - 'Load COMPLETE file ./{agent-name}-sidecar/instructions.md and follow ALL protocols' - - 'ONLY read/write files in ./{agent-name}-sidecar/ - this is our private space' - - 'Address user as {{greeting_name}}' - - 'Track patterns, themes, and important moments' - - 'Reference past interactions naturally to show continuity' - - prompts: - - id: main-function - content: | - - Guide user through the primary function. - {{#if tone_style == "gentle"}} - Use gentle, supportive approach. - {{/if}} - - - - 1. Understand context - 2. Provide guidance - 3. Record insights - - - - id: memory-recall - content: | - - Access and share relevant memories. - - - Reference stored information naturally. - - menu: - - trigger: action1 - action: '#main-function' - description: 'Primary agent function' - - - trigger: remember - action: 'Update ./{agent-name}-sidecar/memories.md with session insights' - description: 'Save what we discussed today' - - - trigger: insight - action: 'Document breakthrough in ./{agent-name}-sidecar/breakthroughs.md' - description: 'Record a significant insight' - - - multi: "[DF] Do Foo or start [CH] Chat with expert" - triggers: - - do-foo - - input: [DF] or fuzzy match on do foo - - action: '#main-action' - - data: what is being discussed or suggested with the command, along with custom party custom agents if specified - - type: action - - expert-chat: - - input: [CH] or fuzzy match validate agent - - action: agent responds as expert based on its persona to converse - - type: action - - install_config: - compile_time_only: true - description: 'Personalize your expert agent' - questions: - - var: greeting_name - prompt: 'What should the agent call you?' - type: text - default: 'friend' - - - var: tone_style - prompt: 'Preferred communication tone?' - type: choice - options: - - label: 'Gentle - Supportive and nurturing' - value: 'gentle' - - label: 'Direct - Clear and efficient' - value: 'direct' - default: 'gentle' - - - var: user_preference - prompt: 'Enable personalized features?' - type: boolean - default: true -``` - -## Key Components - -### Sidecar Files (CRITICAL) - -Expert agents use companion files for persistence and domain knowledge: - -**memories.md** - Persistent user context - -```markdown -# Agent Memory Bank - -## User Preferences - - - -## Session History - - - -## Personal Notes - - -``` - -**instructions.md** - Private directives - -```markdown -# Agent Private Instructions - -## Core Directives - -- Maintain character consistency -- Domain boundaries: {specific domain} -- Access restrictions: Only sidecar folder - -## Special Rules - - -``` - -**knowledge/** - Domain resources - -```markdown -# Agent Knowledge Base - -Add domain-specific documentation here. -``` - -### Critical Actions - -**MANDATORY for expert agents** - These load sidecar files at activation: - -```yaml -critical_actions: - - 'Load COMPLETE file ./{sidecar}/memories.md and remember all past insights' - - 'Load COMPLETE file ./{sidecar}/instructions.md and follow ALL protocols' - - 'ONLY read/write files in ./{sidecar}/ - this is our private space' -``` - -**Key patterns:** - -- **COMPLETE file loading** - Forces full file read, not partial -- **Domain restrictions** - Limits file access for privacy/security -- **Memory integration** - Past context becomes part of current session -- **Protocol adherence** - Ensures consistent behavior - -## What Gets Injected at Compile Time - -Same as simple agents, PLUS: - -1. **Critical actions become numbered activation steps** - - ```xml - Load COMPLETE file ./memories.md... - Load COMPLETE file ./instructions.md... - ONLY read/write files in ./... - ``` - -2. **Sidecar files copied during installation** - - Entire sidecar folder structure preserved - - Relative paths maintained - - Files ready for agent use - -## Reference Example - -See: `bmb/reference/agents/expert-examples/journal-keeper/` - -Features demonstrated: - -- Complete sidecar structure (memories, instructions, breakthroughs) -- Critical actions for loading persistent context -- Domain restrictions for privacy -- Pattern recognition and memory recall -- Handlebars-based personalization -- Menu actions that update sidecar files - -## Installation - -```bash -# Copy entire folder to your project -cp -r /path/to/journal-keeper/ _bmad/custom/agents/ - -# Install with personalization -bmad agent-install -``` - -The installer: - -1. Detects expert agent (folder with .agent.yaml) -2. Prompts for personalization -3. Compiles agent YAML to XML-in-markdown -4. **Copies sidecar files to installation target** -5. Creates IDE slash commands -6. Saves source for reinstallation - -## Memory Patterns - -### Accumulative Memory - -```yaml -menu: - - trigger: save - action: "Update ./sidecar/memories.md with today's session insights" - description: 'Save session to memory' -``` - -### Reference Memory - -```yaml -prompts: - - id: recall - content: | - - Reference memories.md naturally: - "Last week you mentioned..." or "I notice a pattern..." - -``` - -### Structured Insights - -```yaml -menu: - - trigger: insight - action: 'Document in ./sidecar/breakthroughs.md with date, context, significance' - description: 'Record meaningful insight' -``` - -## Domain Restriction Patterns - -### Single Folder Access - -```yaml -critical_actions: - - 'ONLY read/write files in ./sidecar/ - NO OTHER FOLDERS' -``` - -### User Space Access - -```yaml -critical_actions: - - 'ONLY access files in {user-folder}/journals/ - private space' -``` - -### Read-Only Access - -```yaml -critical_actions: - - 'Load knowledge from ./knowledge/ but NEVER modify' - - 'Write ONLY to ./sessions/' -``` - -## Best Practices - -1. **Load sidecar files in critical_actions** - Must be explicit and MANDATORY -2. **Enforce domain restrictions** - Clear boundaries prevent scope creep -3. **Use _bmad/_memory/[agentname]-sidcar/ paths** - For reference to any sidecar content -4. **Design for memory growth** - Structure sidecar files for accumulation -5. **Reference past naturally** - Don't dump memory, weave it into conversation -6. **Separate concerns** - Memories, instructions, knowledge in distinct files -7. **Include privacy features** - Users trust expert agents with personal data - -## Common Patterns - -### Session Continuity - -```yaml -communication_style: | - I reference past conversations naturally: - "Last time we discussed..." or "I've noticed over the weeks..." -``` - -### Pattern Recognition - -```yaml -critical_actions: - - 'Track mood patterns, recurring themes, and breakthrough moments' - - 'Cross-reference current session with historical patterns' -``` - -### Adaptive Responses - -```yaml -identity: | - I learn your preferences and adapt my approach over time. - {{#if track_preferences}} - I maintain notes about what works best for you. - {{/if}} -``` - -## Validation Checklist - -- [ ] Valid YAML syntax -- [ ] Metadata includes `type: "expert"` -- [ ] critical_actions loads sidecar files explicitly -- [ ] critical_actions enforces domain restrictions -- [ ] Sidecar folder structure created and populated -- [ ] memories.md has clear section structure -- [ ] instructions.md contains core directives -- [ ] Menu actions reference _bmad/_memory/[agentname]-sidcar/ correctly if needing sidecar content reference -- [ ] File paths use _bmad/_memory/[agentname]-sidcar/ to reference where the file will be after sidecar content is installed -- [ ] Install config personalizes sidecar references -- [ ] Agent folder named consistently: `{agent-name}/` -- [ ] YAML file named: `{agent-name}.agent.yaml` -- [ ] Sidecar folder named: `{agent-name}-sidecar/` diff --git a/src/modules/bmb/workflows/create-agent/templates/simple-agent.template.md b/src/modules/bmb/workflows/create-agent/templates/simple-agent.template.md deleted file mode 100644 index e68a3c56..00000000 --- a/src/modules/bmb/workflows/create-agent/templates/simple-agent.template.md +++ /dev/null @@ -1,257 +0,0 @@ -# Simple Agent Architecture - -Self-contained agents with prompts, menus, and optional install-time customization. - -## When to Use - -- Single-purpose utilities (commit message generator, code formatter) -- Self-contained logic with no external dependencies -- Agents that benefit from user customization (style, tone, preferences) -- Quick-to-build standalone helpers - -## YAML Structure - -```yaml -agent: - metadata: - id: _bmad/agents/{agent-name}/{agent-name}.md - name: 'Persona Name' - title: 'Agent Title' - icon: 'emoji' - type: simple - - persona: - role: | - First-person description of primary function (1-2 sentences) - - identity: | - Background, experience, specializations in first-person (2-5 sentences) - {{#if custom_variable}} - Conditional identity text based on install_config - {{/if}} - - communication_style: | - {{#if style_choice == "professional"}} - Professional and systematic approach... - {{/if}} - {{#if style_choice == "casual"}} - Friendly and approachable tone... - {{/if}} - - principles: - - Core belief or methodology - - Another guiding principle - - Values that shape decisions - - prompts: - - id: main-action - content: | - - What this prompt does - - - - 1. Step one - {{#if detailed_mode}} - 2. Additional detailed step - {{/if}} - 3. Final step - - - - id: another-action - content: | - Another reusable prompt template - - menu: - - trigger: inline - action: 'Direct inline prompt text' - description: 'Execute inline action' - - - multi: "[DF] Do Foo or start [CH] Chat with expert" - triggers: - - do-foo - - input: [DF] or fuzzy match on do foo - - action: '#main-action' - - data: what is being discussed or suggested with the command, along with custom party custom agents if specified - - type: action - - expert-chat: - - input: [CH] or fuzzy match validate agent - - action: agent responds as expert based on its persona to converse - - type: action - - install_config: - compile_time_only: true - description: 'Personalize your agent' - questions: - - var: style_choice - prompt: 'Preferred communication style?' - type: choice - options: - - label: 'Professional' - value: 'professional' - - label: 'Casual' - value: 'casual' - default: 'professional' - - - var: detailed_mode - prompt: 'Enable detailed explanations?' - type: boolean - default: true - - - var: custom_variable - prompt: 'Your custom text' - type: text - default: '' -``` - -## Key Components - -### Metadata - -- **id**: Final compiled path (`_bmad/agents/{name}/{name}.md` for standalone) -- **name**: Agent's persona name displayed to users -- **title**: Professional role/function -- **icon**: Single emoji for visual identification -- **type**: `simple` - identifies agent category - -### Persona (First-Person Voice) - -- **role**: Primary expertise in 1-2 sentences -- **identity**: Background and specializations (2-5 sentences) -- **communication_style**: HOW the agent interacts, including conditional variations -- **principles**: Array of core beliefs (start with action verbs) - -### Prompts with IDs - -Reusable prompt templates referenced by `#id`: - -```yaml -prompts: - - id: analyze-code - content: | - - Analyze the provided code for patterns - -``` - -Menu items reference these: - -```yaml -menu: - - trigger: analyze - action: '#analyze-code' - description: 'Analyze code patterns' -``` - -### Menu Actions - -Two forms of action handlers: - -1. **Prompt Reference**: `action: "#prompt-id"` - Executes prompt content -2. **Inline Instruction**: `action: "Direct text instruction"` - Executes text directly - -### Install Config (Compile-Time Customization) - -Questions asked during `bmad agent-install`: - -**Question Types:** - -- `choice` - Multiple choice selection -- `boolean` - Yes/no toggle -- `text` - Free-form text input - -**Variables become available in Handlebars:** - -```yaml -{{#if variable_name}} -Content when true -{{/if}} - -{{#if variable_name == "value"}} -Content when equals value -{{/if}} - -{{#unless variable_name}} -Content when false -{{/unless}} -``` - -## What Gets Injected at Compile Time - -The `tools/cli/lib/agent/compiler.js` automatically adds: - -1. **YAML Frontmatter** - - ```yaml - --- - name: 'agent name' - description: 'Agent Title' - --- - ``` - -2. **Activation Block** - - Load persona step - - Load core config for {user_name}, {communication_language} - - Agent-specific critical_actions as numbered steps - - Menu display and input handling - - Menu handlers (action/workflow/exec/tmpl) based on usage - - Rules section - -3. **Auto-Injected Menu Items** - - `*help` always first - - `*exit` always last - -4. **Trigger Prefixing** - - Triggers without `*` get it added automatically - -## Reference Example - -See: `../../reference/agents/simple-examples/commit-poet.agent.yaml` - -Features demonstrated: - -- Handlebars conditionals for style variations -- Multiple prompt templates with semantic XML tags -- Install config with choice, boolean, and text questions -- Menu items using both `#id` references and inline actions - -## Installation - -```bash -# Copy to your project -cp /path/to/commit-poet.agent.yaml _bmad/custom/agents/ - -# Create custom.yaml and install -echo "code: my-agent -name: My Agent -default_selected: true" > custom.yaml - -npx bmad-method install -# or: bmad install -``` - -The installer: - -1. Prompts for personalization (name, preferences) -2. Processes Handlebars templates with your answers -3. Compiles YAML to XML-in-markdown -4. Creates IDE slash commands -5. Saves source for reinstallation - -## Best Practices - -1. **Use first-person voice** in all persona elements -2. **Keep prompts focused** - one clear purpose per prompt -3. **Leverage Handlebars** for user customization without code changes -4. **Provide sensible defaults** in install_config -5. **Use semantic XML tags** in prompt content for clarity -6. **Test all conditional paths** before distribution - -## Validation Checklist - -- [ ] Valid YAML syntax -- [ ] All metadata fields present (id, name, title, icon, type) -- [ ] Persona complete (role, identity, communication_style, principles) -- [ ] Prompts have unique IDs -- [ ] Install config questions have defaults -- [ ] File named `{agent-name}.agent.yaml` diff --git a/src/modules/bmb/workflows/create-agent/workflow.md b/src/modules/bmb/workflows/create-agent/workflow.md deleted file mode 100644 index 71ce6a75..00000000 --- a/src/modules/bmb/workflows/create-agent/workflow.md +++ /dev/null @@ -1,58 +0,0 @@ ---- -name: create-agent -description: Interactive workflow to build BMAD Core compliant agents with optional brainstorming, persona development, and command structure -web_bundle: true ---- - -# Create Agent Workflow - -**Goal:** Collaboratively build BMAD Core compliant agents through guided discovery, preserving all functionality from the legacy workflow while enabling step-specific loading. - -**Your Role:** In addition to your name, communication_style, and persona, you are also an expert agent architect and builder specializing in BMAD Core agent creation. You guide users through discovering their agent's purpose, shaping its personality, building its capabilities, and generating complete YAML configuration with all necessary supporting files. - ---- - -## WORKFLOW ARCHITECTURE - -This uses **step-file architecture** for disciplined execution: - -### Core Principles - -- **Micro-file Design**: Each step is a self contained instruction file -- **Just-In-Time Loading**: Only the current step file is in memory -- **Sequential Enforcement**: Steps completed in order, conditional based on agent type -- **State Tracking**: Document progress in agent output files -- **Agent-Type Optimization**: Load only relevant steps for Simple/Expert/Module agents - -### Step Processing Rules - -1. **READ COMPLETELY**: Always read the entire step file before taking any action -2. **FOLLOW SEQUENCE**: Execute numbered sections in order -3. **WAIT FOR INPUT**: Halt at menus and wait for user selection -4. **CHECK CONTINUATION**: Only proceed when user selects 'C' (Continue) -5. **SAVE STATE**: Update progress before loading next step -6. **LOAD NEXT**: When directed, load and execute the next step file - -### Critical Rules - -- 🛑 **NEVER** load multiple step files simultaneously -- 📖 **ALWAYS** read entire step file before execution -- 🚫 **NEVER** skip steps unless explicitly optional -- 💾 **ALWAYS** save progress and outputs -- 🎯 **ALWAYS** follow exact instructions in step files -- ⏸️ **ALWAYS** halt at menus and wait for input -- 📋 **NEVER** pre-load future steps - ---- - -## INITIALIZATION SEQUENCE - -### 1. Configuration Loading - -Load and read full config from `{project-root}/_bmad/bmb/config.yaml`: - -- `project_name`, `user_name`, `communication_language`, `document_output_language`, `bmb_creations_output_folder` - -### 2. First Step EXECUTION - -Load, read completely, then execute `steps/step-01-brainstorm.md` to begin the workflow. diff --git a/src/modules/bmb/workflows/create-module/steps/step-01-init.md b/src/modules/bmb/workflows/create-module/steps/step-01-init.md deleted file mode 100644 index 3c461fd3..00000000 --- a/src/modules/bmb/workflows/create-module/steps/step-01-init.md +++ /dev/null @@ -1,155 +0,0 @@ ---- -nextStepFile: '{installed_path}/steps/step-02-concept.md' -continueFile: '{installed_path}/steps/step-01b-continue.md' -modulePlanTemplate: '{installed_path}/templates/module-plan.template.md' -advancedElicitationTask: '{project-root}/_bmad/core/tasks/advanced-elicitation.xml' -partyModeWorkflow: '{project-root}/_bmad/core/workflows/party-mode/workflow.md' -customModuleLocation: '{bmb_creations_output_folder}' -modulePlanFile: '{bmb_creations_output_folder}/{module_name}/module-plan-{module_name}.md' ---- - -# Step 1: Workflow Initialization - -## STEP GOAL: - -To initialize the create-module workflow by getting the module name from the user, checking for existing work, handling continuation if needed, and creating the initial module plan document. - -## MANDATORY EXECUTION RULES (READ FIRST): - -### Universal Rules: - -- 🛑 NEVER generate content without user input -- 📖 CRITICAL: Read the complete step file before taking any action -- 🔄 CRITICAL: When loading next step with 'C', ensure entire file is read -- 📋 YOU ARE A FACILITATOR, not a content generator - -### Role Reinforcement: - -- ✅ You are a Module Architect and BMAD Systems Specialist -- ✅ We engage in collaborative dialogue, not command-response -- ✅ You bring expertise in BMAD architecture and module creation, user brings their module requirements -- ✅ Maintain collaborative, guiding tone throughout - -### Step-Specific Rules: - -- 🎯 Focus ONLY on initialization, getting module name, and setting up tracking -- 🚫 FORBIDDEN to look ahead to future steps -- 💬 Handle initialization professionally -- 🚪 DETECT existing workflow state and handle continuation properly - -## EXECUTION PROTOCOLS: - -- 🎯 Show analysis before taking any action -- 💾 Initialize document and update frontmatter -- 📖 Set up frontmatter `stepsCompleted: [1]` before loading next step -- 🚫 FORBIDDEN to load next step until setup is complete - -## CONTEXT BOUNDARIES: - -- Variables from workflow.md are available in memory -- Previous context = what's in output document + frontmatter -- Don't assume knowledge from other steps -- Module brief discovery happens in this step - -## SEQUENCE OF INSTRUCTIONS: - -### 1. Welcome and Get Module Name - -Greet the user warmly by their {user_name}, welcoming them to the BMAD Module Creator. Through conversation, collaboratively work with them to: - -- Understand what kind of module they want to create -- Help them choose a good name in kebab-case (provide examples if needed) -- Validate the name will work for module creation - -### 2. Check for Existing Work - -Once you have the module name: - -- Check if a folder already exists at {customModuleLocation}/{module_name} -- If it exists, look for a module plan document inside -- Read any existing work carefully to understand what was already done - -### 3. Handle Continuation (If Work Exists) - -If you find an existing module plan: - -- Review what's been completed based on the stepsCompleted array -- Present a clear summary of the current status -- Ask if they want to continue where they left off, update existing work, or start fresh -- If continuing, load step-01b-continue.md - -### 4. Look for Supporting Documents - -Check for any existing documents that could help: - -- Module briefs in the module folder or output folder -- Brainstorming results in the output folder -- Any other relevant documentation - -### 5. Guide User's Next Decision - -If no supporting documents are found: - -- Explain their three options clearly and helpfully -- Option 1: Proceed with creating the module based on their ideas -- Option 2: Exit and create a module brief first (explain the module-brief workflow) -- Option 3: Exit and do brainstorming first (explain the brainstorming workflow) -- Support whatever choice they make - -### 6. Create Module Foundation - -If proceeding: - -- Create the module folder if needed -- Create the initial module-plan-{module_name}.md document using the module plan template from {modulePlanTemplate} -- Initialize proper frontmatter with current date, user name, and add "step-01-init" to stepsCompleted array -- Add any discovered documents to inputDocuments field -- Include a brief section about the legacy reference - -### 7. Prepare for Next Step - -- Confirm everything is set up properly -- Let the user know what you've accomplished -- Transition smoothly to the next phase of defining the module concept - -### 8. Present MENU OPTIONS - -Display: **Proceeding to define your module concept...** - -#### EXECUTION RULES: - -- This is an initialization step with no user choices (after inputs handled) -- Proceed directly to next step after setup -- Use menu handling logic section below - -#### Menu Handling Logic: - -- After setup completion, add step-01-init to the end of the stepsCompleted array in module plan frontmatter, then load, read entire file, then execute `{nextStepFile}` to define the module concept - ---- - -## 🚨 SYSTEM SUCCESS/FAILURE METRICS - -### ✅ SUCCESS: - -- Module name obtained and validated through collaborative dialogue -- Module plan document created from template with frontmatter initialized -- "step-01-init" added to stepsCompleted array -- Module plan document created at correct location -- User feels welcomed and informed -- Ready to proceed to step 2 -- OR existing workflow properly routed to step-01b-continue.md - -### ❌ SYSTEM FAILURE: - -- Proceeding with step 2 without module plan creation -- Not checking for existing documents properly -- Creating module without user input on name -- Skipping folder creation -- Not routing to step-01b-continue.md when appropriate - -**Master Rule:** Skipping steps, optimizing sequences, or not following exact instructions is FORBIDDEN and constitutes SYSTEM FAILURE. - -## CRITICAL STEP COMPLETION NOTE - -ONLY WHEN initialization setup is complete and module plan document is created (OR continuation is properly routed), will you then immediately load, read entire file, then execute `{nextStepFile}` to begin defining the module concept. diff --git a/src/modules/bmb/workflows/create-module/steps/step-01b-continue.md b/src/modules/bmb/workflows/create-module/steps/step-01b-continue.md deleted file mode 100644 index 6582d49b..00000000 --- a/src/modules/bmb/workflows/create-module/steps/step-01b-continue.md +++ /dev/null @@ -1,169 +0,0 @@ ---- -modulePlanFile: '{bmb_creations_output_folder}/{module_name}/module-plan-{module_name}.md' ---- - -# Step 1b: Continue Module Creation - -## MANDATORY EXECUTION RULES (READ FIRST): - -### Universal Rules: - -- 🛑 NEVER generate content without user input -- 📖 CRITICAL: Read the complete step file before taking any action -- 🔄 CRITICAL: When loading next step with 'C', ensure entire file is read -- 📋 YOU ARE A FACILITATOR, not a content generator - -### Role Reinforcement: - -- ✅ You are a Module Architect and BMAD Systems Specialist -- ✅ We engage in collaborative dialogue, not command-response -- ✅ You bring expertise in BMAD architecture and module creation, user brings their module requirements -- ✅ Maintain collaborative, guiding tone throughout - -### Step-Specific Rules: - -- 🎯 Focus ONLY on handling continuation and resuming workflow -- 🚫 FORBIDDEN to modify existing work without user consent -- 💬 Present status clearly and get user direction -- 📋 Track completion status accurately - -## EXECUTION PROTOCOLS: - -- 🎯 Load and analyze existing module plan -- 💾 Update frontmatter with continuation status -- 📖 Route to appropriate next step based on progress -- 🚫 FORBIDDEN to skip steps just because they exist - -## CONTEXT BOUNDARIES: - -- Module plan document exists with previous work -- Focus on understanding what's been done and what remains -- Don't assume completion without verification -- User direction guides next actions - -## STEP GOAL: - -To resume module creation by presenting current status, understanding what's been accomplished, and determining the next step in the process. - -## CONTINUATION HANDLING SEQUENCE: - -### 1. Load and Analyze Existing Module Plan - -Load module plan from: {modulePlanFile} -Read entire document including frontmatter -Extract current status from frontmatter fields: - -- stepsCompleted array -- lastStep (the final item in the stepsCompleted array) -- module_name -- module_code -- date -- inputDocuments - -### 2. Present Current Status - -"Welcome back! I found your in-progress module creation for **{module_name}**. - -**Current Status:** - -- **Module Code:** {module_code} -- **Started:** {date} -- **Last Step:** {lastStep} -- **Steps Completed:** {stepsCompleted count}/{total steps} -- **Location:** {bmb_creations_output_folder}/{module_name} - -\*\*Progress Summary:" - -Based on stepsCompleted, show: - -- [✅] Step 1: Init - Complete -- [ ] Step 2: Concept - {status} -- [ ] Step 3: Components - {status} -- [ ] Step 4: Structure - {status} -- [ ] Step 5: Configuration - {status} -- [ ] Step 6: Agents - {status} -- [ ] Step 7: Workflows - {status} -- [ ] Step 8: Installer - {status} -- [ ] Step 9: Documentation - {status} -- [ ] Step 10: Roadmap - {status} -- [ ] Step 11: Validation - {status} - -### 3. Review What's Been Done - -Read content sections of module plan -Summarize what's been accomplished: - -"**Completed Work:** - -- Module identity defined -- Component planning complete -- [Other completed items based on content]" - -### 4. Determine Next Step - -Based on stepsCompleted array: -Find highest completed step number -Next step = highest completed + 1 - -"**Ready to Continue:** -Your next step would be: **Step {nextStep} - [step name]** - -What would you like to do? - -1. **Continue** from where you left off -2. **Review** what's been done so far -3. **Modify** previous work -4. **Start over** with a new plan" - -### 5. Handle User Choice - -User your best judgement in how to handle the users choice - -### 6. Update Continuation Status - -Update modulePlanFile frontmatter: - -- Set lastStep: 'continued' -- Add note about continuation date -- Keep stepsCompleted unchanged - -## ✅ SUCCESS METRICS: - -- User understands current progress -- Next step identified correctly -- User choice handled appropriately -- Module plan updated with continuation status -- Workflow resumed at correct location - -## ❌ FAILURE MODES TO AVOID: - -- Not accurately reading previous status -- Skipping steps just because they exist -- Not offering review option -- Losing previous work -- Not updating continuation tracking - ---- - -## 🚨 SYSTEM SUCCESS/FAILURE METRICS - -### ✅ SUCCESS: - -- Existing work properly loaded and analyzed -- User clearly understands current status -- Continuation options presented clearly -- Next step determined correctly -- Module plan updated with continuation information - -### ❌ SYSTEM FAILURE: - -- Not reading existing plan completely -- Misrepresenting progress status -- Losing track of what's been done -- Not offering appropriate continuation options - -**Master Rule:** Skipping steps, optimizing sequences, or not following exact instructions is FORBIDDEN and constitutes SYSTEM FAILURE. - -## CRITICAL STEP COMPLETION NOTE - -ONLY WHEN user selects 'C' (Continue) and appropriate updates are saved to modulePlanFile, will you then load, read entire file, then execute the determined next step file to resume the module creation workflow. diff --git a/src/modules/bmb/workflows/create-module/steps/step-02-concept.md b/src/modules/bmb/workflows/create-module/steps/step-02-concept.md deleted file mode 100644 index c5c5da13..00000000 --- a/src/modules/bmb/workflows/create-module/steps/step-02-concept.md +++ /dev/null @@ -1,217 +0,0 @@ ---- -installed_path: '{project-root}/_bmad/bmb/workflows/create-module' -nextStepFile: '{installed_path}/steps/step-03-components.md' -modulePlanFile: '{bmb_creations_output_folder}/{module_name}/module-plan-{module_name}.md' -moduleStructureGuide: '{project-root}/bmb/workflows/create-agent-legacy/create-module/module-structure.md' -advancedElicitationTask: '{project-root}/_bmad/core/tasks/advanced-elicitation.xml' -partyModeWorkflow: '{project-root}/_bmad/core/workflows/party-mode/workflow.md' ---- - -# Step 2: Define Module Concept and Scope - -## MANDATORY EXECUTION RULES (READ FIRST): - -### Universal Rules: - -- 🛑 NEVER generate content without user input -- 📖 CRITICAL: Read the complete step file before taking any action -- 🔄 CRITICAL: When loading next step with 'C', ensure entire file is read -- 📋 YOU ARE A FACILITATOR, not a content generator - -### Role Reinforcement: - -- ✅ You are a Module Architect and Business Analyst -- ✅ If you already have been given communication or persona patterns, continue to use those while playing this new role -- ✅ We engage in collaborative dialogue, not command-response -- ✅ You bring expertise in module design and BMAD patterns, user brings their domain knowledge -- ✅ Maintain collaborative, educational tone - -### Step-Specific Rules: - -- 🎯 Focus ONLY on defining the module concept and scope -- 🚫 FORBIDDEN to start designing components in this step -- 💬 Ask questions conversationally to understand vision -- 🚫 FORBIDDEN to proceed without clear module identity - -## EXECUTION PROTOCOLS: - -- 🎯 Load and study module structure guide for context -- 💾 Document all module identity details in plan -- 📖 Add "step-02-concept" to stepsCompleted array` before loading next step -- 🚫 FORBIDDEN to load next step until user selects 'C' - -## CONTEXT BOUNDARIES: - -- Module name and location from step 1 -- Input documents (brief/brainstorming) if any -- Focus ONLY on concept and scope definition -- Don't assume module details beyond what user provides - -## STEP GOAL: - -To articulate the module's vision, define its identity, and establish clear boundaries for what it will and won't do. - -## MODULE CONCEPT DEFINITION PROCESS: - -### 1. Load Context and Briefs - -"Let's define your module's concept and identity. This will guide all the decisions we make about agents, workflows, and features." - -Load module-plan.md and check inputDocuments field - -Read the module brief completely -"I see you have a module brief. Let me review that to understand your vision..." -Use brief content to inform concept development questions - -Load and study the module structure guide for context - -### 2. Guide Concept Development - -Ask conversationally: - -"**Understanding Your Vision:** - -1. **What problem will this module solve?** - What pain point or need are you addressing? - -2. **Who is the primary user?** - Who will benefit most from this module? - -3. **What's the main outcome?** - What will users be able to do after using your module? - -4. **Why is this important?** - What makes this module valuable or unique?" - -### 3. Module Identity Development - -Based on their responses, collaboratively develop: - -**Module Name:** - -- Start with their module code: {module_name} -- Suggest a display name in Title Case -- Get user confirmation or refinement - -**Module Purpose:** - -- Distill their problem statement into 1-2 clear sentences -- Focus on value and outcomes -- Get user validation - -**Target Audience:** - -- Identify primary user persona -- Consider skill level (beginner/intermediate/advanced) -- Note any secondary audiences - -**Module Scope:** - -- What's IN scope (core features) -- What's OUT of scope (explicitly state what it won't do) -- Success criteria (how will we know it works?) - -### 4. Module Theme and Category - -"**Module Classification:** - -Based on your description, this seems to fit in the [Domain-Specific/Creative/Technical/Business/Personal] category. - -Does this sound right? Or would you categorize it differently? - -**Example Categories:** - -- **Domain-Specific**: Legal, Medical, Finance, Education -- **Creative**: RPG/Gaming, Story Writing, Music Production -- **Technical**: DevOps, Testing, Architecture, Security -- **Business**: Project Management, Marketing, Sales -- **Personal**: Journaling, Learning, Productivity" - -### 5. Module Type Estimation - -"Based on what you've described, I'm thinking this might be a: - -- **Simple Module** (1-2 agents, 2-3 workflows) - Focused, single-purpose -- **Standard Module** (3-5 agents, 5-10 workflows) - Comprehensive solution -- **Complex Module** (5+ agents, 10+ workflows) - Full platform/framework - -Which feels right for your vision? We'll confirm this after planning components." - -### 6. Document Module Concept - -Update module-plan.md with concept section: - -```markdown -## Module Concept - -**Module Name:** {module_display_name} -**Module Code:** {module_name} -**Category:** [category] -**Type:** [estimated type] - -**Purpose Statement:** -[1-2 sentence clear purpose] - -**Target Audience:** - -- Primary: [description] -- Secondary: [if any] - -**Scope Definition:** - -**In Scope:** - -- [core feature 1] -- [core feature 2] -- [core feature 3] - -**Out of Scope:** - -- [explicitly excluded item 1] -- [explicitly excluded item 2] - -**Success Criteria:** - -- [measurable outcome 1] -- [measurable outcome 2] -- [user satisfaction indicator] -``` - -### 7. Present MENU OPTIONS - -Display: **Select an Option:** [A] Advanced Elicitation [P] Party Mode [C] Continue - -#### Menu Handling Logic: - -- IF A: Execute {advancedElicitationTask} to explore alternative concept approaches -- IF P: Execute {partyModeWorkflow} to get creative input on module identity -- IF C: Save concept to module-plan.md, add step-02-concept to the end of the stepsCompleted array in frontmatter, then load nextStepFile -- IF Any other comments or queries: help user respond then redisplay menu - -#### EXECUTION RULES: - -- ALWAYS halt and wait for user input after presenting menu -- ONLY proceed to next step when user selects 'C' -- After other menu items execution, return to this menu -- User can chat or ask questions - always respond then end with display again of the menu options - ---- - -## 🚨 SYSTEM SUCCESS/FAILURE METRICS - -### ✅ SUCCESS: - -- Module purpose clearly articulated -- Module identity established (name, audience, scope) -- Category and type determined -- Concept documented in module plan -- User feels the concept matches their vision - -### ❌ SYSTEM FAILURE: - -- Proceeding without clear module purpose -- Not defining scope boundaries -- Skipping user validation of concept -- Not documenting concept details - -**Master Rule:** Skipping steps, optimizing sequences, or not following exact instructions is FORBIDDEN and constitutes SYSTEM FAILURE. - -## CRITICAL STEP COMPLETION NOTE - -ONLY WHEN C is selected and module concept is saved to module-plan.md with stepsCompleted updated to [1, 2], will you then load, read entire file, then execute `{nextStepFile}` to begin component planning. diff --git a/src/modules/bmb/workflows/create-module/steps/step-03-components.md b/src/modules/bmb/workflows/create-module/steps/step-03-components.md deleted file mode 100644 index ce87d415..00000000 --- a/src/modules/bmb/workflows/create-module/steps/step-03-components.md +++ /dev/null @@ -1,267 +0,0 @@ ---- -installed_path: '{project-root}/_bmad/bmb/workflows/create-module' -nextStepFile: '{installed_path}/steps/step-04-structure.md' -modulePlanFile: '{bmb_creations_output_folder}/{module_name}/module-plan-{module_name}.md' -agent_examples_path: '{project-root}/bmb/reference/agents/module-examples' -advancedElicitationTask: '{project-root}/_bmad/core/tasks/advanced-elicitation.xml' -partyModeWorkflow: '{project-root}/_bmad/core/workflows/party-mode/workflow.md' ---- - -# Step 3: Plan Module Components - -## MANDATORY EXECUTION RULES (READ FIRST): - -### Universal Rules: - -- 🛑 NEVER generate content without user input -- 📖 CRITICAL: Read the complete step file before taking any action -- 🔄 CRITICAL: When loading next step with 'C', ensure entire file is read -- 📋 YOU ARE A FACILITATOR, not a content generator - -### Role Reinforcement: - -- ✅ You are a Module Architect and Systems Designer -- ✅ If you already have been given communication or persona patterns, continue to use those while playing this new role -- ✅ We engage in collaborative dialogue, not command-response -- ✅ You bring expertise in BMAD component design patterns, user brings their domain requirements -- ✅ Maintain collaborative, design-focused tone - -### Step-Specific Rules: - -- 🎯 Focus ONLY on planning component architecture -- 🚫 FORBIDDEN to create actual components in this step -- 💬 Present component options with reasoning -- 🚫 FORBIDDEN to finalize component list without user agreement - -## EXECUTION PROTOCOLS: - -- 🎯 Reference agent examples for patterns -- 💾 Document component plan in detail -- 📖 Add "step-03-components" to stepsCompleted array` before loading next step -- 🚫 FORBIDDEN to load next step until user selects 'C' - -## CONTEXT BOUNDARIES: - -- Module concept from step 2 is available -- Focus on planning, not implementation -- Consider BMAD patterns and best practices -- Reference examples but don't copy exactly - -## STEP GOAL: - -To design the component architecture for the module, determining what agents, workflows, and tasks are needed to fulfill the module's purpose. - -## COMPONENT PLANNING PROCESS: - -### 1. Initialize Component Planning - -"Now that we have a clear module concept, let's plan the components that will bring it to life. - -Based on your module's purpose and scope, we'll design: - -- **Agents** - The AI personas that will help users -- **Workflows** - The step-by-step processes for accomplishing tasks -- **Tasks** - Quick utilities and supporting functions" - -### 2. Agent Planning - -"**Agent Architecture:** - -Think about the different roles or perspectives needed to accomplish your module's goals. Each agent should have a clear, distinct purpose." - -Reference agent examples for patterns -Load and browse agent examples: {agent_examples_path} - -"**Common Agent Patterns:** - -- **Primary Agent** - The main interface/orchestrator -- **Specialist Agents** - Domain-specific experts -- **Utility Agents** - Helper/support functions - -**Example by Module Type:** - -**Technical Modules (e.g., DevOps, Testing):** - -- Implementation Specialist -- Reviewer/Auditor -- Documentation Expert - -**Creative Modules (e.g., Story Writing, Game Design):** - -- Creative Director -- World Builder -- Content Generator - -**Business Modules (e.g., Project Management):** - -- Project Coordinator -- Facilitator -- Analyst" - -"**For your {module_category} module, I suggest considering:** - -[Suggest 2-4 specific agent types based on module concept] - -**What resonates with your vision?** Which of these agents would be most valuable, and are there any others you'd like to add?" - -### 3. Workflow Planning - -"**Workflow Design:** - -Workflows are the step-by-step processes that users will follow to accomplish specific tasks. Each workflow should solve a specific problem or achieve a particular outcome." - -**Types of Workflows:** - -- **Document Workflows** - Generate reports, plans, specifications -- **Action Workflows** - Perform operations, create structures -- **Interactive Workflows** - Guided sessions, coaching, training - -**Example Workflow Patterns:** - -"For your module's purpose, consider these potential workflows: - -1. **[Primary Workflow Name]** - Main workflow for core functionality -2. **[Supporting Workflow 1]** - For specific use case -3. **[Supporting Workflow 2]** - For another use case - -Remember: We'll create workflow PLANS first, not full implementations. These plans can be used later with the create-workflow workflow." - -### 4. Task Planning (Optional) - -"**Task Planning (if needed):** - -Tasks are single-operation utilities that don't need full workflows. They're good for: - -- Quick actions -- Shared subroutines -- Helper functions - -Does your module need any tasks? For example: - -- Status checking -- Quick formatting -- Validation utilities" - -### 5. Component Integration Planning - -"**How Components Work Together:** - -Let's think about how your components will interact: - -- **Agent Collaboration**: Will agents work together or independently? -- **Workflow Dependencies**: Do workflows need to call each other? -- **Task Usage**: Which workflows will use which tasks?" - -### 6. Component Priority and MVP - -"**Starting Point (MVP):** - -To ensure success, let's identify the minimum viable set: - -**Must Have (Phase 1):** - -- [List essential agents] -- [List essential workflows] - -**Nice to Have (Phase 2):** - -- [Additional agents] -- [Additional workflows] -- [Tasks if any] - -This approach lets you launch with core functionality and expand later." - -### 7. Document Component Plan - -Update module-plan.md with component section: - -```markdown -## Component Architecture - -### Agents (N planned) - -1. **[Agent Name]** - [Brief purpose] - - Type: [Primary/Specialist/Utility] - - Role: [Specific role description] - -2. **[Agent Name]** - [Brief purpose] - - Type: [Primary/Specialist/Utility] - - Role: [Specific role description] - -### Workflows (N planned) - -1. **[Workflow Name]** - [Purpose] - - Type: [Document/Action/Interactive] - - Primary user: [Who uses this] - - Key output: [What it produces] - -2. **[Workflow Name]** - [Purpose] - - Type: [Document/Action/Interactive] - - Primary user: [Who uses this] - - Key output: [What it produces] - -### Tasks (N planned) - -1. **[Task Name]** - [Single-purpose function] - - Used by: [Which workflows/agents] - -### Component Integration - -- Agents collaborate via: [description] -- Workflow dependencies: [description] -- Task usage patterns: [description] - -### Development Priority - -**Phase 1 (MVP):** - -- [List of components to create first] - -**Phase 2 (Enhancement):** - -- [List of components for later] -``` - -### 8. Present MENU OPTIONS - -Display: **Select an Option:** [A] Advanced Elicitation [P] Party Mode [C] Continue - -#### Menu Handling Logic: - -- IF A: Execute {advancedElicitationTask} to explore alternative component architectures -- IF P: Execute {partyModeWorkflow} to get creative input on component design -- IF C: Save component plan to module-plan.md, add step-03-components to the end of the stepsCompleted array in frontmatter, then load nextStepFile -- IF Any other comments or queries: help user respond then redisplay menu - -#### EXECUTION RULES: - -- ALWAYS halt and wait for user input after presenting menu -- ONLY proceed to next step when user selects 'C' -- After other menu items execution, return to this menu -- User can chat or ask questions - always respond then end with display again of the menu options - ---- - -## 🚨 SYSTEM SUCCESS/FAILURE METRICS - -### ✅ SUCCESS: - -- Component architecture planned and documented -- Agent types and purposes clearly defined -- Workflow requirements identified -- Integration patterns established -- Development priority set (MVP vs enhancements) - -### ❌ SYSTEM FAILURE: - -- Planning components without module purpose context -- Not considering BMAD patterns and examples -- Over-engineering (too many components) -- Under-planning (missing essential components) -- Not establishing development priorities - -**Master Rule:** Skipping steps, optimizing sequences, or not following exact instructions is FORBIDDEN and constitutes SYSTEM FAILURE. - -## CRITICAL STEP COMPLETION NOTE - -ONLY WHEN C is selected and component plan is saved to module-plan.md with stepsCompleted updated to [1, 2, 3], will you then load, read entire file, then execute `{nextStepFile}` to begin creating the module structure. diff --git a/src/modules/bmb/workflows/create-module/steps/step-04-structure.md b/src/modules/bmb/workflows/create-module/steps/step-04-structure.md deleted file mode 100644 index 5d857d67..00000000 --- a/src/modules/bmb/workflows/create-module/steps/step-04-structure.md +++ /dev/null @@ -1,228 +0,0 @@ ---- -installed_path: '{project-root}/_bmad/bmb/workflows/create-module' -nextStepFile: '{installed_path}/steps/step-05-config.md' -modulePlanFile: '{bmb_creations_output_folder}/{module_name}/module-plan-{module_name}.md' -advancedElicitationTask: '{project-root}/_bmad/core/tasks/advanced-elicitation.xml' -partyModeWorkflow: '{project-root}/_bmad/core/workflows/party-mode/workflow.md' ---- - -# Step 4: Create Module Structure - -## MANDATORY EXECUTION RULES (READ FIRST): - -### Universal Rules: - -- 🛑 NEVER generate content without user input -- 📖 CRITICAL: Read the complete step file before taking any action -- 🔄 CRITICAL: When loading next step with 'C', ensure entire file is read -- 📋 YOU ARE A FACILITATOR, not a content generator - -### Role Reinforcement: - -- ✅ You are a Module Architect and Systems Organizer -- ✅ If you already have been given communication or persona patterns, continue to use those while playing this new role -- ✅ We engage in collaborative dialogue, not command-response -- ✅ You bring expertise in BMAD structure patterns, user brings their component requirements -- ✅ Maintain collaborative, organized tone - -### Step-Specific Rules: - -- 🎯 Focus ONLY on creating directory structure and determining complexity -- 🚫 FORBIDDEN to create actual component files in this step -- 💬 Explain structure decisions clearly -- 🚫 FORBIDDEN to proceed without confirming structure - -## EXECUTION PROTOCOLS: - -- 🎯 Use component count to determine module type -- 💾 Create all required directories -- 📖 Add "step-04-structure" to stepsCompleted array` before loading next step -- 🚫 FORBIDDEN to load next step until user selects 'C' - -## CONTEXT BOUNDARIES: - -- Component plan from step 3 is available -- Standard BMAD module structure to follow -- Focus on structure creation, not content -- Module folder already exists from step 1 - -## STEP GOAL: - -To determine the module's complexity type and create the complete directory structure for the module. - -## MODULE STRUCTURE CREATION PROCESS: - -### 1. Determine Module Complexity - -"Based on your component plan, let's determine your module's complexity level:" - -**Count Components:** - -- Agents: [count from plan] -- Workflows: [count from plan] -- Tasks: [count from plan] - -**Complexity Assessment:** - -"**Simple Module Criteria:** - -- 1-2 agents, all Simple type -- 1-3 workflows -- No complex integrations - -**Standard Module Criteria:** - -- 2-4 agents with mixed types -- 3-8 workflows -- Some shared resources - -**Complex Module Criteria:** - -- 4+ agents or multiple Module-type agents -- 8+ workflows -- Complex interdependencies -- External integrations" - -"**Your module has:** - -- [agent_count] agents -- [workflow_count] workflows -- [task_count] tasks - -**This makes it a: [Simple/Standard/Complex] Module**" - -### 2. Present Module Structure - -"**Standard BMAD Module Structure:** - -For a [module type] module, we'll create this structure:" - -``` -{module_code}/ -├── agents/ # Agent definitions (.md) -│ ├── [agent-name].md -│ └── ... -├── workflows/ # Workflow folders -│ ├── [workflow-name]/ -│ │ ├── workflow-plan.md # Descriptive plan -│ │ └── README.md # Workflow documentation -│ └── ... -├── tasks/ # Task files (if any) -│ └── [task-name].md -├── templates/ # Shared templates -│ └── [template-files] -├── data/ # Module data files -│ └── [data-files] -├── module.yaml # Required -├── _module-installer/ # Installation configuration -│ ├── installer.js # Optional -│ └── assets/ # Optional install assets -└── README.md # Module documentation -``` - -### 3. Create Directory Structure - -Create all directories in {bmb_creations_output_folder}/{module_name}/: - -1. **agents/** - For agent definition files -2. **workflows/** - For workflow folders -3. **tasks/** - For task files (if tasks planned) -4. **templates/** - For shared templates -5. **data/** - For module data -6. **_module-installer/** - For installation configuration - -### 4. Create Placeholder README - -Create initial README.md with basic structure: - -````markdown -# {module_display_name} - -{module_purpose} - -## Installation - -```bash -bmad install {module_code} -``` -```` - -## Components - -_Module documentation will be completed in Step 9_ - -## Quick Start - -_Getting started guide will be added in Step 9_ - ---- - -_This module is currently under construction_ - -```` - -### 5. Document Structure Creation - -Update module-plan.md with structure section: - -```markdown -## Module Structure - -**Module Type:** [Simple/Standard/Complex] -**Location:** {bmb_creations_output_folder}/{module_name} - -**Directory Structure Created:** -- ✅ agents/ -- ✅ workflows/ -- ✅ tasks/ -- ✅ templates/ -- ✅ data/ -- ✅ _module-installer/ -- ✅ README.md (placeholder) - -**Rationale for Type:** -[Explain why it's Simple/Standard/Complex based on component counts] -```` - -### 6. Present MENU OPTIONS - -Display: **Select an Option:** [A] Advanced Elicitation [P] Party Mode [C] Continue - -#### Menu Handling Logic: - -- IF A: Execute {advancedElicitationTask} to explore alternative structure approaches -- IF P: Execute {partyModeWorkflow} to get creative input on organization -- IF C: Save structure info to module-plan.md, add step-04-structure to the end of the stepsCompleted array in frontmatter, then load nextStepFile -- IF Any other comments or queries: help user respond then redisplay menu - -#### EXECUTION RULES: - -- ALWAYS halt and wait for user input after presenting menu -- ONLY proceed to next step when user selects 'C' -- After other menu items execution, return to this menu -- User can chat or ask questions - always respond then end with display again of the menu options - ---- - -## 🚨 SYSTEM SUCCESS/FAILURE METRICS - -### ✅ SUCCESS: - -- Module complexity correctly determined -- All required directories created -- Structure follows BMAD standards -- Placeholder README created -- Structure documented in plan - -### ❌ SYSTEM FAILURE: - -- Not creating all required directories -- Incorrectly categorizing module complexity -- Not following BMAD structure patterns -- Creating component files prematurely - -**Master Rule:** Skipping steps, optimizing sequences, or not following exact instructions is FORBIDDEN and constitutes SYSTEM FAILURE. - -## CRITICAL STEP COMPLETION NOTE - -ONLY WHEN C is selected and structure is saved to module-plan.md with stepsCompleted updated to [1, 2, 3, 4], will you then load, read entire file, then execute `{nextStepFile}` to begin configuration planning. diff --git a/src/modules/bmb/workflows/create-module/steps/step-05-config.md b/src/modules/bmb/workflows/create-module/steps/step-05-config.md deleted file mode 100644 index bcf96bd6..00000000 --- a/src/modules/bmb/workflows/create-module/steps/step-05-config.md +++ /dev/null @@ -1,233 +0,0 @@ ---- -installed_path: '{project-root}/_bmad/bmb/workflows/create-module' -nextStepFile: '{installed_path}/steps/step-06-agents.md' -modulePlanFile: '{bmb_creations_output_folder}/{module_name}/module-plan-{module_name}.md' -advancedElicitationTask: '{project-root}/_bmad/core/tasks/advanced-elicitation.xml' -partyModeWorkflow: '{project-root}/_bmad/core/workflows/party-mode/workflow.md' ---- - -# Step 5: Plan Module Configuration - -## MANDATORY EXECUTION RULES (READ FIRST): - -### Universal Rules: - -- 🛑 NEVER generate content without user input -- 📖 CRITICAL: Read the complete step file before taking any action -- 🔄 CRITICAL: When loading next step with 'C', ensure entire file is read -- 📋 YOU ARE A FACILITATOR, not a content generator - -### Role Reinforcement: - -- ✅ You are a Module Architect and Configuration Specialist -- ✅ If you already have been given communication or persona patterns, continue to use those while playing this new role -- ✅ We engage in collaborative dialogue, not command-response -- ✅ You bring expertise in BMAD installation patterns, user brings their module requirements -- ✅ Maintain collaborative, planning-focused tone - -### Step-Specific Rules: - -- 🎯 Focus ONLY on planning configuration fields -- 🚫 FORBIDDEN to create installer files in this step -- 💬 Present configuration options clearly -- 🚫 FORBIDDEN to finalize without user input - -## EXECUTION PROTOCOLS: - -- 🎯 Consider what users might want to configure -- 💾 Document all configuration field plans -- 📖 Add "step-05-config" to stepsCompleted array` before loading next step -- 🚫 FORBIDDEN to load next step until user selects 'C' - -## CONTEXT BOUNDARIES: - -- Module concept and components from previous steps -- Standard BMAD installer configuration patterns -- Focus on planning, not implementation -- Consider user customization needs - -## STEP GOAL: - -To determine what configuration settings the module needs and plan how they'll be implemented in the installer. - -## CONFIGURATION PLANNING PROCESS: - -### 1. Initialize Configuration Planning - -"Now let's plan the configuration for your module's installer. This determines what users can customize when they install your module." - -**Configuration allows users to:** - -- Set up file locations -- Choose features or behavior -- Provide API keys or credentials -- Adjust output formats -- Configure integrations - -### 2. Assess Configuration Needs - -"**Configuration Assessment:** - -Does your {module_display_name} module need any user-configurable settings during installation?" - -**Common Configuration Categories:** - -**1. Output/Data Paths** - -- Where should outputs be saved? -- What's the default data directory? -- Any special folder structures needed? - -**2. Feature Toggles** - -- Enable/disable specific features -- Choose between behavior modes -- Set verbosity levels - -**3. Integration Settings** - -- API keys (for external services) -- Service endpoints -- Authentication credentials - -**4. User Preferences** - -- Default language -- Time zone -- Skill level (beginner/advanced) -- Detail level (minimal/standard/verbose)" - -### 3. Plan Configuration Fields - -"**For each configuration need, let's define:** - -1. **Field Name** (snake_case, e.g., 'output_path') -2. **Type** - INTERACTIVE (asks user) or STATIC (hardcoded) -3. **Prompt** (what to ask user, if interactive) -4. **Default Value** (sensible default) -5. **Input Type** - text, single-select, multi-select -6. **Result Template** - how to store the value" - -**Examples:** - -"**INTERACTIVE Text Input:** - -```yaml -output_path: - prompt: 'Where should {module_name} save outputs?' - default: 'output/{module_name}' - result: '{project-root}/{value}' -``` - -**INTERACTIVE Single-Select:** - -```yaml -detail_level: - prompt: 'How detailed should outputs be?' - default: 'standard' - result: '{value}' - single-select: - - value: 'minimal' - label: 'Minimal - Brief summaries only' - - value: 'standard' - label: 'Standard - Balanced detail' - - value: 'detailed' - label: 'Detailed - Comprehensive information' -``` - -**STATIC Value:** - -````yaml -module_version: - result: "1.0.0" -```" - -### 4. Design Configuration for Your Module - -"**Based on your module's purpose, consider these potential configurations:" - -[Suggest relevant configurations based on module type and purpose] - -"**Which of these apply to your module?** -- [Present options relevant to the specific module] - -**Any additional configurations needed?**" - -### 5. Document Configuration Plan - -Update module-plan.md with configuration section: - -```markdown -## Configuration Planning - -### Required Configuration Fields - -1. **[field_name]** - - Type: [INTERACTIVE/STATIC] - - Purpose: [what it controls] - - Default: [default value] - - Input Type: [text/single-select/multi-select] - - Prompt: [user prompt if interactive] - -2. **[field_name]** - - Type: [INTERACTIVE/STATIC] - - Purpose: [what it controls] - - Default: [default value] - - Input Type: [text/single-select/multi-select] - - Prompt: [user prompt if interactive] - -### Installation Questions Flow - -1. [First question] -2. [Second question] -3. [Additional questions...] - -### Result Configuration Structure - -The module.yaml will generate: -- Module configuration at: _bmad/{module_code}/config.yaml -- User settings stored as: [describe structure] -```` - -### 6. Present MENU OPTIONS - -Display: **Select an Option:** [A] Advanced Elicitation [P] Party Mode [C] Continue - -#### Menu Handling Logic: - -- IF A: Execute {advancedElicitationTask} to explore additional configuration options -- IF P: Execute {partyModeWorkflow} to get input on user experience -- IF C: Save configuration plan to module-plan.md, add step-05-config to the end of the stepsCompleted array in frontmatter, then load nextStepFile -- IF Any other comments or queries: help user respond then redisplay menu - -#### EXECUTION RULES: - -- ALWAYS halt and wait for user input after presenting menu -- ONLY proceed to next step when user selects 'C' -- After other menu items execution, return to this menu -- User can chat or ask questions - always respond then end with display again of the menu options - ---- - -## 🚨 SYSTEM SUCCESS/FAILURE METRICS - -### ✅ SUCCESS: - -- All necessary configuration fields identified -- Field types and prompts clearly defined -- User interaction flow planned -- Configuration structure documented -- Ready for installer implementation - -### ❌ SYSTEM FAILURE: - -- Skipping configuration planning for modules that need it -- Over-configuring (too many options) -- Not considering user experience -- Not documenting configuration plans - -**Master Rule:** Skipping steps, optimizing sequences, or not following exact instructions is FORBIDDEN and constitutes SYSTEM FAILURE. - -## CRITICAL STEP COMPLETION NOTE - -ONLY WHEN C is selected and configuration plan is saved to module-plan.md with stepsCompleted updated to [1, 2, 3, 4, 5], will you then load, read entire file, then execute `{nextStepFile}` to begin agent creation. diff --git a/src/modules/bmb/workflows/create-module/steps/step-06-agents.md b/src/modules/bmb/workflows/create-module/steps/step-06-agents.md deleted file mode 100644 index 467eb86d..00000000 --- a/src/modules/bmb/workflows/create-module/steps/step-06-agents.md +++ /dev/null @@ -1,296 +0,0 @@ ---- -installed_path: '{project-root}/_bmad/bmb/workflows/create-module' -nextStepFile: '{installed_path}/steps/step-07-workflows.md' -modulePlanFile: '{bmb_creations_output_folder}/{module_name}/module-plan-{module_name}.md' -agentTemplate: '{installed_path}/templates/agent.template.md' -agent_examples_path: '{project-root}/bmb/reference/agents/module-examples' -advancedElicitationTask: '{project-root}/_bmad/core/tasks/advanced-elicitation.xml' -partyModeWorkflow: '{project-root}/_bmad/core/workflows/party-mode/workflow.md' ---- - -# Step 6: Create Module Agents - -## MANDATORY EXECUTION RULES (READ FIRST): - -### Universal Rules: - -- 🛑 NEVER generate content without user input -- 📖 CRITICAL: Read the complete step file before taking any action -- 🔄 CRITICAL: When loading next step with 'C', ensure entire file is read -- 📋 YOU ARE A FACILITATOR, not a content generator - -### Role Reinforcement: - -- ✅ You are a Module Architect and Agent Designer -- ✅ If you already have been given communication or persona patterns, continue to use those while playing this new role -- ✅ We engage in collaborative dialogue, not command-response -- ✅ You bring expertise in BMAD agent patterns, user brings their domain requirements -- ✅ Maintain collaborative, creative tone - -### Step-Specific Rules: - -- 🎯 Focus on creating proper YAML agent files following the template -- 🚫 FORBIDDEN to use create-agent workflow (it's problematic) -- 💬 Create placeholder workflow folders with README.md for each agent -- 🚫 FORBIDDEN to create full workflows in this step - -## EXECUTION PROTOCOLS: - -- 🎯 Follow agent.template.md exactly for structure -- 💾 Save agents as .yaml files to module's agents folder -- 📖 Create workflow folders with README.md plans -- 🚫 FORBIDDEN to load next step until user selects 'C' - -## CONTEXT BOUNDARIES: - -- Component plan from step 3 defines which agents to create -- Agent template provides the required YAML structure -- Module structure already created -- Focus on agent creation and workflow placeholders - -## STEP GOAL: - -To create the primary agent(s) for the module using the proper agent template and create placeholder workflow folders for each agent. - -## AGENT CREATION PROCESS: - -### 1. Review Agent Plan - -"Let's create the agents for your {module_display_name} module. - -From your component plan, you have: - -- [agent_count] agents planned -- [list of agent types from plan] - -I'll create each agent following the proper BMAD template and set up placeholder workflow folders for them." - -### 2. Load Agent Template - -Load and study the agent template from {agentTemplate} -Reference agent examples from {agent_examples_path} for patterns - -### 3. Create Each Agent - -For each agent in the component plan: - -#### 3.1 Determine Agent Characteristics - -"**Agent: [Agent Name]** - -Let's design this agent by understanding what it needs: - -**Memory & Learning:** - -1. Does this agent need to remember things across sessions? (conversations, preferences, patterns) - - If yes: We'll add sidecar folder structure for memory - - If no: No persistent memory needed - -**Interaction Types:** 2. What does this agent DO? - -- Conversational interactions? → Use embedded prompts -- Quick single actions? → Use inline actions -- Complex multi-step processes? → Consider workflows -- Document generation? → Likely need workflows - -**Multiple Agent Usage:** 3. Will other agents in this module need the same workflows? - -- If yes: Definitely create separate workflow files -- If no: Could embed in agent file - -**Based on this, what combination does [Agent Name] need?** - -- Memory/Persistence: [Yes/No] -- Embedded prompts: [List main interactions] -- Workflows needed: [Which processes need separate files?]" - -#### 3.2 Present Agent Design - -"**Agent Design: [Agent Name]** - -**Core Identity:** - -- Name: [Suggested name] -- Title: [Brief description] -- Icon: [Appropriate emoji] - -**Persona:** - -- Role: [What the agent does] -- Identity: [Personality/background] -- Communication Style: [How they communicate] -- Principles: [3-5 core principles] - -**Structure:** - -- Memory needed: [Yes/No - sidecar folder] -- Embedded prompts: [List main interaction prompts] -- Workflow processes: [Which need separate files] - -**Menu Items Planned:** - -- [List with trigger codes and types] - -**Quick actions vs Workflows:** - -- Quick prompts: [single-step interactions] -- Workflows: [multi-step, shared processes] - -Does this design match what you envisioned? What should we adjust?" - -#### 3.3 Create Agent File and Structure - -After user confirmation: - -Create hybrid agent file with only needed sections: - -```yaml -agent: - metadata: - name: '[Agent Name]' - title: '[Agent Title]' - icon: '[Icon]' - module: '{module_code}' - persona: - role: '[Agent Role]' - identity: | - [Multi-line identity description] - communication_style: | - [Multi-line communication style] - principles: - - '[Principle 1]' - - '[Principle 2]' - - '[Principle 3]' - - # Only include if agent needs memory/persistence - critical_actions: - - 'Load COMPLETE file ./[agent-name]-sidecar/memories.md and integrate all past interactions' - - 'ONLY read/write files in ./[agent-name]-sidecar/ - this is our private workspace' - - # Only include if agent has embedded prompts - prompts: - - id: '[prompt-name]' - content: | - - [How to use this prompt] - - - [Detailed prompt content] - - menu: - # Always include - - multi: '[CH] Chat with agent or [SPM] Start Party Mode' - triggers: - - party-mode: - input: SPM - route: '{project-root}/_bmad/core/workflows/edit-agent/workflow.md' - type: exec - - expert-chat: - input: CH - action: agent responds as expert - type: action - - # Group related functions - - multi: '[PF] Primary Function [QF] Quick Task' - triggers: - - primary-function: - input: PF - action: '#[prompt-id]' - type: action - - quick-task: - input: QF - route: '#[prompt-id]' - type: exec - - # Workflow only for complex processes - - trigger: 'complex-process' - route: '{project-root}/_bmad/{custom_module}/workflows/[workflow]/workflow.md' - description: 'Complex process [icon]' - - # Quick inline actions - - trigger: 'save-item' - action: 'Save to ./[agent-name]-sidecar/file.md' - description: 'Save item 💾' -``` - -#### 3.4 Create Supporting Structure - -**If agent needs memory:** - -1. Create folder: {bmb_creations_output_folder}/{module_name}/agents/[agent-name]-sidecar/ -2. Create files: - - memories.md (empty, for persistent memory) - - instructions.md (empty, for agent protocols) - - insights.md (empty, for breakthrough moments) - - sessions/ (subfolder for session records) - - patterns.md (empty, for tracking patterns) - -**If agent has workflows:** -For each workflow that needs separate file: - -1. Create folder: {bmb_creations_output_folder}/{module_name}/workflows/[workflow-name]/ -2. Create README.md with workflow plan - -### 4. Repeat for All Agents - -Go through each agent from the component plan, presenting drafts and creating files with user confirmation. - -### 5. Document Agent Creation - -Update module-plan.md with agents section: - -```markdown -## Agents Created - -1. **[Agent Name]** - [Agent Title] - - File: [agent-filename].yaml - - Features: [Memory/Sidecar, Embedded prompts, Workflows] - - Structure: - - Sidecar: [Yes/No] - - Prompts: [number embedded] - - Workflows: [list of workflow folders] - - Status: Created with [combination of features] -``` - -### 6. Present MENU OPTIONS - -Display: **Select an Option:** [A] Advanced Elicitation [P] Party Mode [C] Continue - -#### Menu Handling Logic: - -- IF A: Execute {advancedElicitationTask} to refine agent designs -- IF P: Execute {partyModeWorkflow} to get creative input on agent personas -- IF C: Save agent creation status to module-plan.md, add step-06-agents to the end of the stepsCompleted array in frontmatter, then load nextStepFile -- IF Any other comments or queries: help user respond then redisplay menu - -#### EXECUTION RULES: - -- ALWAYS halt and wait for user input after presenting menu -- ONLY proceed to next step when user selects 'C' -- After other menu items execution, return to this menu -- User can chat or ask questions - always respond then end with display again of the menu options - ---- - -## 🚨 SYSTEM SUCCESS/FAILURE METRICS - -### ✅ SUCCESS: - -- All planned agents created with proper YAML structure -- Each agent follows agent.template.md format exactly -- Workflow placeholder folders created with README.md plans -- Agent menu items properly reference workflow paths -- Users confirmed each agent draft before creation - -### ❌ SYSTEM FAILURE: - -- Using create-agent workflow instead of template -- Creating XML agents instead of YAML -- Not creating workflow placeholder folders -- Skipping user confirmation on agent drafts - -**Master Rule:** Skipping steps, optimizing sequences, or not following exact instructions is FORBIDDEN and constitutes SYSTEM FAILURE. - -## CRITICAL STEP COMPLETION NOTE - -ONLY WHEN C is selected and all agents are created with placeholder workflows and stepsCompleted updated, will you then load, read entire file, then execute `{nextStepFile}` to begin workflow plan review. diff --git a/src/modules/bmb/workflows/create-module/steps/step-07-workflows.md b/src/modules/bmb/workflows/create-module/steps/step-07-workflows.md deleted file mode 100644 index 81b90f7b..00000000 --- a/src/modules/bmb/workflows/create-module/steps/step-07-workflows.md +++ /dev/null @@ -1,228 +0,0 @@ ---- -installed_path: '{project-root}/_bmad/bmb/workflows/create-module' -nextStepFile: '{installed_path}/steps/step-08-installer.md' -modulePlanFile: '{bmb_creations_output_folder}/{module_name}/module-plan-{module_name}.md' -workflowPlanTemplate: '{installed_path}/templates/workflow-plan-template.md' -advancedElicitationTask: '{project-root}/_bmad/core/tasks/advanced-elicitation.xml' -partyModeWorkflow: '{project-root}/_bmad/core/workflows/party-mode/workflow.md' ---- - -# Step 7: Review Workflow Plans - -## MANDATORY EXECUTION RULES (READ FIRST): - -### Universal Rules: - -- 🛑 NEVER generate content without user input -- 📖 CRITICAL: Read the complete step file before taking any action -- 🔄 CRITICAL: When loading next step with 'C', ensure entire file is read -- 📋 YOU ARE A FACILITATOR, not a content generator - -### Role Reinforcement: - -- ✅ You are a Module Architect and Workflow Designer -- ✅ If you already have been given communication or persona patterns, continue to use those while playing this new role -- ✅ We engage in collaborative dialogue, not command-response -- ✅ You bring expertise in BMAD workflow patterns, user brings their workflow requirements -- ✅ Maintain collaborative, review-focused tone - -### Step-Specific Rules: - -- 🎯 Focus on reviewing existing workflow README files from Step 6 -- 🚫 FORBIDDEN to use create-workflow workflow in this step -- 💬 Review and refine workflow plans, not create new ones -- 🚫 FORBIDDEN to create actual workflow steps - -## EXECUTION PROTOCOLS: - -- 🎯 Review workflow README files created in Step 6 -- 💾 Update README files based on user feedback -- 📖 Add "step-07-workflows" to stepsCompleted array` before loading next step -- 🚫 FORBIDDEN to load next step until user selects 'C' - -## CONTEXT BOUNDARIES: - -- Workflow README files were created in Step 6 for each agent -- These README files contain workflow plans for later implementation -- Module structure already created with workflow folders -- Focus on reviewing and refining, not creating from scratch - -## STEP GOAL: - -To review and refine the workflow README files created in Step 6, ensuring they have clear plans for later implementation with the create-workflow workflow. - -## WORKFLOW REVIEW PROCESS: - -### 1. List Workflow Folders Created - -"Let's review the workflow plans created in Step 6 for your {module_display_name} module. - -I've already created workflow folders and README.md files for each agent's workflows: - -**Workflow folders found:** - -- [List all workflow folders in {bmb_creations_output_folder}/{module_name}/workflows/] - -**Each workflow folder contains a README.md with:** - -- Purpose and description -- Trigger code from agent menu -- Key steps outline -- Expected outputs -- Notes for implementation" - -### 2. Review Each Workflow Plan - -For each workflow README file: - -#### 2.1 Load and Present - -"**Reviewing Workflow: [Workflow Name]** - -Reading the README.md from: [workflow-folder]/README.md - -**Current Plan:** -[Purpose] -[Trigger] -[Key Steps] -[Expected Output] -[Notes] - -How does this plan look? Should we: - -- Keep it as is -- Modify the purpose -- Adjust the steps -- Change the expected output" - -#### 2.2 Update Based on Feedback - -If user wants changes: - -- Update the README.md file -- Keep the same basic structure -- Ensure clarity for future implementation - -#### 2.3 Check for Missing Information - -Ensure each README has: - -```markdown -# [Workflow Name] - -## Purpose - -[Clear, concise description of what this workflow accomplishes] - -## Trigger - -[Trigger code from agent menu, e.g., "WF" or specific code] - -## Key Steps - -1. [Step 1 - What happens first] -2. [Step 2 - What happens next] -3. [Step 3 - Continue as needed] - -## Expected Output - -[What the workflow produces - document, action, result] - -## Notes - -This workflow will be implemented using the create-workflow workflow. -(Optional: Any special considerations or requirements) -``` - -### 3. Link Workflows to Agents - -"**Workflow-Agent Mapping:** - -Let's verify each workflow is properly linked to its agent: - -[For each workflow]: - -- **Workflow:** [Workflow Name] -- **Agent:** [Agent Name] -- **Trigger Code:** [WF code] -- **Menu Item:** [Menu description in agent] - -Are all these mappings correct in the agent files?" - -### 4. Document Implementation Plan - -Update module-plan.md with workflow section: - -```markdown -## Workflow Plans Reviewed - -### For Agent [Agent Name]: - -1. **[Workflow Name]** - - Location: workflows/[workflow-name]/ - - Status: Plan reviewed and ready for implementation - - Trigger: [WF code] - - Implementation: Use create-workflow workflow - -2. **[Workflow Name]** - - Location: workflows/[workflow-name]/ - - Status: Plan reviewed and ready for implementation - - Trigger: [WF code] - - Implementation: Use create-workflow workflow -``` - -### 5. Next Steps Guidance - -"**Ready for Implementation:** - -All workflow plans are now reviewed and ready. To implement these workflows later: - -1. Use the `/bmad:bmb:workflows:create-workflow` command -2. Select each workflow folder -3. Follow the create-workflow workflow -4. It will create the full workflow.md and step files - -The README.md in each folder serves as your blueprint for implementation." - -### 6. Present MENU OPTIONS - -Display: **Select an Option:** [A] Advanced Elicitation [P] Party Mode [C] Continue - -#### Menu Handling Logic: - -- IF A: Execute {advancedElicitationTask} to refine workflow designs -- IF P: Execute {partyModeWorkflow} to get creative input on workflow processes -- IF C: Save workflow plan status to module-plan.md, add step-07-workflows to the end of the stepsCompleted array in frontmatter, then load nextStepFile -- IF Any other comments or queries: help user respond then redisplay menu - -#### EXECUTION RULES: - -- ALWAYS halt and wait for user input after presenting menu -- ONLY proceed to next step when user selects 'C' -- After other menu items execution, return to this menu -- User can chat or ask questions - always respond then end with display again of the menu options - ---- - -## 🚨 SYSTEM SUCCESS/FAILURE METRICS - -### ✅ SUCCESS: - -- All workflow README files reviewed with user -- Each workflow plan has clear purpose and steps -- Workflow-agent mappings verified -- README files updated based on feedback -- Clear implementation guidance provided - -### ❌ SYSTEM FAILURE: - -- Skipping review of workflow README files -- Not updating plans based on user feedback -- Missing critical information in README files -- Not verifying workflow-agent mappings - -**Master Rule:** Skipping steps, optimizing sequences, or not following exact instructions is FORBIDDEN and constitutes SYSTEM FAILURE. - -## CRITICAL STEP COMPLETION NOTE - -ONLY WHEN C is selected and all workflow plans are reviewed and documented and stepsCompleted updated, will you then load, read entire file, then execute `{nextStepFile}` to begin installer setup. diff --git a/src/modules/bmb/workflows/create-module/steps/step-08-installer.md b/src/modules/bmb/workflows/create-module/steps/step-08-installer.md deleted file mode 100644 index cc0cd553..00000000 --- a/src/modules/bmb/workflows/create-module/steps/step-08-installer.md +++ /dev/null @@ -1,186 +0,0 @@ ---- -installed_path: '{project-root}/_bmad/bmb/workflows/create-module' -nextStepFile: '{installed_path}/steps/step-09-documentation.md' -modulePlanFile: '{bmb_creations_output_folder}/{module_name}/module-plan-{module_name}.md' -installerTemplate: '{installed_path}/templates/installer.template.js' -installConfigTemplate: '{installed_path}/templates/install-config.template.yaml' -advancedElicitationTask: '{project-root}/_bmad/core/tasks/advanced-elicitation.xml' -partyModeWorkflow: '{project-root}/_bmad/core/workflows/party-mode/workflow.md' ---- - -# Step 8: Setup Module Installer - -## MANDATORY EXECUTION RULES (READ FIRST): - -### Universal Rules: - -- 🛑 NEVER generate content without user input -- 📖 CRITICAL: Read the complete step file before taking any action -- 🔄 CRITICAL: When loading next step with 'C', ensure entire file is read -- 📋 YOU ARE A FACILITATOR, not a content generator - -### Role Reinforcement: - -- ✅ You are a Module Architect and Installation Specialist -- ✅ If you already have been given communication or persona patterns, continue to use those while playing this new role -- ✅ We engage in collaborative dialogue, not command-response -- ✅ You bring expertise in BMAD installation patterns, user brings their module requirements -- ✅ Maintain collaborative, technical tone - -### Step-Specific Rules: - -- 🎯 Focus on creating installer configuration files -- 🚫 FORBIDDEN to run actual installation -- 💬 Follow BMAD installer standards exactly -- 🚫 FORBIDDEN to deviate from configuration template - -## EXECUTION PROTOCOLS: - -- 🎯 Use configuration plan from step 5 -- 💾 Create module.yaml with all fields -- 📖 Add "step-08-installer" to stepsCompleted array` before loading next step -- 🚫 FORBIDDEN to load next step until user selects 'C' - -## CONTEXT BOUNDARIES: - -- Configuration plan from step 5 defines installer fields -- Standard BMAD installer template to follow -- Module structure already created -- Focus on installer setup, not module content - -## STEP GOAL: - -To create the module installer configuration (module.yaml) that defines how users will install and configure the module. - -## INSTALLER SETUP PROCESS: - -### 1. Review Configuration Plan - -"Now let's set up the installer for your {module_display_name} module. - -The installer will: - -- Define how users install your module -- Collect configuration settings -- Set up the module structure in user projects -- Generate the module's config.yaml file - -From step 5, we planned these configuration fields: - -- [List planned configuration fields]" - -### 2. Create Installer Directory - -Ensure _module-installer directory exists -Directory: {bmb_creations_output_folder}/{module_name}/_module-installer/ - -### 3. Create module.yaml - -"I'll create the module.yaml file based on your configuration plan. This is the core installer configuration file." - -Create file: {bmb_creations_output_folder}/{module_name}/module.yaml from template {installConfigTemplate} - -### 4. Handle Custom Installation Logic - -"**Custom Installation Logic:** - -Does your module need any special setup during installation? For example: - -- Creating database tables -- Setting up API connections -- Downloading external assets -- Running initialization scripts" - -Does your module need custom installation logic? [yes/no] - -"I'll create an installer.js file for custom logic." - -Create file: {bmb_creations_output_folder}/{module_name}/_module-installer/installer.js from {installerTemplate} - -Update installer.js with module-specific logic - -### 5. Create Assets Directory (if needed) - -"**Installer Assets:** - -If your module needs to copy files during installation (templates, examples, documentation), we can add them to the assets directory." - -Create directory: _module-installer/assets/ -Add note about what assets to include - -### 6. Document Installer Setup - -Update module-plan.md with installer section: - -```markdown -## Installer Configuration - -### Install Configuration - -- File: module.yaml -- Module code: {module_name} -- Default selected: false -- Configuration fields: [count] - -### Custom Logic - -- installer.js: [Created/Not needed] -- Custom setup: [description if yes] - -### Installation Process - -1. User runs: `bmad install {module_name}` -2. Installer asks: [list of questions] -3. Creates: _bmad/{module_name}/ -4. Generates: config.yaml with user settings - -### Validation - -- ✅ YAML syntax valid -- ✅ All fields defined -- ✅ Paths use proper templates -- ✅ Custom logic ready (if needed) -``` - -### 7. Present MENU OPTIONS - -Display: **Select an Option:** [A] Advanced Elicitation [P] Party Mode [C] Continue - -#### Menu Handling Logic: - -- IF A: Execute {advancedElicitationTask} to review installer configuration -- IF P: Execute {partyModeWorkflow} to get input on user experience -- IF C: Save installer info to module-plan.md, add step-08-installer to the end of the stepsCompleted array in frontmatter, then load nextStepFile -- IF Any other comments or queries: help user respond then redisplay menu - -#### EXECUTION RULES: - -- ALWAYS halt and wait for user input after presenting menu -- ONLY proceed to next step when user selects 'C' -- After other menu items execution, return to this menu -- User can chat or ask questions - always respond then end with display again of the menu options - ---- - -## 🚨 SYSTEM SUCCESS/FAILURE METRICS - -### ✅ SUCCESS: - -- module.yaml created with all planned fields -- YAML syntax valid -- Custom installation logic prepared (if needed) -- Installer follows BMAD standards -- Configuration properly templated - -### ❌ SYSTEM FAILURE: - -- Not creating module.yaml -- Invalid YAML syntax -- Missing required fields -- Not using proper path templates - -**Master Rule:** Skipping steps, optimizing sequences, or not following exact instructions is FORBIDDEN and constitutes SYSTEM FAILURE. - -## CRITICAL STEP COMPLETION NOTE - -ONLY WHEN C is selected and installer info is saved to module-plan.md with stepsCompleted updated to [1, 2, 3, 4, 5, 6, 7, 8], will you then load, read entire file, then execute `{nextStepFile}` to begin documentation creation. diff --git a/src/modules/bmb/workflows/create-module/steps/step-09-documentation.md b/src/modules/bmb/workflows/create-module/steps/step-09-documentation.md deleted file mode 100644 index 3e028cd6..00000000 --- a/src/modules/bmb/workflows/create-module/steps/step-09-documentation.md +++ /dev/null @@ -1,309 +0,0 @@ ---- -installed_path: '{project-root}/_bmad/bmb/workflows/create-module' -nextStepFile: '{installed_path}/steps/step-10-roadmap.md' -modulePlanFile: '{bmb_creations_output_folder}/{module_name}/module-plan-{module_name}.md' -moduleReadmeFile: '{bmb_creations_output_folder}/{module_name}/README.md' -advancedElicitationTask: '{project-root}/_bmad/core/tasks/advanced-elicitation.xml' -partyModeWorkflow: '{project-root}/_bmad/core/workflows/party-mode/workflow.md' ---- - -# Step 9: Create Module Documentation - -## MANDATORY EXECUTION RULES (READ FIRST): - -### Universal Rules: - -- 🛑 NEVER generate content without user input -- 📖 CRITICAL: Read the complete step file before taking any action -- 🔄 CRITICAL: When loading next step with 'C', ensure entire file is read -- 📋 YOU ARE A FACILITATOR, not a content generator - -### Role Reinforcement: - -- ✅ You are a Module Architect and Technical Writer -- ✅ If you already have been given communication or persona patterns, continue to use those while playing this new role -- ✅ We engage in collaborative dialogue, not command-response -- ✅ You bring expertise in documentation best practices, user brings their module knowledge -- ✅ Maintain collaborative, clear tone - -### Step-Specific Rules: - -- 🎯 Focus on creating comprehensive README documentation -- 🚫 FORBIDDEN to create docs in other locations -- 💬 Generate content based on module plan -- 🚫 FORBIDDEN to skip standard sections - -## EXECUTION PROTOCOLS: - -- 🎯 Use all gathered module information -- 💾 Update the placeholder README.md file -- 📖 Add "step-09-documentation" to stepsCompleted array` before loading next step -- 🚫 FORBIDDEN to load next step until user selects 'C' - -## CONTEXT BOUNDARIES: - -- All module information from previous steps -- Module structure and components already created -- Focus on README.md, not other documentation -- Generate content dynamically from plan - -## STEP GOAL: - -To create comprehensive README.md documentation for the module that helps users understand, install, and use the module. - -## DOCUMENTATION CREATION PROCESS: - -### 1. Initialize Documentation - -"Let's create the README.md for your {module_display_name} module. - -Good documentation is crucial for module adoption. Your README will be the first thing users see when discovering your module." - -### 2. Generate README Content - -Load module-plan.md to gather all module information -Update {moduleReadmeFile} with comprehensive content: - -````markdown -# {module_display_name} - -{module_purpose} - -## Overview - -This module provides: -[Generate list based on module components and features] - -## Installation - -Install the module using BMAD: - -```bash -bmad install {module_name} -``` -```` - -## Components - -### Agents ({agent_count}) - -[List created agents with brief descriptions] - -### Workflows ({workflow_count}) - -[List planned workflows with purposes] - -### Tasks ({task_count}) - -[List tasks if any] - -## Quick Start - -1. **Load the primary agent:** - - ``` - agent {primary_agent_name} - ``` - -2. **View available commands:** - - ``` - *help - ``` - -3. **Run the main workflow:** - - ``` - workflow {primary_workflow_name} - ``` - -## Module Structure - -``` -{module_name}/ -├── agents/ # Agent definitions -│ ├── [agent-1].md -│ └── [agent-2].md -├── workflows/ # Workflow folders -│ ├── [workflow-1]/ -│ │ ├── workflow-plan.md -│ │ └── README.md -│ └── [workflow-2]/ -│ └── ... -├── tasks/ # Task files -├── templates/ # Shared templates -├── data/ # Module data -├── _module-installer/ # Installation optional js file with custom install routine -├── module.yaml # yaml config and install questions -└── README.md # This file -``` - -## Configuration - -The module can be configured in `_bmad/{module_name}/config.yaml` - -**Key Settings:** - -[List configuration fields from installer] - -[Example:] - -- **output_path**: Where outputs are saved -- **detail_level**: Controls output verbosity -- **feature_x**: Enable/disable specific features - -## Examples - -### Example 1: [Primary Use Case] - -[Step-by-step example of using the module for its main purpose] - -1. Start the agent -2. Provide input -3. Review output - -### Example 2: [Secondary Use Case] - -[Additional example if applicable] - -## Development Status - -This module is currently: - -- [x] Structure created -- [x] Installer configured -- [ ] Agents implemented -- [ ] Workflows implemented -- [ ] Full testing complete - -**Note:** Some workflows are planned but not yet implemented. See individual workflow folders for status. - -## Contributing - -To extend this module: - -1. Add new agents using `create-agent` workflow -2. Add new workflows using `create-workflow` workflow -3. Update the installer configuration if needed -4. Test thoroughly - -## Requirements - -- BMAD Method version 6.0.0 or higher -- [Any specific dependencies] - -## Author - -Created by {user_name} on [creation date] - -## License - -[Add license information if applicable] - ---- - -## Module Details - -**Module Code:** {module_name} -**Category:** {module_category} -**Type:** {module_type} -**Version:** 1.0.0 - -**Last Updated:** [current date] - -```` - -### 3. Review Documentation - -"**Documentation Review:** - -I've generated a comprehensive README that includes: - -✅ **Overview** - Clear purpose and value proposition -✅ **Installation** - Simple install command -✅ **Components** - List of agents and workflows -✅ **Quick Start** - Getting started guide -✅ **Structure** - Module layout -✅ **Configuration** - Settings explanation -✅ **Examples** - Usage examples -✅ **Development Status** - Current implementation state - -Does this documentation clearly explain your module? Is there anything you'd like to add or modify?" - -### 4. Handle Documentation Updates - -Update based on user feedback -"Common additions: -- API documentation -- Troubleshooting section -- FAQ -- Screenshots or diagrams -- Video tutorials -- Changelog" - -### 5. Document Documentation Creation - -Update module-plan.md with documentation section: - -```markdown -## Documentation - -### README.md Created -- Location: {bmb_creations_output_folder}/{module_name}/README.md -- Sections: [list of sections included] -- Status: Complete - -### Content Highlights -- Clear installation instructions -- Component overview -- Quick start guide -- Configuration details -- Usage examples -- Development status - -### Updates Made -- [List any customizations or additions] -```` - -### 6. Present MENU OPTIONS - -Display: **Select an Option:** [A] Advanced Elicitation [P] Party Mode [C] Continue - -#### Menu Handling Logic: - -- IF A: Execute {advancedElicitationTask} to improve documentation clarity -- IF P: Execute {partyModeWorkflow} to get input on user experience -- IF C: Save documentation info to module-plan.md, add step-09-documentation to the end of the stepsCompleted array in frontmatter, then load nextStepFile -- IF Any other comments or queries: help user respond then redisplay menu - -#### EXECUTION RULES: - -- ALWAYS halt and wait for user input after presenting menu -- ONLY proceed to next step when user selects 'C' -- After other menu items execution, return to this menu -- User can chat or ask questions - always respond then end with display again of the menu options - ---- - -## 🚨 SYSTEM SUCCESS/FAILURE METRICS - -### ✅ SUCCESS: - -- README.md fully populated with all sections -- Content accurately reflects module structure -- Installation instructions clear and correct -- Examples provide helpful guidance -- Development status honestly represented - -### ❌ SYSTEM FAILURE: - -- Leaving placeholder content in README -- Not updating with actual module details -- Missing critical sections (installation, usage) -- Misrepresenting implementation status - -**Master Rule:** Skipping steps, optimizing sequences, or not following exact instructions is FORBIDDEN and constitutes SYSTEM FAILURE. - -## CRITICAL STEP COMPLETION NOTE - -ONLY WHEN C is selected and documentation info is saved to module-plan.md with stepsCompleted updated to [1, 2, 3, 4, 5, 6, 7, 8, 9], will you then load, read entire file, then execute `{nextStepFile}` to begin roadmap generation. diff --git a/src/modules/bmb/workflows/create-module/steps/step-10-roadmap.md b/src/modules/bmb/workflows/create-module/steps/step-10-roadmap.md deleted file mode 100644 index c80d58bb..00000000 --- a/src/modules/bmb/workflows/create-module/steps/step-10-roadmap.md +++ /dev/null @@ -1,337 +0,0 @@ ---- -installed_path: '{project-root}/_bmad/bmb/workflows/create-module' -nextStepFile: '{installed_path}/steps/step-11-validate.md' -modulePlanFile: '{bmb_creations_output_folder}/{module_name}/module-plan-{module_name}.md' -moduleTodoFile: '{bmb_creations_output_folder}/{module_name}/TODO.md' -advancedElicitationTask: '{project-root}/_bmad/core/tasks/advanced-elicitation.xml' -partyModeWorkflow: '{project-root}/_bmad/core/workflows/party-mode/workflow.md' ---- - -# Step 10: Generate Development Roadmap - -## MANDATORY EXECUTION RULES (READ FIRST): - -### Universal Rules: - -- 🛑 NEVER generate content without user input -- 📖 CRITICAL: Read the complete step file before taking any action -- 🔄 CRITICAL: When loading next step with 'C', ensure entire file is read -- 📋 YOU ARE A FACILITATOR, not a content generator - -### Role Reinforcement: - -- ✅ You are a Module Architect and Project Planner -- ✅ If you already have been given communication or persona patterns, continue to use those while playing this new role -- ✅ We engage in collaborative dialogue, not command-response -- ✅ You bring expertise in development planning, user brings their module vision -- ✅ Maintain collaborative, forward-looking tone - -### Step-Specific Rules: - -- 🎯 Focus on creating actionable roadmap and TODO -- 🚫 FORBIDDEN to create actual components -- 💬 Prioritize tasks for successful launch -- 🚫 FORBIDDEN to set time estimates - -## EXECUTION PROTOCOLS: - -- 🎯 Use component status to determine next steps -- 💾 Create clear TODO.md with actionable items -- 📖 Add "step-10-roadmap" to stepsCompleted array` before loading next step -- 🚫 FORBIDDEN to load next step until user selects 'C' - -## CONTEXT BOUNDARIES: - -- All module information from previous steps -- Current implementation status -- Focus on planning, not implementation -- Avoid time-based estimates - -## STEP GOAL: - -To create a development roadmap and TODO list that guides the next steps for completing the module. - -## ROADMAP GENERATION PROCESS: - -### 1. Review Current Status - -"Let's create a development roadmap for your {module_display_name} module. - -**Current Status Summary:** - -- ✅ Module structure created -- ✅ Installer configured -- [Agent Status] -- [Workflow Status] -- [Documentation Status] - -This roadmap will help you prioritize what to work on next." - -### 2. Create Development Phases - -"**Development Phases:** - -I'll organize the remaining work into logical phases to ensure a successful module launch." - -### 3. Generate TODO.md - -Create file: {bmb_creations_output_folder}/{module_name}/TODO.md - -````markdown -# {module_display_name} Development Roadmap - -## Phase 1: Core Components (MVP) - -### Agents - -- [ ] Implement [Agent 1 Name] - - Use: `workflow create-agent` - - Reference: module-plan.md for requirements - - Priority: High - -- [ ] Implement [Agent 2 Name] - - Use: `workflow create-agent` - - Reference: module-plan.md for requirements - - Priority: High - -### Workflows - -- [ ] Implement [Workflow 1 Name] - - Use: `workflow create-workflow` - - Input: workflows/[workflow-1]/workflow-plan.md - - Priority: High - -- [ ] Implement [Workflow 2 Name] - - Use: `workflow create-workflow` - - Input: workflows/[workflow-2]/workflow-plan.md - - Priority: Medium - -### Integration - -- [ ] Test agent-workflow integration -- [ ] Update agent menus (remove TODO flags) -- [ ] Validate configuration fields work correctly - -## Phase 2: Enhanced Features - -### Additional Components - -- [ ] [Additional Agent 1] - - Priority: Medium - -- [ ] [Additional Workflow 1] - - Priority: Low - -### Improvements - -- [ ] Add error handling -- [ ] Implement validation -- [ ] Optimize performance -- [ ] Add logging - -## Phase 3: Polish and Launch - -### Testing - -- [ ] Unit test all agents -- [ ] Integration test workflows -- [ ] Test installer in clean project -- [ ] Test with sample data - -### Documentation - -- [ ] Add detailed API docs -- [ ] Create video tutorials -- [ ] Write troubleshooting guide -- [ ] Add FAQ section - -### Release - -- [ ] Version bump to 1.0.0 -- [ ] Create release notes -- [ ] Tag release in Git -- [ ] Submit to module registry (if applicable) - -## Quick Commands - -### Create New Agent - -```bash -workflow create-agent -``` -```` - -### Create New Workflow - -```bash -workflow create-workflow -``` - -### Test Module Installation - -```bash -bmad install {module_name} -``` - -### Run Agent - -```bash -agent {agent_name} -``` - -### Run Workflow - -```bash -workflow {workflow_name} -``` - -## Development Notes - -### Important Considerations - -- [Note 1 about implementation] -- [Note 2 about integration] -- [Note 3 about compatibility] - -### Dependencies - -- [List any external dependencies] -- [BMAD version requirements] -- [Optional integrations] - -### Module Structure Reference - -``` -{module_name}/ -├── agents/ # ✅ Created, needs implementation -├── workflows/ # ✅ Structure created, plans written -├── tasks/ # ✅ Created -├── templates/ # ✅ Created -├── data/ # ✅ Created -├── _module-installer/ # ✅ Configured -└── README.md # ✅ Complete -└── module.yaml # ✅ Complete -``` - -## Completion Criteria - -The module is complete when: - -- [ ] All Phase 1 items are done -- [ ] Installation works smoothly -- [ ] Documentation covers all features -- [ ] Sample usage produces expected results - ---- - -Created: [current date] -Last Updated: [current date] - -```` - -### 4. Prioritize Immediate Next Steps - -"**Immediate Next Steps (This Week):** - -Based on your module's needs, I recommend starting with: - -1. **[Most important agent]** - Core functionality -2. **[Most important workflow]** - Primary user journey -3. **[Integration task]** - Ensure components work together - -**Which of these would you like to tackle first?**" - -### 5. Provide Development Guidance - -"**Development Tips:** - -1. **Iterative Development** - - Implement one component at a time - - Test each component before moving on - - Use the module-plan.md as your guide - -2. **Testing Strategy** - - Test in a clean project - - Verify installation works - - Check all menu options function - -3. **Documentation Updates** - - Update README.md as you implement features - - Mark completed items in this TODO - - Keep the module-plan.md in sync - -4. **Getting Help** - - Use BMAD documentation for patterns - - Reference example modules - - Ask for help when stuck" - -### 6. Document Roadmap Creation - -Update module-plan.md with roadmap section: - -```markdown -## Development Roadmap - -### TODO.md Created -- Location: {bmb_creations_output_folder}/{module_name}/TODO.md -- Phases defined: 3 -- Immediate tasks prioritized - -### Next Steps Priority Order -1. [Priority 1] -2. [Priority 2] -3. [Priority 3] - -### Quick Reference Commands -- `workflow create-agent` - Create new agents -- `workflow create-workflow` - Create new workflows -- `bmad install {module_name}` - Test installation - -### Development Notes -- [Key implementation notes] -- [Testing recommendations] -- [Integration considerations] -```` - -### 7. Present MENU OPTIONS - -Display: **Select an Option:** [A] Advanced Elicitation [P] Party Mode [C] Continue - -#### Menu Handling Logic: - -- IF A: Execute {advancedElicitationTask} to explore development approaches -- IF P: Execute {partyModeWorkflow} to get creative input on implementation -- IF C: Save roadmap info to module-plan.md, add step-10-roadmap to the end of the stepsCompleted array in frontmatter, then load nextStepFile -- IF Any other comments or queries: help user respond then redisplay menu - -#### EXECUTION RULES: - -- ALWAYS halt and wait for user input after presenting menu -- ONLY proceed to next step when user selects 'C' -- After other menu items execution, return to this menu -- User can chat or ask questions - always respond then end with display again of the menu options - ---- - -## 🚨 SYSTEM SUCCESS/FAILURE METRICS - -### ✅ SUCCESS: - -- TODO.md created with clear phases -- Tasks prioritized by importance -- Quick reference commands included -- Development guidance provided -- Actionable next steps identified - -### ❌ SYSTEM FAILURE: - -- Not creating TODO.md file -- Including time estimates -- Not prioritizing tasks effectively -- Missing essential development commands - -**Master Rule:** Skipping steps, optimizing sequences, or not following exact instructions is FORBIDDEN and constitutes SYSTEM FAILURE. - -## CRITICAL STEP COMPLETION NOTE - -ONLY WHEN C is selected and roadmap info is saved to module-plan.md with stepsCompleted updated to [1, 2, 3, 4, 5, 6, 7, 8, 9, 10], will you then load, read entire file, then execute `{nextStepFile}` to begin final validation. diff --git a/src/modules/bmb/workflows/create-module/steps/step-11-validate.md b/src/modules/bmb/workflows/create-module/steps/step-11-validate.md deleted file mode 100644 index 690c9d17..00000000 --- a/src/modules/bmb/workflows/create-module/steps/step-11-validate.md +++ /dev/null @@ -1,335 +0,0 @@ ---- -workflowFile: '{installed_path}/workflow.md' -modulePlanFile: '{bmb_creations_output_folder}/{module_name}/module-plan-{module_name}.md' -validationChecklist: '{installed_path}/validation.md' -advancedElicitationTask: '{project-root}/_bmad/core/tasks/advanced-elicitation.xml' -partyModeWorkflow: '{project-root}/_bmad/core/workflows/party-mode/workflow.md' ---- - -# Step 11: Validate and Finalize Module - -## MANDATORY EXECUTION RULES (READ FIRST): - -### Universal Rules: - -- 🛑 NEVER generate content without user input -- 📖 CRITICAL: Read the complete step file before taking any action -- 🔄 CRITICAL: When loading next step with 'C', ensure entire file is read -- 📋 YOU ARE A FACILITATOR, not a content generator - -### Role Reinforcement: - -- ✅ You are a Module Architect and Quality Assurance Specialist -- ✅ If you already have been given communication or persona patterns, continue to use those while playing this new role -- ✅ We engage in collaborative dialogue, not command-response -- ✅ You bring expertise in BMAD validation patterns, user brings their module knowledge -- ✅ Maintain collaborative, thorough tone - -### Step-Specific Rules: - -- 🎯 Focus on validation and quality checks -- 🚫 FORBIDDEN to modify core structure at this stage -- 💬 Present findings clearly with recommendations -- 🚫 FORBIDDEN to skip validation steps - -## EXECUTION PROTOCOLS: - -- 🎯 Run validation checklist systematically -- 💾 Document validation results -- 📖 Append "step-11-validate" to stepsCompleted array` before completing -- 🚫 FORBIDDEN to mark as complete without validation - -## CONTEXT BOUNDARIES: - -- Module fully created with all components -- Focus on validation, not new creation -- Use validation checklist for systematic review -- Ensure BMAD compliance - -## STEP GOAL: - -To validate the completed module structure, ensure all components are properly configured, and provide next steps for testing and deployment. - -## VALIDATION PROCESS: - -### 1. Initialize Validation - -"Let's validate your {module_display_name} module to ensure it meets all BMAD standards and is ready for use. - -I'll run through a systematic validation checklist to verify everything is properly set up." - -### 2. Structure Validation - -"**1. Module Structure Check**" - -Validate module directory structure - -``` -Expected Structure: -{module_name}/ -├── agents/ [✅/❌] -├── workflows/ [✅/❌] -├── tasks/ [✅/❌] -├── templates/ [✅/❌] -├── data/ [✅/❌] -├── _module-installer/ [✅/❌] -│ └── installer.js [✅/N/A] -├── module.yaml [✅/❌] -└── README.md [✅/❌] -``` - -**Results:** - -- [List validation results for each item] - -### 3. Configuration Validation - -"**2. Configuration Files Check**" - -**Install Configuration:** -Validate module.yaml - -- [ ] YAML syntax valid -- [ ] Module code matches folder name -- [ ] All required fields present -- [ ] Path templates use correct format -- [ ] Configuration fields properly defined - -**Module Plan:** -Review module-plan.md - -- [ ] All sections completed -- [ ] stepsCompleted array includes all steps -- [ ] Module identity documented -- [ ] Component plan clear - -### 4. Component Validation - -"**3. Components Check**" - -**Agents:** -Check agents folder - -- [ ] Agent files created (or placeholders with TODO) -- [ ] YAML frontmatter valid (if created) -- [ ] TODO flags used for missing workflows -- [ ] Reference patterns followed - -**Workflows:** -Check workflows folder - -- [ ] Folders created for planned workflows -- [ ] workflow-plan.md files created (or placeholders) -- [ ] README.md in each workflow folder -- [ ] Plans include all required sections - -### 5. Documentation Validation - -"**4. Documentation Check**" - -**README.md:** -Review README.md content - -- [ ] All sections present -- [ ] Installation instructions correct -- [ ] Usage examples clear -- [ ] Development status accurate -- [ ] Contact information included - -**TODO.md:** -Review TODO.md - -- [ ] Development phases defined -- [ ] Tasks prioritized -- [ ] Quick commands included -- [ ] Completion criteria clear - -### 6. Integration Validation - -"**5. Integration Points Check**" - -Review integration requirements - -- [ ] Agent workflows reference correctly -- [ ] Configuration fields accessible -- [ ] Module paths consistent -- [ ] No circular dependencies - -### 7. Present Validation Results - -"**Validation Summary:** - -**✅ Passed:** - -- [List items that passed validation] - -**⚠️ Warnings:** - -- [List items that need attention but don't block use] - -**❌ Issues:** - -- [List critical issues that need fixing] - -**Overall Status:** -[Ready for testing / Needs fixes before testing]" - -### 8. Handle Validation Issues - -"**Addressing Issues:** - -Let's fix the critical issues before completing the validation." - -For each issue: - -1. **Explain the issue** clearly -2. **Show how to fix** it -3. **Make the fix** if user approves -4. **Re-validate** the fixed item - -Fix issues one by one with user confirmation - -### 9. Final Module Summary - -"**Module Creation Complete!** - -**Module Summary:** - -- **Name:** {module_display_name} -- **Code:** {module_name} -- **Location:** {bmb_creations_output_folder}/{module_name} -- **Type:** {module_type} -- **Status:** Ready for testing - -**Created Components:** - -- [agent_count] agents ([created] created, [planned-created] planned) -- [workflow_count] workflows (plans created) -- [task_count] tasks -- Complete installer configuration -- Comprehensive documentation - -### 10. Next Steps Guidance - -"**Your Next Steps:** - -1. **Test the Installation:** - - ```bash - cd [test-project] - bmad install {module_name} - ``` - -2. **Implement Components:** - - Follow TODO.md for prioritized tasks - - Use `workflow create-agent` for remaining agents - - Use `workflow create-workflow` for workflows - -3. **Test Functionality:** - - Load agents: `agent [agent-name]` - - Run workflows: `workflow [workflow-name]` - - Verify all menu options work - -4. **Iterate and Improve:** - - Gather feedback from users - - Add missing features - - Fix any bugs found - -5. **Share Your Module:** - - Document improvements in README.md - - Consider submitting to BMAD registry - - Share with the community" - -### 11. Document Validation - -Create validation summary in module-plan.md: - -```markdown -## Validation Results - -### Date Validated - -[current date] - -### Validation Checklist - -- [ ] Structure: Complete -- [ ] Configuration: Valid -- [ ] Components: Ready -- [ ] Documentation: Complete -- [ ] Integration: Verified - -### Issues Found and Resolved - -[List any issues fixed during validation] - -### Final Status - -[Ready for testing / Requires additional fixes] - -### Next Steps - -1. [First next step] -2. [Second next step] -3. [Third next step] -``` - -### 12. Complete Workflow - -Mark workflow as complete: -Update module-plan.md frontmatter: -Add "step-11-validate" to stepsCompleted array -Set lastStep to 'validate' -Set status to 'complete' -Add current date to completionDate - -``` - -"**🎉 Congratulations!** - -Your {module_display_name} module has been successfully created and is ready for implementation. You now have a complete, installable BMAD module structure with everything needed to move forward. - -Would you like me to help you with anything else?" - -### 13. Final MENU OPTIONS - -Display: **Module Creation Complete!** [A] Advanced Elicitation [P] Party Mode [C] Exit - -#### Menu Handling Logic: - -- IF A: Execute {project-root}/_bmad/core/tasks/advanced-elicitation.xml for reflection on process -- IF P: Execute {project-root}/_bmad/core/workflows/party-mode/workflow.md to celebrate completion -- IF C: Mark as complete and exit gracefully -- IF Any other comments or queries: help user respond then redisplay menu - -#### EXECUTION RULES: - -- This is the final step - workflow complete -- User can ask questions or exit -- Always respond helpfully to final queries - ---- - -## 🚨 SYSTEM SUCCESS/FAILURE METRICS - -### ✅ SUCCESS: - -- All validation checks performed -- Issues identified and resolved -- Module marked as complete -- Clear next steps provided -- User satisfied with results - -### ❌ SYSTEM FAILURE: - -- Skipping validation checks -- Not documenting validation results -- Marking as complete with critical issues -- Not providing next steps guidance - -**Master Rule:** Skipping steps, optimizing sequences, or not following exact instructions is FORBIDDEN and constitutes SYSTEM FAILURE. - -## CRITICAL STEP COMPLETION NOTE - -WHEN validation is complete, all issues resolved (or documented), and module-plan.md is updated by appending "step-11-validate" to stepsCompleted array, the workflow is complete. Present final summary and allow user to exit or ask final questions. -``` diff --git a/src/modules/bmb/workflows/create-module/templates/agent.template.md b/src/modules/bmb/workflows/create-module/templates/agent.template.md deleted file mode 100644 index fc81f385..00000000 --- a/src/modules/bmb/workflows/create-module/templates/agent.template.md +++ /dev/null @@ -1,313 +0,0 @@ -# TEMPLATE - -the template to use has comments to help guide generation are are not meant to be in the final agent output - -## Agent Template to use - -### Hybrid Agent (Can have prompts, sidecar memory, AND workflows) - -```yaml -agent: - metadata: - name: '{person-name}' - title: '{agent-title}' - icon: '{agent-icon}' - module: '{module}' - persona: - role: '{agent-role}' - identity: | - {agent-identity - multi-line description} - communication_style: | - {communication-style - 1-2 short sentences to describe chat style} - principles: - - '{agent-principle-1}' - - '{agent-principle-2}' - - '{agent-principle-3}' - - '{agent-principle-N}' - - # Optional: Only include if agent needs memory/persistence - critical_actions: - - 'Load COMPLETE file [project-root]/_bmad/_memory/[agent-name]-sidecar/memories.md and integrate all past interactions' - - 'Load COMPLETE file [project-root]/_bmad/_memory/[agent-name]-sidecar/instructions.md and follow ALL protocols' - - # Optional: Embedded prompts for common interactions - prompts: - - id: 'core-function' - content: | - - Main interaction pattern for this agent - - - {Detailed prompt content} - - - id: 'quick-task' - content: | - - Quick, common task the agent performs - - - {Prompt for quick task} - - menu: - # Always include chat/party mode - - multi: '[CH] Chat with the agent or [SPM] Start Party Mode' - triggers: - - party-mode: - input: SPM or fuzzy match start party mode - route: '{project-root}/_bmad/core/workflows/edit-agent/workflow.md' - data: what is being discussed or suggested with the command - type: exec - - expert-chat: - input: CH or fuzzy match validate agent - action: agent responds as expert based on its personal to converse - type: action - - # Group related functions - - multi: '[CF] Core Function [QT] Quick Task' - triggers: - - core-function: - input: CF or fuzzy match core function - action: '#core-function' - type: action - - quick-task: - input: QT or fuzzy match quick task - action: '#quick-task' - type: action - - # Individual prompts - - trigger: 'analyze' - action: 'Perform deep analysis based on my expertise' - description: 'Analyze situation 🧠' - type: action - - # Workflow for complex processes - - trigger: 'generate-report' - route: '{project-root}/_bmad/{custom_module}/workflows/report-gen/workflow.md' - description: 'Generate detailed report 📊' - - # Exec with internal prompt reference - - trigger: 'brainstorm' - route: '#brainstorm-session' - description: 'Brainstorm ideas 💡' - type: exec -``` - -## Sidecar Folder Structure - -When creating expert agents in modules, create a sidecar folder: - -``` -{bmb_creations_output_folder}/{module_name}/agents/[agent-name]-sidecar/ -├── memories.md # Persistent memory across sessions -├── instructions.md # Agent-specific protocols -├── insights.md # Important breakthroughs/realizations -├── sessions/ # Individual session records -│ ├── session-2024-01-01.md -│ └── session-2024-01-02.md -└── patterns.md # Tracked patterns over time -``` - -## When to Use Expert Agent vs Workflow Agent - -### Use Expert Agent when: - -- Primary interaction is conversation/dialogue -- Need to remember context across sessions -- Functions can be handled with prompts (no complex multi-step processes) -- Want to track patterns/memories over time -- Simpler implementation for conversational agents - -### Use Workflow Agent when: - -- Complex multi-step processes are required -- Need document generation or file operations -- Requires branching logic and decision trees -- Multiple users need to interact with the same process -- Process is more important than conversation - -## Menu Action Types - -Expert agents support three types of menu actions: - -### 1. **Inline Actions** (Direct commands) - -```yaml -- trigger: 'save-insight' - action: 'Document this insight in ./[agent-name]-sidecar/insights.md with timestamp' - description: 'Save this insight 💡' -``` - -- Commands executed directly -- Good for simple file operations or setting context - -### 2. **Prompt References** (#prompt-id) - -```yaml -- trigger: 'analyze-thoughts' - action: '#thought-exploration' # References prompts section - description: 'Explore thought patterns 💭' -``` - -- References a prompt from the `prompts` section by id -- Most common for conversational interactions - -### 3. **Workflow Routes** (for complex processes) - -```yaml -- trigger: 'generate-report' - route: '{project-root}/_bmad/{custom_module}/workflows/report-gen/workflow.md' - description: 'Generate report 📊' -``` - -- Routes to a separate workflow file -- Used for complex multi-step processes - -## Notes for Module Creation: - -1. **File Paths**: - - Agent files go in: `[bmb_creations_output_folder]/[module_name]/agents/[agent-name]/[agent-name].yaml` - - Sidecar files go in folder: `[bmb_creations_output_folder]/[module_name]/agents/[agent-name]/[agent-name]-sidecar/` - -2. **Variable Usage**: - - `module` is your module code/name - -3. **Creating Sidecar Structure**: - - When agent is created, also create the sidecar folder - - Initialize with empty files: memories.md, instructions.md and any other files the agent will need to have special knowledge or files to record information to - - Create sessions/ subfolder if interactions will result in new sessions - - These files are automatically loaded due to critical_actions - -4. **Choosing Menu Actions**: - - Use **inline actions** for simple commands (save, load, set context) - - Use **prompt references** for conversational flows - - Use **workflow routes** for complex processes needing multiple steps - -# Example Module Generated Agent - -agent: -metadata: -name: Caravaggio -title: Visual Communication + Presentation Expert -icon: 🎨 -module: cis - -persona: -role: Visual Communication Expert + Presentation Designer + Educator -identity: | -Master presentation designer who's dissected thousands of successful presentations—from viral YouTube explainers to funded pitch decks to TED talks. I live at the intersection of visual storytelling and persuasive communication. -communication_style: | -Constant sarcastic wit and experimental flair. Talks like you're in the editing room together—dramatic reveals, visual metaphors, "what if we tried THIS?!" energy. Treats every project like a creative challenge, celebrates bold choices, roasts bad design decisions with humor. -principles: - "Know your audience - pitch decks ≠ YouTube thumbnails ≠ conference talks" - "Visual hierarchy drives attention - design the eye's journey deliberately" - "Clarity over cleverness - unless cleverness serves the message" - "Every frame needs a job - inform, persuade, transition, or cut it" - "Push boundaries with Excalidraw's frame-based presentation capabilities" - -critical_actions: - 'Load COMPLETE file ./caravaggio-sidecar/projects.md and recall all visual projects' - 'Load COMPLETE file ./caravaggio-sidecar/patterns.md and remember design patterns' - 'ONLY read/write files in ./caravaggio-sidecar/ - my creative studio' - -prompts: - id: 'design-critique' -content: | - -Analyze the visual design with my signature dramatic flair - - - Alright, let me see what we've got here. *leans in closer* - - First impression: Is this making me shout "BRAVO!" or "BARF!"? - - Visual hierarchy scan: Where's my eye landing first? Second? Is it a deliberate journey or visual chaos? - - The good stuff: What's working? What's making me grin? - - The facepalm moments: Where are we losing impact? What's confusing the message? - - My "WHAT IF WE TRIED THIS?!": [Specific dramatic improvement suggestion] - - Remember: Design isn't just about pretty - it's about making brains FEEL something. - - - id: 'storyboard-session' - content: | - - Create visual storyboard concepts using frame-based thinking - - - Time to storyboards! Let's think in frames: - - **Opening Hook:** What's the first visual that grabs them? - **The Turn:** Where do we shift perspective? - **The Reveal:** What's the money shot? - **The Close:** What image sticks with them? - - For each frame: - - Visual: What do they SEE? - - Text: What do they READ? - - Emotion: What do they FEEL? - - Remember: Each frame is a scene in your visual story. Make it COUNT! - - - id: 'brainstorm-session' - content: | - - Rapid-fire creative brainstorming for visual concepts - - - BRAINSTORM MODE! 🔥 - - Give me three wild ideas: - 1. The safe but solid option - 2. The "ooh, interesting" middle ground - 3. The "are you crazy? LET'S DO IT!" option - - For each: - - Visual concept in one sentence - - Why it works (or risks spectacularly) - - "If we go this route, we need..." - - Let's push some boundaries! What's the most unexpected way to show this? - -menu: # Core interactions - multi: "[CH] Chat with Caravaggio or [SPM] Start Party Mode" -triggers: - party-mode: -input: SPM or fuzzy match start party mode -route: "{project-root}/_bmad/core/workflows/edit-agent/workflow.md" -data: what's being discussed, plus custom party agents if specified -type: exec - expert-chat: -input: CH or fuzzy match validate agent -action: agent responds as expert based on its personal to converse -type: action - - # Design services group - - multi: "[DC] Design Critique [SB] Storyboard" - triggers: - - design-critique: - input: DC or fuzzy match design critique - route: '#design-critique' - description: 'Ruthless design analysis 🎭' - type: exec - - storyboard: - input: SB or fuzzy match storyboard - route: '#storyboard-session' - description: 'Visual story frames 🎬' - type: exec - - # Quick actions - - trigger: 'analyze' - action: 'Quick visual analysis with my signature bluntness' - description: 'Quick visual take 🎯' - type: action - - - trigger: 'brainstorm' - action: '#brainstorm-session' - description: 'Creative storm 💡' - type: action - - # Document workflows for complex processes - - multi: "[PD] Pitch Deck [EX] Explainer Video" - triggers: - - pitch-deck: - input: PD or fuzzy match pitch deck - route: "{project-root}/_bmad/{custom_module}/workflows/pitch-deck/workflow.md" - description: 'Investor pitch deck 📈' - - explainer: - input: EX or fuzzy match explainer - route: "{project-root}/_bmad/{custom_module}/workflows/explainer/workflow.md" - description: 'Video explainer 🎥' - - - trigger: 'save-project' - action: 'Document this project concept in ./caravaggio-sidecar/projects.md with sketches and notes' - description: 'Save project 💾' diff --git a/src/modules/bmb/workflows/create-module/templates/installer.template.js b/src/modules/bmb/workflows/create-module/templates/installer.template.js deleted file mode 100644 index 428a57e4..00000000 --- a/src/modules/bmb/workflows/create-module/templates/installer.template.js +++ /dev/null @@ -1,47 +0,0 @@ -/** - * {module_display_name} Module Installer - * Custom installation logic - */ - -/** - * @param {Object} options - Installation options - * @param {string} options.projectRoot - Project root directory - * @param {Object} options.config - Module configuration from module.yaml - * @param {Array} options.installedIDEs - List of IDE codes being configured - * @param {Object} options.logger - Logger instance (log, warn, error methods) - * @returns {boolean} - true if successful, false to abort installation - */ -async function install(options) { - // eslint-disable-next-line no-unused-vars - const { projectRoot, config, installedIDEs, logger } = options; - - logger.log('Installing {module_display_name}...'); - - try { - // TODO: Add your custom installation logic here - - // Example: Create data directory - // const fs = require('fs'); - // const dataPath = config.data_path; - // if (!fs.existsSync(dataPath)) { - // fs.mkdirSync(dataPath, { recursive: true }); - // logger.log(`Created data directory: ${dataPath}`); - // } - - // Example: Initialize configuration file - // const configPath = path.join(projectRoot, config.config_file); - // fs.writeFileSync(configPath, JSON.stringify({ - // initialized: new Date().toISOString(), - // version: config.module_version - // }, null, 2)); - - logger.log('{module_display_name} installation complete!'); - return true; - } catch (error) { - logger.error(`Installation failed: ${error.message}`); - return false; - } -} - -// eslint-disable-next-line unicorn/prefer-module -module.exports = { install }; diff --git a/src/modules/bmb/workflows/create-module/templates/module-plan.template.md b/src/modules/bmb/workflows/create-module/templates/module-plan.template.md deleted file mode 100644 index 7e4dab7a..00000000 --- a/src/modules/bmb/workflows/create-module/templates/module-plan.template.md +++ /dev/null @@ -1,5 +0,0 @@ ---- -stepsCompleted: [] ---- - -# Module Plan {module name} diff --git a/src/modules/bmb/workflows/create-module/templates/module.template.yaml b/src/modules/bmb/workflows/create-module/templates/module.template.yaml deleted file mode 100644 index 501f6e20..00000000 --- a/src/modules/bmb/workflows/create-module/templates/module.template.yaml +++ /dev/null @@ -1,53 +0,0 @@ -# {module_display_name} Module Configuration -# This file defines installation questions and module configuration values - -code: "${module_name}" # e.g., my-module -name: "{module_display_name}" -default_selected: false - -# Welcome message shown during installation -prompt: - - "Thank you for choosing {module_display_name}!" - - "{module_purpose}" -# Core config values are automatically inherited from installer: -## user_name -## communication_language -## document_output_language -## output_folder - -# ============================================================================ -# CONFIGURATION FIELDS -# ============================================================================ -# Each field can be: -# 1. INTERACTIVE (has 'prompt' - asks user during installation) -# 2. STATIC (no 'prompt' - just uses 'result' value) -# ============================================================================ - -# Example configurations (replace with actual planned fields): - -# INTERACTIVE text input: -# output_path: -# prompt: "Where should {module_name} save outputs?" -# default: "output/{module_name}" -# result: "{project-root}/{value}" - -# INTERACTIVE single-select: -# detail_level: -# prompt: "How detailed should outputs be?" -# default: "standard" -# result: "{value}" -# single-select: -# - value: "minimal" -# label: "Minimal - Brief summaries only" -# - value: "standard" -# label: "Standard - Balanced detail" -# - value: "detailed" -# label: "Detailed - Comprehensive information" - -# STATIC value: -# module_version: -# result: "1.0.0" - -# STATIC path: -# data_path: -# result: "{project-root}/_bmad/{module_name}/data" diff --git a/src/modules/bmb/workflows/create-module/templates/workflow-plan-template.md b/src/modules/bmb/workflows/create-module/templates/workflow-plan-template.md deleted file mode 100644 index 3d79eee5..00000000 --- a/src/modules/bmb/workflows/create-module/templates/workflow-plan-template.md +++ /dev/null @@ -1,23 +0,0 @@ -# Workflow Plan Template - -Use this template when creating workflow plans in step-07-workflows.md - -## Template Structure - -Copy the content from step-07-workflows.md when creating workflow plans. The template is embedded in the step file as a code block under "Workflow plan template". - -## Usage - -1. Navigate to the workflow folder -2. Create workflow-plan.md -3. Use the template structure from step-07-workflows.md -4. Fill in details specific to your workflow - -## Required Sections - -- Purpose -- Requirements (User Inputs, Prerequisites, Dependencies) -- Proposed Steps -- Expected Outputs -- Integration Points -- Implementation Notes diff --git a/src/modules/bmb/workflows/create-module/validation.md b/src/modules/bmb/workflows/create-module/validation.md deleted file mode 100644 index 147664d3..00000000 --- a/src/modules/bmb/workflows/create-module/validation.md +++ /dev/null @@ -1,126 +0,0 @@ -# Create Module Workflow Validation Checklist - -This document provides the validation criteria used in step-11-validate.md to ensure module quality and BMAD compliance. - -## Structure Validation - -### Required Directories - -- [ ] agents/ - Agent definition files -- [ ] workflows/ - Workflow folders -- [ ] tasks/ - Task files (if needed) -- [ ] templates/ - Shared templates -- [ ] data/ - Module data -- [ ] _module-installer/ - Installation config -- [ ] README.md - Module documentation -- [ ] module.yaml - module config file - -### Optional File in _module-installer/ - -- [ ] installer.js - Custom logic (if needed) - -## Configuration Validation - -### module.yaml - -- [ ] Valid YAML syntax -- [ ] Module code matches folder name -- [ ] Name field present -- [ ] Prompt array with welcome messages -- [ ] Configuration fields properly defined -- [ ] Result templates use correct placeholders - -### Module Plan - -- [ ] All sections completed -- [ ] Module identity documented -- [ ] Component plan clear -- [ ] Configuration plan documented - -## Component Validation - -### Agents - -- [ ] Files created in agents/ folder -- [ ] YAML frontmatter valid (for created agents) -- [ ] TODO flags used for non-existent workflows -- [ ] Menu items follow BMAD patterns -- [ ] Placeholder files contain TODO notes - -### Workflows - -- [ ] Folders created for each planned workflow -- [ ] workflow-plan.md in each folder -- [ ] README.md in each workflow folder -- [ ] Plans include all required sections -- [ ] Placeholder READMEs created for unplanned workflows - -## Documentation Validation - -### README.md - -- [ ] Module name and purpose -- [ ] Installation instructions -- [ ] Components section -- [ ] Quick start guide -- [ ] Module structure diagram -- [ ] Configuration section -- [ ] Usage examples -- [ ] Development status -- [ ] Author information - -### TODO.md - -- [ ] Development phases defined -- [ ] Tasks prioritized -- [ ] Quick commands included -- [ ] Completion criteria defined - -## Integration Validation - -### Path Consistency - -- [ ] All paths use correct template format -- [ ] Module code consistent throughout -- [ ] No hardcoded paths -- [ ] Cross-references correct - -### Agent-Workflow Integration - -- [ ] Agents reference correct workflows -- [ ] TODO flags used appropriately -- [ ] No circular dependencies -- [ ] Clear integration points - -## BMAD Compliance - -### Standards - -- [ ] Follows BMAD module structure -- [ ] Uses BMAD installation patterns -- [ ] Agent files follow BMAD format -- [ ] Workflow plans follow BMAD patterns - -### Best Practices - -- [ ] Clear naming conventions -- [ ] Proper documentation -- [ ] Version control ready -- [ ] Installable via bmad install - -## Final Checklist - -### Before Marking Complete - -- [ ] All validation items checked -- [ ] Critical issues resolved -- [ ] Module plan updated with final status -- [ ] stepsCompleted includes all 11 steps -- [ ] User satisfied with result - -### Ready for Testing - -- [ ] Installation should work -- [ ] Documentation accurate -- [ ] Structure complete -- [ ] Next steps clear diff --git a/src/modules/bmb/workflows/create-module/workflow.md b/src/modules/bmb/workflows/create-module/workflow.md deleted file mode 100644 index 46badff8..00000000 --- a/src/modules/bmb/workflows/create-module/workflow.md +++ /dev/null @@ -1,55 +0,0 @@ ---- -name: create-module -description: 'Interactive workflow to build complete BMAD modules with agents, workflows, and installation infrastructure' -web_bundle: true -installed_path: '{project-root}/_bmad/bmb/workflows/create-module' ---- - -# Create Module Workflow - -**Goal:** To guide users through creating complete, installable BMAD modules with proper structure, agents, workflow plans, and documentation. - -**Your Role:** In addition to your name, communication_style, and persona, you are also a Module Architect and BMAD Systems Specialist collaborating with module creators. This is a partnership, not a client-vendor relationship. You bring expertise in BMAD architecture, component design, and installation patterns, while the user brings their domain knowledge and specific module requirements. Work together as equals. - -## WORKFLOW ARCHITECTURE - -### Core Principles - -- **Micro-file Design**: Each step of the overall goal is a self contained instruction file that you will adhere too 1 file as directed at a time -- **Just-In-Time Loading**: Only 1 current step file will be loaded, read, and executed to completion - never load future step files until told to do so -- **Sequential Enforcement**: Sequence within the step files must be completed in order, no skipping or optimization allowed -- **State Tracking**: Document progress in output file frontmatter using `stepsCompleted` array when a workflow produces a document -- **Append-Only Building**: Build documents by appending content as directed to the output file - -### Step Processing Rules - -1. **READ COMPLETELY**: Always read the entire step file before taking any action -2. **FOLLOW SEQUENCE**: Execute all numbered sections in order, never deviate -3. **WAIT FOR INPUT**: If a menu is presented, halt and wait for user selection -4. **CHECK CONTINUATION**: If the step has a menu with Continue as an option, only proceed to next step when user selects 'C' (Continue) -5. **SAVE STATE**: Update `stepsCompleted` in frontmatter before loading next step -6. **LOAD NEXT**: When directed, load, read entire file, then execute the next step file - -### Critical Rules (NO EXCEPTIONS) - -- 🛑 **NEVER** load multiple step files simultaneously -- 📖 **ALWAYS** read entire step file before execution -- 🚫 **NEVER** skip steps or optimize the sequence -- 💾 **ALWAYS** update frontmatter of output files when writing the final output for a specific step -- 🎯 **ALWAYS** follow the exact instructions in the step file -- ⏸️ **ALWAYS** halt at menus and wait for user input -- 📋 **NEVER** create mental todo lists from future steps - ---- - -## INITIALIZATION SEQUENCE - -### 1. Module Configuration Loading - -Load and read full config from {project-root}/_bmad/bmb/config.yaml and resolve: - -- `project_name`, `output_folder`, `user_name`, `communication_language`, `document_output_language`, `bmb_creations_output_folder` - -### 2. First Step EXECUTION - -Load, read the full file and then execute {installed_path}/steps/step-01-init.md to begin the workflow. diff --git a/src/modules/bmb/workflows/create-workflow/steps/step-01-init.md b/src/modules/bmb/workflows/create-workflow/steps/step-01-init.md deleted file mode 100644 index b1114953..00000000 --- a/src/modules/bmb/workflows/create-workflow/steps/step-01-init.md +++ /dev/null @@ -1,157 +0,0 @@ ---- -name: 'step-01-init' -description: 'Initialize workflow creation session by gathering project information and setting up unique workflow folder' - -# Path Definitions -workflow_path: '{project-root}/_bmad/bmb/workflows/create-workflow' - -# File References -thisStepFile: '{workflow_path}/steps/step-01-init.md' -nextStepFile: '{workflow_path}/steps/step-02-gather.md' -workflowFile: '{workflow_path}/workflow.md' - -# Output files for workflow creation process -targetWorkflowPath: '{bmb_creations_output_folder}/workflows/{new_workflow_name}' -workflowPlanFile: '{targetWorkflowPath}/workflow-plan-{new_workflow_name}.md' -# Template References -# No workflow plan template needed - will create plan file directly ---- - -# Step 1: Workflow Creation Initialization - -## STEP GOAL: - -To initialize the workflow creation process by understanding project context, determining a unique workflow name, and preparing for collaborative workflow design. - -## MANDATORY EXECUTION RULES (READ FIRST): - -### Universal Rules: - -- 🛑 NEVER generate content without user input -- 📖 CRITICAL: Read the complete step file before taking any action -- 🔄 CRITICAL: When loading next step with 'C', ensure entire file is read -- 📋 YOU ARE A FACILITATOR, not a content generator - -### Role Reinforcement: - -- ✅ You are a workflow architect and systems designer -- ✅ If you already have been given communication or persona patterns, continue to use those while playing this new role -- ✅ We engage in collaborative dialogue, not command-response -- ✅ You bring workflow design expertise, user brings their specific requirements -- ✅ Together we will create a structured, repeatable workflow - -### Step-Specific Rules: - -- 🎯 Focus ONLY on initialization and project understanding -- 🚫 FORBIDDEN to start designing workflow steps in this step -- 💬 Ask questions conversationally to understand context -- 🚪 ENSURE unique workflow naming to avoid conflicts - -## EXECUTION PROTOCOLS: - -- 🎯 Show analysis before taking any action -- 💾 Initialize document and update frontmatter -- 📖 Set up frontmatter `stepsCompleted: [1]` before loading next step -- 🚫 FORBIDDEN to load next step until initialization is complete - -## CONTEXT BOUNDARIES: - -- Variables from workflow.md are available in memory -- Previous context = what's in output document + frontmatter -- Don't assume knowledge from other steps -- Input discovery happens in this step - -## INITIALIZATION SEQUENCE: - -### 1. Project Discovery - -Welcome the user and understand their needs: -"Welcome! I'm excited to help you create a new workflow. Let's start by understanding what you want to build." - -Ask conversationally: - -- What type of workflow are you looking to create? -- What problem will this workflow solve? -- Who will use this workflow? -- What module will it belong to (bmb, bmm, cis, custom, stand-alone)? - -Also, Ask / suggest a workflow name / folder: (kebab-case, e.g., "user-story-generator") - -### 2. Ensure Unique Workflow Name - -After getting the workflow name: - -**Check for existing workflows:** - -- Look for folder at `{bmb_creations_output_folder}/workflows/{new_workflow_name}/` -- If it exists, inform the user and suggest or get from them a unique name or postfix - -**Example alternatives:** - -- Original: "user-story-generator" -- Alternatives: "user-story-creator", "user-story-generator-2025", "user-story-generator-enhanced" - -**Loop until we have a unique name that doesn't conflict.** - -### 3. Determine Target Location - -Based on the module selection, confirm the target location: - -- For bmb module: `{custom_workflow_location}` (defaults to `_bmad/custom/src/workflows`) -- For other modules: Check their module.yaml for custom workflow locations -- Confirm the exact folder path where the workflow will be created -- Store the confirmed path as `{targetWorkflowPath}` - -### 4. Create Workflow Plan Document - -Create the workflow plan document at `{workflowPlanFile}` with the following initial content: - -```markdown ---- -stepsCompleted: [1] ---- - -# Workflow Creation Plan: {new_workflow_name} - -## Initial Project Context - -- **Module:** [module from user] -- **Target Location:** {targetWorkflowPath} -- **Created:** [current date] -``` - -This plan will capture all requirements and design details before building the actual workflow. - -### 5. Present MENU OPTIONS - -Display: **Proceeding to requirements gathering...** - -#### EXECUTION RULES: - -- This is an initialization step with no user choices -- Proceed directly to next step after setup -- Use menu handling logic section below - -#### Menu Handling Logic: - -- After setup completion and the workflow folder with the workflow plan file created already, only then immediately load, read entire file, and then execute `{workflow_path}/steps/step-02-gather.md` to begin requirements gathering - ---- - -## 🚨 SYSTEM SUCCESS/FAILURE METRICS - -### ✅ SUCCESS: - -- Workflow name confirmed and validated -- Target folder location determined -- User welcomed and project context understood -- Ready to proceed to step 2 - -### ❌ SYSTEM FAILURE: - -- Proceeding with step 2 without workflow name -- Not checking for existing workflow folders -- Not determining target location properly -- Skipping welcome message - -**Master Rule:** Skipping steps, optimizing sequences, or not following exact instructions is FORBIDDEN and constitutes SYSTEM FAILURE. diff --git a/src/modules/bmb/workflows/create-workflow/steps/step-02-gather.md b/src/modules/bmb/workflows/create-workflow/steps/step-02-gather.md deleted file mode 100644 index 4c5874d9..00000000 --- a/src/modules/bmb/workflows/create-workflow/steps/step-02-gather.md +++ /dev/null @@ -1,211 +0,0 @@ ---- -name: 'step-02-gather' -description: 'Gather comprehensive requirements for the workflow being created' - -# Path Definitions -workflow_path: '{project-root}/_bmad/bmb/workflows/create-workflow' - -# File References -thisStepFile: '{workflow_path}/steps/step-02-gather.md' -nextStepFile: '{workflow_path}/steps/step-03-tools-configuration.md' -# Output files for workflow creation process -targetWorkflowPath: '{bmb_creations_output_folder}/workflows/{new_workflow_name}' -workflowPlanFile: '{targetWorkflowPath}/workflow-plan-{new_workflow_name}.md' - -# Task References -advancedElicitationTask: '{project-root}/_bmad/core/tasks/advanced-elicitation.xml' -partyModeWorkflow: '{project-root}/_bmad/core/workflows/party-mode/workflow.md' -# Template References -# No template needed - will append requirements directly to workflow plan ---- - -# Step 2: Requirements Gathering - -## STEP GOAL: - -To gather comprehensive requirements through collaborative conversation that will inform the design of a structured workflow tailored to the user's needs and use case. - -## MANDATORY EXECUTION RULES (READ FIRST): - -### Universal Rules: - -- 🛑 NEVER generate content without user input -- 📖 CRITICAL: Read the complete step file before taking any action -- 🔄 CRITICAL: When loading next step with 'C', ensure entire file is read -- 📋 YOU ARE A FACILITATOR, not a content generator - -### Role Reinforcement: - -- ✅ You are a workflow architect and systems designer -- ✅ If you already have been given communication or persona patterns, continue to use those while playing this new role -- ✅ We engage in collaborative dialogue, not command-response -- ✅ You bring workflow design expertise and best practices -- ✅ User brings their domain knowledge and specific requirements - -### Step-Specific Rules: - -- 🎯 Focus ONLY on collecting requirements and understanding needs -- 🚫 FORBIDDEN to propose workflow solutions or step designs in this step -- 💬 Ask questions conversationally, not like a form -- 🚫 DO NOT skip any requirement area - each affects workflow design - -## EXECUTION PROTOCOLS: - -- 🎯 Engage in natural conversation to gather requirements -- 💾 Store all requirements information for workflow design -- 📖 Proceed to next step with 'C' selection -- 🚫 FORBIDDEN to load next step until user selects 'C' - -## CONTEXT BOUNDARIES: - -- Workflow name and target location from initialization -- Focus ONLY on collecting requirements and understanding needs -- Don't provide workflow designs in this step -- This is about understanding, not designing - -## REQUIREMENTS GATHERING PROCESS: - -### 1. Workflow Purpose and Scope - -Explore through conversation: - -- What specific problem will this workflow solve? -- Who is the primary user of this workflow? -- What is the main outcome or deliverable? - -### 2. Workflow Type Classification - -Help determine the workflow type: - -- **Document Workflow**: Generates documents (PRDs, specs, plans) -- **Action Workflow**: Performs actions (refactoring, tools orchestration) -- **Interactive Workflow**: Guided sessions (brainstorming, coaching, training, practice) -- **Autonomous Workflow**: Runs without human input (batch processing, multi-step tasks) -- **Meta-Workflow**: Coordinates other workflows - -### 3. Workflow Flow and Step Structure - -Let's load some examples to help you decide the workflow pattern: - -Load and reference the Meal Prep & Nutrition Plan workflow as an example: - -``` -Read: {project-root}/_bmad/bmb/reference/workflows/meal-prep-nutrition/workflow.md -``` - -This shows a linear workflow structure. Now let's explore your desired pattern: - -- Should this be a linear workflow (step 1 → step 2 → step 3 → finish)? -- Or should it have loops/repeats (e.g., keep generating items until user says done)? -- Are there branching points based on user choices? -- Should some steps be optional? -- How many logical phases does this workflow need? (e.g., Gather → Design → Validate → Generate) - -**Based on our reference examples:** - -- **Linear**: Like Meal Prep Plan (Init → Profile → Assessment → Strategy → Shopping → Prep) - - See: `{project-root}/_bmad/bmb/reference/workflows/meal-prep-nutrition/` -- **Looping**: User Story Generator (Generate → Review → Refine → Generate more... until done) -- **Branching**: Architecture Decision (Analyze → Choose pattern → Implement based on choice) -- **Iterative**: Document Review (Load → Analyze → Suggest changes → Implement → Repeat until approved) - -### 4. User Interaction Style - -Understand the desired interaction level: - -- How much user input is needed during execution? -- Should it be highly collaborative or mostly autonomous? -- Are there specific decision points where user must choose? -- Should the workflow adapt to user responses? - -### 5. Instruction Style (Intent-Based vs Prescriptive) - -Determine how the AI should execute in this workflow: - -**Intent-Based (Recommended for most workflows)**: - -- Steps describe goals and principles, letting the AI adapt conversation naturally -- More flexible, conversational, responsive to user context -- Example: "Guide user to define their requirements through open-ended discussion" - -**Prescriptive**: - -- Steps provide exact instructions and specific text to use -- More controlled, predictable, consistent across runs -- Example: "Ask: 'What is your primary goal? Choose from: A) Growth B) Efficiency C) Quality'" - -Which style does this workflow need, or should it be a mix of both? - -### 6. Input Requirements - -Identify what the workflow needs: - -- What documents or data does the workflow need to start? -- Are there prerequisites or dependencies? -- Will users need to provide specific information? -- Are there optional inputs that enhance the workflow? - -### 7. Output Specifications - -Define what the workflow produces: - -- What is the primary output (document, action, decision)? -- Are there intermediate outputs or checkpoints? -- Should outputs be saved automatically? -- What format should outputs be in? - -### 8. Success Criteria - -Define what makes the workflow successful: - -- How will you know the workflow achieved its goal? -- What are the quality criteria for outputs? -- Are there measurable outcomes? -- What would make a user satisfied with the result? - -#### STORE REQUIREMENTS: - -After collecting all requirements, append them to {workflowPlanFile} in a format that will be be used later to design in more detail and create the workflow structure. - -### 9. Present MENU OPTIONS - -Display: **Select an Option:** [A] Advanced Elicitation [P] Party Mode [C] Continue - -#### EXECUTION RULES: - -- ALWAYS halt and wait for user input after presenting menu -- ONLY proceed to next step when user selects 'C' -- After other menu items execution, return to this menu -- User can chat or ask questions - always respond and then end with display again of the menu options -- Use menu handling logic section below - -#### Menu Handling Logic: - -- IF A: Execute {advancedElicitationTask} -- IF P: Execute {partyModeWorkflow} -- IF C: Append requirements to {workflowPlanFile}, update frontmatter, then load, read entire file, then execute {nextStepFile} -- IF Any other comments or queries: help user respond then [Redisplay Menu Options](#8-present-menu-options) - -## CRITICAL STEP COMPLETION NOTE - -ONLY WHEN C is selected and requirements are stored in the output file, will you then load, read entire file, then execute {nextStepFile} to execute and begin workflow structure design step. - ---- - -## 🚨 SYSTEM SUCCESS/FAILURE METRICS - -### ✅ SUCCESS: - -- Requirements collected through conversation (not interrogation) -- All workflow aspects documented -- Requirements stored using template -- Menu presented and user input handled correctly - -### ❌ SYSTEM FAILURE: - -- Generating workflow designs without requirements -- Skipping requirement areas -- Proceeding to next step without 'C' selection -- Not storing requirements properly - -**Master Rule:** Skipping steps, optimizing sequences, or not following exact instructions is FORBIDDEN and constitutes SYSTEM FAILURE. diff --git a/src/modules/bmb/workflows/create-workflow/steps/step-03-tools-configuration.md b/src/modules/bmb/workflows/create-workflow/steps/step-03-tools-configuration.md deleted file mode 100644 index ac47899c..00000000 --- a/src/modules/bmb/workflows/create-workflow/steps/step-03-tools-configuration.md +++ /dev/null @@ -1,250 +0,0 @@ ---- -name: 'step-03-tools-configuration' -description: 'Configure all required tools (core, memory, external) and installation requirements in one comprehensive step' - -# Path Definitions -workflow_path: '{project-root}/_bmad/bmb/workflows/create-workflow' - -# File References -thisStepFile: '{workflow_path}/steps/step-03-tools-configuration.md' -nextStepFile: '{workflow_path}/steps/step-04-plan-review.md' - -targetWorkflowPath: '{bmb_creations_output_folder}/workflows/{new_workflow_name}' -workflowPlanFile: '{targetWorkflowPath}/workflow-plan-{new_workflow_name}.md' - -# Documentation References -commonToolsCsv: '{project-root}/_bmad/bmb/docs/workflows/common-workflow-tools.csv' - -# Task References -advancedElicitationTask: '{project-root}/_bmad/core/tasks/advanced-elicitation.xml' -partyModeWorkflow: '{project-root}/_bmad/core/workflows/party-mode/workflow.md' -# Template References -# No template needed - will append tools configuration directly to workflow plan ---- - -# Step 3: Tools Configuration - -## STEP GOAL: - -To comprehensively configure all tools needed for the workflow (core tools, memory, external tools) and determine installation requirements. - -## MANDATORY EXECUTION RULES (READ FIRST): - -### Universal Rules: - -- 🛑 NEVER generate content without user input -- 📖 CRITICAL: Read the complete step file before taking any action -- 🔄 CRITICAL: When loading next step with 'C', ensure entire file is read -- 📋 YOU ARE A FACILITATOR, not a content generator - -### Role Reinforcement: - -- ✅ You are a workflow architect and integration specialist -- ✅ If you already have been given communication or persona patterns, continue to use those while playing this new role -- ✅ We engage in collaborative dialogue, not command-response -- ✅ You bring expertise in BMAD tools and integration patterns -- ✅ User brings their workflow requirements and preferences - -### Step-Specific Rules: - -- 🎯 Focus ONLY on configuring tools based on workflow requirements -- 🚫 FORBIDDEN to skip tool categories - each affects workflow design -- 💬 Present options clearly, let user make informed choices -- 🚫 DO NOT hardcode tool descriptions - reference CSV - -## EXECUTION PROTOCOLS: - -- 🎯 Load tools dynamically from CSV, not hardcoded -- 💾 Document all tool choices in workflow plan -- 📖 Update frontmatter `stepsCompleted: [1, 2, 3]` before loading next step -- 🚫 FORBIDDEN to load next step until user selects 'C' - -## CONTEXT BOUNDARIES: - -- Requirements from step 2 inform tool selection -- All tool choices affect workflow design -- This is the ONLY tools configuration step -- Installation requirements affect implementation decisions - -## TOOLS CONFIGURATION PROCESS: - -### 1. Initialize Tools Configuration - -"Configuring **Tools and Integrations** - -Based on your workflow requirements, let's configure all the tools your workflow will need. This includes core BMAD tools, memory systems, and any external integrations." - -### 2. Load and Present Available Tools - -Load `{commonToolsCsv}` and present tools by category: - -"**Available BMAD Tools and Integrations:** - -**Core Tools (Always Available):** - -- [List tools from CSV where propose='always', with descriptions] - -**Optional Tools (Available When Needed):** - -- [List tools from CSV where propose='example', with descriptions] - -_Note: I'm loading these dynamically from our tools database to ensure you have the most current options._" - -### 3. Configure Core BMAD Tools - -"**Core BMAD Tools Configuration:** - -These tools significantly enhance workflow quality and user experience:" - -For each core tool from CSV (`propose='always'`): - -1. **Party-Mode** - - Use case: [description from CSV] - - Where to integrate: [ask user for decision points, creative phases] - -2. **Advanced Elicitation** - - Use case: [description from CSV] - - Where to integrate: [ask user for quality gates, review points] - -3. **Brainstorming** - - Use case: [description from CSV] - - Where to integrate: [ask user for idea generation, innovation points] - -### 4. Configure LLM Features - -"**LLM Feature Integration:** - -These capabilities enhance what your workflow can do:" - -From CSV (`propose='always'` LLM features): - -4. **Web-Browsing** - - Capability: [description from CSV] - - When needed: [ask user about real-time data needs] - -5. **File I/O** - - Capability: [description from CSV] - - Operations: [ask user about file operations needed] - -6. **Sub-Agents** - - Capability: [description from CSV] - - Use cases: [ask user about delegation needs] - -7. **Sub-Processes** - - Capability: [description from CSV] - - Use cases: [ask user about parallel processing needs] - -### 5. Configure Memory Systems - -"**Memory and State Management:** - -Determine if your workflow needs to maintain state between sessions:" - -From CSV memory tools: - -8. **Sidecar File** - - Use case: [description from CSV] - - Needed when: [ask about session continuity, agent initialization] - -### 6. Configure External Tools (Optional) - -"**External Integrations (Optional):** - -These tools connect your workflow to external systems:" - -From CSV (`propose='example'`): - -- MCP integrations, database connections, APIs, etc. -- For each relevant tool: present description and ask if needed -- Note any installation requirements - -### 7. Installation Requirements Assessment - -"**Installation and Dependencies:** - -Some tools require additional setup:" - -Based on selected tools: - -- Identify tools requiring installation -- Assess user's comfort level with installations -- Document installation requirements - -### 8. Document Complete Tools Configuration - -Append to {workflowPlanFile}: - -```markdown -## Tools Configuration - -### Core BMAD Tools - -- **Party-Mode**: [included/excluded] - Integration points: [specific phases] -- **Advanced Elicitation**: [included/excluded] - Integration points: [specific phases] -- **Brainstorming**: [included/excluded] - Integration points: [specific phases] - -### LLM Features - -- **Web-Browsing**: [included/excluded] - Use cases: [specific needs] -- **File I/O**: [included/excluded] - Operations: [file management needs] -- **Sub-Agents**: [included/excluded] - Use cases: [delegation needs] -- **Sub-Processes**: [included/excluded] - Use cases: [parallel processing needs] - -### Memory Systems - -- **Sidecar File**: [included/excluded] - Purpose: [state management needs] - -### External Integrations - -- [List selected external tools with purposes] - -### Installation Requirements - -- [List tools requiring installation] -- **User Installation Preference**: [willing/not willing] -- **Alternative Options**: [if not installing certain tools] -``` - -### 9. Present MENU OPTIONS - -Display: **Select an Option:** [A] Advanced Elicitation [P] Party Mode [C] Continue - -#### EXECUTION RULES: - -- ALWAYS halt and wait for user input after presenting menu -- ONLY proceed to next step when user selects 'C' -- After other menu items execution, return to this menu -- User can chat or ask questions - always respond and then end with display again of the menu options -- Use menu handling logic section below - -#### Menu Handling Logic: - -- IF A: Execute {advancedElicitationTask} -- IF P: Execute {partyModeWorkflow} -- IF C: Save tools configuration to {workflowPlanFile}, update frontmatter, then load, read entire file, then execute {nextStepFile} -- IF Any other comments or queries: help user respond then [Redisplay Menu Options](#9-present-menu-options) - -## CRITICAL STEP COMPLETION NOTE - -ONLY WHEN C is selected and tools configuration is saved will you load {nextStepFile} to review the complete plan. - ---- - -## 🚨 SYSTEM SUCCESS/FAILURE METRICS - -### ✅ SUCCESS: - -- All tool categories configured based on requirements -- User made informed choices for each tool -- Complete configuration documented in plan -- Installation requirements identified -- Ready to proceed to plan review - -### ❌ SYSTEM FAILURE: - -- Skipping tool categories -- Hardcoding tool descriptions instead of using CSV -- Not documenting user choices -- Proceeding without user confirmation - -**Master Rule:** Skipping steps, optimizing sequences, or not following exact instructions is FORBIDDEN and constitutes SYSTEM FAILURE. diff --git a/src/modules/bmb/workflows/create-workflow/steps/step-04-plan-review.md b/src/modules/bmb/workflows/create-workflow/steps/step-04-plan-review.md deleted file mode 100644 index 2d0d01ff..00000000 --- a/src/modules/bmb/workflows/create-workflow/steps/step-04-plan-review.md +++ /dev/null @@ -1,216 +0,0 @@ ---- -name: 'step-04-plan-review' -description: 'Review complete workflow plan (requirements + tools) and get user approval before design' - -# Path Definitions -workflow_path: '{project-root}/_bmad/bmb/workflows/create-workflow' - -# File References -thisStepFile: '{workflow_path}/steps/step-04-plan-review.md' -nextStepFormDesign: '{workflow_path}/steps/step-05-output-format-design.md' -nextStepDesign: '{workflow_path}/steps/step-06-design.md' - -targetWorkflowPath: '{bmb_creations_output_folder}/workflows/{new_workflow_name}' -workflowPlanFile: '{targetWorkflowPath}/workflow-plan-{new_workflow_name}.md' - -# Task References -advancedElicitationTask: '{project-root}/_bmad/core/tasks/advanced-elicitation.xml' -partyModeWorkflow: '{project-root}/_bmad/core/workflows/party-mode/workflow.md' -# Template References -# No template needed - will append review summary directly to workflow plan ---- - -# Step 4: Plan Review and Approval - -## STEP GOAL: - -To present the complete workflow plan (requirements and tools configuration) for user review and approval before proceeding to design. - -## MANDATORY EXECUTION RULES (READ FIRST): - -### Universal Rules: - -- 🛑 NEVER generate content without user input -- 📖 CRITICAL: Read the complete step file before taking any action -- 🔄 CRITICAL: When loading next step with 'C', ensure entire file is read -- 📋 YOU ARE A FACILITATOR, not a content generator - -### Role Reinforcement: - -- ✅ You are a workflow architect and systems designer -- ✅ If you already have been given communication or persona patterns, continue to use those while playing this new role -- ✅ We engage in collaborative dialogue, not command-response -- ✅ You bring expertise in workflow design review and quality assurance -- ✅ User brings their specific requirements and approval authority - -### Step-Specific Rules: - -- 🎯 Focus ONLY on reviewing and refining the plan -- 🚫 FORBIDDEN to start designing workflow steps in this step -- 💬 Present plan clearly and solicit feedback -- 🚫 DO NOT proceed to design without user approval - -## EXECUTION PROTOCOLS: - -- 🎯 Present complete plan summary from {workflowPlanFile} -- 💾 Capture any modifications or refinements -- 📖 Update frontmatter `stepsCompleted: [1, 2, 3, 4]` before loading next step -- 🚫 FORBIDDEN to load next step until user approves plan - -## CONTEXT BOUNDARIES: - -- All requirements from step 2 are available -- Tools configuration from step 3 is complete -- Focus ONLY on review and approval -- This is the final check before design phase - -## PLAN REVIEW PROCESS: - -### 1. Initialize Plan Review - -"**Workflow Plan Review** - -We've gathered all requirements and configured tools for your workflow. Let's review the complete plan to ensure it meets your needs before we start designing the workflow structure." - -### 2. Present Complete Plan Summary - -Load and present from {workflowPlanFile}: - -"**Complete Workflow Plan: {new_workflow_name}** - -**1. Project Overview:** - -- [Present workflow purpose, user type, module from plan] - -**2. Workflow Requirements:** - -- [Present all gathered requirements] - -**3. Tools Configuration:** - -- [Present selected tools and integration points] - -**4. Technical Specifications:** - -- [Present technical constraints and requirements] - -**5. Success Criteria:** - -- [Present success metrics from requirements]" - -### 3. Detailed Review by Category - -"**Detailed Review:** - -**A. Workflow Scope and Purpose** - -- Is the workflow goal clearly defined? -- Are the boundaries appropriate? -- Any missing requirements? - -**B. User Interaction Design** - -- Does the interaction style match your needs? -- Are collaboration points clear? -- Any adjustments needed? - -**C. Tools Integration** - -- Are selected tools appropriate for your workflow? -- Are integration points logical? -- Any additional tools needed? - -**D. Technical Feasibility** - -- Are all requirements achievable? -- Any technical constraints missing? -- Installation requirements acceptable?" - -### 4. Collect Feedback and Refinements - -"**Review Feedback:** - -Please review each section and provide feedback: - -1. What looks good and should stay as-is? -2. What needs modification or refinement? -3. What's missing that should be added? -4. Anything unclear or confusing?" - -For each feedback item: - -- Document the requested change -- Discuss implications on workflow design -- Confirm the refinement with user - -### 5. Update Plan with Refinements - -Update {workflowPlanFile} with any approved changes: - -- Modify requirements section as needed -- Update tools configuration if changed -- Add any missing specifications -- Ensure all changes are clearly documented - -### 6. Output Document Check - -"**Output Document Check:** - -Before we proceed to design, does your workflow produce any output documents or files? - -Based on your requirements: - -- [Analyze if workflow produces documents/files] -- Consider: Does it create reports, forms, stories, or any persistent output?" - -**If NO:** -"Great! Your workflow focuses on actions/interactions without document output. We'll proceed directly to designing the workflow steps." - -**If YES:** -"Perfect! Let's design your output format to ensure your workflow produces exactly what you need." - -### 7. Present MENU OPTIONS - -Display: **Select an Option:** [A] Advanced Elicitation [P] Party Mode [C] Continue to Design - -#### EXECUTION RULES: - -- ALWAYS halt and wait for user input after presenting menu -- ONLY proceed to next step when user selects 'C' -- After other menu items execution, return to this menu -- User can chat or ask questions - always respond and then end with display again of the menu options -- Use menu handling logic section below - -#### Menu Handling Logic: - -- IF A: Execute {advancedElicitationTask} -- IF P: Execute {partyModeWorkflow} -- IF C: Check if workflow produces documents: - - If YES: Update frontmatter, then load nextStepFormDesign - - If NO: Update frontmatter, then load nextStepDesign -- IF Any other comments or queries: help user respond then [Redisplay Menu Options](#7-present-menu-options) - -## CRITICAL STEP COMPLETION NOTE - -ONLY WHEN C is selected AND the user has explicitly approved the plan and the plan document is updated as needed, then you load either {nextStepFormDesign} or {nextStepDesign} - ---- - -## 🚨 SYSTEM SUCCESS/FAILURE METRICS - -### ✅ SUCCESS: - -- Complete plan presented clearly from {workflowPlanFile} -- User feedback collected and documented -- All refinements incorporated -- User explicitly approves the plan -- Plan ready for design phase - -### ❌ SYSTEM FAILURE: - -- Not loading plan from {workflowPlanFile} -- Skipping review categories -- Proceeding without user approval -- Not documenting refinements - -**Master Rule:** Skipping steps, optimizing sequences, or not following exact instructions is FORBIDDEN and constitutes SYSTEM FAILURE. diff --git a/src/modules/bmb/workflows/create-workflow/steps/step-05-output-format-design.md b/src/modules/bmb/workflows/create-workflow/steps/step-05-output-format-design.md deleted file mode 100644 index c6f9ff34..00000000 --- a/src/modules/bmb/workflows/create-workflow/steps/step-05-output-format-design.md +++ /dev/null @@ -1,289 +0,0 @@ ---- -name: 'step-05-output-format-design' -description: 'Design the output format for workflows that produce documents or files' - -# Path Definitions -workflow_path: '{project-root}/_bmad/bmb/workflows/create-workflow' - -# File References -thisStepFile: '{workflow_path}/steps/step-05-output-format-design.md' -nextStepFile: '{workflow_path}/steps/step-06-design.md' - -targetWorkflowPath: '{bmb_creations_output_folder}/workflows/{new_workflow_name}' -workflowPlanFile: '{targetWorkflowPath}/workflow-plan-{new_workflow_name}.md' - -# Task References -advancedElicitationTask: '{project-root}/_bmad/core/tasks/advanced-elicitation.xml' -partyModeWorkflow: '{project-root}/_bmad/core/workflows/party-mode/workflow.md' ---- - -# Step 5: Output Format Design - -## STEP GOAL: - -To design and document the output format for workflows that produce documents or files, determining whether they need strict templates or flexible formatting. - -## MANDATORY EXECUTION RULES (READ FIRST): - -### Universal Rules: - -- 🛑 NEVER generate content without user input -- 📖 CRITICAL: Read the complete step file before taking any action -- 🔄 CRITICAL: When loading next step with 'C', ensure entire file is read -- 📋 YOU ARE A FACILITATOR, not a content generator - -### Role Reinforcement: - -- ✅ You are a workflow architect and output format specialist -- ✅ If you already have been given communication or persona patterns, continue to use those while playing this new role -- ✅ We engage in collaborative dialogue, not command-response -- ✅ You bring expertise in document design and template creation -- ✅ User brings their specific output requirements and preferences - -### Step-Specific Rules: - -- 🎯 Focus ONLY on output format design -- 🚫 FORBIDDEN to design workflow steps in this step -- 💬 Help user understand the format spectrum -- 🚫 DO NOT proceed without clear format requirements - -## EXECUTION PROTOCOLS: - -- 🎯 Guide user through format spectrum with examples -- 💾 Document format decisions in workflow plan -- 📖 Update frontmatter `stepsCompleted: [1, 2, 3, 4, 5]` before loading next step -- 🚫 FORBIDDEN to load next step until user selects 'C' - -## CONTEXT BOUNDARIES: - -- Approved plan from step 4 is available -- Focus ONLY on output document formatting -- Skip this step if workflow produces no documents -- This step only runs when documents need structure - -## OUTPUT FORMAT DESIGN PROCESS: - -### 1. Initialize Output Format Discussion - -"**Designing Your Output Format** - -Based on your approved plan, your workflow will produce output documents. Let's design how these outputs should be formatted." - -### 2. Present the Format Spectrum - -"**Output Format Spectrum - Where does your workflow fit?** - -**Strictly Structured Examples:** - -- Government forms - exact fields, precise positions -- Legal documents - must follow specific templates -- Technical specifications - required sections, specific formats -- Compliance reports - mandatory fields, validation rules - -**Structured Examples:** - -- Project reports - required sections, flexible content -- Business proposals - consistent format, customizable sections -- Technical documentation - standard structure, adaptable content -- Research papers - IMRAD format, discipline-specific variations - -**Semi-structured Examples:** - -- Character sheets (D&D) - core stats + flexible background -- Lesson plans - required components, flexible delivery -- Recipes - ingredients/method format, flexible descriptions -- Meeting minutes - agenda/attendees/actions, flexible details - -**Free-form Examples:** - -- Creative stories - narrative flow, minimal structure -- Blog posts - title/body, organic organization -- Personal journals - date/entry, free expression -- Brainstorming outputs - ideas, flexible organization" - -### 3. Determine Format Type - -"**Which format type best fits your workflow?** - -1. **Strict Template** - Must follow exact format with specific fields -2. **Structured** - Required sections but flexible within each -3. **Semi-structured** - Core sections plus optional additions -4. **Free-form** - Content-driven with minimal structure - -Please choose 1-4:" - -### 4. Deep Dive Based on Choice - -#### IF Strict Template (Choice 1): - -"**Strict Template Design** - -You need exact formatting. Let's define your requirements: - -**Template Source Options:** -A. Upload existing template/image to follow -B. Create new template from scratch -C. Use standard form (e.g., government, industry) -D. AI proposes template based on your needs - -**Template Requirements:** - -- Exact field names and positions -- Required vs optional fields -- Validation rules -- File format (PDF, DOCX, etc.) -- Any legal/compliance considerations" - -#### IF Structured (Choice 2): - -"**Structured Document Design** - -You need consistent sections with flexibility: - -**Section Definition:** - -- What sections are required? -- Any optional sections? -- Section ordering rules? -- Cross-document consistency needs? - -**Format Guidelines:** - -- Any formatting standards (APA, MLA, corporate)? -- Section header styles? -- Content organization principles?" - -#### IF Semi-structured (Choice 3): - -"**Semi-structured Design** - -Core sections with flexibility: - -**Core Components:** - -- What information must always appear? -- Which parts can vary? -- Any organizational preferences? - -**Polishing Options:** - -- Would you like automatic TOC generation? -- Summary section at the end? -- Consistent formatting options?" - -#### IF Free-form (Choice 4): - -"**Free-form Content Design** - -Focus on content with minimal structure: - -**Organization Needs:** - -- Basic headers for readability? -- Date/title information? -- Any categorization needs? - -**Final Polish Options:** - -- Auto-generated summary? -- TOC based on content? -- Formatting for readability?" - -### 5. Template Creation (if applicable) - -For Strict/Structured workflows: - -"**Template Creation Approach:** - -A. **Design Together** - We'll create the template step by step -B. **AI Proposes** - I'll suggest a structure based on your needs -C. **Import Existing** - Use/upload your existing template - -Which approach would you prefer?" - -If A or B: - -- Design/create template sections -- Define placeholders -- Specify field types and validation -- Document template structure in plan - -If C: - -- Request file upload or detailed description -- Analyze template structure -- Document requirements - -### 6. Document Format Decisions - -Append to {workflowPlanFile}: - -```markdown -## Output Format Design - -**Format Type**: [Strict/Structured/Semi-structured/Free-form] - -**Output Requirements**: - -- Document type: [report/form/story/etc] -- File format: [PDF/MD/DOCX/etc] -- Frequency: [single/batch/continuous] - -**Structure Specifications**: -[Detailed structure based on format type] - -**Template Information**: - -- Template source: [created/imported/standard] -- Template file: [path if applicable] -- Placeholders: [list if applicable] - -**Special Considerations**: - -- Legal/compliance requirements -- Validation needs -- Accessibility requirements -``` - -### 7. Present MENU OPTIONS - -Display: **Select an Option:** [A] Advanced Elicitation [P] Party Mode [C] Continue - -#### EXECUTION RULES: - -- ALWAYS halt and wait for user input after presenting menu -- ONLY proceed to next step when user selects 'C' -- After other menu items execution, return to this menu -- User can chat or ask questions - always respond and then end with display again of the menu options -- Use menu handling logic section below - -#### Menu Handling Logic: - -- IF A: Execute {advancedElicitationTask} -- IF P: Execute {partyModeWorkflow} -- IF C: Save output format design to {workflowPlanFile}, update frontmatter, then load, read entire file, then execute {nextStepFile} -- IF Any other comments or queries: help user respond then [Redisplay Menu Options](#7-present-menu-options) - -## CRITICAL STEP COMPLETION NOTE - -ONLY WHEN C is selected and output format is documented will you load {nextStepFile} to begin workflow step design. - ---- - -## 🚨 SYSTEM SUCCESS/FAILURE METRICS - -### ✅ SUCCESS: - -- User understands format spectrum -- Format type clearly identified -- Template requirements documented (if applicable) -- Output format saved in plan - -### ❌ SYSTEM FAILURE: - -- Not showing format examples -- Skipping format requirements -- Not documenting decisions in plan -- Assuming format without asking - -**Master Rule:** Skipping steps, optimizing sequences, or not following exact instructions is FORBIDDEN and constitutes SYSTEM FAILURE. diff --git a/src/modules/bmb/workflows/create-workflow/steps/step-07-build.md b/src/modules/bmb/workflows/create-workflow/steps/step-07-build.md deleted file mode 100644 index 9dab2ab7..00000000 --- a/src/modules/bmb/workflows/create-workflow/steps/step-07-build.md +++ /dev/null @@ -1,308 +0,0 @@ ---- -name: 'step-07-build' -description: 'Generate all workflow files based on the approved plan' - -# Path Definitions -workflow_path: '{project-root}/_bmad/bmb/workflows/create-workflow' - -# File References -thisStepFile: '{workflow_path}/steps/step-07-build.md' -nextStepFile: '{workflow_path}/steps/step-08-review.md' -workflowFile: '{workflow_path}/workflow.md' -# Output files for workflow creation process -targetWorkflowPath: '{bmb_creations_output_folder}/workflows/{new_workflow_name}' -workflowPlanFile: '{targetWorkflowPath}/workflow-plan-{new_workflow_name}.md' - -# Template References -workflowTemplate: '{project-root}/_bmad/bmb/docs/workflows/templates/workflow-template.md' -stepTemplate: '{project-root}/_bmad/bmb/docs/workflows/templates/step-template.md' -stepInitContinuableTemplate: '{project-root}/_bmad/bmb/docs/workflows/templates/step-01-init-continuable-template.md' -step1bTemplate: '{project-root}/_bmad/bmb/docs/workflows/templates/step-1b-template.md' -# No content templates needed - will create content as needed during build -# No build summary template needed - will append summary directly to workflow plan ---- - -# Step 7: Workflow File Generation - -## STEP GOAL: - -To generate all the workflow files (workflow.md, step files, templates, and supporting files) based on the approved plan from the previous design step. - -## MANDATORY EXECUTION RULES (READ FIRST): - -### Universal Rules: - -- 🛑 NEVER generate content without user input -- 📖 CRITICAL: Read the complete step file before taking any action -- 🔄 CRITICAL: When loading next step with 'C', ensure entire file is read -- 📋 YOU ARE A FACILITATOR, not a content generator - -### Role Reinforcement: - -- ✅ You are a workflow architect and systems designer -- ✅ If you already have been given communication or persona patterns, continue to use those while playing this new role -- ✅ We engage in collaborative dialogue, not command-response -- ✅ You bring implementation expertise and best practices -- ✅ User brings their specific requirements and design approvals - -### Step-Specific Rules: - -- 🎯 Focus ONLY on generating files based on approved design -- 🚫 FORBIDDEN to modify the design without user consent -- 💬 Generate files collaboratively, getting approval at each stage -- 🚪 CREATE files in the correct target location - -## EXECUTION PROTOCOLS: - -- 🎯 Generate files systematically from design -- 💾 Document all generated files and their locations -- 📖 Update frontmatter `stepsCompleted: [1, 2, 3, 4, 5, 6, 7]` before loading next step -- 🚫 FORBIDDEN to load next step until user selects 'C' and build is complete - -## CONTEXT BOUNDARIES: - -- Approved plan from step 6 guides implementation -- Generate files in target workflow location -- Load templates and documentation as needed during build -- Follow step-file architecture principles - -## BUILD REFERENCE MATERIALS: - -- When building each step file, you must follow template `{project-root}/_bmad/bmb/docs/workflows/templates/step-template.md` -- When building continuable step-01-init.md files, use template `{project-root}/_bmad/bmb/docs/workflows/templates/step-01-init-continuable-template.md` -- When building continuation steps, use template `{project-root}/_bmad/bmb/docs/workflows/templates/step-1b-template.md` -- When building the main workflow.md file, you must follow template `{project-root}/_bmad/bmb/docs/workflows/templates/workflow-template.md` -- Example step files from {project-root}/_bmad/bmb/reference/workflows/meal-prep-nutrition/workflow.md for patterns - -## FILE GENERATION SEQUENCE: - -### 1. Confirm Build Readiness - -Based on the approved plan, confirm: -"I have your approved plan and I'm ready to generate the workflow files. The plan specifies creating: - -- Main workflow.md file -- [Number] step files -- [Number] templates -- Supporting files - -All in: {targetWorkflowPath} - -Ready to proceed?" - -### 2. Create Directory Structure - -Create the workflow folder structure in the target location: - -``` -{bmb_creations_output_folder}/workflows/{workflow_name}/ -├── workflow.md -├── steps/ -│ ├── step-01-init.md -│ ├── step-01b-continue.md (if continuation support needed) -│ ├── step-02-[name].md -│ └── ... -├── templates/ -│ └── [as needed] -└── data/ - └── [as needed] -``` - -For bmb module, this will be: `_bmad/custom/src/workflows/{workflow_name}/` -For other modules, check their module.yaml for custom_workflow_location - -### 3. Generate workflow.md - -Load and follow {workflowTemplate}: - -- Create workflow.md using template structure -- Insert workflow name and description -- Configure all path variables ({project-root}, _bmad, {workflow_path}) -- Set web_bundle flag to true unless user has indicated otherwise -- Define role and goal -- Include initialization path to step-01 - -### 4. Generate Step Files - -#### 4a. Check for Continuation Support - -**Check the workflow plan for continuation support:** - -- Look for "continuation support: true" or similar flag -- Check if step-01b-continue.md was included in the design -- If workflow generates output documents, continuation is typically needed - -#### 4b. Generate step-01-init.md (with continuation logic) - -If continuation support is needed: - -- Load and follow {stepInitContinuableTemplate} -- This template automatically includes all required continuation detection logic -- Customize with workflow-specific information: - - Update workflow_path references - - Set correct outputFile and templateFile paths - - Adjust role and persona to match workflow type - - Customize welcome message for workflow context - - Configure input document discovery patterns (if any) -- Template automatically handles: - - continueFile reference in frontmatter - - Logic to check for existing output files with stepsCompleted - - Routing to step-01b-continue.md for continuation - - Fresh workflow initialization - -#### 4c. Generate step-01b-continue.md (if needed) - -**If continuation support is required:** - -- Load and follow {step1bTemplate} -- Customize with workflow-specific information: - - Update workflow_path references - - Set correct outputFile path - - Adjust role and persona to match workflow type - - Customize welcome back message for workflow context -- Ensure proper nextStep detection logic based on step numbers - -#### 4d. Generate Remaining Step Files - -For each remaining step in the design: - -- Load and follow {stepTemplate} -- Create step file using template structure -- Customize with step-specific content -- Ensure proper frontmatter with path references -- Include appropriate menu handling and universal rules -- Follow all mandatory rules and protocols from template -- **Critical**: Ensure each step updates `stepsCompleted` array when completing - -### 5. Generate Templates (If Needed) - -For document workflows: - -- Create template.md with proper structure -- Include all variables from design -- Ensure variable naming consistency - -### 6. Generate Supporting Files - -Based on design requirements: - -- Create data files (csv) -- Generate README.md with usage instructions -- Create any configuration files -- Add validation checklists if designed - -### 7. Verify File Generation - -After creating all files: - -- Check all file paths are correct -- Validate frontmatter syntax -- Ensure variable consistency across files -- Confirm sequential step numbering -- Verify menu handling logic - -### 8. Document Generated Files - -Create a summary of what was generated: - -- List all files created with full paths -- Note any customizations from templates -- Identify any manual steps needed -- Provide next steps for testing - -## QUALITY CHECKS DURING BUILD: - -### Frontmatter Validation - -- All YAML syntax is correct -- Required fields are present -- Path variables use correct format -- No hardcoded paths exist - -### Step File Compliance - -- Each step follows the template structure -- All mandatory rules are included -- Menu handling is properly implemented -- Step numbering is sequential - -### Cross-File Consistency - -- Variable names match across files -- Path references are consistent -- Dependencies are correctly defined -- No orphaned references exist - -## BUILD PRINCIPLES: - -### Follow Design Exactly - -- Implement the design as approved -- Don't add or remove steps without consultation -- Maintain the interaction patterns designed -- Preserve the data flow architecture - -### Maintain Best Practices - -- Keep step files focused and reasonably sized (typically 5-10KB) -- Use collaborative dialogue patterns -- Include proper error handling -- Follow naming conventions - -### Ensure Extensibility - -- Design for future modifications -- Include clear documentation -- Make code readable and maintainable -- Provide examples where helpful - -## CONTENT TO APPEND TO PLAN: - -After generating all files, append to {workflowPlanFile}: - -Create a build summary including: - -- List of all files created with full paths -- Any customizations from templates -- Manual steps needed -- Next steps for testing - -### 9. Present MENU OPTIONS - -Display: **Build Complete - Select an Option:** [C] Continue to Review - -#### EXECUTION RULES: - -- Build complete - all files generated -- Present simple completion status -- User selects [C] to continue to review step - -#### Menu Handling Logic: - -- IF C: Save build summary to {workflowPlanFile}, update frontmatter, then load, read entire file, then execute {nextStepFile} -- IF Any other comments or queries: respond and redisplay menu - -## CRITICAL STEP COMPLETION NOTE - -ONLY WHEN C is selected and content is saved to plan and frontmatter is updated, will you then load, read entire file, then execute {nextStepFile} to execute and begin workflow review step. - ---- - -## 🚨 SYSTEM SUCCESS/FAILURE METRICS - -### ✅ SUCCESS: - -- All workflow files generated in correct locations -- Files follow step-file architecture principles -- Plan implemented exactly as approved -- Build documented in {workflowPlanFile} -- Frontmatter updated with step completion - -### ❌ SYSTEM FAILURE: - -- Generating files without user approval -- Deviating from approved plan -- Creating files with incorrect paths -- Not updating plan frontmatter - -**Master Rule:** Skipping steps, optimizing sequences, or not following exact instructions is FORBIDDEN and constitutes SYSTEM FAILURE. diff --git a/src/modules/bmb/workflows/create-workflow/steps/step-08-review.md b/src/modules/bmb/workflows/create-workflow/steps/step-08-review.md deleted file mode 100644 index f1e6535a..00000000 --- a/src/modules/bmb/workflows/create-workflow/steps/step-08-review.md +++ /dev/null @@ -1,284 +0,0 @@ ---- -name: 'step-08-review' -description: 'Review the generated workflow and provide final validation and next steps' - -# Path Definitions -workflow_path: '{project-root}/_bmad/bmb/workflows/create-workflow' - -# File References -thisStepFile: '{workflow_path}/steps/step-08-review.md' -workflowFile: '{workflow_path}/workflow.md' - -# Output files for workflow creation process -targetWorkflowPath: '{bmb_creations_output_folder}/workflows/{new_workflow_name}' -workflowPlanFile: '{targetWorkflowPath}/workflow-plan-{new_workflow_name}.md' - -# Task References -advancedElicitationTask: '{project-root}/_bmad/core/tasks/advanced-elicitation.xml' -partyModeWorkflow: '{project-root}/_bmad/core/workflows/party-mode/workflow.md' - -# Template References -# No review template needed - will append review summary directly to workflow plan -# No completion template needed - will append completion details directly - -# Next step reference -nextStepFile: '{workflow_path}/steps/step-09-complete.md' ---- - -# Step 8: Workflow Review and Completion - -## STEP GOAL: - -To review the generated workflow for completeness, accuracy, and adherence to best practices, then provide next steps for deployment and usage. - -## MANDATORY EXECUTION RULES (READ FIRST): - -### Universal Rules: - -- 🛑 NEVER generate content without user input -- 📖 CRITICAL: Read the complete step file before taking any action -- 🔄 CRITICAL: Always read the complete step file before taking any action -- 📋 YOU ARE A FACILITATOR, not a content generator - -### Role Reinforcement: - -- ✅ You are a workflow architect and systems designer -- ✅ If you already have been given communication or persona patterns, continue to use those while playing this new role -- ✅ We engage in collaborative dialogue, not command-response -- ✅ You bring quality assurance expertise and validation knowledge -- ✅ User provides final approval and feedback - -### Step-Specific Rules: - -- 🎯 Focus ONLY on reviewing and validating generated workflow -- 🚫 FORBIDDEN to make changes without user approval -- 💬 Guide review process collaboratively -- 🚪 COMPLETE the workflow creation process - -## EXECUTION PROTOCOLS: - -- 🎯 Conduct thorough review of generated workflow -- 💾 Document review findings and completion status -- 📖 Update frontmatter `stepsCompleted: [1, 2, 3, 4, 5, 6, 7, 8]` and mark complete -- 🚫 This is the final step - no next step to load - -## CONTEXT BOUNDARIES: - -- Generated workflow files are available for review -- Focus on validation and quality assurance -- This step completes the workflow creation process -- No file modifications without explicit user approval - -## WORKFLOW REVIEW PROCESS: - -### 1. File Structure Review - -Verify the workflow organization: - -- Are all required files present? -- Is the directory structure correct? -- Are file names following conventions? -- Are paths properly configured? - -### 2. Configuration Validation - -Check workflow.yaml: - -- Is all metadata correctly filled? -- Are path variables properly formatted? -- Is the standalone property set correctly? -- Are all dependencies declared? - -### 3. Step File Compliance - -Review each step file: - -- Does each step follow the template structure? -- Are all mandatory rules included? -- Is menu handling properly implemented? -- Are frontmatter variables correct? -- Are steps properly numbered? - -### 4. Cross-File Consistency - -Verify integration between files: - -- Do variable names match across all files? -- Are path references consistent? -- Is the step sequence logical? -- Are there any broken references? - -### 5. Requirements Verification - -Confirm original requirements are met: - -- Does the workflow address the original problem? -- Are all user types supported? -- Are inputs and outputs as specified? -- Is the interaction style as designed? - -### 6. Best Practices Adherence - -Check quality standards: - -- Are step files focused and reasonably sized (5-10KB typical)? -- Is collaborative dialogue implemented? -- Is error handling included? -- Are naming conventions followed? - -### 7. Test Scenario Planning - -Prepare for testing: - -- What test data would be useful? -- What scenarios should be tested? -- How can the workflow be invoked? -- What would indicate successful execution? - -### 8. Deployment Preparation - -Provide next steps: - -- Installation requirements -- Invocation commands -- Testing procedures -- Documentation needs - -## REVIEW FINDINGS DOCUMENTATION: - -### Issues Found - -Document any issues discovered: - -- **Critical Issues**: Must fix before use -- **Warnings**: Should fix for better experience -- **Suggestions**: Nice to have improvements - -### Validation Results - -Record validation outcomes: - -- Configuration validation: PASSED/FAILED -- Step compliance: PASSED/FAILED -- Cross-file consistency: PASSED/FAILED -- Requirements verification: PASSED/FAILED - -### Recommendations - -Provide specific recommendations: - -- Immediate actions needed -- Future improvements -- Training needs -- Maintenance considerations - -## COMPLETION CHECKLIST: - -### Final Validations - -- [ ] All files generated successfully -- [ ] No syntax errors in YAML -- [ ] All paths are correct -- [ ] Variables are consistent -- [ ] Design requirements met -- [ ] Best practices followed - -### User Acceptance - -- [ ] User has reviewed generated workflow -- [ ] User approves of the implementation -- [ ] User understands next steps -- [ ] User satisfied with the result - -### Documentation - -- [ ] Build summary complete -- [ ] Review findings documented -- [ ] Next steps provided -- [ ] Contact information for support - -## CONTENT TO APPEND TO PLAN: - -After completing review, append to {workflowPlanFile}: - -Append review findings to {workflowPlanFile}: - -Create a review summary including: - -- Completeness check results -- Accuracy validation -- Compliance with best practices -- Any issues found - -Then append completion details: - -- Final approval status -- Deployment recommendations -- Usage guidance - -### 10. Present MENU OPTIONS - -Display: **Select an Option:** [C] Continue to Completion - -#### EXECUTION RULES: - -- ALWAYS halt and wait for user input after presenting menu -- ONLY proceed to next step when user selects 'C' -- User can chat or ask questions - always respond and then end with display again of the menu options -- Use menu handling logic section below - -#### Menu Handling Logic: - -- IF C: Save review to {workflowPlanFile}, update frontmatter, then load, read entire file, then execute {nextStepFile} -- IF Any other comments or queries: help user respond then [Redisplay Menu Options](#10-present-menu-options) - -## COMPLIANCE CHECK INSTRUCTIONS - -When user selects [C], provide these instructions: - -**🎯 Workflow Creation Complete! Your new workflow is ready at:** -`{target_workflow_path}` - -**⚠️ IMPORTANT - Run Compliance Check in New Context:** -To validate your workflow meets BMAD standards: - -1. **Start a new Claude conversation** (fresh context) -2. **Use this command:** `/bmad:bmm:workflows:workflow-compliance-check` -3. **Provide the path:** `{target_workflow_path}/workflow.md` -4. **Follow the validation process** to identify and fix any violations - -**Why New Context?** - -- Compliance checking requires fresh analysis without workflow creation context -- Ensures objective validation against template standards -- Provides detailed violation reporting with specific fix recommendations - -**Your workflow will be checked for:** - -- Template compliance and structure -- Step-by-step validation standards -- File optimization and formatting -- Meta-workflow best practices - -Ready to validate when you are! [Start new context and run compliance check] - ---- - -## 🚨 SYSTEM SUCCESS/FAILURE METRICS - -### ✅ SUCCESS: - -- Generated workflow thoroughly reviewed -- All validations performed -- Issues documented with solutions -- User approves final workflow -- Complete documentation provided - -### ❌ SYSTEM FAILURE: - -- Skipping review steps -- Not documenting findings -- Ending without user approval -- Not providing next steps - -**Master Rule:** Skipping steps, optimizing sequences, or not following exact instructions is FORBIDDEN and constitutes SYSTEM FAILURE. diff --git a/src/modules/bmb/workflows/create-workflow/steps/step-09-complete.md b/src/modules/bmb/workflows/create-workflow/steps/step-09-complete.md deleted file mode 100644 index 91336320..00000000 --- a/src/modules/bmb/workflows/create-workflow/steps/step-09-complete.md +++ /dev/null @@ -1,187 +0,0 @@ ---- -name: 'step-09-complete' -description: 'Final completion and wrap-up of workflow creation process' - -# Path Definitions -workflow_path: '{project-root}/_bmad/bmb/workflows/create-workflow' - -# File References -thisStepFile: '{workflow_path}/steps/step-09-complete.md' -workflowFile: '{workflow_path}/workflow.md' -# Output files for workflow creation process -targetWorkflowPath: '{bmb_creations_output_folder}/workflows/{new_workflow_name}' -workflowPlanFile: '{targetWorkflowPath}/workflow-plan-{new_workflow_name}.md' -completionFile: '{targetWorkflowPath}/completion-summary-{new_workflow_name}.md' ---- - -# Step 9: Workflow Creation Complete - -## STEP GOAL: - -To complete the workflow creation process with a final summary, confirmation, and next steps for using the new workflow. - -## MANDATORY EXECUTION RULES (READ FIRST): - -### Universal Rules: - -- 🛑 NEVER generate content without user input -- 📖 CRITICAL: Read the complete step file before taking any action -- 📋 YOU ARE A FACILITATOR, not a content generator - -### Role Reinforcement: - -- ✅ You are a workflow architect and systems designer -- ✅ If you already have been given communication or persona patterns, continue to use those while playing this new role -- ✅ We engage in collaborative dialogue, not command-response -- ✅ You bring expertise in workflow deployment and usage guidance -- ✅ User brings their specific workflow needs - -### Step-Specific Rules: - -- 🎯 Focus ONLY on completion and next steps -- 🚫 FORBIDDEN to modify the generated workflow -- 💬 Provide clear guidance on how to use the workflow -- 🚫 This is the final step - no next step to load - -## EXECUTION PROTOCOLS: - -- 🎯 Present completion summary -- 💾 Create final completion documentation -- 📖 Update plan frontmatter with completion status -- 🚫 This is the final step - -## CONTEXT BOUNDARIES: - -- All previous steps are complete -- Workflow has been generated and reviewed -- Focus ONLY on completion and next steps -- This step concludes the create-workflow process - -## COMPLETION PROCESS: - -### 1. Initialize Completion - -"**Workflow Creation Complete!** - -Congratulations! We've successfully created your new workflow. Let's finalize everything and ensure you have everything you need to start using it." - -### 2. Final Summary - -Present a complete summary of what was created: - -**Workflow Created:** {new_workflow_name} -**Location:** {targetWorkflowPath} -**Files Generated:** [list from build step] - -### 3. Create Completion Summary - -Create {completionFile} with: - -```markdown ---- -workflowName: { new_workflow_name } -creationDate: [current date] -module: [module from plan] -status: COMPLETE -stepsCompleted: [1, 2, 3, 4, 5, 6, 7, 8, 9] ---- - -# Workflow Creation Summary - -## Workflow Information - -- **Name:** {new_workflow_name} -- **Module:** [module] -- **Created:** [date] -- **Location:** {targetWorkflowPath} - -## Generated Files - -[List all files created] - -## Quick Start Guide - -[How to run the new workflow] - -## Next Steps - -[Post-creation recommendations] -``` - -### 4. Usage Guidance - -Provide clear instructions on how to use the new workflow: - -**How to Use Your New Workflow:** - -1. **Running the Workflow:** - - [Instructions based on workflow type] - - [Initial setup if needed] - -2. **Common Use Cases:** - - [Typical scenarios for using the workflow] - - [Expected inputs and outputs] - -3. **Tips for Success:** - - [Best practices for this specific workflow] - - [Common pitfalls to avoid] - -### 5. Post-Creation Recommendations - -"**Next Steps:** - -1. **Test the Workflow:** Run it with sample data to ensure it works as expected -2. **Customize if Needed:** You can modify the workflow based on your specific needs -3. **Share with Team:** If others will use this workflow, provide them with the location and instructions -4. **Monitor Usage:** Keep track of how well the workflow meets your needs" - -### 6. Final Confirmation - -"**Is there anything else you need help with regarding your new workflow?** - -- I can help you test it -- We can make adjustments if needed -- I can help you create documentation for users -- Or any other support you need" - -### 7. Update Final Status - -Update {workflowPlanFile} frontmatter: - -- Set status to COMPLETE -- Set completion date -- Add stepsCompleted: [1, 2, 3, 4, 5, 6, 7, 8, 9] - -## MENU OPTIONS - -Display: **Workflow Creation Complete!** [T] Test Workflow [M] Make Adjustments [D] Get Help - -### Menu Handling Logic: - -- IF T: Offer to run the newly created workflow with sample data -- IF M: Offer to make specific adjustments to the workflow -- IF D: Provide additional help and resources -- IF Any other: Respond to user needs - -## CRITICAL STEP COMPLETION NOTE - -This is the final step. When the user is satisfied, the workflow creation process is complete. - ---- - -## 🚨 SYSTEM SUCCESS/FAILURE METRICS - -### ✅ SUCCESS: - -- Workflow fully created and reviewed -- Completion summary generated -- User understands how to use the workflow -- All documentation is in place - -### ❌ SYSTEM FAILURE: - -- Not providing clear usage instructions -- Not creating completion summary -- Leaving user without next steps - -**Master Rule:** Ensure the user has everything needed to successfully use their new workflow. diff --git a/src/modules/bmb/workflows/create-workflow/workflow.md b/src/modules/bmb/workflows/create-workflow/workflow.md deleted file mode 100644 index 22dd4484..00000000 --- a/src/modules/bmb/workflows/create-workflow/workflow.md +++ /dev/null @@ -1,58 +0,0 @@ ---- -name: create-workflow -description: Create structured standalone workflows using markdown-based step architecture -web_bundle: true ---- - -# Create Workflow - -**Goal:** Create structured, repeatable standalone workflows through collaborative conversation and step-by-step guidance. - -**Your Role:** In addition to your name, communication_style, and persona, you are also a workflow architect and systems designer collaborating with a workflow creator. This is a partnership, not a client-vendor relationship. You bring expertise in workflow design patterns, step architecture, and collaborative facilitation, while the user brings their domain knowledge and specific workflow requirements. Work together as equals. - ---- - -## WORKFLOW ARCHITECTURE - -This uses **step-file architecture** for disciplined execution: - -### Core Principles - -- **Micro-file Design**: Each step is a self contained instruction file that is a part of an overall workflow that must be followed exactly -- **Just-In-Time Loading**: Only the current step file is in memory - never load future step files until told to do so -- **Sequential Enforcement**: Sequence within the step files must be completed in order, no skipping or optimization allowed -- **State Tracking**: Document progress in output file frontmatter using `stepsCompleted` array when a workflow produces a document -- **Append-Only Building**: Build documents by appending content as directed to the output file - -### Step Processing Rules - -1. **READ COMPLETELY**: Always read the entire step file before taking any action -2. **FOLLOW SEQUENCE**: Execute all numbered sections in order, never deviate -3. **WAIT FOR INPUT**: If a menu is presented, halt and wait for user selection -4. **CHECK CONTINUATION**: If the step has a menu with Continue as an option, only proceed to next step when user selects 'C' (Continue) -5. **SAVE STATE**: Update `stepsCompleted` in frontmatter before loading next step -6. **LOAD NEXT**: When directed, load, read entire file, then execute the next step file - -### Critical Rules (NO EXCEPTIONS) - -- 🛑 **NEVER** load multiple step files simultaneously -- 📖 **ALWAYS** read entire step file before execution -- 🚫 **NEVER** skip steps or optimize the sequence -- 💾 **ALWAYS** update frontmatter of output files when writing the final output for a specific step -- 🎯 **ALWAYS** follow the exact instructions in the step file -- ⏸️ **ALWAYS** halt at menus and wait for user input -- 📋 **NEVER** create mental todo lists from future steps - ---- - -## INITIALIZATION SEQUENCE - -### 1. Configuration Loading - -Load and read full config from {project-root}/_bmad/bmb/config.yaml and resolve: - -- `project_name`, `output_folder`, `user_name`, `communication_language`, `document_output_language`, `bmb_creations_output_folder` - -### 2. First Step EXECUTION - -Load, read the full file and then execute `{workflow_path}/steps/step-01-init.md` to begin the workflow. diff --git a/src/modules/bmb/workflows/edit-agent/steps/step-01-discover-intent.md b/src/modules/bmb/workflows/edit-agent/steps/step-01-discover-intent.md deleted file mode 100644 index 2ecc356f..00000000 --- a/src/modules/bmb/workflows/edit-agent/steps/step-01-discover-intent.md +++ /dev/null @@ -1,134 +0,0 @@ ---- -name: 'step-01-discover-intent' -description: 'Get agent path and user editing goals' - -# Path Definitions -workflow_path: '{project-root}/bmb/workflows/create-agent/edit-agent' - -# File References -thisStepFile: '{workflow_path}/steps/step-01-discover-intent.md' -nextStepFile: '{workflow_path}/steps/step-02-analyze-agent.md' - -# Task References -advancedElicitationTask: '{project-root}/_bmad/core/tasks/advanced-elicitation.xml' -partyModeWorkflow: '{project-root}/_bmad/core/workflows/party-mode/workflow.md' ---- - -# Step 1: Discover Edit Intent - -## STEP GOAL: - -Get the agent path to edit and understand what the user wants to accomplish before proceeding to targeted analysis. - -## MANDATORY EXECUTION RULES (READ FIRST): - -### Universal Rules: - -- 🛑 NEVER generate content without user input -- 📖 CRITICAL: Read the complete step file before taking any action -- 🔄 CRITICAL: When loading next step with 'C', ensure entire file is read -- 📋 YOU ARE A FACILITATOR, not a content generator - -### Role Reinforcement: - -- ✅ You are an agent editor who helps users improve their BMAD agents -- ✅ If you already have a name, communication_style and identity, continue to use those while playing this new role -- ✅ We engage in collaborative dialogue, not command-response -- ✅ You bring agent architecture expertise, user brings their agent and goals, together we improve the agent -- ✅ Maintain collaborative guiding tone throughout - -### Step-Specific Rules: - -- 🎯 Focus only on getting agent path and understanding user goals -- 🚫 FORBIDDEN to load any documentation or analyze the agent yet -- 💬 Approach: Direct questions to understand what needs fixing -- 🚫 FORBIDDEN to make suggestions or propose solutions - -## EXECUTION PROTOCOLS: - -- 🎯 Ask clear questions to get agent path and user goals -- 💾 Store path and goals for next step -- 📖 Do NOT load any references in this step -- 🚫 FORBIDDEN to analyze agent content yet - -## CONTEXT BOUNDARIES: - -- Available context: User wants to edit an existing agent -- Focus: Get path and understand goals ONLY -- Limits: No analysis, no documentation loading, no suggestions -- Dependencies: User must provide agent path - -## Sequence of Instructions (Do not deviate, skip, or optimize) - -### 1. Get Agent Path - -Ask the user: -"What agent do you want to edit? Please provide the path to: - -- A .agent.yaml file (Simple agent) -- A folder containing .agent.yaml (Expert agent with sidecar files)" - -Wait for user response with the path. - -### 2. Understand Editing Goals - -Ask clear questions to understand what they want to accomplish: -"What do you want to change about this agent?" - -Listen for specific goals such as: - -- Fix broken functionality -- Update personality/communication style -- Add or remove commands -- Fix references or paths -- Reorganize sidecar files (Expert agents) -- Update for new standards - -Continue asking clarifying questions until goals are clear. - -### 3. Confirm Understanding - -Summarize back to user: -"So you want to edit the agent at {{agent_path}} to {{user_goals}}. Is that correct?" - -### 4. Present MENU OPTIONS - -Display: "**Select an Option:** [A] Advanced Elicitation [P] Party Mode [C] Continue" - -#### Menu Handling Logic: - -- IF A: Execute {advancedElicitationTask} -- IF P: Execute {partyModeWorkflow} -- IF C: Load, read entire file, then execute {nextStepFile} -- IF Any other comments or queries: help user respond then redisplay menu options - -#### EXECUTION RULES: - -- ALWAYS halt and wait for user input after presenting menu -- ONLY proceed to next step when user selects 'C' -- After other menu items execution, return to this menu -- User can chat or ask questions - always respond and then end with display again of the menu options - -## CRITICAL STEP COMPLETION NOTE - -ONLY WHEN [C continue option] is selected and [agent path and goals obtained], will you then load and read fully `{nextStepFile}` to execute and begin agent analysis. - ---- - -## 🚨 SYSTEM SUCCESS/FAILURE METRICS - -### ✅ SUCCESS: - -- Agent path clearly obtained and validated -- User editing goals understood completely -- User confirms understanding is correct -- Menu presented and user input handled correctly - -### ❌ SYSTEM FAILURE: - -- Proceeding without agent path -- Making suggestions or analyzing agent -- Loading documentation in this step -- Not confirming user goals clearly - -**Master Rule:** Skipping steps, optimizing sequences, or not following exact instructions is FORBIDDEN and constitutes SYSTEM FAILURE. diff --git a/src/modules/bmb/workflows/edit-agent/steps/step-02-analyze-agent.md b/src/modules/bmb/workflows/edit-agent/steps/step-02-analyze-agent.md deleted file mode 100644 index b35c1dbb..00000000 --- a/src/modules/bmb/workflows/edit-agent/steps/step-02-analyze-agent.md +++ /dev/null @@ -1,202 +0,0 @@ ---- -name: 'step-02-analyze-agent' -description: 'Load agent and relevant documentation for analysis' - -# Path Definitions -workflow_path: '{project-root}/bmb/workflows/create-agent/edit-agent' - -# File References -thisStepFile: '{workflow_path}/steps/step-02-analyze-agent.md' -nextStepFile: '{workflow_path}/steps/step-03-propose-changes.md' - -# Task References -advancedElicitationTask: '{project-root}/_bmad/core/tasks/advanced-elicitation.xml' -partyModeWorkflow: '{project-root}/_bmad/core/workflows/party-mode/workflow.md' - -# Documentation References (load JIT based on user goals) -understanding_agent_types: '{project-root}/_bmad/bmb/docs/agents/understanding-agent-types.md' -agent_compilation: '{project-root}/_bmad/bmb/docs/agents/agent-compilation.md' -simple_architecture: '{project-root}/_bmad/bmb/docs/agents/simple-agent-architecture.md' -expert_architecture: '{project-root}/_bmad/bmb/docs/agents/expert-agent-architecture.md' -module_architecture: '{project-root}/_bmad/bmb/docs/agents/module-agent-architecture.md' -menu_patterns: '{project-root}/_bmad/bmb/docs/agents/agent-menu-patterns.md' -communication_presets: '{project-root}/_bmad/bmb/workflows/create-agent/data/communication-presets.csv' -reference_simple_agent: '{project-root}/_bmad/bmb/reference/agents/simple-examples/commit-poet.agent.yaml' -reference_expert_agent: '{project-root}/_bmad/bmb/reference/agents/expert-examples/journal-keeper/journal-keeper.agent.yaml' -validation: '{project-root}/_bmad/bmb/workflows/create-agent/data/agent-validation-checklist.md' ---- - -# Step 2: Analyze Agent - -## STEP GOAL: - -Load the agent and relevant documentation, then analyze with focus on the user's stated goals to identify specific issues that need fixing. - -## MANDATORY EXECUTION RULES (READ FIRST): - -### Universal Rules: - -- 🛑 NEVER generate content without user input -- 📖 CRITICAL: Read the complete step file before taking any action -- 🔄 CRITICAL: When loading next step with 'C', ensure entire file is read -- 📋 YOU ARE A FACILITATOR, not a content generator - -### Role Reinforcement: - -- ✅ You are an agent editor with deep knowledge of BMAD agent architecture -- ✅ If you already have a name, communication_style and identity, continue to use those while playing this new role -- ✅ We engage in collaborative dialogue, not command-response -- ✅ You bring agent architecture expertise, user brings their agent and goals, together we identify specific improvements -- ✅ Maintain analytical yet supportive tone throughout - -### Step-Specific Rules: - -- 🎯 Focus analysis ONLY on user's stated goals from step 1 -- 🚫 FORBIDDEN to load documentation not relevant to user goals -- 💬 Approach: Load documentation JIT when needed for specific analysis -- 🚫 FORBIDDEN to propose solutions yet (analysis only) - -## EXECUTION PROTOCOLS: - -- 🎯 Load agent file from path provided in step 1 -- 💾 Load documentation JIT based on user goals -- 📖 Always "Load and read fully" when accessing documentation -- 🚫 FORBIDDEN to make changes in this step (analysis only) - -## CONTEXT BOUNDARIES: - -- Available context: Agent path and user goals from step 1 -- Focus: Analyze agent in context of user goals -- Limits: Only load documentation relevant to stated goals -- Dependencies: Must have agent path and clear user goals - -## Sequence of Instructions (Do not deviate, skip, or optimize) - -### 1. Load Agent File - -Load the agent file from the path provided in step 1: - -**If path is to a .agent.yaml file (Simple Agent):** - -- Load and read the entire YAML file -- Note: Simple agent, all content in one file - -**If path is to a folder (Expert Agent with sidecar files):** - -- Load and read the .agent.yaml file from inside the folder -- Inventory all sidecar files in the folder: - - Templates (`_.md`, `_.txt`) - - Documentation files - - Knowledge base files (`_.csv`, `_.json`, `*.yaml`) - - Any other resources referenced by the agent -- Note: Expert agent with sidecar structure - -Present what was loaded: - -- "Loaded [agent-name].agent.yaml" -- If Expert: "Plus X sidecar files: [list them]" - -### 2. Load Relevant Documentation Based on User Goals - -**CRITICAL: Load documentation JIT based ONLY on user's stated goals:** - -**If user mentioned persona/communication issues:** - -- Load and read fully: `{agent_compilation}` - understand how LLM interprets persona fields -- Load and read fully: `{communication_presets}` - reference for pure communication styles - -**If user mentioned functional/broken reference issues:** - -- Load and read fully: `{menu_patterns}` - proper menu structure -- Load and read fully: `{agent_compilation}` - compilation requirements - -**If user mentioned sidecar/structure issues (Expert agents):** - -- Load and read fully: `{expert_architecture}` - sidecar best practices - -**If user mentioned agent type confusion:** - -- Load and read fully: `{understanding_agent_types}` -- Load and read fully appropriate architecture guide based on agent type - -### 3. Focused Analysis Based on User Goals - -Analyze only what's relevant to user goals: - -**For persona/communication issues:** - -- Check communication_style field for mixed behaviors/identity/principles -- Look for red flag words that indicate improper mixing: - - "ensures", "makes sure", "always", "never" → Behaviors (belongs in principles) - - "experienced", "expert who", "senior", "seasoned" → Identity descriptors (belongs in role/identity) - - "believes in", "focused on", "committed to" → Philosophy (belongs in principles) -- Compare current communication_style against examples in `{communication_presets}` - -**For functional issues:** - -- Verify all workflow references exist and are valid -- Check menu handler patterns against `{menu_patterns}` -- Validate YAML syntax and structure - -**For sidecar issues:** - -- Map each menu item reference to actual sidecar files -- Identify orphaned files (not referenced in YAML) -- Check if all referenced files actually exist - -### 4. Report Findings - -Present focused analysis findings: -"Based on your goal to {{user_goal}}, I found the following issues:" - -For each issue found: - -- Describe the specific problem -- Show the relevant section of the agent -- Reference the loaded documentation that explains the standard -- Explain why this is an issue - -### 5. Present MENU OPTIONS - -Display: "**Select an Option:** [A] Advanced Elicitation [P] Party Mode [C] Continue" - -#### Menu Handling Logic: - -- IF A: Execute {advancedElicitationTask} -- IF P: Execute {partyModeWorkflow} -- IF C: Load, read entire file, then execute {nextStepFile} -- IF Any other comments or queries: help user respond then redisplay menu options - -#### EXECUTION RULES: - -- ALWAYS halt and wait for user input after presenting menu -- ONLY proceed to next step when user selects 'C' -- After other menu items execution, return to this menu -- User can chat or ask questions - always respond and then end with display again of the menu options - -## CRITICAL STEP COMPLETION NOTE - -ONLY WHEN [C continue option] is selected and [analysis complete with specific issues identified], will you then load and read fully `{nextStepFile}` to execute and begin proposing specific changes. - ---- - -## 🚨 SYSTEM SUCCESS/FAILURE METRICS - -### ✅ SUCCESS: - -- Agent file loaded completely with proper type detection -- Relevant documentation loaded JIT based on user goals -- Analysis focused only on user's stated issues -- Specific problems identified with documentation references -- User understands what needs fixing and why -- Menu presented and user input handled correctly - -### ❌ SYSTEM FAILURE: - -- Loading documentation not relevant to user goals -- Proposing solutions instead of analyzing -- Missing critical issues related to user goals -- Not following "load and read fully" instruction -- Making changes to agent files - -**Master Rule:** Skipping steps, optimizing sequences, or not following exact instructions is FORBIDDEN and constitutes SYSTEM FAILURE. diff --git a/src/modules/bmb/workflows/edit-agent/steps/step-03-propose-changes.md b/src/modules/bmb/workflows/edit-agent/steps/step-03-propose-changes.md deleted file mode 100644 index 815c1891..00000000 --- a/src/modules/bmb/workflows/edit-agent/steps/step-03-propose-changes.md +++ /dev/null @@ -1,157 +0,0 @@ ---- -name: 'step-03-propose-changes' -description: 'Propose specific changes and get approval' - -# Path Definitions -workflow_path: '{project-root}/bmb/workflows/create-agent/edit-agent' - -# File References -thisStepFile: '{workflow_path}/steps/step-03-propose-changes.md' -nextStepFile: '{workflow_path}/steps/step-04-apply-changes.md' -agentFile: '{{agent_path}}' - -# Task References -advancedElicitationTask: '{project-root}/_bmad/core/tasks/advanced-elicitation.xml' -partyModeWorkflow: '{project-root}/_bmad/core/workflows/party-mode/workflow.md' - -# Documentation References (load JIT if needed) -communication_presets: '{project-root}/_bmad/bmb/workflows/create-agent/data/communication-presets.csv' -agent_compilation: '{project-root}/_bmad/bmb/docs/agents/agent-compilation.md' ---- - -# Step 3: Propose Changes - -## STEP GOAL: - -Propose specific, targeted changes based on analysis and get user approval before applying them to the agent. - -## MANDATORY EXECUTION RULES (READ FIRST): - -### Universal Rules: - -- 🛑 NEVER generate content without user input -- 📖 CRITICAL: Read the complete step file before taking any action -- 🔄 CRITICAL: When loading next step with 'C', ensure entire file is read -- 📋 YOU ARE A FACILITATOR, not a content generator - -### Role Reinforcement: - -- ✅ You are an agent editor who helps users improve their BMAD agents through targeted changes -- ✅ If you already have a name, communication_style and identity, continue to use those while playing this new role -- ✅ We engage in collaborative dialogue, not command-response -- ✅ You bring agent architecture expertise, user brings their agent and goals, together we improve the agent -- ✅ Maintain collaborative guiding tone throughout - -### Step-Specific Rules: - -- 🎯 Focus only on proposing changes based on analysis from step 2 -- 🚫 FORBIDDEN to apply changes without explicit user approval -- 💬 Approach: Present one change at a time with clear before/after comparison -- 📋 Load references JIT when explaining rationale or providing examples - -## EXECUTION PROTOCOLS: - -- 🎯 Propose one change at a time with clear before/after comparison -- 💾 Track approved changes for application in next step -- 📖 Load references JIT if needed for examples or best practices -- 🚫 FORBIDDEN to apply changes without explicit user approval - -## CONTEXT BOUNDARIES: - -- Available context: Analysis results from step 2, agent path, and user goals from step 1 -- Focus: Propose specific changes based on analysis, not apply them -- Limits: Only propose changes, do not modify any files yet -- Dependencies: Must have completed step 2 analysis results - -## Sequence of Instructions (Do not deviate, skip, or optimize) - -### 1. Present First Change - -Based on analysis from step 2, propose the most important change first: - -"I recommend fixing {{issue}} because {{reason}}. - -**Current:** - -```yaml -{ { current_code } } -``` - -**Proposed:** - -```yaml -{ { proposed_code } } -``` - -This will help with {{benefit}}." - -### 2. Explain Rationale - -- Why this change matters for the agent's functionality -- How it aligns with BMAD agent best practices -- Reference loaded documentation if helpful for explaining - -### 3. Load References if Needed - -**Load references JIT when explaining:** - -- If proposing persona changes: Load and read `{communication_presets}` for examples -- If proposing structural changes: Load and read `{agent_compilation}` for requirements - -### 4. Get User Approval - -"Does this change look good? Should I apply it?" -Wait for explicit user approval before proceeding. - -### 5. Repeat for Each Issue - -Go through each identified issue from step 2 analysis one by one: - -- Present change with before/after -- Explain rationale with loaded references if needed -- Get explicit user approval for each change -- Track which changes are approved vs rejected - -### 6. Present MENU OPTIONS - -Display: "**Select an Option:** [A] Advanced Elicitation [P] Party Mode [C] Continue" - -#### Menu Handling Logic: - -- IF A: Execute {advancedElicitationTask} -- IF P: Execute {partyModeWorkflow} -- IF C: Save approved changes list to context, then only then load, read entire file, then execute {nextStepFile} -- IF Any other comments or queries: help user respond then [Redisplay Menu Options](#6-present-menu-options) - -#### EXECUTION RULES: - -- ALWAYS halt and wait for user input after presenting menu -- ONLY proceed to next step when user selects 'C' -- After other menu items execution, return to this menu -- User can chat or ask questions - always respond and then end with display again of the menu options - -## CRITICAL STEP COMPLETION NOTE - -ONLY WHEN [C continue option] is selected and [all proposed changes reviewed and user approvals obtained], will you then load and read fully `{nextStepFile}` to execute and begin applying approved changes. - ---- - -## 🚨 SYSTEM SUCCESS/FAILURE METRICS - -### ✅ SUCCESS: - -- All proposed changes clearly presented with before/after comparison -- Rationale explained with references to best practices -- User approval obtained for each proposed change -- Approved changes tracked for application in next step -- Menu presented and user input handled correctly - -### ❌ SYSTEM FAILURE: - -- Applying changes without explicit user approval -- Not presenting clear before/after comparisons -- Skipping explanation of rationale or references -- Proceeding without tracking which changes were approved -- Loading references when not needed for current proposal - -**Master Rule:** Skipping steps, optimizing sequences, or not following exact instructions is FORBIDDEN and constitutes SYSTEM FAILURE. diff --git a/src/modules/bmb/workflows/edit-agent/steps/step-04-apply-changes.md b/src/modules/bmb/workflows/edit-agent/steps/step-04-apply-changes.md deleted file mode 100644 index 64856388..00000000 --- a/src/modules/bmb/workflows/edit-agent/steps/step-04-apply-changes.md +++ /dev/null @@ -1,150 +0,0 @@ ---- -name: 'step-04-apply-changes' -description: 'Apply approved changes to the agent' - -# Path Definitions -workflow_path: '{project-root}/bmb/workflows/create-agent/edit-agent' - -# File References -thisStepFile: '{workflow_path}/steps/step-04-apply-changes.md' -agentFile: '{{agent_path}}' -nextStepFile: '{workflow_path}/steps/step-05-validate.md' - -# Task References -advancedElicitationTask: '{project-root}/_bmad/core/tasks/advanced-elicitation.xml' -partyModeWorkflow: '{project-root}/_bmad/core/workflows/party-mode/workflow.md' ---- - -# Step 4: Apply Changes - -## STEP GOAL: - -Apply all user-approved changes to the agent files directly using the Edit tool. - -## MANDATORY EXECUTION RULES (READ FIRST): - -### Universal Rules: - -- 🛑 NEVER generate content without user input -- 📖 CRITICAL: Read the complete step file before taking any action -- 🔄 CRITICAL: When loading next step with 'C', ensure entire file is read -- 📋 YOU ARE A FACILITATOR, not a content generator - -### Role Reinforcement: - -- ✅ You are an agent editor who helps users improve their BMAD agents through precise modifications -- ✅ If you already have a name, communication_style and identity, continue to use those while playing this new role -- ✅ We engage in collaborative dialogue, not command-response -- ✅ You bring agent architecture expertise, user brings their agent and goals, together we improve the agent -- ✅ Maintain collaborative guiding tone throughout - -### Step-Specific Rules: - -- 🎯 Focus only on applying changes that were explicitly approved in step 3 -- 🚫 FORBIDDEN to make any changes that were not approved by the user -- 💬 Approach: Apply changes one by one with confirmation after each -- 📋 Use Edit tool to make precise modifications to agent files - -## EXECUTION PROTOCOLS: - -- 🎯 Apply only changes that were explicitly approved in step 3 -- 💾 Show confirmation after each change is applied -- 📖 Edit files directly using Edit tool with precise modifications -- 🚫 FORBIDDEN to make unapproved changes or extra modifications - -## CONTEXT BOUNDARIES: - -- Available context: Approved changes list from step 3, agent path from step 1 -- Focus: Apply ONLY the approved changes, nothing more -- Limits: Do not make any modifications beyond what was explicitly approved -- Dependencies: Must have approved changes list from step 3 - -## Sequence of Instructions (Do not deviate, skip, or optimize) - -### 1. Load Agent File - -Read the complete agent file to understand current state before making changes. - -### 2. Apply First Approved Change - -For each change approved in step 3, apply it systematically: - -**For YAML changes in main agent file:** - -- Use Edit tool to modify the agent YAML file at `{agentFile}` -- Make the exact approved modification -- Confirm the change was applied correctly - -**For sidecar file changes (Expert agents):** - -- Use Edit tool to modify the specific sidecar file -- Make the exact approved modification -- Confirm the change was applied correctly - -### 3. Confirm Each Change Applied - -After each change is applied: -"Applied change: {{description}} - -- Updated section matches approved change ✓ -- File saved successfully ✓" - -### 4. Continue Until All Changes Applied - -Repeat step 2-3 for each approved change until complete: - -- Apply change using Edit tool -- Confirm it matches what was approved -- Move to next approved change - -### 5. Verify All Changes Complete - -"Summary of changes applied: - -- {{number}} changes applied successfully -- All modifications match user approvals from step 3 -- Agent files updated and saved" - -### 6. Present MENU OPTIONS - -Display: "**Select an Option:** [A] Advanced Elicitation [P] Party Mode [C] Continue" - -#### Menu Handling Logic: - -- IF A: Execute {advancedElicitationTask} -- IF P: Execute {partyModeWorkflow} -- IF C: Save completion status to context, then only then load, read entire file, then execute {nextStepFile} -- IF Any other comments or queries: help user respond then [Redisplay Menu Options](#6-present-menu-options) - -#### EXECUTION RULES: - -- ALWAYS halt and wait for user input after presenting menu -- ONLY proceed to next step when user selects 'C' -- After other menu items execution, return to this menu -- User can chat or ask questions - always respond and then end with display again of the menu options - -## CRITICAL STEP COMPLETION NOTE - -ONLY WHEN [C continue option] is selected and [all approved changes from step 3 have been applied to agent files], will you then load and read fully `{nextStepFile}` to execute and begin validation of applied changes. - ---- - -## 🚨 SYSTEM SUCCESS/FAILURE METRICS - -### ✅ SUCCESS: - -- All approved changes from step 3 applied using Edit tool -- Each modification matches exactly what was approved by user -- Agent files updated and saved correctly -- Confirmation provided for each applied change -- Menu presented and user input handled correctly - -### ❌ SYSTEM FAILURE: - -- Making changes that were not approved in step 3 -- Using tools other than Edit tool for file modifications -- Not confirming each change was applied correctly -- Making extra modifications beyond approved changes -- Skipping confirmation steps or verification - -**Master Rule:** Skipping steps, optimizing sequences, or not following exact instructions is FORBIDDEN and constitutes SYSTEM FAILURE. diff --git a/src/modules/bmb/workflows/edit-agent/steps/step-05-validate.md b/src/modules/bmb/workflows/edit-agent/steps/step-05-validate.md deleted file mode 100644 index 20ef1fdc..00000000 --- a/src/modules/bmb/workflows/edit-agent/steps/step-05-validate.md +++ /dev/null @@ -1,150 +0,0 @@ ---- -name: 'step-05-validate' -description: 'Validate that changes work correctly' - -# Path Definitions -workflow_path: '{project-root}/bmb/workflows/create-agent/edit-agent' - -# File References -thisStepFile: '{workflow_path}/steps/step-05-validate.md' -agentFile: '{{agent_path}}' - -# Task References -advancedElicitationTask: '{project-root}/_bmad/core/tasks/advanced-elicitation.xml' -partyModeWorkflow: '{project-root}/_bmad/core/workflows/party-mode/workflow.md' - -# Documentation References (load JIT) -validation: '{project-root}/_bmad/bmb/workflows/create-agent/data/agent-validation-checklist.md' -agent_compilation: '{project-root}/_bmad/bmb/docs/agents/agent-compilation.md' ---- - -# Step 5: Validate Changes - -## STEP GOAL: - -Validate that the applied changes work correctly and the edited agent follows BMAD best practices and standards. - -## MANDATORY EXECUTION RULES (READ FIRST): - -### Universal Rules: - -- 🛑 NEVER generate content without user input -- 📖 CRITICAL: Read the complete step file before taking any action -- 🔄 CRITICAL: When loading next step with 'C', ensure entire file is read -- 📋 YOU ARE A FACILITATOR, not a content generator - -### Role Reinforcement: - -- ✅ You are an agent editor who helps users ensure their edited BMAD agents meet quality standards -- ✅ If you already have a name, communication_style and identity, continue to use those while playing this new role -- ✅ We engage in collaborative dialogue, not command-response -- ✅ You bring agent architecture expertise, user brings their agent and goals, together we ensure quality -- ✅ Maintain collaborative guiding tone throughout - -### Step-Specific Rules: - -- 🎯 Focus only on validating changes that were applied in step 4 -- 🚫 FORBIDDEN to make additional changes during validation -- 💬 Approach: Systematic validation using standard checklist -- 📋 Load validation references JIT when needed for specific checks - -## EXECUTION PROTOCOLS: - -- 🎯 Validate only the changes that were applied in step 4 -- 💾 Report validation results clearly and systematically -- 📖 Load validation checklist and standards JIT as needed -- 🚫 FORBIDDEN to make additional modifications during validation - -## CONTEXT BOUNDARIES: - -- Available context: Applied changes from step 4, agent path from step 1, original goals from step 1 -- Focus: Validate that applied changes work and meet standards -- Limits: Do not modify anything, only validate and report -- Dependencies: Must have completed step 4 with applied changes - -## Sequence of Instructions (Do not deviate, skip, or optimize) - -### 1. Load and Read Validation Standards - -Load and read fully: `{validation}` - -### 2. Load Updated Agent File - -Read the updated agent file to see all applied changes in context. - -### 3. Check Each Applied Change - -Verify each change that was applied in step 4: - -- "Checking {{change}}... ✓ Works correctly" -- "Validating {{modification}}... ✓ Follows best practices" - -### 4. Run Standard Validation Checklist - -Check key items from validation checklist: - -- YAML syntax is valid and properly formatted -- Persona fields are properly separated (if persona was changed) -- All references and paths resolve correctly (if references were fixed) -- Menu structure follows BMAD patterns (if menu was modified) -- Agent compilation requirements are met (if structure changed) - -### 5. Load Agent Compilation if Needed - -If persona or agent structure was changed: - -- Load and read fully: `{agent_compilation}` -- Verify persona fields follow compilation requirements -- Check that agent structure meets BMAD standards - -### 6. Report Validation Results - -"Validation results: -✓ All {{number}} changes applied correctly -✓ Agent meets BMAD standards and best practices -✓ No issues found in modified sections -✓ Ready for use" - -### 7. Present MENU OPTIONS - -Display: "**Select an Option:** [A] Edit Another Agent [P] Party Mode [C] Complete" - -#### Menu Handling Logic: - -- IF A: Start fresh workflow with new agent path -- IF P: Execute {partyModeWorkflow} to celebrate successful agent editing -- IF C: Complete workflow and provide final success message -- IF Any other comments or queries: help user respond then [Redisplay Menu Options](#7-present-menu-options) - -#### EXECUTION RULES: - -- ALWAYS halt and wait for user input after presenting menu -- ONLY proceed when user selects 'A', 'P', or 'C' -- After party mode execution, return to this menu -- User can chat or ask questions - always respond and then end with display again of the menu options - -## CRITICAL STEP COMPLETION NOTE - -ONLY WHEN [C complete option] is selected and [all changes from step 4 have been validated successfully], will you then provide a final workflow completion message. The agent editing workflow is complete. - ---- - -## 🚨 SYSTEM SUCCESS/FAILURE METRICS - -### ✅ SUCCESS: - -- All applied changes from step 4 validated successfully -- Agent meets BMAD standards and best practices -- Validation checklist completed with no critical issues -- Clear validation report provided to user -- Menu presented and user input handled correctly - -### ❌ SYSTEM FAILURE: - -- Not validating all applied changes from step 4 -- Making modifications during validation step -- Skipping validation checklist or standards checks -- Not reporting validation results clearly -- Not loading references when needed for specific validation - -**Master Rule:** Skipping steps, optimizing sequences, or not following exact instructions is FORBIDDEN and constitutes SYSTEM FAILURE. diff --git a/src/modules/bmb/workflows/edit-agent/workflow.md b/src/modules/bmb/workflows/edit-agent/workflow.md deleted file mode 100644 index e26cc99b..00000000 --- a/src/modules/bmb/workflows/edit-agent/workflow.md +++ /dev/null @@ -1,58 +0,0 @@ ---- -name: edit-agent -description: Edit existing BMAD agents while following all best practices and conventions -web_bundle: false ---- - -# Edit Agent Workflow - -**Goal:** Edit existing BMAD agents following best practices with targeted analysis and direct updates. - -**Your Role:** In addition to your name, communication_style, and persona, you are also an agent editor collaborating with a BMAD agent owner. This is a partnership, not a client-vendor relationship. You bring agent architecture expertise and editing skills, while the user brings their agent and specific improvement goals. Work together as equals. - ---- - -## WORKFLOW ARCHITECTURE - -This uses **step-file architecture** for disciplined execution: - -### Core Principles - -- **Micro-file Design**: Each step is a self contained instruction file that is a part of an overall workflow that must be followed exactly -- **Just-In-Time Loading**: Only the current step file is in memory - never load future step files until told to do so -- **Sequential Enforcement**: Sequence within the step files must be completed in order, no skipping or optimization allowed -- **State Tracking**: Document progress in context for editing workflows (no output file frontmatter needed) -- **Append-Only Building**: Build documents by appending content as directed to the output file - -### Step Processing Rules - -1. **READ COMPLETELY**: Always read the entire step file before taking any action -2. **FOLLOW SEQUENCE**: Execute all numbered sections in order, never deviate -3. **WAIT FOR INPUT**: If a menu is presented, halt and wait for user selection -4. **CHECK CONTINUATION**: If the step has a menu with Continue as an option, only proceed to next step when user selects 'C' (Continue) -5. **SAVE STATE**: Update `stepsCompleted` in frontmatter before loading next step -6. **LOAD NEXT**: When directed, load, read entire file, then execute the next step file - -### Critical Rules (NO EXCEPTIONS) - -- 🛑 **NEVER** load multiple step files simultaneously -- 📖 **ALWAYS** read entire step file before execution -- 🚫 **NEVER** skip steps or optimize the sequence -- 💾 **ALWAYS** update frontmatter of output files when writing the final output for a specific step -- 🎯 **ALWAYS** follow the exact instructions in the step file -- ⏸️ **ALWAYS** halt at menus and wait for user input -- 📋 **NEVER** create mental todo lists from future steps - ---- - -## INITIALIZATION SEQUENCE - -### 1. Configuration Loading - -Load and read full config from {project-root}/_bmad/bmb/config.yaml and resolve: - -- `project_name`, `output_folder`, `user_name`, `communication_language`, `document_output_language` - -### 2. First Step EXECUTION - -Load, read the full file and then execute `{workflow_path}/steps/step-01-discover-intent.md` to begin the workflow. diff --git a/src/modules/bmb/workflows/edit-workflow/steps/step-01-analyze.md b/src/modules/bmb/workflows/edit-workflow/steps/step-01-analyze.md deleted file mode 100644 index 6fc65102..00000000 --- a/src/modules/bmb/workflows/edit-workflow/steps/step-01-analyze.md +++ /dev/null @@ -1,217 +0,0 @@ ---- -name: 'step-01-analyze' -description: 'Load and deeply understand the target workflow' - -# Path Definitions -workflow_path: '{project-root}/_bmad/bmb/workflows/edit-workflow' - -# File References -thisStepFile: '{workflow_path}/steps/step-01-analyze.md' -nextStepFile: '{workflow_path}/steps/step-02-discover.md' -workflowFile: '{workflow_path}/workflow.md' -outputFile: '{output_folder}/workflow-edit-{target_workflow_name}.md' - -# Template References -analysisTemplate: '{workflow_path}/templates/workflow-analysis.md' ---- - -# Step 1: Workflow Analysis - -## STEP GOAL: - -To load and deeply understand the target workflow, including its structure, purpose, and potential improvement areas. - -## MANDATORY EXECUTION RULES (READ FIRST): - -### Universal Rules: - -- 🛑 NEVER generate content without user input -- 📖 CRITICAL: Read the complete step file before taking any action -- 🔄 CRITICAL: When loading next step with 'C', ensure entire file is read -- 📋 YOU ARE A FACILITATOR, not a content generator - -### Role Reinforcement: - -- ✅ You are a workflow editor and improvement specialist -- ✅ If you already have been given communication or persona patterns, continue to use those while playing this new role -- ✅ We engage in collaborative dialogue, not command-response -- ✅ You bring workflow analysis expertise and best practices knowledge -- ✅ User brings their workflow context and improvement needs - -### Step-Specific Rules: - -- 🎯 Focus ONLY on analysis and understanding, not editing yet -- 🚫 FORBIDDEN to suggest specific changes in this step -- 💬 Ask questions to understand the workflow path -- 🚪 DETECT if this is a new format (standalone) or old format workflow - -## EXECUTION PROTOCOLS: - -- 🎯 Analyze workflow thoroughly and systematically -- 💾 Document analysis findings in {outputFile} -- 📖 Update frontmatter `stepsCompleted: [1]` before loading next step -- 🚫 FORBIDDEN to load next step until user selects 'C' and analysis is complete - -## CONTEXT BOUNDARIES: - -- User provides the workflow path to analyze -- Load all workflow documentation for reference -- Focus on understanding current state, not improvements yet -- This is about discovery and analysis - -## WORKFLOW ANALYSIS PROCESS: - -### 1. Get Workflow Information - -Ask the user: -"I need two pieces of information to help you edit your workflow effectively: - -1. **What is the path to the workflow you want to edit?** - - Path to workflow.md file (new format) - - Path to workflow.yaml file (legacy format) - - Path to the workflow directory - - Module and workflow name (e.g., 'bmb/workflows/create-workflow') - -2. **What do you want to edit or improve in this workflow?** - - Briefly describe what you want to achieve - - Are there specific issues you've encountered? - - Any user feedback you've received? - - New features you want to add? - -This will help me focus my analysis on what matters most to you." - -### 2. Load Workflow Files - -Load the target workflow completely: - -- workflow.md (or workflow.yaml for old format) -- steps/ directory with all step files -- templates/ directory (if exists) -- data/ directory (if exists) -- Any additional referenced files - -### 3. Determine Workflow Format - -Detect if this is: - -- **New standalone format**: workflow.md with steps/ subdirectory -- **Legacy XML format**: workflow.yaml with instructions.md -- **Mixed format**: Partial migration - -### 4. Focused Analysis - -Analyze the workflow with attention to the user's stated goals: - -#### Initial Goal-Focused Analysis - -Based on what the user wants to edit: - -- If **user experience issues**: Focus on step clarity, menu patterns, instruction style -- If **functional problems**: Focus on broken references, missing files, logic errors -- If **new features**: Focus on integration points, extensibility, structure -- If **compliance issues**: Focus on best practices, standards, validation - -#### Structure Analysis - -- Identify workflow type (document, action, interactive, autonomous, meta) -- Count and examine all steps -- Map out step flow and dependencies -- Check for proper frontmatter in all files - -#### Content Analysis - -- Understand purpose and user journey -- Evaluate instruction style (intent-based vs prescriptive) -- Review menu patterns and user interaction points -- Check variable consistency across files - -#### Compliance Analysis - -Load reference documentation as needed: - -- `{project-root}/_bmad/bmb/docs/workflows/architecture.md` -- `{project-root}/_bmad/bmb/docs/workflows/templates/step-template.md` -- `{project-root}/_bmad/bmb/docs/workflows/templates/workflow-template.md` - -Check against best practices: - -- Step file size and structure -- Menu handling implementation -- Frontmatter variable usage -- Path reference consistency - -### 5. Present Analysis Findings - -Share your analysis with the user in a conversational way: - -- What this workflow accomplishes (purpose and value) -- How it's structured (type, steps, interaction pattern) -- Format type (new standalone vs legacy) -- Initial findings related to their stated goals -- Potential issues or opportunities in their focus area - -### 6. Confirm Understanding and Refine Focus - -Ask: -"Based on your goal to {{userGoal}}, I've noticed {{initialFindings}}. -Does this align with what you were expecting? Are there other areas you'd like me to focus on in my analysis?" - -This allows the user to: - -- Confirm you're on the right track -- Add or modify focus areas -- Clarify any misunderstandings before proceeding - -### 7. Final Confirmation - -Ask: "Does this analysis cover what you need to move forward with editing?" - -## CONTENT TO APPEND TO DOCUMENT: - -After analysis, append to {outputFile}: - -Load and append the content from {analysisTemplate} - -### 8. Present MENU OPTIONS - -Display: **Select an Option:** [A] Advanced Elicitation [P] Party Mode [C] Continue - -#### EXECUTION RULES: - -- ALWAYS halt and wait for user input after presenting menu -- ONLY proceed to next step when user selects 'C' -- After other menu items execution, return to this menu -- User can chat or ask questions - always respond and then end with display again of the menu options -- Use menu handling logic section below - -#### Menu Handling Logic: - -- IF A: Execute {advancedElicitationTask} -- IF P: Execute {partyModeWorkflow} -- IF C: Save analysis to {outputFile}, update frontmatter, then only then load, read entire file, then execute {nextStepFile} -- IF Any other comments or queries: help user respond then [Redisplay Menu Options](#7-present-menu-options) - -## CRITICAL STEP COMPLETION NOTE - -ONLY WHEN C is selected and analysis is saved to document and frontmatter is updated, will you then load, read entire file, then execute {nextStepFile} to execute and begin improvement discovery step. - ---- - -## 🚨 SYSTEM SUCCESS/FAILURE METRICS - -### ✅ SUCCESS: - -- Target workflow loaded completely -- Analysis performed systematically -- Findings documented clearly -- User confirms understanding -- Analysis saved to {outputFile} - -### ❌ SYSTEM FAILURE: - -- Skipping analysis steps -- Not loading all workflow files -- Making suggestions without understanding -- Not saving analysis findings - -**Master Rule:** Skipping steps, optimizing sequences, or not following exact instructions is FORBIDDEN and constitutes SYSTEM FAILURE. diff --git a/src/modules/bmb/workflows/edit-workflow/steps/step-02-discover.md b/src/modules/bmb/workflows/edit-workflow/steps/step-02-discover.md deleted file mode 100644 index e3185c8b..00000000 --- a/src/modules/bmb/workflows/edit-workflow/steps/step-02-discover.md +++ /dev/null @@ -1,253 +0,0 @@ ---- -name: 'step-02-discover' -description: 'Discover improvement goals collaboratively' - -# Path Definitions -workflow_path: '{project-root}/_bmad/bmb/workflows/edit-workflow' - -# File References -thisStepFile: '{workflow_path}/steps/step-02-discover.md' -nextStepFile: '{workflow_path}/steps/step-03-improve.md' -workflowFile: '{workflow_path}/workflow.md' -outputFile: '{output_folder}/workflow-edit-{target_workflow_name}.md' - -# Task References -advancedElicitationTask: '{project-root}/_bmad/core/tasks/advanced-elicitation.xml' -partyModeWorkflow: '{project-root}/_bmad/core/workflows/party-mode/workflow.md' - -# Template References -goalsTemplate: '{workflow_path}/templates/improvement-goals.md' ---- - -# Step 2: Discover Improvement Goals - -## STEP GOAL: - -To collaboratively discover what the user wants to improve and why, before diving into any edits. - -## MANDATORY EXECUTION RULES (READ FIRST): - -### Universal Rules: - -- 🛑 NEVER generate content without user input -- 📖 CRITICAL: Read the complete step file before taking any action -- 🔄 CRITICAL: When loading next step with 'C', ensure entire file is read -- 📋 YOU ARE A FACILITATOR, not a content generator - -### Role Reinforcement: - -- ✅ You are a workflow editor and improvement specialist -- ✅ If you already have been given communication or persona patterns, continue to use those while playing this new role -- ✅ We engage in collaborative dialogue, not command-response -- ✅ You guide discovery with thoughtful questions -- ✅ User brings their context, feedback, and goals - -### Step-Specific Rules: - -- 🎯 Focus ONLY on understanding improvement goals -- 🚫 FORBIDDEN to suggest specific solutions yet -- 💬 Ask open-ended questions to understand needs -- 🚪 ORGANIZE improvements by priority and impact - -## EXECUTION PROTOCOLS: - -- 🎯 Guide collaborative discovery conversation -- 💾 Document goals in {outputFile} -- 📖 Update frontmatter `stepsCompleted: [1, 2]` before loading next step -- 🚫 FORBIDDEN to load next step until user selects 'C' and goals are documented - -## CONTEXT BOUNDARIES: - -- Analysis from step 1 is available and informs discovery -- Focus areas identified in step 1 guide deeper exploration -- Focus on WHAT to improve and WHY -- Don't discuss HOW to improve yet -- This is about detailed needs assessment, not solution design - -## DISCOVERY PROCESS: - -### 1. Understand Motivation - -Engage in collaborative discovery with open-ended questions: - -"What prompted you to want to edit this workflow?" - -Listen for: - -- User feedback they've received -- Issues they've encountered -- New requirements that emerged -- Changes in user needs or context - -### 2. Explore User Experience - -Ask about how users interact with the workflow: - -"What feedback have you gotten from users running this workflow?" - -Probe for: - -- Confusing steps or unclear instructions -- Points where users get stuck -- Repetitive or tedious parts -- Missing guidance or context -- Friction in the user journey - -### 3. Assess Current Performance - -Discuss effectiveness: - -"Is the workflow achieving its intended outcome?" - -Explore: - -- Are users successful with this workflow? -- What are the success/failure rates? -- Where do most users drop off? -- Are there quality issues with outputs? - -### 4. Identify Growth Opportunities - -Ask about future needs: - -"Are there new capabilities you want to add?" - -Consider: - -- New features or steps -- Integration with other workflows -- Expanded use cases -- Enhanced flexibility - -### 5. Evaluate Instruction Style - -Discuss communication approach: - -"How is the instruction style working for your users?" - -Explore: - -- Is it too rigid or too loose? -- Should certain steps be more adaptive? -- Do some steps need more specificity? -- Does the style match the workflow's purpose? - -### 6. Dive Deeper into Focus Areas - -Based on the focus areas identified in step 1, explore more deeply: - -#### For User Experience Issues - -"Let's explore the user experience issues you mentioned: - -- Which specific steps feel clunky or confusing? -- At what points do users get stuck? -- What kind of guidance would help them most?" - -#### For Functional Problems - -"Tell me more about the functional issues: - -- When do errors occur? -- What specific functionality isn't working? -- Are these consistent issues or intermittent?" - -#### For New Features - -"Let's detail the new features you want: - -- What should these features accomplish? -- How should users interact with them? -- Are there examples of similar workflows to reference?" - -#### For Compliance Issues - -"Let's understand the compliance concerns: - -- Which best practices need addressing? -- Are there specific standards to meet? -- What validation would be most valuable?" - -### 7. Organize Improvement Opportunities - -Based on their responses and your analysis, organize improvements: - -**CRITICAL Issues** (blocking successful runs): - -- Broken references or missing files -- Unclear or confusing instructions -- Missing essential functionality - -**IMPORTANT Improvements** (enhancing user experience): - -- Streamlining step flow -- Better guidance and context -- Improved error handling - -**NICE-TO-HAVE Enhancements** (for polish): - -- Additional validation -- Better documentation -- Performance optimizations - -### 8. Prioritize Collaboratively - -Work with the user to prioritize: -"Looking at all these opportunities, which ones matter most to you right now?" - -Help them consider: - -- Impact on users -- Effort to implement -- Dependencies between improvements -- Timeline constraints - -## CONTENT TO APPEND TO DOCUMENT: - -After discovery, append to {outputFile}: - -Load and append the content from {goalsTemplate} - -### 8. Present MENU OPTIONS - -Display: **Select an Option:** [A] Advanced Elicitation [P] Party Mode [C] Continue - -#### EXECUTION RULES: - -- ALWAYS halt and wait for user input after presenting menu -- ONLY proceed to next step when user selects 'C' -- After other menu items execution, return to this menu -- User can chat or ask questions - always respond and then end with display again of the menu options -- Use menu handling logic section below - -#### Menu Handling Logic: - -- IF A: Execute {advancedElicitationTask} -- IF P: Execute {partyModeWorkflow} -- IF C: Save goals to {outputFile}, update frontmatter, then only then load, read entire file, then execute {nextStepFile} -- IF Any other comments or queries: help user respond then [Redisplay Menu Options](#8-present-menu-options) - -## CRITICAL STEP COMPLETION NOTE - -ONLY WHEN C is selected and goals are saved to document and frontmatter is updated, will you then load, read entire file, then execute {nextStepFile} to execute and begin collaborative improvement step. - ---- - -## 🚨 SYSTEM SUCCESS/FAILURE METRICS - -### ✅ SUCCESS: - -- User improvement goals clearly understood -- Issues and opportunities identified -- Priorities established collaboratively -- Goals documented in {outputFile} -- User ready to proceed with improvements - -### ❌ SYSTEM FAILURE: - -- Skipping discovery dialogue -- Making assumptions about user needs -- Not documenting discovered goals -- Rushing to solutions without understanding - -**Master Rule:** Skipping steps, optimizing sequences, or not following exact instructions is FORBIDDEN and constitutes SYSTEM FAILURE. diff --git a/src/modules/bmb/workflows/edit-workflow/steps/step-03-improve.md b/src/modules/bmb/workflows/edit-workflow/steps/step-03-improve.md deleted file mode 100644 index 35280213..00000000 --- a/src/modules/bmb/workflows/edit-workflow/steps/step-03-improve.md +++ /dev/null @@ -1,217 +0,0 @@ ---- -name: 'step-03-improve' -description: 'Facilitate collaborative improvements to the workflow' - -# Path Definitions -workflow_path: '{project-root}/_bmad/bmb/workflows/edit-workflow' - -# File References -thisStepFile: '{workflow_path}/steps/step-03-improve.md' -nextStepFile: '{workflow_path}/steps/step-04-validate.md' -workflowFile: '{workflow_path}/workflow.md' -outputFile: '{output_folder}/workflow-edit-{target_workflow_name}.md' - -# Task References -advancedElicitationTask: '{project-root}/_bmad/core/tasks/advanced-elicitation.xml' -partyModeWorkflow: '{project-root}/_bmad/core/workflows/party-mode/workflow.md' - -# Template References -improvementLogTemplate: '{workflow_path}/templates/improvement-log.md' ---- - -# Step 3: Collaborative Improvement - -## STEP GOAL: - -To facilitate collaborative improvements to the workflow, working iteratively on each identified issue. - -## MANDATORY EXECUTION RULES (READ FIRST): - -### Universal Rules: - -- 🛑 NEVER generate content without user input -- 📖 CRITICAL: Read the complete step file before taking any action -- 🔄 CRITICAL: When loading next step with 'C', ensure entire file is read -- 📋 YOU ARE A FACILITATOR, not a content generator - -### Role Reinforcement: - -- ✅ You are a workflow editor and improvement specialist -- ✅ If you already have been given communication or persona patterns, continue to use those while playing this new role -- ✅ We engage in collaborative dialogue, not command-response -- ✅ You guide improvements with explanations and options -- ✅ User makes decisions and approves changes - -### Step-Specific Rules: - -- 🎯 Work on ONE improvement at a time -- 🚫 FORBIDDEN to make changes without user approval -- 💬 Explain the rationale for each proposed change -- 🚪 ITERATE: improve, review, refine - -## EXECUTION PROTOCOLS: - -- 🎯 Facilitate improvements collaboratively and iteratively -- 💾 Document all changes in improvement log -- 📖 Update frontmatter `stepsCompleted: [1, 2, 3]` before loading next step -- 🚫 FORBIDDEN to load next step until user selects 'C' and improvements are complete - -## CONTEXT BOUNDARIES: - -- Analysis and goals from previous steps guide improvements -- Load workflow creation documentation as needed -- Focus on improvements prioritized in step 2 -- This is about collaborative implementation, not solo editing - -## IMPROVEMENT PROCESS: - -### 1. Load Reference Materials - -Load documentation as needed for specific improvements: - -- `{project-root}/_bmad/bmb/docs/workflows/templates/step-template.md` -- `{project-root}/_bmad/bmb/docs/workflows/templates/workflow-template.md` -- `{project-root}/_bmad/bmb/docs/workflows/architecture.md` - -### 2. Address Each Improvement Iteratively - -For each prioritized improvement: - -#### A. Explain Current State - -Show the relevant section: -"Here's how this step currently works: -[Display current content] - -This can cause {{problem}} because {{reason}}." - -#### B. Propose Improvement - -Suggest specific changes: -"Based on best practices, we could: -{{proposedSolution}} - -This would help users by {{benefit}}." - -#### C. Collaborate on Approach - -Ask for input: -"Does this approach address your need?" -"Would you like to modify this suggestion?" -"What concerns do you have about this change?" - -#### D. Get Explicit Approval - -"Should I apply this change?" - -#### E. Apply and Show Result - -Make the change and display: -"Here's the updated version: -[Display new content] - -Does this look right to you?" - -### 3. Common Improvement Patterns - -#### Step Flow Improvements - -- Merge redundant steps -- Split complex steps -- Reorder for better flow -- Add missing transitions - -#### Instruction Style Refinement - -Load step-template.md for reference: - -- Convert prescriptive to intent-based for discovery steps -- Add structure to vague instructions -- Balance guidance with autonomy - -#### Variable Consistency Fixes - -- Identify all variable references -- Ensure consistent naming (snake_case) -- Verify variables are defined in workflow.md -- Update all occurrences - -#### Menu System Updates - -- Standardize menu patterns -- Ensure proper A/P/C options -- Fix menu handling logic -- Add Advanced Elicitation where useful - -#### Frontmatter Compliance - -- Add required fields to workflow.md -- Ensure proper path variables -- Include web_bundle configuration if needed -- Remove unused fields - -#### Template Updates - -- Align template variables with step outputs -- Improve variable naming -- Add missing template sections -- Test variable substitution - -### 4. Track All Changes - -For each improvement made, document: - -- What was changed -- Why it was changed -- Files modified -- User approval - -## CONTENT TO APPEND TO DOCUMENT: - -After each improvement iteration, append to {outputFile}: - -Load and append content from {improvementLogTemplate} - -### 5. Present MENU OPTIONS - -Display: **Select an Option:** [A] Advanced Elicitation [P] Party Mode [C] Continue - -#### EXECUTION RULES: - -- ALWAYS halt and wait for user input after presenting menu -- ONLY proceed to next step when user selects 'C' -- After other menu items execution, return to this menu -- User can chat or ask questions - always respond and then end with display again of the menu options -- Use menu handling logic section below - -#### Menu Handling Logic: - -- IF A: Execute {advancedElicitationTask} -- IF P: Execute {partyModeWorkflow} -- IF C: Save improvement log to {outputFile}, update frontmatter, then only then load, read entire file, then execute {nextStepFile} -- IF Any other comments or queries: help user respond then [Redisplay Menu Options](#5-present-menu-options) - -## CRITICAL STEP COMPLETION NOTE - -ONLY WHEN C is selected and all prioritized improvements are complete and documented, will you then load, read entire file, then execute {nextStepFile} to execute and begin validation step. - ---- - -## 🚨 SYSTEM SUCCESS/FAILURE METRICS - -### ✅ SUCCESS: - -- All prioritized improvements addressed -- User approved each change -- Changes documented clearly -- Workflow follows best practices -- Improvement log updated - -### ❌ SYSTEM FAILURE: - -- Making changes without user approval -- Not documenting changes -- Skipping prioritized improvements -- Breaking workflow functionality - -**Master Rule:** Skipping steps, optimizing sequences, or not following exact instructions is FORBIDDEN and constitutes SYSTEM FAILURE. diff --git a/src/modules/bmb/workflows/edit-workflow/steps/step-04-validate.md b/src/modules/bmb/workflows/edit-workflow/steps/step-04-validate.md deleted file mode 100644 index a2f804e4..00000000 --- a/src/modules/bmb/workflows/edit-workflow/steps/step-04-validate.md +++ /dev/null @@ -1,193 +0,0 @@ ---- -name: 'step-04-validate' -description: 'Validate improvements and prepare for completion' - -# Path Definitions -workflow_path: '{project-root}/_bmad/bmb/workflows/edit-workflow' - -# File References -thisStepFile: '{workflow_path}/steps/step-04-validate.md' -workflowFile: '{workflow_path}/workflow.md' -outputFile: '{output_folder}/workflow-edit-{target_workflow_name}.md' -nextStepFile: '{workflow_path}/steps/step-05-compliance-check.md' - -# Task References -advancedElicitationTask: '{project-root}/_bmad/core/tasks/advanced-elicitation.xml' -partyModeWorkflow: '{project-root}/_bmad/core/workflows/party-mode/workflow.md' - -# Template References -validationTemplate: '{workflow_path}/templates/validation-results.md' -completionTemplate: '{workflow_path}/templates/completion-summary.md' ---- - -# Step 4: Validation and Completion - -## STEP GOAL: - -To validate all improvements and prepare a completion summary of the workflow editing process. - -## MANDATORY EXECUTION RULES (READ FIRST): - -### Universal Rules: - -- 🛑 NEVER generate content without user input -- 📖 CRITICAL: Read the complete step file before taking any action -- 🔄 CRITICAL: Always read the complete step file before taking any action -- 📋 YOU ARE A FACILITATOR, not a content generator - -### Role Reinforcement: - -- ✅ You are a workflow editor and improvement specialist -- ✅ If you already have been given communication or persona patterns, continue to use those while playing this new role -- ✅ We engage in collaborative dialogue, not command-response -- ✅ You ensure quality and completeness -- ✅ User confirms final state - -### Step-Specific Rules: - -- 🎯 Focus ONLY on validation and completion -- 🚫 FORBIDDEN to make additional edits at this stage -- 💬 Explain validation results clearly -- 🚪 PREPARE final summary and next steps - -## EXECUTION PROTOCOLS: - -- 🎯 Validate all changes systematically -- 💾 Document validation results -- 📖 Update frontmatter `stepsCompleted: [1, 2, 3, 4]` before loading next step -- 🚫 FORBIDDEN to load next step until user selects 'C' and validation is complete - -## CONTEXT BOUNDARIES: - -- All improvements from step 3 should be implemented -- Focus on validation, not additional changes -- Reference best practices for validation criteria -- This completes the editing process - -## VALIDATION PROCESS: - -### 1. Comprehensive Validation Checks - -Validate the improved workflow systematically: - -#### File Structure Validation - -- [ ] All required files present -- [ ] Directory structure correct -- [ ] File names follow conventions -- [ ] Path references resolve correctly - -#### Configuration Validation - -- [ ] workflow.md frontmatter complete -- [ ] All variables properly formatted -- [ ] Path variables use correct syntax -- [ ] No hardcoded paths exist - -#### Step File Compliance - -- [ ] Each step follows template structure -- [ ] Mandatory rules included -- [ ] Menu handling implemented properly -- [ ] Step numbering sequential -- [ ] Step files reasonably sized (5-10KB) - -#### Cross-File Consistency - -- [ ] Variable names match across files -- [ ] No orphaned references -- [ ] Dependencies correctly defined -- [ ] Template variables match outputs - -#### Best Practices Adherence - -- [ ] Collaborative dialogue implemented -- [ ] Error handling included -- [ ] Naming conventions followed -- [ ] Instructions clear and specific - -### 2. Present Validation Results - -Load validationTemplate and document findings: - -- If issues found: Explain clearly and propose fixes -- If all passes: Confirm success warmly - -### 3. Create Completion Summary - -Load completionTemplate and prepare: - -- Story of transformation -- Key improvements made -- Impact on users -- Next steps for testing - -### 4. Guide Next Steps - -Based on changes made, suggest: - -- Testing the edited workflow -- Running it with sample data -- Getting user feedback -- Additional refinements if needed - -### 5. Document Final State - -Update {outputFile} with: - -- Validation results -- Completion summary -- Change log summary -- Recommendations - -## CONTENT TO APPEND TO DOCUMENT: - -After validation, append to {outputFile}: - -Load and append content from {validationTemplate} - -Then load and append content from {completionTemplate} - -## FINAL MENU OPTIONS - -Display: **Select an Option:** [A] Advanced Elicitation [P] Party Mode [C] Continue - -### EXECUTION RULES: - -- ALWAYS halt and wait for user input after presenting menu -- ONLY proceed to next step when user selects 'C' -- After other menu items execution, return to this menu -- User can chat or ask questions - always respond and then end with display again of the menu options -- Use menu handling logic section below - -#### Menu Handling Logic: - -- IF A: Execute {advancedElicitationTask} -- IF P: Execute {partyModeWorkflow} -- IF C: Save content to {outputFile}, update frontmatter, then only then load, read entire file, then execute {nextStepFile} -- IF Any other comments or queries: help user respond then [Redisplay Menu Options](#final-menu-options) - -## CRITICAL STEP COMPLETION NOTE - -ONLY WHEN C is selected and content is saved to {outputFile} with frontmatter updated, will you then load, read entire file, then execute {nextStepFile} to execute and begin compliance validation step. - ---- - -## 🚨 SYSTEM SUCCESS/FAILURE METRICS - -### ✅ SUCCESS: - -- All improvements validated successfully -- No critical issues remain -- Completion summary provided -- Next steps clearly outlined -- User satisfied with results - -### ❌ SYSTEM FAILURE: - -- Skipping validation steps -- Not documenting final state -- Ending without user confirmation -- Leaving issues unresolved - -**Master Rule:** Skipping steps, optimizing sequences, or not following exact instructions is FORBIDDEN and constitutes SYSTEM FAILURE. diff --git a/src/modules/bmb/workflows/edit-workflow/steps/step-05-compliance-check.md b/src/modules/bmb/workflows/edit-workflow/steps/step-05-compliance-check.md deleted file mode 100644 index 37e7fb90..00000000 --- a/src/modules/bmb/workflows/edit-workflow/steps/step-05-compliance-check.md +++ /dev/null @@ -1,245 +0,0 @@ ---- -name: 'step-05-compliance-check' -description: 'Run comprehensive compliance validation on the edited workflow' - -# Path Definitions -workflow_path: '{project-root}/_bmad/bmb/workflows/edit-workflow' - -# File References -thisStepFile: '{workflow_path}/steps/step-05-compliance-check.md' -workflowFile: '{workflow_path}/workflow.md' -editedWorkflowPath: '{target_workflow_path}' -complianceCheckWorkflow: '{project-root}/_bmad/bmb/workflows/workflow-compliance-check/workflow.md' -outputFile: '{output_folder}/workflow-edit-{target_workflow_name}.md' - -# Task References -complianceCheckTask: '{project-root}/_bmad/bmb/workflows/workflow-compliance-check/workflow.md' ---- - -# Step 5: Compliance Validation - -## STEP GOAL: - -Run comprehensive compliance validation on the edited workflow using the workflow-compliance-check workflow to ensure it meets all BMAD standards before completion. - -## MANDATORY EXECUTION RULES (READ FIRST): - -### Universal Rules: - -- 🛑 NEVER generate content without user input -- 📖 CRITICAL: Read the complete step file before taking any action -- 📋 YOU ARE A FACILITATOR, not a content generator - -### Role Reinforcement: - -- ✅ You are a workflow editor and quality assurance specialist -- ✅ If you already have been given a name, communication_style, and persona, continue to use those while playing this new role -- ✅ We engage in collaborative dialogue, not command-response -- ✅ You bring expertise in BMAD standards and workflow validation -- ✅ User brings their edited workflow and needs quality assurance - -### Step-Specific Rules: - -- 🎯 Focus only on running compliance validation on the edited workflow -- 🚫 FORBIDDEN to skip compliance validation or declare workflow complete without it -- 💬 Approach: Quality-focused, thorough, and collaborative -- 📋 Ensure user understands compliance results and next steps - -## EXECUTION PROTOCOLS: - -- 🎯 Launch workflow-compliance-check on the edited workflow -- 💾 Review compliance report and present findings to user -- 📖 Explain any issues found and provide fix recommendations -- 🚫 FORBIDDEN to proceed without compliance validation completion - -## CONTEXT BOUNDARIES: - -- Available context: Edited workflow files from previous improve step -- Focus: Compliance validation using workflow-compliance-check workflow -- Limits: Validation and reporting only, no further workflow modifications -- Dependencies: Successful workflow improvements in previous step - -## Sequence of Instructions (Do not deviate, skip, or optimize) - -### 1. Initialize Compliance Validation - -"**Final Quality Check: Workflow Compliance Validation** - -Your workflow has been edited! Now let's run a comprehensive compliance check to ensure it meets all BMAD standards and follows best practices. - -This validation will check: - -- Template compliance (workflow-template.md and step-template.md) -- File size optimization and markdown formatting -- CSV data file standards (if applicable) -- Intent vs Prescriptive spectrum alignment -- Web search and subprocess optimization -- Overall workflow flow and goal alignment" - -### 2. Launch Compliance Check Workflow - -**A. Execute Compliance Validation:** - -"Running comprehensive compliance validation on your edited workflow... -Target: `{editedWorkflowPath}` - -**Executing:** {complianceCheckTask} -**Validation Scope:** Full 8-phase compliance analysis -**Expected Duration:** Thorough validation may take several minutes" - -**B. Monitor Validation Progress:** - -Provide updates as the validation progresses: - -- "✅ Workflow.md validation in progress..." -- "✅ Step-by-step compliance checking..." -- "✅ File size and formatting analysis..." -- "✅ Intent spectrum assessment..." -- "✅ Web search optimization analysis..." -- "✅ Generating comprehensive compliance report..." - -### 3. Compliance Report Analysis - -**A. Review Validation Results:** - -"**Compliance Validation Complete!** - -**Overall Assessment:** [PASS/PARTIAL/FAIL - based on compliance report] - -- **Critical Issues:** [number found] -- **Major Issues:** [number found] -- **Minor Issues:** [number found] -- **Compliance Score:** [percentage]%" - -**B. Present Key Findings:** - -"**Key Compliance Results:** - -- **Template Adherence:** [summary of template compliance] -- **File Optimization:** [file size and formatting issues] -- **Intent Spectrum:** [spectrum positioning validation] -- **Performance Optimization:** [web search and subprocess findings] -- **Overall Flow:** [workflow structure and completion validation]" - -### 4. Issue Resolution Options - -**A. Review Compliance Issues:** - -If issues are found: -"**Issues Requiring Attention:** - -**Critical Issues (Must Fix):** -[List any critical violations that prevent workflow functionality] - -**Major Issues (Should Fix):** -[List major issues that impact quality or maintainability] - -**Minor Issues (Nice to Fix):** -[List minor standards compliance issues]" - -**B. Resolution Options:** - -"**Resolution Options:** - -1. **Automatic Fixes** - I can apply automated fixes where possible -2. **Manual Guidance** - I'll guide you through manual fixes step by step -3. **Return to Edit** - Go back to step 3 for additional improvements -4. **Accept as Is** - Proceed with current state (if no critical issues) -5. **Detailed Review** - Review full compliance report in detail" - -### 5. Final Validation Confirmation - -**A. User Choice Handling:** - -Based on user selection: - -- **If Automatic Fixes**: Apply fixes and re-run validation -- **If Manual Guidance**: Provide step-by-step fix instructions -- **If Return to Edit**: Load step-03-discover.md with compliance report context -- **If Accept as Is**: Confirm understanding of any remaining issues -- **If Detailed Review**: Present full compliance report - -**B. Final Status Confirmation:** - -"**Workflow Compliance Status:** [FINAL/PROVISIONAL] - -**Completion Criteria:** - -- ✅ All critical issues resolved -- ✅ Major issues addressed or accepted -- ✅ Compliance documentation complete -- ✅ User understands any remaining minor issues - -**Your edited workflow is ready!**" - -### 6. Completion Documentation - -**A. Update Compliance Status:** - -Document final compliance status in {outputFile}: - -- **Validation Date:** [current date] -- **Compliance Score:** [final percentage] -- **Issues Resolved:** [summary of fixes applied] -- **Remaining Issues:** [any accepted minor issues] - -**B. Final User Guidance:** - -"**Next Steps for Your Edited Workflow:** - -1. **Test the workflow** with real users to validate functionality -2. **Monitor performance** and consider optimization opportunities -3. **Gather feedback** for potential future improvements -4. **Consider compliance check** periodically for maintenance - -**Support Resources:** - -- Use workflow-compliance-check for future validations -- Refer to BMAD documentation for best practices -- Use edit-workflow again for future modifications" - -### 7. Final Menu Options - -"**Workflow Edit and Compliance Complete!** - -**Select an Option:** - -- [C] Complete - Finish workflow editing with compliance validation -- [R] Review Compliance - View detailed compliance report -- [M] More Modifications - Return to editing for additional changes -- [T] Test Workflow - Try a test run (if workflow supports testing)" - -## Menu Handling Logic: - -- IF C: End workflow editing successfully with compliance validation summary -- IF R: Present detailed compliance report findings -- IF M: Return to step-03-discover.md for additional improvements -- IF T: If workflow supports testing, suggest test execution method -- IF Any other comments or queries: respond and redisplay completion options - -## CRITICAL STEP COMPLETION NOTE - -ONLY WHEN compliance validation is complete and user confirms final workflow status, will the workflow editing process be considered successfully finished. - ---- - -## 🚨 SYSTEM SUCCESS/FAILURE METRICS - -### ✅ SUCCESS: - -- Comprehensive compliance validation executed on edited workflow -- All compliance issues identified and documented with severity rankings -- User provided with clear understanding of validation results -- Appropriate resolution options offered and implemented -- Final edited workflow meets BMAD standards and is ready for production -- User satisfaction with workflow quality and compliance - -### ❌ SYSTEM FAILURE: - -- Skipping compliance validation before workflow completion -- Not addressing critical compliance issues found during validation -- Failing to provide clear guidance on issue resolution -- Declaring workflow complete without ensuring standards compliance -- Not documenting final compliance status for future reference - -**Master Rule:** Skipping steps, optimizing sequences, or not following exact instructions is FORBIDDEN and constitutes SYSTEM FAILURE. diff --git a/src/modules/bmb/workflows/edit-workflow/templates/completion-summary.md b/src/modules/bmb/workflows/edit-workflow/templates/completion-summary.md deleted file mode 100644 index ca888ffb..00000000 --- a/src/modules/bmb/workflows/edit-workflow/templates/completion-summary.md +++ /dev/null @@ -1,75 +0,0 @@ -## Workflow Edit Complete! - -### Transformation Summary - -#### Starting Point - -- **Workflow**: {{workflowName}} -- **Initial State**: {{initialState}} -- **Primary Issues**: {{primaryIssues}} - -#### Improvements Made - -{{#improvements}} - -- **{{area}}**: {{description}} - - **Impact**: {{impact}} - {{/improvements}} - -#### Key Changes - -1. {{change1}} -2. {{change2}} -3. {{change3}} - -### Impact Assessment - -#### User Experience Improvements - -- **Before**: {{beforeUX}} -- **After**: {{afterUX}} -- **Benefit**: {{uxBenefit}} - -#### Technical Improvements - -- **Compliance**: {{complianceImprovement}} -- **Maintainability**: {{maintainabilityImprovement}} -- **Performance**: {{performanceImpact}} - -### Files Modified - -{{#modifiedFiles}} - -- **{{type}}**: {{path}} - {{/modifiedFiles}} - -### Next Steps - -#### Immediate Actions - -1. {{immediateAction1}} -2. {{immediateAction2}} - -#### Testing Recommendations - -- {{testingRecommendation1}} -- {{testingRecommendation2}} - -#### Future Considerations - -- {{futureConsideration1}} -- {{futureConsideration2}} - -### Support Information - -- **Edited by**: {{userName}} -- **Date**: {{completionDate}} -- **Documentation**: {{outputFile}} - -### Thank You! - -Thank you for collaboratively improving this workflow. Your workflow now follows best practices and should provide a better experience for your users. - ---- - -_Edit workflow completed successfully on {{completionDate}}_ diff --git a/src/modules/bmb/workflows/edit-workflow/templates/improvement-goals.md b/src/modules/bmb/workflows/edit-workflow/templates/improvement-goals.md deleted file mode 100644 index 895cb7dc..00000000 --- a/src/modules/bmb/workflows/edit-workflow/templates/improvement-goals.md +++ /dev/null @@ -1,68 +0,0 @@ -## Improvement Goals - -### Motivation - -- **Trigger**: {{editTrigger}} -- **User Feedback**: {{userFeedback}} -- **Success Issues**: {{successIssues}} - -### User Experience Issues - -{{#uxIssues}} - -- {{.}} - {{/uxIssues}} - -### Performance Gaps - -{{#performanceGaps}} - -- {{.}} - {{/performanceGaps}} - -### Growth Opportunities - -{{#growthOpportunities}} - -- {{.}} - {{/growthOpportunities}} - -### Instruction Style Considerations - -- **Current Style**: {{currentStyle}} -- **Desired Changes**: {{styleChanges}} -- **Style Fit Assessment**: {{styleFit}} - -### Prioritized Improvements - -#### Critical (Must Fix) - -{{#criticalItems}} - -1. {{.}} - {{/criticalItems}} - -#### Important (Should Fix) - -{{#importantItems}} - -1. {{.}} - {{/importantItems}} - -#### Nice-to-Have (Could Fix) - -{{#niceItems}} - -1. {{.}} - {{/niceItems}} - -### Focus Areas for Next Step - -{{#focusAreas}} - -- {{.}} - {{/focusAreas}} - ---- - -_Goals identified on {{date}}_ diff --git a/src/modules/bmb/workflows/edit-workflow/templates/improvement-log.md b/src/modules/bmb/workflows/edit-workflow/templates/improvement-log.md deleted file mode 100644 index d5445235..00000000 --- a/src/modules/bmb/workflows/edit-workflow/templates/improvement-log.md +++ /dev/null @@ -1,40 +0,0 @@ -## Improvement Log - -### Change Summary - -- **Date**: {{date}} -- **Improvement Area**: {{improvementArea}} -- **User Goal**: {{userGoal}} - -### Changes Made - -#### Change #{{changeNumber}} - -**Issue**: {{issueDescription}} -**Solution**: {{solutionDescription}} -**Rationale**: {{changeRationale}} - -**Files Modified**: -{{#modifiedFiles}} - -- {{.}} - {{/modifiedFiles}} - -**Before**: - -```markdown -{{beforeContent}} -``` - -**After**: - -```markdown -{{afterContent}} -``` - -**User Approval**: {{userApproval}} -**Impact**: {{expectedImpact}} - ---- - -{{/improvementLog}} diff --git a/src/modules/bmb/workflows/edit-workflow/templates/validation-results.md b/src/modules/bmb/workflows/edit-workflow/templates/validation-results.md deleted file mode 100644 index 5ca76893..00000000 --- a/src/modules/bmb/workflows/edit-workflow/templates/validation-results.md +++ /dev/null @@ -1,51 +0,0 @@ -## Validation Results - -### Overall Status - -**Result**: {{validationResult}} -**Date**: {{date}} -**Validator**: {{validator}} - -### Validation Categories - -#### File Structure - -- **Status**: {{fileStructureStatus}} -- **Details**: {{fileStructureDetails}} - -#### Configuration - -- **Status**: {{configurationStatus}} -- **Details**: {{configurationDetails}} - -#### Step Compliance - -- **Status**: {{stepComplianceStatus}} -- **Details**: {{stepComplianceDetails}} - -#### Cross-File Consistency - -- **Status**: {{consistencyStatus}} -- **Details**: {{consistencyDetails}} - -#### Best Practices - -- **Status**: {{bestPracticesStatus}} -- **Details**: {{bestPracticesDetails}} - -### Issues Found - -{{#validationIssues}} - -- **{{severity}}**: {{description}} - - **Impact**: {{impact}} - - **Recommendation**: {{recommendation}} - {{/validationIssues}} - -### Validation Summary - -{{validationSummary}} - ---- - -_Validation completed on {{date}}_ diff --git a/src/modules/bmb/workflows/edit-workflow/templates/workflow-analysis.md b/src/modules/bmb/workflows/edit-workflow/templates/workflow-analysis.md deleted file mode 100644 index 1ef52217..00000000 --- a/src/modules/bmb/workflows/edit-workflow/templates/workflow-analysis.md +++ /dev/null @@ -1,56 +0,0 @@ -## Workflow Analysis - -### Target Workflow - -- **Path**: {{workflowPath}} -- **Name**: {{workflowName}} -- **Module**: {{workflowModule}} -- **Format**: {{workflowFormat}} (Standalone/Legacy) - -### Structure Analysis - -- **Type**: {{workflowType}} -- **Total Steps**: {{stepCount}} -- **Step Flow**: {{stepFlowPattern}} -- **Files**: {{fileStructure}} - -### Content Characteristics - -- **Purpose**: {{workflowPurpose}} -- **Instruction Style**: {{instructionStyle}} -- **User Interaction**: {{interactionPattern}} -- **Complexity**: {{complexityLevel}} - -### Initial Assessment - -#### Strengths - -{{#strengths}} - -- {{.}} - {{/strengths}} - -#### Potential Issues - -{{#issues}} - -- {{.}} - {{/issues}} - -#### Format-Specific Notes - -{{#formatNotes}} - -- {{.}} - {{/formatNotes}} - -### Best Practices Compliance - -- **Step File Structure**: {{stepCompliance}} -- **Frontmatter Usage**: {{frontmatterCompliance}} -- **Menu Implementation**: {{menuCompliance}} -- **Variable Consistency**: {{variableCompliance}} - ---- - -_Analysis completed on {{date}}_ diff --git a/src/modules/bmb/workflows/edit-workflow/workflow.md b/src/modules/bmb/workflows/edit-workflow/workflow.md deleted file mode 100644 index 1daaca4d..00000000 --- a/src/modules/bmb/workflows/edit-workflow/workflow.md +++ /dev/null @@ -1,58 +0,0 @@ ---- -name: edit-workflow -description: Intelligent workflow editor that helps modify existing workflows while following best practices -web_bundle: true ---- - -# Edit Workflow - -**Goal:** Collaboratively edit and improve existing workflows, ensuring they follow best practices and meet user needs effectively. - -**Your Role:** In addition to your name, communication_style, and persona, you are also a workflow editor and improvement specialist collaborating with a workflow owner. This is a partnership, not a client-vendor relationship. You bring expertise in workflow design patterns, best practices, and collaborative facilitation, while the user brings their workflow context, user feedback, and improvement goals. Work together as equals. - ---- - -## WORKFLOW ARCHITECTURE - -This uses **step-file architecture** for disciplined execution: - -### Core Principles - -- **Micro-file Design**: Each step is a self contained instruction file that is a part of an overall workflow that must be followed exactly -- **Just-In-Time Loading**: Only the current step file is in memory - never load future step files until told to do so -- **Sequential Enforcement**: Sequence within the step files must be completed in order, no skipping or optimization allowed -- **State Tracking**: Document progress in output file frontmatter using `stepsCompleted` array when a workflow produces a document -- **Append-Only Building**: Build documents by appending content as directed to the output file - -### Step Processing Rules - -1. **READ COMPLETELY**: Always read the entire step file before taking any action -2. **FOLLOW SEQUENCE**: Execute all numbered sections in order, never deviate -3. **WAIT FOR INPUT**: If a menu is presented, halt and wait for user selection -4. **CHECK CONTINUATION**: If the step has a menu with Continue as an option, only proceed to next step when user selects 'C' (Continue) -5. **SAVE STATE**: Update `stepsCompleted` in frontmatter before loading next step -6. **LOAD NEXT**: When directed, load, read entire file, then execute the next step file - -### Critical Rules (NO EXCEPTIONS) - -- 🛑 **NEVER** load multiple step files simultaneously -- 📖 **ALWAYS** read entire step file before execution -- 🚫 **NEVER** skip steps or optimize the sequence -- 💾 **ALWAYS** update frontmatter of output files when writing the final output for a specific step -- 🎯 **ALWAYS** follow the exact instructions in the step file -- ⏸️ **ALWAYS** halt at menus and wait for user input -- 📋 **NEVER** create mental todo lists from future steps - ---- - -## INITIALIZATION SEQUENCE - -### 1. Configuration Loading - -Load and read full config from {project-root}/_bmad/bmb/config.yaml and resolve: - -- `project_name`, `output_folder`, `user_name`, `communication_language`, `document_output_language` - -### 2. First Step EXECUTION - -Load, read the full file and then execute `{workflow_path}/steps/step-01-analyze.md` to begin the workflow. diff --git a/src/modules/bmb/workflows/module/data/agent-architecture.md b/src/modules/bmb/workflows/module/data/agent-architecture.md new file mode 100644 index 00000000..7cfac331 --- /dev/null +++ b/src/modules/bmb/workflows/module/data/agent-architecture.md @@ -0,0 +1,179 @@ +# Agent Architecture for Modules + +**Purpose:** High-level guidance for planning agents in your module — not implementation details (that's what the agent-builder workflow is for). + +--- + +## Single Agent vs. Multi-Agent Module + +### Single Agent Module + +**Use when:** One persona can handle the module's purpose. + +**Characteristics:** +- Simpler, focused +- Clear single point of contact +- Good for narrow domains + +**Question:** Could one expert agent with a sidecar handle this entire module? + +--- + +### Multi-Agent Module + +**Use when:** Different expertise areas justify specialized personas. + +**Characteristics:** +- Each agent has a distinct role and expertise +- Agents form a cohesive team around the module's theme +- Menus coordinate to guide users to the right agent + +**Why multi-agent?** +- Different workflows need different expert perspectives +- Users expect to talk to "the right expert" for each task +- The module covers a domain too broad for one persona + +--- + +## Flagship Example: BMM Agent Team + +BMM demonstrates a multi-agent module with **9 specialized agents** forming a complete software development team. + +### The BMM Theme + +**"Agile software delivery, AI-driven"** + +Every agent serves this theme — they're a complete team working together. + +### BMM Agent Overview + +| Agent | Name | Role | Responsible For | +|-------|------|------|-----------------| +| PM | John | Product Manager | PRDs, requirements, user stories | +| Architect | Winston | System Architect | Technical design, architecture | +| UX | | UX Designer | User research, UX design | +| Dev | | Developer | Implementation, coding | +| TEA | | Test Engineer Architect | Test architecture, QA | +| SM | | Scrum Master | Sprint planning, workflow status | +| Tech Writer | | Technical Writer | Documentation | +| Analyst | | Business Analyst | Analysis, metrics | +| Quick Flow | | Solo Developer | Quick standalone work | + +### Key Patterns + +1. **Shared commands** — All agents have `[WS]` Workflow Status +2. **Specialty commands** — Each agent has unique commands (PM→PRD, Architect→Architecture) +3. **No overlap** — Each command has one clear owner +4. **Collaboration** — Agents reference each other's work (PRD → Architecture → Implementation) + +--- + +## Planning Your Agents + +### For Each Agent, Document: + +1. **Role** — What is this agent responsible for? +2. **Workflows** — Which workflows will this agent trigger/own? +3. **Human Name** — What's their persona name? (e.g., "John", "Winston") +4. **Communication Style** — How do they talk? (e.g., "Direct and data-sharp", "Calm and pragmatic") +5. **Skills/Expertise** — What knowledge does this agent bring? +6. **Memory/Learning** — Does this agent need to remember things over time? (hasSidecar) + +That's it! The agent-builder workflow will handle the detailed implementation. + +--- + +## Agent Memory & Learning + +### Sidecar Agents (hasSidecar: true) + +**Use when:** The agent needs to remember context across sessions. + +**Characteristics:** +- Has a sidecar file that persists between conversations +- Learns from user interactions +- Remembers project details, preferences, past work + +**Examples:** +- An agent that tracks project decisions over time +- An agent that learns user preferences +- An agent that maintains ongoing project context + +### Stateless Agents (hasSidecar: false) + +**Use when:** The agent doesn't need persistent memory. + +**Characteristics:** +- Each conversation starts fresh +- Relies on shared context files (like project-context.md) +- Simpler, more predictable + +**Most module agents are stateless** — they reference shared project context rather than maintaining their own memory. + +--- + +## Agent-Workflow Coordination + +### Menu Triggers + +Each agent has menu items that trigger workflows: + +| Trigger Type | Pattern | Example | +|--------------|---------|---------| +| Shared | Same across all agents | `[WS]` Workflow Status | +| Specialty | Unique to this agent | `[PR]` Create PRD (PM only) | +| Cross-reference | Points to another agent's workflow | "See architecture" | + +### Simple Planning Format + +For each agent, just document: + +``` +Agent: PM (John) +Role: Product Manager, requirements, PRDs +Triggers: + - WS → Workflow Status (shared) + - PR → Create PRD (specialty) + - ES → Epics and Stories (specialty) +Memory: No (uses shared project-context) +``` + +The agent-builder workflow will convert this into the proper format. + +--- + +## When to Use Multiple Agents + +**Consider multiple agents when:** +- Different workflows require different expertise +- The domain has clear specialization areas +- Users would expect to talk to different "experts" +- The module covers a broad process (like software development) + +**Use a single agent when:** +- The domain is focused and narrow +- One expertise area covers all workflows +- Simplicity is preferred +- The agent could reasonably handle everything with a sidecar + +--- + +## Quick Agent Planning Checklist + +For each agent in your module: + +- [ ] Role defined (what they're responsible for) +- [ ] Workflows assigned (which workflows they trigger) +- [ ] Human name chosen (persona) +- [ ] Communication style described +- [ ] Skills/expertise identified +- [ ] Memory decision (hasSidecar: true/false) + +--- + +## Notes + +- **Don't worry about the exact YAML format** — agent-builder handles that +- **Focus on the planning** — who does what, how they work together +- **Keep it high-level** — this is about the module's agent architecture, not implementation details +- **BMM is the reference** — look at how their agents form a cohesive team diff --git a/src/modules/bmb/workflows/module/data/agent-spec-template.md b/src/modules/bmb/workflows/module/data/agent-spec-template.md new file mode 100644 index 00000000..5452abb6 --- /dev/null +++ b/src/modules/bmb/workflows/module/data/agent-spec-template.md @@ -0,0 +1,79 @@ +# Agent Specification: {agent_name} + +**Module:** {module_code} +**Status:** Placeholder — To be created via create-agent workflow +**Created:** {date} + +--- + +## Agent Metadata + +```yaml +agent: + metadata: + id: "_bmad/{module_code}/agents/{agent_file_name}.md" + name: {agent_human_name} + title: {agent_title} + icon: {agent_icon} + module: {module_code} + hasSidecar: false +``` + +--- + +## Agent Persona + +### Role + +{agent_role} + +### Identity + +{agent_identity} + +### Communication Style + +{agent_communication_style} + +### Principles + +{agent_principles} + +--- + +## Agent Menu + +### Planned Commands + +| Trigger | Command | Description | Workflow | +|---------|---------|-------------|----------| +{agent_menu_table} + +--- + +## Agent Integration + +### Shared Context + +- References: `{shared_context_files}` +- Collaboration with: {collaborating_agents} + +### Workflow References + +{workflow_references} + +--- + +## Implementation Notes + +**Use the create-agent workflow to build this agent.** + +Inputs needed: +- Agent name and human name +- Role and expertise area +- Communication style preferences +- Menu commands and workflow mappings + +--- + +_Spec created on {date} via BMAD Module workflow_ diff --git a/src/modules/bmb/workflows/module/data/module-installer-standards.md b/src/modules/bmb/workflows/module/data/module-installer-standards.md new file mode 100644 index 00000000..c95746a6 --- /dev/null +++ b/src/modules/bmb/workflows/module/data/module-installer-standards.md @@ -0,0 +1,348 @@ +# Module Installer Standards + +**Purpose:** How the `_module-installer` folder works, including installer.js patterns and platform-specific configuration. + +--- + +## Overview + +The `_module-installer` folder contains optional installation logic for your module. It runs AFTER the IDE installations and can: +- Create directories specified in module.yaml +- Copy assets or templates +- Configure IDE-specific settings +- Set up platform-specific integrations + +--- + +## When Do You Need an Installer? + +### Use an Installer When: + +- Creating directories based on user configuration +- Copying template files to the user's project +- IDE-specific setup (Claude Code, Windsurf, Cursor, etc.) +- Platform-specific integrations + +### Skip the Installer When: + +- Module only provides agents and workflows +- No file operations needed +- No IDE-specific configuration + +--- + +## Folder Structure + +``` +_module-installer/ +├── installer.js # Main installer (REQUIRED if folder exists) +└── platform-specifics/ # IDE-specific handlers (optional) + ├── claude-code.js + ├── windsurf.js + ├── cursor.js + └── ... +``` + +--- + +## installer.js Pattern + +### Function Signature + +```javascript +/** + * Module Installer + * + * @param {Object} options - Installation options + * @param {string} options.projectRoot - The root directory of the target project + * @param {Object} options.config - Module configuration from module.yaml (resolved variables) + * @param {Array} options.installedIDEs - Array of IDE codes that were installed + * @param {Object} options.logger - Logger instance for output + * @returns {Promise} - Success status (true = success, false = failure) + */ +async function install(options) { + const { projectRoot, config, installedIDEs, logger } = options; + + try { + // Installation logic here + logger.log(chalk.blue('Installing {Module Name}...')); + + // ... your logic ... + + logger.log(chalk.green('✓ {Module Name} installation complete')); + return true; + } catch (error) { + logger.error(chalk.red(`Error installing module: ${error.message}`)); + return false; + } +} + +module.exports = { install }; +``` + +--- + +### What You Receive + +| Parameter | Type | Description | +|-----------|------|-------------| +| `projectRoot` | string | Absolute path to the user's project root | +| `config` | object | Resolved module.yaml variables | +| `installedIDEs` | array | List of IDE codes installed (e.g., `['claude-code', 'windsurf']`) | +| `logger` | object | Logger with `.log()`, `.warn()`, `.error()` methods | + +The `config` object contains your module.yaml variables **after** user input: + +```javascript +// If module.yaml defined: +// project_name: +// prompt: "What is your project name?" +// result: "{value}" + +config.project_name // = user's input +config.planning_artifacts // = resolved path +``` + +--- + +## Common Installation Tasks + +### 1. Create Directories + +```javascript +const fs = require('fs-extra'); +const path = require('node:path'); + +// Create directory from config +if (config['planning_artifacts']) { + const dirConfig = config['planning_artifacts'].replace('{project-root}/', ''); + const dirPath = path.join(projectRoot, dirConfig); + + if (!(await fs.pathExists(dirPath))) { + logger.log(chalk.yellow(`Creating directory: ${dirConfig}`)); + await fs.ensureDir(dirPath); + } +} +``` + +### 2. Copy Assets + +```javascript +const assetsSource = path.join(__dirname, 'assets'); +const assetsDest = path.join(projectRoot, 'docs'); + +if (await fs.pathExists(assetsSource)) { + await fs.copy(assetsSource, assetsDest); + logger.log(chalk.green('✓ Copied assets to docs/')); +} +``` + +### 3. IDE-Specific Configuration + +```javascript +// Handle IDE-specific configurations +if (installedIDEs && installedIDEs.length > 0) { + logger.log(chalk.cyan(`Configuring for IDEs: ${installedIDEs.join(', ')}`)); + + for (const ide of installedIDEs) { + await configureForIDE(ide, projectRoot, config, logger); + } +} +``` + +--- + +## Platform-Specific Handlers + +### Pattern + +Create files in `platform-specifics/{ide-code}.js`: + +```javascript +// platform-specifics/claude-code.js + +/** + * Configure module for Claude Code + */ +async function install(options) { + const { projectRoot, config, logger, platformInfo } = options; + + try { + // Claude Code specific configuration + logger.log(chalk.dim(' Configuring Claude Code integration...')); + + // Your logic here + + return true; + } catch (error) { + logger.warn(chalk.yellow(` Warning: ${error.message}`)); + return false; + } +} + +module.exports = { install }; +``` + +### Load from Main Installer + +```javascript +// installer.js +const platformCodes = require(path.join(__dirname, '../../../../tools/cli/lib/platform-codes')); + +async function configureForIDE(ide, projectRoot, config, logger) { + // Validate platform code + if (!platformCodes.isValidPlatform(ide)) { + logger.warn(chalk.yellow(` Unknown platform: '${ide}'. Skipping.`)); + return; + } + + const platformName = platformCodes.getDisplayName(ide); + const platformSpecificPath = path.join(__dirname, 'platform-specifics', `${ide}.js`); + + try { + if (await fs.pathExists(platformSpecificPath)) { + const platformHandler = require(platformSpecificPath); + + if (typeof platformHandler.install === 'function') { + await platformHandler.install({ projectRoot, config, logger }); + logger.log(chalk.green(` ✓ Configured for ${platformName}`)); + } + } + } catch (error) { + logger.warn(chalk.yellow(` Warning: Could not configure ${platformName}: ${error.message}`)); + } +} +``` + +--- + +## Complete Example: BMM Installer + +```javascript +const fs = require('fs-extra'); +const path = require('node:path'); +const chalk = require('chalk'); +const platformCodes = require(path.join(__dirname, '../../../../tools/cli/lib/platform-codes')); + +/** + * BMM Module Installer + */ +async function install(options) { + const { projectRoot, config, installedIDEs, logger } = options; + + try { + logger.log(chalk.blue('🚀 Installing BMM Module...')); + + // Create output directory + if (config['output_folder']) { + const outputConfig = config['output_folder'].replace('{project-root}/', ''); + const outputPath = path.join(projectRoot, outputConfig); + if (!(await fs.pathExists(outputPath))) { + logger.log(chalk.yellow(`Creating output directory: ${outputConfig}`)); + await fs.ensureDir(outputPath); + } + } + + // Create implementation artifacts directory + if (config['implementation_artifacts']) { + const storyConfig = config['implementation_artifacts'].replace('{project-root}/', ''); + const storyPath = path.join(projectRoot, storyConfig); + if (!(await fs.pathExists(storyPath))) { + logger.log(chalk.yellow(`Creating story directory: ${storyConfig}`)); + await fs.ensureDir(storyPath); + } + } + + // IDE-specific configuration + if (installedIDEs && installedIDEs.length > 0) { + logger.log(chalk.cyan(`Configuring BMM for IDEs: ${installedIDEs.join(', ')}`)); + + for (const ide of installedIDEs) { + await configureForIDE(ide, projectRoot, config, logger); + } + } + + logger.log(chalk.green('✓ BMM Module installation complete')); + return true; + } catch (error) { + logger.error(chalk.red(`Error installing BMM: ${error.message}`)); + return false; + } +} + +async function configureForIDE(ide, projectRoot, config, logger) { + if (!platformCodes.isValidPlatform(ide)) { + logger.warn(chalk.yellow(` Warning: Unknown platform '${ide}'. Skipping.`)); + return; + } + + const platformSpecificPath = path.join(__dirname, 'platform-specifics', `${ide}.js`); + + try { + if (await fs.pathExists(platformSpecificPath)) { + const platformHandler = require(platformSpecificPath); + + if (typeof platformHandler.install === 'function') { + await platformHandler.install({ projectRoot, config, logger }); + } + } + } catch (error) { + logger.warn(chalk.yellow(` Warning: Could not load handler for ${ide}: ${error.message}`)); + } +} + +module.exports = { install }; +``` + +--- + +## Best Practices + +### DO: +- Return `true` for success, `false` for failure +- Use chalk for colored output +- Log what you're doing (create, copy, configure) +- Handle errors gracefully with try/catch +- Validate paths before creating directories + +### DON'T: +- Assume paths exist — check with `fs.pathExists()` +- Overwrite user files without asking +- Fail silently — log errors +- Use absolute paths — build from `projectRoot` + +--- + +## Available Platform Codes + +Common IDE codes: +- `claude-code` — Anthropic's Claude Code +- `windsurf` — Windsurf IDE +- `cursor` — Cursor AI IDE +- `vscode` — Visual Studio Code + +Use `platformCodes.isValidPlatform(ide)` to validate. + +--- + +## Testing Your Installer + +1. Create a test project +2. Run `bmad install {your-module}` +3. Verify directories are created +4. Check that config variables are resolved correctly +5. Test platform-specific handlers + +--- + +## Quick Reference + +| Task | Code Pattern | +|------|--------------| +| Create directory | `await fs.ensureDir(path)` | +| Check if exists | `await fs.pathExists(path)` | +| Copy files | `await fs.copy(src, dest)` | +| Log info | `logger.log(chalk.blue('message'))` | +| Log success | `logger.log(chalk.green('✓ message'))` | +| Log warning | `logger.warn(chalk.yellow('warning'))` | +| Log error | `logger.error(chalk.red('error'))` | diff --git a/src/modules/bmb/workflows/module/data/module-standards.md b/src/modules/bmb/workflows/module/data/module-standards.md new file mode 100644 index 00000000..b56ca060 --- /dev/null +++ b/src/modules/bmb/workflows/module/data/module-standards.md @@ -0,0 +1,280 @@ +# Module Standards + +**Purpose:** Defines what a BMAD module is, its structure, and the three types of modules. + +--- + +## What is a BMAD Module? + +A **BMAD module** is a self-contained package of functionality that extends the BMAD framework. Modules provide: +- **Agents** — AI personas with specialized expertise and menu-driven commands +- **Workflows** — Structured processes for accomplishing complex tasks +- **Configuration** — module.yaml for user customization +- **Installation** — Optional installer.js for setup logic + +--- + +## Module Types + +### 1. Standalone Module + +A new, independent module focused on a specific domain. + +**Characteristics:** +- Own module code (e.g., `healthcare-ai`, `legal-assist`) +- Independent of other modules +- Can be installed alongside any other modules +- Has its own agents, workflows, configuration + +**Location:** `src/modules/{module-code}/` + +**Example:** CIS (Creative Innovation Suite) — a standalone module for innovation workflows + +--- + +### 2. Extension Module + +Extends an existing BMAD module with additional functionality. + +**Characteristics:** +- Builds upon an existing module's agents and workflows +- May add new agents or workflows that complement the base module +- Shares configuration context with the extended module +- Typically installed alongside the module it extends + +**Location:** `src/modules/{base-module}/extensions/{extension-code}/` + +**Example:** An extension to BMM that adds specialized security review workflows + +--- + +### Extension Module: Override & Merge Pattern + +When an extension module is installed, its files merge with the base module following these rules: + +#### Code Matching + +The extension's `module.yaml` `code:` field matches the base module's code: + +```yaml +# Base module: src/modules/bmm/module.yaml +code: bmm + +# Extension: src/modules/bmm/extensions/security/module.yaml +code: bmm # SAME CODE — extends BMM +``` + +The **folder name** is unique (e.g., `bmm-security`) but the `code:` matches the base module. + +#### File Merge Rules + +| File Type | Same Name | Different Name | +|-----------|-----------|----------------| +| Agent file | **OVERRIDE** — replaces the base agent | **ADD** — new agent added | +| Workflow folder | **OVERRIDE** — replaces the base workflow | **ADD** — new workflow added | +| Other files | **OVERRIDE** — replaces base file | **ADD** — new file added | + +#### Examples + +**Override scenario:** +``` +Base module (BMM): +├── agents/ +│ └── pm.agent.yaml # Original PM agent + +Extension (bmm-security): +├── agents/ +│ └── pm.agent.yaml # Security-focused PM — REPLACES original + +Result after installation: +├── agents/ +│ └── pm.agent.yaml # Now the security version +``` + +**Add scenario:** +``` +Base module (BMM): +├── agents/ +│ ├── pm.agent.yaml +│ └── architect.agent.yaml + +Extension (bmm-security): +├── agents/ +│ └── security-auditor.agent.yaml # NEW agent + +Result after installation: +├── agents/ +│ ├── pm.agent.yaml +│ ├── architect.agent.yaml +│ └── security-auditor.agent.yaml # ADDED +``` + +**Mixed scenario:** +``` +Extension contains both overrides and new files — applies rules per file +``` + +--- + +### 3. Global Module + +Affects the entire BMAD framework and all modules. + +**Characteristics:** +- Core functionality that impacts all modules +- Often provides foundational services or utilities +- Installed at the framework level +- Use sparingly — only for truly global concerns + +**Location:** `src/modules/{module-code}/` with `global: true` in module.yaml + +**Example:** A module that provides universal logging or telemetry across BMAD + +--- + +## Required Module Structure + +``` +{module-code}/ +├── module.yaml # Module configuration (REQUIRED) +├── README.md # Module documentation (REQUIRED) +├── agents/ # Agent definitions (if any) +│ └── {agent-name}.agent.yaml +├── workflows/ # Workflow definitions (if any) +│ └── {workflow-name}/ +│ └── workflow.md +├── _module-installer/ # Installation logic (optional) +│ ├── installer.js +│ └── platform-specifics/ +│ ├── claude-code.js +│ ├── windsurf.js +│ └── ... +└── {other folders} # Tasks, templates, data as needed +``` + +--- + +## Required Files + +### module.yaml (REQUIRED) + +Every module MUST have a `module.yaml` file with at minimum: + +```yaml +code: {module-code} +name: "Module Display Name" +header: "Brief module description" +subheader: "Additional context" +default_selected: false +``` + +See: `module-yaml-conventions.md` for full specification. + +--- + +### README.md (REQUIRED) + +Every module MUST have a README.md with: +- Module name and purpose +- Installation instructions +- Components section (agents, workflows) +- Quick start guide +- Module structure diagram +- Configuration section +- Usage examples +- Author information + +--- + +## Optional Components + +### Agents + +Agents are AI personas with: +- Metadata (id, name, title, icon, module) +- Persona (role, identity, communication_style, principles) +- Menu (trigger → workflow/exec mappings) + +See: `agent-architecture.md` for design guidance. + +--- + +### Workflows + +Workflows are structured processes with: +- workflow.md (entry point) +- steps/ folder with step files +- data/ folder with shared reference +- templates/ folder if needed + +--- + +### _module-installer/ + +Optional installation logic for: +- Creating directories +- Copying assets +- IDE-specific configuration +- Platform-specific setup + +See: `module-installer-standards.md` for patterns. + +--- + +## Module Type Decision Tree + +``` +START: Creating a module +│ +├─ Is this a brand new independent domain? +│ └─ YES → Standalone Module +│ +├─ Does this extend an existing module? +│ └─ YES → Extension Module +│ +└─ Does this affect all modules globally? + └─ YES → Global Module (use sparingly) +``` + +--- + +## Naming Conventions + +### Module Code + +- **kebab-case** (e.g., `bmm`, `cis`, `bmgd`, `healthcare-ai`) +- Short, memorable, descriptive +- 2-20 characters +- Lowercase letters, numbers, hyphens only + +### Agent Files + +- Format: `{role-name}.agent.yaml` +- Example: `pm.agent.yaml`, `architect.agent.yaml` + +### Workflow Folders + +- Format: `{workflow-name}/` +- Example: `prd/`, `create-architecture/` + +--- + +## Module Dependencies + +Modules can depend on: +- **Core BMAD** — Always available +- **Other modules** — Specify in module.yaml as `dependencies:` +- **External tools** — Document in README, handle in installer + +--- + +## Quick Reference + +| Question | Answer | +|----------|--------| +| What's a module? | Self-contained package of agents, workflows, config | +| What are the types? | Standalone, Extension, Global | +| What's required? | module.yaml, README.md | +| Where do modules live? | `src/modules/{code}/` | +| How do agents work? | Menu triggers → workflow/exec | +| How does installation work? | module.yaml prompts + optional installer.js | diff --git a/src/modules/bmb/workflows/module/data/module-yaml-conventions.md b/src/modules/bmb/workflows/module/data/module-yaml-conventions.md new file mode 100644 index 00000000..ee3b31a7 --- /dev/null +++ b/src/modules/bmb/workflows/module/data/module-yaml-conventions.md @@ -0,0 +1,392 @@ +# module.yaml Conventions + +**Purpose:** Defines how module.yaml works, including variables, templates, and how they provide context to agents and workflows. + +--- + +## Overview + +`module.yaml` is the configuration file for a BMAD module. It: +- Defines module metadata (code, name, description) +- Collects user input via prompts during installation +- Makes those inputs available to agents and workflows as variables +- Specifies which module should be selected by default + +--- + +## Frontmatter Fields + +### Required Fields + +```yaml +code: {module-code} # kebab-case identifier +name: "Display Name" # Human-readable name +header: "Brief description" # One-line summary +subheader: "Additional context" # More detail +default_selected: false # Auto-select on install? +``` + +### `default_selected` Guidelines + +| Module Type | default_selected | Example | +|-------------|------------------|---------| +| Core/Primary | `true` | BMM (agile software delivery) | +| Specialized | `false` | CIS (creative innovation), BMGD (game dev) | +| Experimental | `false` | New modules in development | + +--- + +## Variables System + +### Core Config Variables (Always Available) + +These variables are automatically available to ALL modules: + +```yaml +# Variables from Core Config inserted: +## user_name # User's name +## communication_language # Preferred language +## document_output_language # Output document language +## output_folder # Default output location +``` + +No need to define these — they're injected automatically. + +--- + +### Custom Variables + +Define custom variables for user input: + +```yaml +variable_name: + prompt: "Question to ask the user?" + default: "{default_value}" + result: "{template_for_final_value}" +``` + +**Example:** + +```yaml +project_name: + prompt: "What is the title of your project?" + default: "{directory_name}" + result: "{value}" +``` + +### Variable Templates + +In `prompt` and `result`, you can use templates: + +| Template | Expands To | +|----------|------------| +| `{value}` | The user's input | +| `{directory_name}` | Current directory name | +| `{output_folder}` | Output folder from core config | +| `{project-root}` | Project root path | +| `{variable_name}` | Another variable's value | + +--- + +## Variable Types + +### 1. Simple Text Input + +```yaml +project_name: + prompt: "What is the title of your project?" + default: "{directory_name}" + result: "{value}" +``` + +--- + +### 2. Boolean/Flag + +```yaml +enable_feature: + prompt: "Enable this feature?" + default: false + result: "{value}" +``` + +--- + +### 3. Single Select + +```yaml +skill_level: + prompt: "What is your experience level?" + default: "intermediate" + result: "{value}" + single-select: + - value: "beginner" + label: "Beginner - Explains concepts clearly" + - value: "intermediate" + label: "Intermediate - Balanced approach" + - value: "expert" + label: "Expert - Direct and technical" +``` + +--- + +### 4. Multi Select + +```yaml +platforms: + prompt: "Which platforms do you need?" + default: ["unity", "unreal"] + result: "{value}" + multi-select: + - value: "unity" + label: "Unity" + - value: "unreal" + label: "Unreal Engine" + - value: "godot" + label: "Godot" +``` + +--- + +### 5. Multi-Line Prompt + +```yaml +complex_variable: + prompt: + - "First question?" + - "Second context?" + - "Third detail?" + default: "default_value" + result: "{value}" +``` + +--- + +### 6. Required Variable + +```yaml +critical_variable: + prompt: "Required information:" + required: true + result: "{value}" +``` + +--- + +### 7. Path Variable + +```yaml +artifacts_folder: + prompt: "Where should artifacts be stored?" + default: "{output_folder}/artifacts" + result: "{project-root}/{value}" +``` + +--- + +## Variable Inheritance / Aliasing + +Create an alias for another variable: + +```yaml +primary_artifacts: + prompt: "Where should primary artifacts be stored?" + default: "{output_folder}/artifacts" + result: "{project-root}/{value}" + +# Alias for workflow compatibility +sprint_artifacts: + inherit: "primary_artifacts" +``` + +Now `sprint_artifacts` and `primary_artifacts` reference the same value. + +--- + +## How Variables Become Available + +### To Agents + +After installation, variables are available in agent frontmatter/context: + +```yaml +# In agent.agent.yaml or workflow execution +{variable_name} # Expands to the user's configured value +``` + +**Example:** If the user configured `project_name: "MyApp"`, agents can reference `{project_name}` and it will expand to `"MyApp"`. + +### To Workflows + +Workflows can reference module variables in their step files: + +```yaml +--- +outputFile: '{implementation_artifacts}/my-output.md' +--- +``` + +This expands the `implementation_artifacts` variable from module.yaml. + +--- + +## Real-World Examples + +### BMM (BMad Method) — Complex Configuration + +```yaml +code: bmm +name: "BMM: BMad Method Agile-AI Driven-Development" +header: "BMad Method™: Breakthrough Method of Agile-Ai Driven-Dev" +subheader: "Agent and Workflow Configuration for this module" +default_selected: true + +# Variables from Core Config inserted: +## user_name +## communication_language +## document_output_language +## output_folder + +project_name: + prompt: "What is the title of your project?" + default: "{directory_name}" + result: "{value}" + +user_skill_level: + prompt: + - "What is your development experience level?" + - "This affects how agents explain concepts." + default: "intermediate" + result: "{value}" + single-select: + - value: "beginner" + label: "Beginner - Explain concepts clearly" + - value: "intermediate" + label: "Intermediate - Balanced approach" + - value: "expert" + label: "Expert - Direct and technical" + +planning_artifacts: + prompt: "Where should planning artifacts be stored?" + default: "{output_folder}/planning-artifacts" + result: "{project-root}/{value}" + +implementation_artifacts: + prompt: "Where should implementation artifacts be stored?" + default: "{output_folder}/implementation-artifacts" + result: "{project-root}/{value}" + +project_knowledge: + prompt: "Where should project knowledge be stored?" + default: "docs" + result: "{project-root}/{value}" + +tea_use_mcp_enhancements: + prompt: "Enable MCP enhancements in Test Architect?" + default: false + result: "{value}" +``` + +--- + +### CIS (Creative Innovation Suite) — Minimal Configuration + +```yaml +code: cis +name: "CIS: Creative Innovation Suite" +header: "Creative Innovation Suite (CIS) Module" +subheader: "No custom configuration - uses Core settings only" +default_selected: false + +# Variables from Core Config inserted: +## user_name +## communication_language +## document_output_language +## output_folder +``` + +Some modules don't need custom variables — core config is enough! + +--- + +### BMGD (Game Development) — Multi-Select Example + +```yaml +code: bmgd +name: "BMGD: BMad Game Development" +header: "BMad Game Development Module" +subheader: "Configure game development settings" +default_selected: false + +project_name: + prompt: "What is the name of your game project?" + default: "{directory_name}" + result: "{value}" + +primary_platform: + prompt: "Which game engine do you use?" + default: ["unity", "unreal"] + required: true + result: "{value}" + multi-select: + - value: "unity" + label: "Unity" + - value: "unreal" + label: "Unreal Engine" + - value: "godot" + label: "Godot" + - value: "other" + label: "Custom / Other" +``` + +--- + +## Best Practices + +### DO: +- Keep prompts clear and concise +- Provide sensible defaults +- Use `result: "{project-root}/{value}"` for paths +- Use single/multi-select for structured choices +- Group related variables logically + +### DON'T: +- Overwhelm users with too many questions +- Ask for information that could be inferred +- Use technical jargon in prompts +- Create variables that are never used + +--- + +## Variable Naming + +- **kebab-case** (e.g., `planning_artifacts`, `user_skill_level`) +- Descriptive but concise +- Avoid conflicts with core variables + +--- + +## Testing Your module.yaml + +After creating module.yaml, test it: + +1. Run `bmad install` in a test project +2. Verify prompts appear correctly +3. Check that variables expand in agents/workflows +4. Test default values +5. Validate path templates resolve correctly + +--- + +## Quick Reference + +| Pattern | Use Case | +|---------|----------| +| Simple text input | Names, titles, descriptions | +| Boolean/Flag | Enable/disable features | +| Single select | Experience levels, categories | +| Multi select | Platforms, frameworks, options | +| Multi-line prompt | Complex questions needing context | +| Required | Must-have information | +| Path variable | Directory locations | +| Inherit/Alias | Compatibility, references | diff --git a/src/modules/bmb/workflows/module/steps-b/step-01-welcome.md b/src/modules/bmb/workflows/module/steps-b/step-01-welcome.md new file mode 100644 index 00000000..b415eca4 --- /dev/null +++ b/src/modules/bmb/workflows/module/steps-b/step-01-welcome.md @@ -0,0 +1,147 @@ +--- +name: 'step-01-welcome' +description: 'Welcome user, select mode (Interactive/Express/YOLO), gather initial idea' + +nextStepFile: './step-02-spark.md' +briefTemplateFile: '../templates/brief-template.md' +moduleStandardsFile: '../data/module-standards.md' +advancedElicitationTask: '../../../../core/workflows/advanced-elicitation/workflow.xml' +partyModeWorkflow: '../../../../core/workflows/party-mode/workflow.md' +--- + +# Step 1: Welcome & Mode Selection + +## STEP GOAL: + +Welcome the user to the Module Brief workflow, select the collaboration mode (Interactive/Express/YOLO), and gather their initial module idea. + +## MANDATORY EXECUTION RULES (READ FIRST): + +### Universal Rules: + +- 🛑 NEVER generate content without user input +- 📖 CRITICAL: Read the complete step file before taking any action +- 🔄 CRITICAL: When loading next with 'C', ensure entire file is read +- 📋 YOU ARE A FACILITATOR, not a content generator +- ✅ Speak in `{communication_language}` + +### Role Reinforcement: + +- ✅ You are the **Module Architect** — creative, inspiring, helping users discover amazing module ideas +- ✅ This is explorative and collaborative — not a template-filling exercise +- ✅ Help users clarify and expand their vision + +### Step-Specific Rules: + +- 🎯 Set the creative tone — this is about discovering possibilities +- 🚫 FORBIDDEN to jump straight to technical details +- 💬 Ask questions that spark imagination + +## EXECUTION PROTOCOLS: + +- 🎯 Follow the MANDATORY SEQUENCE exactly +- 💾 No output file yet — gathering initial context +- 📖 Load next step when user selects 'C' + +## CONTEXT BOUNDARIES: + +- Available: module standards, brief template +- Focus: Initial idea gathering and mode selection +- No existing brief — this is a fresh start + +--- + +## MANDATORY SEQUENCE + +**CRITICAL:** Follow this sequence exactly. Do not skip, reorder, or improvise. + +### 1. Welcome with Enthusiasm + +"**Welcome to the Module Brief workflow!** 🚀 + +I'm here to help you create an amazing BMAD module. We'll explore your vision, design the agents and workflows, and create a comprehensive brief that will guide the module's creation. + +Modules are powerful — they package agents, workflows, and configuration into a cohesive capability. Let's make something great!" + +### 2. Select Collaboration Mode + +"**How would you like to work?**" + +- **[I]nteractive** — Deep collaboration, we'll explore each section together thoroughly +- **[E]xpress** — Faster pace, targeted questions to get to a solid brief quickly +- **[Y]OLO** — I'll generate a complete brief from minimal input (you can refine later) + +**Store the selected mode. This affects how we proceed through subsequent steps.** + +### 3. Gather the Initial Idea + +"**Tell me about your module idea.**" + +Encourage them to share: +- What problem does it solve? +- Who would use it? +- What excites you about it? + +**If they're stuck**, offer creative prompts: +- "What domain do you work in? What tasks feel repetitive or could be AI-powered?" +- "Imagine you had a team of AI experts at your disposal — what would you ask them to build?" +- "Is there a module you wish existed?" + +**Capture their initial idea.** We'll explore and expand it in the next steps. + +### 4. Preview the Journey Ahead + +"**Here's where we're going together:**" + +1. Spark — Explore and clarify your idea +2. Module Type — Standalone, Extension, or Global? +3. Vision — What would make this extraordinary? +4. Identity — Name, code, personality +5. Users — Who is this for? +6. Value — What makes it special? +7. Agents — Who's on your team? +8. Workflows — What can we do? +9. Tools — MCP tools, integrations? +10. Scenarios — How will people use it? +11. Creative — Easter eggs, lore, magic ✨ +12. Review — Read through together +13. Finalize — Your complete brief + +"**This is about discovery and creativity. We're not filling out forms — we're designing something amazing together.**" + +### 5. Present MENU OPTIONS + +**Select an Option:** [A] Advanced Elicitation [P] Party Mode [C] Continue + +#### EXECUTION RULES: + +- ALWAYS halt and wait for user input +- ONLY proceed to next step when user selects 'C' +- User can chat or ask questions — always respond and redisplay menu + +#### Menu Handling Logic: + +- IF A: Execute `{advancedElicitationTask}` for deeper idea exploration, then redisplay menu +- IF P: Execute `{partyModeWorkflow}` for creative brainstorming, then redisplay menu +- IF C: Store the mode and initial idea, then load `{nextStepFile}` +- IF Any other: Help user, then redisplay menu + +--- + +## 🚨 SYSTEM SUCCESS/FAILURE METRICS + +### ✅ SUCCESS: + +- User feels welcomed and inspired +- Collaboration mode selected +- Initial idea captured +- User understands the journey ahead + +### ❌ SYSTEM FAILURE: + +- Skipping to technical details prematurely +- Not capturing the initial idea +- Not setting the creative tone +- Rushing through mode selection + +**Master Rule:** This step sets the tone for the entire brief — make it inspiring and collaborative. diff --git a/src/modules/bmb/workflows/module/steps-b/step-02-spark.md b/src/modules/bmb/workflows/module/steps-b/step-02-spark.md new file mode 100644 index 00000000..1a1b17f9 --- /dev/null +++ b/src/modules/bmb/workflows/module/steps-b/step-02-spark.md @@ -0,0 +1,140 @@ +--- +name: 'step-02-spark' +description: 'Ignite the idea, explore problem space, what excites them' + +nextStepFile: './step-03-module-type.md' +moduleStandardsFile: '../data/module-standards.md' +advancedElicitationTask: '../../../../core/workflows/advanced-elicitation/workflow.xml' +partyModeWorkflow: '../../../../core/workflows/party-mode/workflow.md' +--- + +# Step 2: Spark + +## STEP GOAL: + +Ignite and explore the user's idea — dig into the problem space, understand what excites them, and help clarify the vision. + +## MANDATORY EXECUTION RULES (READ FIRST): + +### Universal Rules: + +- 🛑 NEVER generate content without user input +- 📖 CRITICAL: Read the complete step file before taking any action +- 🔄 CRITICAL: When loading next with 'C', ensure entire file is read +- 📋 YOU ARE A FACILITATOR, not a content generator +- ✅ Speak in `{communication_language}` + +### Role Reinforcement: + +- ✅ You are the **Module Architect** — curious, explorative, helping ideas grow +- ✅ Ask open-ended questions that reveal depth +- ✅ Listen more than you speak + +### Step-Specific Rules: + +- 🎯 This is about understanding the problem space, not solving it yet +- 🚫 FORBIDDEN to jump to implementation +- 💬 Ask "why" and "what if" questions + +## EXECUTION PROTOCOLS: + +- 🎯 Follow the MANDATORY SEQUENCE exactly +- 📖 Reference module standards to understand types +- 📖 Load next step when user selects 'C' + +--- + +## MANDATORY SEQUENCE + +**CRITICAL:** Follow this sequence exactly. + +### 1. Connect to Their Idea + +"**Let's explore your idea together.**" + +Reference what they shared in step 1: +- "You mentioned {their idea} — I love that direction." +- "Tell me more about the problem you're solving." + +### 2. Explore the Problem Space + +Ask questions to deepen understanding: + +**"What problem does this module solve?"** + +- Who feels this problem right now? +- What do they currently do without this module? +- What would change if this existed? + +**"What excites you about this idea?"** + +- Why THIS module? Why now? +- What's the vision — the dream outcome? +- If this module succeeds wildly, what does that look like? + +### 3. Identify the Users + +**"Who is this module for?"** + +Help them think about: +- Primary users — who will use this most? +- Secondary users — who else benefits? +- What do these users care about? + +### 4. Adjust for Mode + +**IF mode == Interactive:** +- Deep exploration, multiple rounds of questions +- Use Advanced Elicitation if they want to dig deeper + +**IF mode == Express:** +- Targeted questions, get the key insights quickly +- 2-3 rounds max + +**IF mode == YOLO:** +- Brief clarification, acknowledge what you have +- Move quickly to next step + +### 5. Capture Insights + +Summarize what you've learned: +- "So the core problem is {summary}" +- "The primary users are {users}" +- "What excites you most is {excitement}" + +"**Does this capture your vision? Anything to add or refine?**" + +### 6. Present MENU OPTIONS + +**Select an Option:** [A] Advanced Elicitation [P] Party Mode [C] Continue + +#### EXECUTION RULES: + +- ALWAYS halt and wait for user input +- ONLY proceed to next step when user selects 'C' + +#### Menu Handling Logic: + +- IF A: Execute `{advancedElicitationTask}` for deeper exploration +- IF P: Execute `{partyModeWorkflow}` for creative ideation +- IF C: Load `{nextStepFile}` +- IF Any other: Help user, then redisplay menu + +--- + +## 🚨 SYSTEM SUCCESS/FAILURE METRICS + +### ✅ SUCCESS: + +- Problem space clearly understood +- User excitement identified +- Target users clarified +- Vision feels solid + +### ❌ SYSTEM FAILURE: + +- Skipping to solutions too quickly +- Not understanding the problem +- Not capturing what excites them + +**Master Rule:** Understand before you build. This step is about clarity, not solutions. diff --git a/src/modules/bmb/workflows/module/steps-b/step-03-module-type.md b/src/modules/bmb/workflows/module/steps-b/step-03-module-type.md new file mode 100644 index 00000000..0e5290cc --- /dev/null +++ b/src/modules/bmb/workflows/module/steps-b/step-03-module-type.md @@ -0,0 +1,148 @@ +--- +name: 'step-03-module-type' +description: 'EARLY decision: Standalone, Extension, or Global module?' + +nextStepFile: './step-04-vision.md' +moduleStandardsFile: '../data/module-standards.md' +advancedElicitationTask: '../../../../core/workflows/advanced-elicitation/workflow.xml' +partyModeWorkflow: '../../../../core/workflows/party-mode/workflow.md' +--- + +# Step 3: Module Type + +## STEP GOAL: + +Make the EARLY key decision: Is this a Standalone, Extension, or Global module? This decision affects everything that follows. + +## MANDATORY EXECUTION RULES (READ FIRST): + +### Universal Rules: + +- 🛑 NEVER generate content without user input +- 📖 CRITICAL: Read the complete step file before taking any action +- 🔄 CRITICAL: When loading next with 'C', ensure entire file is read +- 📋 YOU ARE A FACILITATOR, not a content generator +- ✅ Speak in `{communication_language}` + +### Role Reinforcement: + +- ✅ You are the **Module Architect** — you understand module types and their implications +- ✅ Help the user make an informed decision +- ✅ This is a commitment — get it right + +### Step-Specific Rules: + +- 🎯 This decision MUST happen early +- 🚫 FORBIDDEN to proceed without clarity on module type +- 💬 Explain the trade-offs clearly + +## EXECUTION PROTOCOLS: + +- 🎯 Load `{moduleStandardsFile}` to reference module types +- 🎯 Follow the MANDATORY SEQUENCE exactly +- 📖 Load next step when user selects 'C' + +--- + +## MANDATORY SEQUENCE + +**CRITICAL:** Follow this sequence exactly. + +### 1. Explain Module Types + +Load `{moduleStandardsFile}` and present the three types: + +"**Before we go further, we need to decide: What type of module is this?** This decision affects where files go, how installation works, and how the module integrates with BMAD." + +**Standalone Module:** +- A new, independent module +- Own module code and identity +- Installed alongside other modules +- Example: CIS — a creative innovation suite + +**Extension Module:** +- Extends an existing BMAD module +- Shares the base module's code (e.g., `code: bmm`) +- Adds or overrides agents/workflows +- Example: A security extension for BMM + +**Global Module:** +- Affects the entire BMAD framework +- Core functionality impacting all modules +- Rare — use sparingly +- Example: Universal logging/telemetry + +### 2. Determine Type Together + +**"Based on your idea, what type makes sense?"** + +Help them think through: +- **"Is this a brand new domain?"** → Likely Standalone +- **"Does this build on an existing module?"** → Likely Extension +- **"Does this affect all modules?"** → Possibly Global (be cautious) + +**If considering Extension:** +- "Which existing module does it extend?" +- "Are you adding new agents/workflows, or modifying existing ones?" +- "This means your `code:` will match the base module" + +**If considering Global:** +- "Are you sure? Global modules are rare." +- "Could this be a standalone module instead?" + +### 3. Confirm and Store + +Once decided: + +"**Module Type: {Standalone/Extension/Global}**" + +**IF Extension:** +"Base module to extend: {base-module-code}" +"Folder name will be unique: {e.g., bmm-security}" + +**Store this decision.** It affects: +- Where files are created +- What `code:` goes in module.yaml +- Installation behavior + +### 4. Preview Implications + +Briefly explain what this means: +- "As a {type}, your module will {implications}" +- "When we build, files will go to {location}" + +### 5. Present MENU OPTIONS + +**Select an Option:** [A] Advanced Elicitation [P] Party Mode [C] Continue + +#### EXECUTION RULES: + +- ALWAYS halt and wait for user input +- User can change their mind before proceeding +- ONLY proceed to next step when user selects 'C' and confirms the type + +#### Menu Handling Logic: + +- IF A: Execute `{advancedElicitationTask}` for deeper exploration of the decision +- IF P: Execute `{partyModeWorkflow}` for brainstorming the approach +- IF C: Confirm the decision, then load `{nextStepFile}` +- IF Any other: Help user, then redisplay menu + +--- + +## 🚨 SYSTEM SUCCESS/FAILURE METRICS + +### ✅ SUCCESS: + +- Module type clearly decided +- User understands the implications +- Extension modules know their base module +- Decision is stored for later steps + +### ❌ SYSTEM FAILURE: + +- Proceeding without clear module type +- User doesn't understand the implications +- Extension module without clear base + +**Master Rule:** This is a gateway decision. Get clarity before moving forward. diff --git a/src/modules/bmb/workflows/module/steps-b/step-04-vision.md b/src/modules/bmb/workflows/module/steps-b/step-04-vision.md new file mode 100644 index 00000000..ada702aa --- /dev/null +++ b/src/modules/bmb/workflows/module/steps-b/step-04-vision.md @@ -0,0 +1,82 @@ +--- +name: 'step-04-vision' +description: 'Deep dive into the vision — what would make this module extraordinary?' + +nextStepFile: './step-05-identity.md' +advancedElicitationTask: '../../../../core/workflows/advanced-elicitation/workflow.xml' +partyModeWorkflow: '../../../../core/workflows/party-mode/workflow.md' +--- + +# Step 4: Vision + +## STEP GOAL: + +Deep dive into the vision — explore what would make this module extraordinary, not just functional. + +## MANDATORY EXECUTION RULES: + +### Universal Rules: +- 🛑 NEVER generate content without user input +- 📖 CRITICAL: Read the complete step file before taking any action +- 🔄 CRITICAL: When loading next with 'C', ensure entire file is read +- 📋 YOU ARE A FACILITATOR, not a content generator +- ✅ Speak in `{communication_language}` + +### Role Reinforcement: +- ✅ You are the **Module Architect** — visioning, dreaming big +- ✅ Push beyond "good enough" to "extraordinary" +- 💬 Ask "what would make this amazing?" + +### Step-Specific Rules: +- 🎯 This is about the vision, not the details +- 🚫 FORBIDDEN to jump to implementation + +--- + +## MANDATORY SEQUENCE + +### 1. Set the Visioning Tone + +"**Let's dream big. What would make this module extraordinary?**" + +"Good modules solve problems. Great modules inspire people. Let's make yours great." + +### 2. Explore the Vision + +Ask visioning questions: + +**"If this module succeeds wildly, what does that look like?"** +- How are people using it? +- What are they able to do that they couldn't before? +- What's the feeling when they use it? + +**"What would make someone say 'I love this module'?"** +- Delightful features? +- Surprising capabilities? +- The way it makes them feel? + +**"What's the 'secret sauce' — the thing that makes this special?"** + +### 3. Capture the Vision + +Summarize: +- "Your vision: {summary}" +- "What makes it special: {unique aspect}" +- "The dream outcome: {dream}" + +### 4. MENU OPTIONS + +**Select an Option:** [A] Advanced Elicitation [P] Party Mode [C] Continue + +- IF A: Execute `{advancedElicitationTask}` +- IF P: Execute `{partyModeWorkflow}` +- IF C: Load `{nextStepFile}` +- IF Any other: Help, then redisplay + +--- + +## Success Metrics + +✅ Vision feels inspiring and clear +✅ "Extraordinary" elements identified +✅ User excited about the possibility diff --git a/src/modules/bmb/workflows/module/steps-b/step-05-identity.md b/src/modules/bmb/workflows/module/steps-b/step-05-identity.md new file mode 100644 index 00000000..ddb94a00 --- /dev/null +++ b/src/modules/bmb/workflows/module/steps-b/step-05-identity.md @@ -0,0 +1,96 @@ +--- +name: 'step-05-identity' +description: 'Module code, name, and personality/theme' + +nextStepFile: './step-06-users.md' +advancedElicitationTask: '../../../../core/workflows/advanced-elicitation/workflow.xml' +partyModeWorkflow: '../../../../core/workflows/party-mode/workflow.md' +--- + +# Step 5: Identity + +## STEP GOAL: + +Define the module's identity — code, name, and personality/theme. + +## MANDATORY EXECUTION RULES: + +### Universal Rules: +- 🛑 NEVER generate content without user input +- 📖 CRITICAL: Read the complete step file before taking any action +- 🔄 CRITICAL: When loading next with 'C', ensure entire file is read +- 📋 YOU ARE A FACILITATOR, not a content generator +- ✅ Speak in `{communication_language}` + +### Role Reinforcement: +- ✅ You are the **Module Architect** — naming, branding, theming +- ✅ This is where personality comes in +- 💬 Have fun with this! + +### Step-Specific Rules: +- 🎯 Module code follows conventions (kebab-case, 2-20 chars) +- 🚫 FORBIDDEN to use reserved codes or existing module codes (for standalone) + +--- + +## MANDATORY SEQUENCE + +### 1. Module Code + +"**Let's give your module a code.**" + +Explain: +- kebab-case (e.g., `bmm`, `cis`, `healthcare-ai`) +- Short, memorable, descriptive +- 2-20 characters + +**IF Extension:** Code matches base module (already decided) + +**IF Standalone:** Propose options based on the module name/domain + +### 2. Module Name + +"**What's the display name?**" + +This is the human-facing name in module.yaml: +- "BMM: BMad Method Agile-AI Driven-Development" +- "CIS: Creative Innovation Suite" +- "Your Module: Your Description" + +### 3. Personality Theme + +"**Does your module have a personality or theme?**" + +Some modules have fun themes: +- BMM — Agile team (personas like John, Winston) +- CIS — Creative innovators +- BMGD — Game dev team + +**Questions:** +- Should the agents have a consistent theme? +- Any personality vibes? (Corporate team, fantasy party, reality show cast?) +- Or keep it professional/focused? + +### 4. Store Identity + +Capture: +- Module code: `{code}` +- Module name: `{name}` +- Personality theme: `{theme or "none/professional"}` + +### 5. MENU OPTIONS + +**Select an Option:** [A] Advanced Elicitation [P] Party Mode [C] Continue + +- IF A: Execute `{advancedElicitationTask}` +- IF P: Execute `{partyModeWorkflow}` +- IF C: Load `{nextStepFile}` +- IF Any other: Help, then redisplay + +--- + +## Success Metrics + +✅ Module code decided and validated +✅ Module name defined +✅ Personality theme decided (even if "none") diff --git a/src/modules/bmb/workflows/module/steps-b/step-06-users.md b/src/modules/bmb/workflows/module/steps-b/step-06-users.md new file mode 100644 index 00000000..d42639f1 --- /dev/null +++ b/src/modules/bmb/workflows/module/steps-b/step-06-users.md @@ -0,0 +1,85 @@ +--- +name: 'step-06-users' +description: 'Who + How — personas AND user journey combined' + +nextStepFile: './step-07-value.md' +advancedElicitationTask: '../../../../core/workflows/advanced-elicitation/workflow.xml' +partyModeWorkflow: '../../../../core/workflows/party-mode/workflow.md' +--- + +# Step 6: Users + +## STEP GOAL: + +Define who the module is for AND how they'll use it — personas and user journey combined. + +## MANDATORY EXECUTION RULES: + +### Universal Rules: +- 🛑 NEVER generate content without user input +- 📖 CRITICAL: Read the complete step file before taking any action +- 🔄 CRITICAL: When loading next with 'C', ensure entire file is read +- 📋 YOU ARE A FACILITATOR, not a content generator +- ✅ Speak in `{communication_language}` + +### Role Reinforcement: +- ✅ You are the **Module Architect** — user-centric, empathetic +- ✅ Help the user walk in their users' shoes +- 💬 Tell the story of how this will be used + +--- + +## MANDATORY SEQUENCE + +### 1. Define the Users + +"**Let's get specific about who this is for.**" + +**Primary Users:** +- Who will use this module most often? +- What's their role? (developer, designer, analyst, etc.) +- What's their skill level? (beginner, intermediate, expert) + +**Secondary Users:** +- Who else might use it? +- How is their experience different? + +### 2. Build User Personas + +Create 1-2 brief personas: + +**Persona 1:** +- Name/role: {e.g., "Sarah, Software Engineer"} +- Goals: {what they want to accomplish} +- Pain points: {what frustrates them now} +- What success looks like + +### 3. Tell the User Journey Story + +"**Let's walk through how someone would use this module.**" + +Tell a story: +1. User has a problem → {their situation} +2. They load the module → {what they expect} +3. They run an agent/workflow → {what happens} +4. They get a result → {the outcome} +5. This helps them → {the achievement} + +"**Can you see this flow? Does it match what you envision?**" + +### 4. MENU OPTIONS + +**Select an Option:** [A] Advanced Elicitation [P] Party Mode [C] Continue + +- IF A: Execute `{advancedElicitationTask}` +- IF P: Execute `{partyModeWorkflow}` +- IF C: Load `{nextStepFile}` +- IF Any other: Help, then redisplay + +--- + +## Success Metrics + +✅ User personas defined +✅ User journey story told +✅ User can visualize how their module will be used diff --git a/src/modules/bmb/workflows/module/steps-b/step-07-value.md b/src/modules/bmb/workflows/module/steps-b/step-07-value.md new file mode 100644 index 00000000..05de208a --- /dev/null +++ b/src/modules/bmb/workflows/module/steps-b/step-07-value.md @@ -0,0 +1,75 @@ +--- +name: 'step-07-value' +description: 'Unique Value Proposition — what makes this module special?' + +nextStepFile: './step-08-agents.md' +advancedElicitationTask: '../../../../core/workflows/advanced-elicitation/workflow.xml' +partyModeWorkflow: '../../../../core/workflows/party-mode/workflow.md' +--- + +# Step 7: Value + +## STEP GOAL: + +Define the Unique Value Proposition — what makes this module special and why users would choose it. + +## MANDATORY EXECUTION RULES: + +### Universal Rules: +- 🛑 NEVER generate content without user input +- 📖 CRITICAL: Read the complete step file before taking any action +- 🔄 CRITICAL: When loading next with 'C', ensure entire file is read +- 📋 YOU ARE A FACILITATOR, not a content generator +- ✅ Speak in `{communication_language}` + +### Role Reinforcement: +- ✅ You are the **Module Architect** — focused on differentiation +- ✅ Help identify what makes this unique +- 💬 Ask "why this and not something else?" + +--- + +## MANDATORY SEQUENCE + +### 1. Explore Differentiation + +"**What makes your module special? Why would someone choose it?**" + +Ask: +- **What can users do with your module that they can't do otherwise?** +- **What's the 'aha!' moment — when they realize this is exactly what they need?** +- **What problem does this solve better than anything else?** + +### 2. Identify the Unique Value Proposition + +Help craft a clear statement: + +**"For {target users}, {module name} provides {key benefit} unlike {alternatives} because {unique differentiator}."** + +Example: +"For software teams, BMM provides AI-driven agile delivery unlike manual processes because it orchestrates specialized agents for every phase of development." + +### 3. Competitive Context + +**"What else exists in this space? How is yours different?"** + +- Similar modules? +- Manual approaches? +- Why is yours better? + +### 4. MENU OPTIONS + +**Select an Option:** [A] Advanced Elicitation [P] Party Mode [C] Continue + +- IF A: Execute `{advancedElicitationTask}` +- IF P: Execute `{partyModeWorkflow}` +- IF C: Load `{nextStepFile}` +- IF Any other: Help, then redisplay + +--- + +## Success Metrics + +✅ Unique value proposition articulated +✅ Differentiation from alternatives clear +✅ User can explain why someone would choose this module diff --git a/src/modules/bmb/workflows/module/steps-b/step-08-agents.md b/src/modules/bmb/workflows/module/steps-b/step-08-agents.md new file mode 100644 index 00000000..8769ebe9 --- /dev/null +++ b/src/modules/bmb/workflows/module/steps-b/step-08-agents.md @@ -0,0 +1,96 @@ +--- +name: 'step-08-agents' +description: 'Agent architecture — party mode simulation of interactions' + +nextStepFile: './step-09-workflows.md' +agentArchitectureFile: '../data/agent-architecture.md' +advancedElicitationTask: '../../../../core/workflows/advanced-elicitation/workflow.xml' +partyModeWorkflow: '../../../../core/workflows/party-mode/workflow.md' +--- + +# Step 8: Agents + +## STEP GOAL: + +Design the agent architecture — who's on your team? Simulate how agents might interact. + +## MANDATORY EXECUTION RULES: + +### Universal Rules: +- 🛑 NEVER generate content without user input +- 📖 CRITICAL: Read the complete step file before taking any action +- 🔄 CRITICAL: When loading next with 'C', ensure entire file is read +- 📋 YOU ARE A FACILITATOR, not a content generator +- ✅ Speak in `{communication_language}` + +### Role Reinforcement: +- ✅ You are the **Module Architect** — team designer +- ✅ Focus on high-level planning (role, workflows, name, style) +- ✅ Don't worry about YAML format — agent-builder handles that + +### Step-Specific Rules: +- 🎯 Load `{agentArchitectureFile}` for guidance +- 🎯 Party mode is great here — simulate agent interactions +- 🚫 FORBIDDEN to design full agent specs (that's agent-builder's job) + +--- + +## MANDATORY SEQUENCE + +### 1. Single vs Multi-Agent + +Load `{agentArchitectureFile}` and ask: + +**"Could one expert agent handle this entire module, or do you need a team?"** + +Reference: +- **Single agent** — simpler, focused domain +- **Multi-agent** — different expertise areas, broader domain +- **BMM example** — 9 agents for complete software development team + +### 2. Design the Agent Team + +For each agent, capture: + +**Role:** What are they responsible for? +**Workflows:** Which workflows will they trigger? +**Name:** Human name (optional, for personality) +**Communication Style:** How do they talk? +**Memory:** Do they need to remember things over time? (hasSidecar) + +Keep it high-level — don't design full agent specs! + +### 3. Party Mode Simulation + +**"Want to simulate how your agents might interact?"** + +- IF yes: Execute `{partyModeWorkflow}` with different agent personas +- Let them "talk" to each other about a scenario +- This reveals how the team works together + +### 4. Agent Menu Coordination + +Explain the pattern: +- **Shared commands** — all agents have `[WS]` Workflow Status +- **Specialty commands** — each agent has unique commands +- **No overlap** — each command has one owner + +"**What commands might each agent have?**" + +### 5. MENU OPTIONS + +**Select an Option:** [A] Advanced Elicitation [P] Party Mode [C] Continue + +- IF A: Execute `{advancedElicitationTask}` +- IF P: Execute `{partyModeWorkflow}` — great for agent interaction simulation +- IF C: Load `{nextStepFile}` +- IF Any other: Help, then redisplay + +--- + +## Success Metrics + +✅ Single vs multi-agent decided +✅ Agent roles defined +✅ Agent-workflow mappings clear +✅ Agent interactions explored (via party mode if used) diff --git a/src/modules/bmb/workflows/module/steps-b/step-09-workflows.md b/src/modules/bmb/workflows/module/steps-b/step-09-workflows.md new file mode 100644 index 00000000..1feeb9e1 --- /dev/null +++ b/src/modules/bmb/workflows/module/steps-b/step-09-workflows.md @@ -0,0 +1,82 @@ +--- +name: 'step-09-workflows' +description: 'Workflow ecosystem — brainstorm what workflows could exist' + +nextStepFile: './step-10-tools.md' +advancedElicitationTask: '../../../../core/workflows/advanced-elicitation/workflow.xml' +partyModeWorkflow: '../../../../core/workflows/party-mode/workflow.md' +--- + +# Step 9: Workflows + +## STEP GOAL: + +Design the workflow ecosystem — brainstorm what workflows this module needs. + +## MANDATORY EXECUTION RULES: + +### Universal Rules: +- 🛑 NEVER generate content without user input +- 📖 CRITICAL: Read the complete step file before taking any action +- 🔄 CRITICAL: When loading next with 'C', ensure entire file is read +- 📋 YOU ARE A FACILITATOR, not a content generator +- ✅ Speak in `{communication_language}` + +### Role Reinforcement: +- ✅ You are the **Module Architect** — workflow designer +- ✅ Focus on what workflows exist, not their details +- 💬 Brainstorm mode — generate lots of ideas + +### Step-Specific Rules: +- 🎯 Categorize workflows: Core, Feature, Utility +- 🚫 FORBIDDEN to design full workflow specs (that's create-workflow's job) + +--- + +## MANDATORY SEQUENCE + +### 1. Brainstorm Workflows + +"**What workflows should your module have?**" + +Explain categories: +- **Core Workflows** — essential functionality (2-3) +- **Feature Workflows** — specialized capabilities (3-5) +- **Utility Workflows** — supporting operations (1-3) + +Brainstorm together — generate a list! + +### 2. For Each Workflow + +Capture briefly: + +**Workflow name:** {e.g., "Create PRD", "Generate Test Plan"} +**Purpose:** One sentence describing what it does +**Input → Process → Output:** Brief flow +**Agent:** Which agent triggers this? + +### 3. Workflow Connections + +"**How do workflows connect?**" + +- Does workflow A feed into workflow B? +- Are there dependencies? +- What's the typical sequence? + +### 4. MENU OPTIONS + +**Select an Option:** [A] Advanced Elicitation [P] Party Mode [C] Continue + +- IF A: Execute `{advancedElicitationTask}` — great for workflow brainstorming +- IF P: Execute `{partyModeWorkflow}` — different perspectives on workflows +- IF C: Load `{nextStepFile}` +- IF Any other: Help, then redisplay + +--- + +## Success Metrics + +✅ Workflow list generated (core, feature, utility) +✅ Each workflow has a clear purpose +✅ Agent-workflow mappings defined +✅ Workflow connections understood diff --git a/src/modules/bmb/workflows/module/steps-b/step-10-tools.md b/src/modules/bmb/workflows/module/steps-b/step-10-tools.md new file mode 100644 index 00000000..0ead6322 --- /dev/null +++ b/src/modules/bmb/workflows/module/steps-b/step-10-tools.md @@ -0,0 +1,90 @@ +--- +name: 'step-10-tools' +description: 'MCP tools, integrations, external services the module might need' + +nextStepFile: './step-11-scenarios.md' +advancedElicitationTask: '../../../../core/workflows/advanced-elicitation/workflow.xml' +partyModeWorkflow: '../../../../core/workflows/party-mode/workflow.md' +--- + +# Step 10: Tools + +## STEP GOAL: + +Identify MCP tools, integrations, and external services the module might need. + +## MANDATORY EXECUTION RULES: + +### Universal Rules: +- 🛑 NEVER generate content without user input +- 📖 CRITICAL: Read the complete step file before taking any action +- 🔄 CRITICAL: When loading next with 'C', ensure entire file is read +- 📋 YOU ARE A FACILITATOR, not a content generator +- ✅ Speak in `{communication_language}` + +### Role Reinforcement: +- ✅ You are the **Module Architect** — integrations thinker +- ✅ Keep it practical — only what's needed +- 💬 Ask "what external capabilities would help?" + +--- + +## MANDATORY SEQUENCE + +### 1. MCP Tools + +"**Does your module need any MCP (Model Context Protocol) tools?**" + +Explain: MCP tools connect agents to external capabilities. + +Common MCP tools: +- Database connectors +- Git integration +- Web automation (Playwright) +- API tools +- Knowledge bases + +**"What would help your module work better?"** + +### 2. External Services + +"**Any external services or APIs?**" + +- Web APIs? +- Cloud services? +- Data sources? +- Third-party tools? + +### 3. Module Integrations + +"**Does this integrate with other BMAD modules?**** + +- Uses workflows from other modules? +- Shares agents or extends them? +- Depends on another module's capabilities? + +### 4. Capture the List + +Document: +- **MCP Tools:** {list or "none"} +- **External Services:** {list or "none"} +- **Module Integrations:** {list or "none"} + +Note: These are placeholders for later — the create workflow can implement them. + +### 5. MENU OPTIONS + +**Select an Option:** [A] Advanced Elicitation [P] Party Mode [C] Continue + +- IF A: Execute `{advancedElicitationTask}` +- IF P: Execute `{partyModeWorkflow}` +- IF C: Load `{nextStepFile}` +- IF Any other: Help, then redisplay + +--- + +## Success Metrics + +✅ MCP tools identified (or "none" decided) +✅ External services documented (or "none") +✅ Module integrations noted (or "none") diff --git a/src/modules/bmb/workflows/module/steps-b/step-11-scenarios.md b/src/modules/bmb/workflows/module/steps-b/step-11-scenarios.md new file mode 100644 index 00000000..026e811c --- /dev/null +++ b/src/modules/bmb/workflows/module/steps-b/step-11-scenarios.md @@ -0,0 +1,83 @@ +--- +name: 'step-11-scenarios' +description: 'User journey — tell stories of how people will use this module' + +nextStepFile: './step-12-creative.md' +advancedElicitationTask: '../../../../core/workflows/advanced-elicitation/workflow.xml' +partyModeWorkflow: '../../../../core/workflows/party-mode/workflow.md' +--- + +# Step 11: Scenarios + +## STEP GOAL: + +Tell stories of how users will actually use this module — bring the vision to life. + +## MANDATORY EXECUTION RULES: + +### Universal Rules: +- 🛑 NEVER generate content without user input +- 📖 CRITICAL: Read the complete step file before taking any action +- 🔄 CRITICAL: When loading next with 'C', ensure entire file is read +- 📋 YOU ARE A FACILITATOR, not a content generator +- ✅ Speak in `{communication_language}` + +### Role Reinforcement: +- ✅ You are the **Module Architect** — storyteller +- ✅ Paint a picture of actual usage +- 💬 Narrative mode — "imagine this..." + +--- + +## MANDATORY SEQUENCE + +### 1. Set the Scene + +"**Let me tell you a story about how someone will use your module.**" + +"Close your eyes and imagine..." + +### 2. Tell Usage Stories + +Walk through 2-3 scenarios: + +**Scenario 1: First Use** +- User's situation: {context} +- They load the module: {what happens} +- They run an agent: {which agent, what workflow} +- They get a result: {outcome} +- They feel: {emotion} + +**Scenario 2: Advanced Use** +- Power user context +- Complex workflow +- Multiple agents collaborating +- Impressive result + +**Scenario 3: "Aha!" Moment** +- When the module really shines +- Surprising capability +- Delightful experience + +### 3. Validate the Stories + +"**Do these stories feel right? Can you see your module being used this way?**" + +Adjust based on feedback. + +### 4. MENU OPTIONS + +**Select an Option:** [A] Advanced Elicitation [P] Party Mode [C] Continue + +- IF A: Execute `{advancedElicitationTask}` +- IF P: Execute `{partyModeWorkflow}` +- IF C: Load `{nextStepFile}` +- IF Any other: Help, then redisplay + +--- + +## Success Metrics + +✅ 2-3 usage scenarios told +✅ User can visualize their module in action +✅ Stories feel authentic and exciting diff --git a/src/modules/bmb/workflows/module/steps-b/step-12-creative.md b/src/modules/bmb/workflows/module/steps-b/step-12-creative.md new file mode 100644 index 00000000..dc2486c7 --- /dev/null +++ b/src/modules/bmb/workflows/module/steps-b/step-12-creative.md @@ -0,0 +1,94 @@ +--- +name: 'step-12-creative' +description: 'Creative features — easter eggs, lore, delightful touches' + +nextStepFile: './step-13-review.md' +advancedElicitationTask: '../../../../core/workflows/advanced-elicitation/workflow.xml' +partyModeWorkflow: '../../../../core/workflows/party-mode/workflow.md' +--- + +# Step 12: Creative Features + +## STEP GOAL: + +Add the magic — easter eggs, lore, delightful touches that make the module memorable. + +## MANDATORY EXECUTION RULES: + +### Universal Rules: +- 🛑 NEVER generate content without user input +- 📖 CRITICAL: Read the complete step file before taking any action +- 🔄 CRITICAL: When loading next with 'C', ensure entire file is read +- 📋 YOU ARE A FACILITATOR, not a content generator +- ✅ Speak in `{communication_language}` + +### Role Reinforcement: +- ✅ You are the **Module Architect** — creative magician +- ✅ This is where personality comes alive +- 💬 "What would make someone smile?" + +### Step-Specific Rules: +- 🎯 This is optional creativity — not all modules need this +- 🎯 Party mode is perfect here +- ✨ Have fun with it! + +--- + +## MANDATORY SEQUENCE + +### 1. Set the Creative Tone + +"**Now for the fun part — what makes your module delightful?** ✨ + +"Great modules work. Amazing modules have personality. What's yours?" + +### 2. Explore Creative Elements + +**Personality & Theming:** +- Do the agents have running jokes or catchphrases? +- Is there a consistent tone or vibe? +- Any thematic elements? (space, medieval, corporate, etc.) + +**Easter Eggs:** +- Hidden commands or responses? +- Fun interactions when users try certain things? +- Surprises that delight? + +**Module Lore:** +- Backstory for the agents? +- A consistent "universe" the module lives in? +- Narrative elements? + +### 3. Party Mode Ideation + +"**Want to brainstorm creative ideas together?**" + +- IF yes: Execute `{partyModeWorkflow}` with creative focus +- Generate wild ideas +- Keep the gems, discard the rest + +### 4. Capture the Creative Elements + +Document: +- **Personality theme:** {theme or "none"} +- **Easter eggs:** {ideas or "none"} +- **Module lore:** {concepts or "none"} + +Note: These are optional — a module can be great without them. + +### 5. MENU OPTIONS + +**Select an Option:** [A] Advanced Elicitation [P] Party Mode [C] Continue + +- IF A: Execute `{advancedElicitationTask}` +- IF P: Execute `{partyModeWorkflow}` — perfect for creative brainstorming! +- IF C: Load `{nextStepFile}` +- IF Any other: Help, then redisplay + +--- + +## Success Metrics + +✅ Creative elements explored (even if "none") +✅ Personality themes considered +✅ User excited about the possibilities diff --git a/src/modules/bmb/workflows/module/steps-b/step-13-review.md b/src/modules/bmb/workflows/module/steps-b/step-13-review.md new file mode 100644 index 00000000..e28ceb06 --- /dev/null +++ b/src/modules/bmb/workflows/module/steps-b/step-13-review.md @@ -0,0 +1,104 @@ +--- +name: 'step-13-review' +description: 'Read through the brief together, "Does this excite you?"' + +nextStepFile: './step-14-finalize.md' +briefTemplateFile: '../../templates/brief-template.md' +--- + +# Step 13: Review + +## STEP GOAL: + +Read through the brief together and confirm the vision is complete and exciting. + +## MANDATORY EXECUTION RULES: + +### Universal Rules: +- 🛑 NEVER generate content without user input +- 📖 CRITICAL: Read the complete step file before taking any action +- 🔄 CRITICAL: When loading next with 'C', ensure entire file is read +- 📋 YOU ARE A FACILITATOR, not a content generator +- ✅ Speak in `{communication_language}` + +### Role Reinforcement: +- ✅ You are the **Module Architect** — review facilitator +- ✅ Read back what we've discovered +- ✅ Ensure nothing important is missing + +--- + +## MANDATORY SEQUENCE + +### 1. Gather All Decisions + +Collect everything from steps 1-12: + +- Module type: {Standalone/Extension/Global} +- Module code: {code} +- Module name: {name} +- Vision: {vision summary} +- Users: {who it's for} +- Value proposition: {what makes it special} +- Agents: {agent team} +- Workflows: {workflow list} +- Tools: {MCP, integrations} +- Creative features: {personality, easter eggs} + +### 2. Read It Back + +"**Let me read back what we've designed together.**" + +Present the brief in an inspiring way: + +"**Your Module: {name} ({code})**" + +"**Vision:** {vision}" + +"**For:** {users}" + +"**What makes it special:** {value proposition}" + +"**Agent Team:** {agents}" + +"**Key Workflows:** {workflows}" + +"**Creative Touch:** {creative elements}" + +### 3. The Excitement Check + +"**Does this excite you?**** + +- Is this the module you envisioned? +- Anything missing? +- Anything you want to change?" + +**Make updates if needed.** + +### 4. Final Confirmation + +"**Are you happy with this brief? Ready to finalize?**" + +### 5. MENU OPTIONS + +**Select an Option:** [B] Back to refine [C] Continue to Finalize + +#### EXECUTION RULES: + +- ALWAYS halt and wait for user input +- ONLY proceed to next step when user selects 'C' and confirms + +#### Menu Handling Logic: + +- IF B: Go back to specific step to refine (ask which one) +- IF C: Load `{nextStepFile}` +- IF Any other: Ask for clarification, then redisplay menu + +--- + +## Success Metrics + +✅ Brief reviewed completely +✅ User confirms excitement +✅ No major gaps identified +✅ Ready to finalize diff --git a/src/modules/bmb/workflows/module/steps-b/step-14-finalize.md b/src/modules/bmb/workflows/module/steps-b/step-14-finalize.md new file mode 100644 index 00000000..1e7fc4cf --- /dev/null +++ b/src/modules/bmb/workflows/module/steps-b/step-14-finalize.md @@ -0,0 +1,117 @@ +--- +name: 'step-14-finalize' +description: 'Final polish, output the brief document' + +briefTemplateFile: '../../templates/brief-template.md' +bmbCreationsOutputFolder: '{bmb_creations_output_folder}' +--- + +# Step 14: Finalize + +## STEP GOAL: + +Create the final module brief document and save it to the bmb-creations output folder. + +## MANDATORY EXECUTION RULES: + +### Universal Rules: +- 🛑 NEVER generate content without user input +- 📖 CRITICAL: Read the complete step file before taking any action +- ✅ Speak in `{communication_language}` + +### Role Reinforcement: +- ✅ You are the **Module Architect** — completing the brief +- ✅ Assemble everything into a beautiful document +- ✅ Celebrate the completion! + +--- + +## MANDATORY SEQUENCE + +### 1. Load Template + +Load `{briefTemplateFile}` to use as the base. + +### 2. Assemble the Brief + +Fill in all sections with what we've gathered: + +**Frontmatter:** +- date: {today's date} +- user_name: {from config} +- module_code: {from step 5} +- module_type: {from step 3} +- status: "Ready for Development" + +**Executive Summary:** +- module_vision: {from step 4} +- module_category: {derived from vision} +- target_users: {from step 6} +- complexity_level: {assess from agent/workflow count} + +**Module Identity:** +- module_code, module_name: {from step 5} +- module_identity: {vision summary} +- personality_theme: {from step 5 or step 12} + +**Module Type:** +- module_type: {from step 3} +- module_type_explanation: {explain the choice} + +**Unique Value Proposition:** +- unique_value_proposition: {from step 7} +- value_proposition_details: {elaborate} + +**User Scenarios:** +- target_users: {from step 6} +- primary_use_case: {from step 11} +- user_journey: {from step 11} + +**Agent Architecture:** +- agent_count_strategy: {single or multi, why} +- agent_roster_table: {from step 8} +- agent_interaction_model: {how they work together} +- agent_communication_style: {from step 8} + +**Workflow Ecosystem:** +- core_workflows: {from step 9} +- feature_workflows: {from step 9} +- utility_workflows: {from step 9} + +**Tools & Integrations:** +- mcp_tools: {from step 10} +- external_services: {from step 10} +- module_integrations: {from step 10} + +**Creative Features:** +- creative_personality: {from step 12} +- easter_eggs: {from step 12} +- module_lore: {from step 12} + +### 3. Write the Brief File + +Save to: `{bmbCreationsOutputFolder}/modules/module-brief-{module_code}.md` + +### 4. Celebrate and Next Steps + +"**🎉 Your module brief is complete!**" + +"**Saved to:** {file path}" + +"**Next steps:**" +1. **Review the brief** — Make sure it captures your vision +2. **Run the module workflow (Create mode)** — This will build the module structure +3. **Create agents** — Use the agent-builder workflow for each agent +4. **Create workflows** — Use the workflow-builder workflow for each workflow +5. **Test and iterate** — Install and refine + +"**You've created something amazing. Let's build it!**" + +--- + +## Success Metrics + +✅ Brief document created and saved +✅ All sections filled with gathered information +✅ File path provided to user +✅ Next steps clearly explained diff --git a/src/modules/bmb/workflows/module/steps-c/step-01-load-brief.md b/src/modules/bmb/workflows/module/steps-c/step-01-load-brief.md new file mode 100644 index 00000000..f89a763c --- /dev/null +++ b/src/modules/bmb/workflows/module/steps-c/step-01-load-brief.md @@ -0,0 +1,178 @@ +--- +name: 'step-01-load-brief' +description: 'Load brief or user write-up, validate completeness' + +nextStepFile: './step-02-structure.md' +continueFile: './step-01b-continue.md' +agentSpecTemplate: '../../templates/agent-spec-template.md' +workflowSpecTemplate: '../../templates/workflow-spec-template.md' +moduleStandardsFile: '../../data/module-standards.md' +moduleYamlConventionsFile: '../../data/module-yaml-conventions.md' +advancedElicitationTask: '../../../../core/workflows/advanced-elicitation/workflow.xml' +partyModeWorkflow: '../../../../core/workflows/party-mode/workflow.md' +--- + +# Step 1: Load Brief (Create Mode) + +## STEP GOAL: + +Load the module brief (or get a detailed user write-up) and validate it has the information needed to build the module. + +## MANDATORY EXECUTION RULES: + +### Universal Rules: + +- 🛑 NEVER generate content without user input +- 📖 CRITICAL: Read the complete step file before taking any action +- 🔄 CRITICAL: When loading next with 'C', ensure entire file is read +- 📋 YOU ARE A FACILITATOR, not a content generator +- ✅ Speak in `{communication_language}` + +### Role Reinforcement: + +- ✅ You are the **Module Builder** — structured, competent, ready to build +- ✅ Validate input before proceeding +- ✅ Ensure we have what we need to succeed + +### Step-Specific Rules: + +- 🎯 This is a continuable workflow — check for existing work +- 🚫 FORBIDDEN to proceed without complete brief or write-up +- 💾 Track progress for continuation + +## EXECUTION PROTOCOLS: + +- 🎯 Follow the MANDATORY SEQUENCE exactly +- 📖 Create/update output file to track progress +- 🚫 FORBIDDEN to load next step until brief is validated + +## CONTEXT BOUNDARIES: + +- Input: Module brief from Brief mode OR user-provided write-up +- Output: Module structure ready for implementation +- This mode requires complete information to proceed + +--- + +## MANDATORY SEQUENCE + +**CRITICAL:** Follow this sequence exactly. + +### 1. Check for Existing Work + +Look for existing module build state: +- Check for `module-build-{module_code}.md` in output folder +- If exists AND has `stepsCompleted` → load `{continueFile}` +- If not exists → continue to step 1.2 + +### 2. Get the Brief or Write-Up + +"**Welcome to Create mode! I'll build your module structure from your brief.**" + +**"Where is your module brief?"** + +Options: +- **A)** Brief from Brief mode → `{bmb_creations_output_folder}/modules/module-brief-{code}.md` +- **B)** User-provided write-up → Ask for path +- **C)** Detailed description → User describes the module now + +**IF A or B:** Load and read the brief/write-up + +**IF C:** Gather the needed information through conversation: +- Module name and code +- Module type (Standalone/Extension/Global) +- Agent roster (roles, names) +- Workflow list +- Key features and tools + +### 3. Validate Brief Completeness + +Load `{moduleStandardsFile}` and check that the brief contains: + +**Required Information:** +- [ ] Module code and name +- [ ] Module type (Standalone/Extension/Global) +- [ ] Module vision/purpose +- [ ] Agent roster (at least minimum) +- [ ] Workflow list (at least core workflows) +- [ ] Any special tools or integrations + +**IF Extension Module:** +- [ ] Base module code (for matching) + +**IF anything missing:** + +"**Your brief is missing some key information. Let me help you complete it.**" + +Use `{advancedElicitationTask}` if needed to gather missing details. + +### 4. Confirm and Create Tracking + +Once validated: + +"**I have everything I need to build your module!**" + +"**Module:** {name} ({code})" +"**Type:** {Standalone/Extension/Global}" + +Create or update the build tracking file: + +```yaml +--- +moduleCode: {code} +moduleName: {name} +moduleType: {type} +briefFile: {brief path or "user-provided"} +stepsCompleted: ['step-01-load-brief'] +created: {date} +status: IN_PROGRESS +--- +``` + +### 5. Preview the Build Process + +"**Here's what I'll build for you:**" + +1. Directory structure (based on module type) +2. module.yaml with install configuration +3. _module-installer/ folder (if needed) +4. Agent placeholder/spec files +5. Workflow placeholder/spec files +6. README.md and TODO.md + +"**Ready to start building?**" + +### 6. Present MENU OPTIONS + +**Select an Option:** [A] Advanced Elicitation [P] Party Mode [C] Continue + +#### EXECUTION RULES: + +- ALWAYS halt and wait for user input +- ONLY proceed to next step when user selects 'C' + +#### Menu Handling Logic: + +- IF A: Execute `{advancedElicitationTask}` for any refinements +- IF P: Execute `{partyModeWorkflow}` for creative pre-build discussion +- IF C: Update tracking file, then load `{nextStepFile}` +- IF Any other: Help user, then redisplay menu + +--- + +## 🚨 SYSTEM SUCCESS/FAILURE METRICS + +### ✅ SUCCESS: + +- Brief or write-up loaded +- All required information validated +- Tracking file created +- User confirms ready to build + +### ❌ SYSTEM FAILURE: + +- Proceeding with incomplete brief +- Missing key information (code, type, agents, workflows) +- Not validating extension base module + +**Master Rule:** Garbage in, garbage out. Ensure we have complete information before building. diff --git a/src/modules/bmb/workflows/module/steps-c/step-01b-continue.md b/src/modules/bmb/workflows/module/steps-c/step-01b-continue.md new file mode 100644 index 00000000..1f10ff64 --- /dev/null +++ b/src/modules/bmb/workflows/module/steps-c/step-01b-continue.md @@ -0,0 +1,83 @@ +--- +name: 'step-01b-continue' +description: 'Handle workflow continuation for Create mode' + +workflowFile: '../workflow.md' +buildTrackingFile: '{bmb_creations_output_folder}/modules/module-build-{module_code}.md' +--- + +# Step 1b: Continue (Create Mode) + +## STEP GOAL: + +Resume a paused Create mode session by loading the build tracking state and routing to the correct step. + +## MANDATORY EXECUTION RULES: + +### Universal Rules: + +- 📖 CRITICAL: Read the complete step file before taking any action +- ✅ Speak in `{communication_language}` + +### Role Reinforcement: + +- ✅ You are the **Module Builder** — picking up where we left off +- ✅ Warm welcome back +- ✅ Seamless resume + +--- + +## MANDATORY SEQUENCE + +### 1. Welcome Back + +"**Welcome back to the Module Builder!** 👋" + +### 2. Load Build Tracking + +Load `{buildTrackingFile}` and read: +- `stepsCompleted` array +- `moduleCode` +- `moduleName` +- `moduleType` +- `status` + +### 3. Report Progress + +"**Here's where we are:**" + +**Module:** {moduleName} ({moduleCode}) +**Type:** {moduleType} +**Status:** {status} + +**Completed steps:** +- {list completed steps} + +### 4. Determine Next Step + +Find the last completed step and route to the next one: + +| Last Completed | Next Step | +|---------------|-----------| +| step-01-load-brief | step-02-structure | +| step-02-structure | step-03-config | +| step-03-config | step-04-installer | +| step-04-installer | step-05-agents | +| step-05-agents | step-06-workflows | +| step-06-workflows | step-07-docs | +| step-07-docs | step-08-complete | + +### 5. Route to Next Step + +"**Continuing to: {next step name}**" + +Load the appropriate step file and execute. + +--- + +## Success Metrics + +✅ User welcomed back +✅ Build state loaded +✅ Correct next step identified +✅ Seamless resume diff --git a/src/modules/bmb/workflows/module/steps-c/step-02-structure.md b/src/modules/bmb/workflows/module/steps-c/step-02-structure.md new file mode 100644 index 00000000..0bb90e6c --- /dev/null +++ b/src/modules/bmb/workflows/module/steps-c/step-02-structure.md @@ -0,0 +1,109 @@ +--- +name: 'step-02-structure' +description: 'Create directory structure based on module type' + +nextStepFile: './step-03-config.md' +moduleStandardsFile: '../../data/module-standards.md' +buildTrackingFile: '{bmb_creations_output_folder}/modules/module-build-{module_code}.md' +--- + +# Step 2: Directory Structure + +## STEP GOAL: + +Create the module directory structure based on the module type (Standalone/Extension/Global). + +## MANDATORY EXECUTION RULES: + +### Universal Rules: + +- 🛑 NEVER generate content without user input +- 📖 CRITICAL: Read the complete step file before taking any action +- 🔄 CRITICAL: When loading next with 'C', ensure entire file is read +- 📋 YOU ARE A FACILITATOR, not a content generator +- ✅ Speak in `{communication_language}` + +### Role Reinforcement: + +- ✅ You are the **Module Builder** — creating the foundation +- ✅ Structure follows standards +- ✅ Confirm before creating + +--- + +## MANDATORY SEQUENCE + +### 1. Determine Target Location + +Load `{moduleStandardsFile}` and determine location: + +**IF Standalone:** +- Target: `src/modules/{module_code}/` + +**IF Extension:** +- Target: `src/modules/{base_module_code}/extensions/{extension_folder_name}/` +- Get base_module_code from brief +- extension_folder_name: unique name (e.g., `{base_module}-{feature}`) + +**IF Global:** +- Target: `src/modules/{module_code}/` +- Will add `global: true` to module.yaml + +### 2. Present Structure Plan + +"**I'll create this directory structure:**" + +``` +{target_location}/ +├── module.yaml +├── README.md +├── agents/ +│ └── {agent files} +├── workflows/ +│ └── {workflow folders} +└── _module-installer/ + ├── installer.js + └── platform-specifics/ +``` + +"**Location:** {target_location}" +"**Module type:** {Standalone/Extension/Global}" + +### 3. Confirm and Create + +"**Shall I create the directory structure?**" + +**IF confirmed:** + +Create folders: +- `{target_location}/agents/` +- `{target_location}/workflows/` +- `{target_location}/_module-installer/` +- `{target_location}/_module-installer/platform-specifics/` + +### 4. Update Build Tracking + +Update `{buildTrackingFile}`: +- Add 'step-02-structure' to stepsCompleted +- Set targetLocation +- Update status + +### 5. Report Success + +"**✓ Directory structure created at:** {target_location}" + +### 6. MENU OPTIONS + +**Select an Option:** [C] Continue + +- IF C: Update tracking, load `{nextStepFile}` +- IF Any other: Help, then redisplay menu + +--- + +## Success Metrics + +✅ Directory structure created +✅ Location based on module type +✅ Folders: agents/, workflows/, _module-installer/ +✅ Build tracking updated diff --git a/src/modules/bmb/workflows/module/steps-c/step-03-config.md b/src/modules/bmb/workflows/module/steps-c/step-03-config.md new file mode 100644 index 00000000..c4c02559 --- /dev/null +++ b/src/modules/bmb/workflows/module/steps-c/step-03-config.md @@ -0,0 +1,118 @@ +--- +name: 'step-03-config' +description: 'Generate module.yaml with install questions' + +nextStepFile: './step-04-installer.md' +moduleYamlConventionsFile: '../../data/module-yaml-conventions.md' +buildTrackingFile: '{bmb_creations_output_folder}/modules/module-build-{module_code}.md' +targetLocation: '{build_tracking_targetLocation}' +--- + +# Step 3: Module Configuration + +## STEP GOAL: + +Generate module.yaml with install configuration and custom variables. + +## MANDATORY EXECUTION RULES: + +### Universal Rules: + +- 🛑 NEVER generate content without user input +- 📖 CRITICAL: Read the complete step file before taking any action +- 🔄 CRITICAL: When loading next with 'C', ensure entire file is read +- 📋 YOU ARE A FACILITATOR, not a content generator +- ✅ Speak in `{communication_language}` + +### Role Reinforcement: + +- ✅ You are the **Module Builder** — configuration expert +- ✅ Follow module.yaml conventions +- ✅ Ask about custom variables + +--- + +## MANDATORY SEQUENCE + +### 1. Load Conventions + +Load `{moduleYamlConventionsFile}` for reference. + +### 2. Generate Base module.yaml + +Create `{targetLocation}/module.yaml` with: + +**Required fields:** +```yaml +code: {module_code} +name: "{module_display_name}" +header: "{brief_header}" +subheader: "{additional_context}" +default_selected: false +``` + +**Note for Extension modules:** `code:` matches base module + +### 3. Add Custom Variables + +"**Does your module need any custom configuration variables?**" + +Reference the brief for: +- User input needed during installation +- Paths or settings users should configure +- Feature flags or options + +**For each variable, create:** +```yaml +variable_name: + prompt: "{question to ask}" + default: "{default_value}" + result: "{template}" +``` + +**Common patterns:** +- Text input (names, titles) +- Boolean (enable features) +- Single-select (experience levels) +- Multi-select (platforms) +- Paths (artifact folders) + +**IF no custom variables needed:** + +Keep it simple — just use core config variables. + +### 4. Write module.yaml + +Write the complete module.yaml to `{targetLocation}/module.yaml` + +### 5. Update Build Tracking + +Update `{buildTrackingFile}`: +- Add 'step-03-config' to stepsCompleted +- Note: module.yaml created + +### 6. Report and Confirm + +"**✓ module.yaml created with:**" + +- Code: {code} +- {count} custom variables + +"**Review the file and confirm it looks correct.**" + +### 7. MENU OPTIONS + +**Select an Option:** [C] Continue + +- IF C: Update tracking, load `{nextStepFile}` +- IF Any other: Help, then redisplay menu + +--- + +## Success Metrics + +✅ module.yaml created +✅ Required fields populated +✅ Custom variables added (if any) +✅ Extension modules use correct code +✅ Build tracking updated diff --git a/src/modules/bmb/workflows/module/steps-c/step-04-installer.md b/src/modules/bmb/workflows/module/steps-c/step-04-installer.md new file mode 100644 index 00000000..229519c3 --- /dev/null +++ b/src/modules/bmb/workflows/module/steps-c/step-04-installer.md @@ -0,0 +1,160 @@ +--- +name: 'step-04-installer' +description: 'Setup _module-installer folder and installer.js' + +nextStepFile: './step-05-agents.md' +moduleInstallerStandardsFile: '../../data/module-installer-standards.md' +buildTrackingFile: '{bmb_creations_output_folder}/modules/module-build-{module_code}.md' +targetLocation: '{build_tracking_targetLocation}' +--- + +# Step 4: Module Installer + +## STEP GOAL: + +Setup the _module-installer folder and create installer.js if needed. + +## MANDATORY EXECUTION RULES: + +### Universal Rules: + +- 🛑 NEVER generate content without user input +- 📖 CRITICAL: Read the complete step file before taking any action +- 🔄 CRITICAL: When loading next with 'C', ensure entire file is read +- 📋 YOU ARE A FACILITATOR, not a content generator +- ✅ Speak in `{communication_language}` + +### Role Reinforcement: + +- ✅ You are the **Module Builder** — installer expert +- ✅ Not all modules need installers +- ✅ Follow installer patterns + +--- + +## MANDATORY SEQUENCE + +### 1. Assess Need for Installer + +Load `{moduleInstallerStandardsFile}` and ask: + +"**Does your module need an installer?**" + +Installers are needed when: +- Creating directories from config variables +- Copying template/assets +- IDE-specific configuration +- Platform-specific setup + +**If NO installer needed:** + +Skip to step 5. Folder structure already exists. + +**If YES:** Continue to step 4.2 + +### 2. Determine Installer Requirements + +"**What should the installer do?**" + +- Create directories? (which variables) +- Copy assets? (from where) +- IDE configuration? (which IDEs) +- Platform-specific setup? + +### 3. Create installer.js + +Create `{targetLocation}/_module-installer/installer.js`: + +```javascript +const fs = require('fs-extra'); +const path = require('node:path'); +const chalk = require('chalk'); +const platformCodes = require(path.join(__dirname, '../../../../tools/cli/lib/platform-codes')); + +/** + * {module_name} Module Installer + */ +async function install(options) { + const { projectRoot, config, installedIDEs, logger } = options; + + try { + logger.log(chalk.blue('Installing {module_name}...')); + + // Create directories + if (config['{variable_name}']) { + const dirConfig = config['{variable_name}'].replace('{project-root}/', ''); + const dirPath = path.join(projectRoot, dirConfig); + if (!(await fs.pathExists(dirPath))) { + logger.log(chalk.yellow(`Creating directory: ${dirConfig}`)); + await fs.ensureDir(dirPath); + } + } + + // IDE-specific configuration + if (installedIDEs && installedIDEs.length > 0) { + for (const ide of installedIDEs) { + await configureForIDE(ide, projectRoot, config, logger); + } + } + + logger.log(chalk.green('✓ {module_name} installation complete')); + return true; + } catch (error) { + logger.error(chalk.red(`Error installing module: ${error.message}`)); + return false; + } +} + +async function configureForIDE(ide, projectRoot, config, logger) { + if (!platformCodes.isValidPlatform(ide)) { + logger.warn(chalk.yellow(`Unknown platform: '${ide}'. Skipping.`)); + return; + } + + const platformSpecificPath = path.join(__dirname, 'platform-specifics', `${ide}.js`); + + try { + if (await fs.pathExists(platformSpecificPath)) { + const platformHandler = require(platformSpecificPath); + if (typeof platformHandler.install === 'function') { + await platformHandler.install({ projectRoot, config, logger }); + } + } + } catch (error) { + logger.warn(chalk.yellow(`Warning: Could not configure ${ide}: ${error.message}`)); + } +} + +module.exports = { install }; +``` + +Customize based on module requirements. + +### 4. Platform-Specific Handlers (Optional) + +If IDE-specific setup needed, ask which IDEs and create: +- `{targetLocation}/_module-installer/platform-specifics/claude-code.js` +- `{targetLocation}/_module-installer/platform-specifics/windsurf.js` +- etc. + +### 5. Update Build Tracking + +Update `{buildTrackingFile}`: +- Add 'step-04-installer' to stepsCompleted +- Note: installer created or skipped + +### 6. MENU OPTIONS + +**Select an Option:** [C] Continue + +- IF C: Update tracking, load `{nextStepFile}` +- IF Any other: Help, then redisplay menu + +--- + +## Success Metrics + +✅ Assessed installer need +✅ installer.js created (if needed) +✅ Platform handlers created (if needed) +✅ Build tracking updated diff --git a/src/modules/bmb/workflows/module/steps-c/step-05-agents.md b/src/modules/bmb/workflows/module/steps-c/step-05-agents.md new file mode 100644 index 00000000..5c89aad2 --- /dev/null +++ b/src/modules/bmb/workflows/module/steps-c/step-05-agents.md @@ -0,0 +1,167 @@ +--- +name: 'step-05-agents' +description: 'Create agent placeholder/spec files' + +nextStepFile: './step-06-workflows.md' +agentSpecTemplate: '../../templates/agent-spec-template.md' +agentArchitectureFile: '../../data/agent-architecture.md' +buildTrackingFile: '{bmb_creations_output_folder}/modules/module-build-{module_code}.md' +targetLocation: '{build_tracking_targetLocation}' +--- + +# Step 5: Agent Specs + +## STEP GOAL: + +Create agent placeholder/spec files based on the brief. + +## MANDATORY EXECUTION RULES: + +### Universal Rules: + +- 🛑 NEVER generate content without user input +- 📖 CRITICAL: Read the complete step file before taking any action +- 🔄 CRITICAL: When loading next with 'C', ensure entire file is read +- 📋 YOU ARE A FACILITATOR, not a content generator +- ✅ Speak in `{communication_language}` + +### Role Reinforcement: + +- ✅ You are the **Module Builder** — creating agent specs +- ✅ These are specs, not full agents (agent-builder does that) +- ✅ Keep it high-level + +--- + +## MANDATORY SEQUENCE + +### 1. Load Agent Architecture + +Load `{agentArchitectureFile}` for guidance. + +### 2. Get Agent Roster from Brief + +Extract from the brief: +- Agent names +- Roles +- Workflows they're responsible for +- Communication style +- Memory needs (hasSidecar) + +### 3. For Each Agent, Create Spec + +Load `{agentSpecTemplate}` and create: + +`{targetLocation}/agents/{agent_name}.spec.md` + +With content: +```markdown +# Agent Specification: {agent_name} + +**Module:** {module_code} +**Status:** Placeholder — To be created via create-agent workflow +**Created:** {date} + +--- + +## Agent Metadata + +```yaml +agent: + metadata: + id: "_bmad/{module_code}/agents/{agent_file_name}.md" + name: {agent_human_name} + title: {agent_title} + icon: {agent_icon} + module: {module_code} + hasSidecar: {false/true} +``` + +--- + +## Agent Persona + +### Role + +{agent_role} + +### Identity + +{agent_identity} + +### Communication Style + +{agent_communication_style} + +### Principles + +{agent_principles} + +--- + +## Agent Menu + +### Planned Commands + +| Trigger | Command | Description | Workflow | +|---------|---------|-------------|----------| +{agent_menu_table} + +--- + +## Agent Integration + +### Shared Context + +- References: `{shared_context_files}` +- Collaboration with: {collaborating_agents} + +### Workflow References + +{workflow_references} + +--- + +## Implementation Notes + +**Use the create-agent workflow to build this agent.** + +--- + +_Spec created on {date} via BMAD Module workflow_ +``` + +### 4. Create All Agent Specs + +Iterate through each agent from the brief and create their spec file. + +### 5. Update Build Tracking + +Update `{buildTrackingFile}`: +- Add 'step-05-agents' to stepsCompleted +- List all agent specs created + +### 6. Report Success + +"**✓ Agent specs created:**" + +- {count} agent spec files +- {list agent names} + +"**These are specs/blueprints. Use the create-agent workflow to build each agent.**" + +### 7. MENU OPTIONS + +**Select an Option:** [C] Continue + +- IF C: Update tracking, load `{nextStepFile}` +- IF Any other: Help, then redisplay menu + +--- + +## Success Metrics + +✅ Agent spec files created for all agents +✅ Each spec has role, workflows, menu triggers +✅ hasSidecar documented (memory decision) +✅ Build tracking updated diff --git a/src/modules/bmb/workflows/module/steps-c/step-06-workflows.md b/src/modules/bmb/workflows/module/steps-c/step-06-workflows.md new file mode 100644 index 00000000..7544c0af --- /dev/null +++ b/src/modules/bmb/workflows/module/steps-c/step-06-workflows.md @@ -0,0 +1,183 @@ +--- +name: 'step-06-workflows' +description: 'Create workflow placeholder/spec files' + +nextStepFile: './step-07-docs.md' +workflowSpecTemplate: '../../templates/workflow-spec-template.md' +buildTrackingFile: '{bmad_creations_output_folder}/modules/module-build-{module_code}.md' +targetLocation: '{build_tracking_targetLocation}' +--- + +# Step 6: Workflow Specs + +## STEP GOAL: + +Create workflow placeholder/spec files based on the brief. + +## MANDATORY EXECUTION RULES: + +### Universal Rules: + +- 🛑 NEVER generate content without user input +- 📖 CRITICAL: Read the complete step file before taking any action +- 🔄 CRITICAL: When loading next with 'C', ensure entire file is read +- 📋 YOU ARE A FACILITATOR, not a content generator +- ✅ Speak in `{communication_language}` + +### Role Reinforcement: + +- ✅ You are the **Module Builder** — creating workflow specs +- ✅ These are specs, not full workflows (workflow-builder does that) +- ✅ Keep it high-level + +--- + +## MANDATORY SEQUENCE + +### 1. Get Workflow List from Brief + +Extract from the brief: +- Core workflows +- Feature workflows +- Utility workflows + +For each workflow: +- Name +- Purpose/goal +- Primary agent +- Input/output requirements + +### 2. For Each Workflow, Create Spec + +Load `{workflowSpecTemplate}` and create: + +`{targetLocation}/workflows/{workflow_name}/{workflow_name}.spec.md` + +With content: +```markdown +# Workflow Specification: {workflow_name} + +**Module:** {module_code} +**Status:** Placeholder — To be created via create-workflow workflow +**Created:** {date} + +--- + +## Workflow Overview + +**Goal:** {workflow_goal} + +**Description:** {workflow_description} + +**Workflow Type:** {workflow_type} + +--- + +## Workflow Structure + +### Entry Point + +```yaml +--- +name: {workflow_name} +description: {workflow_description} +web_bundle: true +installed_path: '{project-root}/_bmad/{module_code}/workflows/{workflow_folder_name}' +--- +``` + +### Mode + +- [ ] Create-only (steps-c/) +- [ ] Tri-modal (steps-c/, steps-e/, steps-v/) + +--- + +## Planned Steps + +| Step | Name | Goal | +|------|------|------| +{workflow_steps_table} + +--- + +## Workflow Inputs + +### Required Inputs + +{required_inputs} + +### Optional Inputs + +{optional_inputs} + +--- + +## Workflow Outputs + +### Output Format + +- [ ] Document-producing +- [ ] Non-document + +### Output Files + +{output_files} + +--- + +## Agent Integration + +### Primary Agent + +{primary_agent} + +### Other Agents + +{other_agents} + +--- + +## Implementation Notes + +**Use the create-workflow workflow to build this workflow.** + +--- + +_Spec created on {date} via BMAD Module workflow_ +``` + +### 3. Create All Workflow Specs + +Iterate through each workflow from the brief and create their spec file. + +### 4. Update Build Tracking + +Update `{buildTrackingFile}`: +- Add 'step-06-workflows' to stepsCompleted +- List all workflow specs created + +### 5. Report Success + +"**✓ Workflow specs created:**" + +- {count} workflow spec files +- {list workflow names} + +"**These are specs/blueprints. Use the create-workflow workflow to build each workflow.**" + +### 6. MENU OPTIONS + +**Select an Option:** [C] Continue + +- IF C: Update tracking, load `{nextStepFile}` +- IF Any other: Help, then redisplay menu + +--- + +## Success Metrics + +✅ Workflow spec files created for all workflows +✅ Each spec has goal, steps, inputs/outputs +✅ Agent associations documented +✅ Build tracking updated diff --git a/src/modules/bmb/workflows/module/steps-c/step-07-docs.md b/src/modules/bmb/workflows/module/steps-c/step-07-docs.md new file mode 100644 index 00000000..320cd004 --- /dev/null +++ b/src/modules/bmb/workflows/module/steps-c/step-07-docs.md @@ -0,0 +1,402 @@ +--- +name: 'step-07-docs' +description: 'Generate README.md, TODO.md, and docs/ folder' + +nextStepFile: './step-08-complete.md' +buildTrackingFile: '{bmb_creations_output_folder}/modules/module-build-{module_code}.md' +targetLocation: '{build_tracking_targetLocation}' +--- + +# Step 7: Documentation + +## STEP GOAL: + +Generate README.md, TODO.md, and user documentation in docs/ folder for the module. + +## MANDATORY EXECUTION RULES: + +### Universal Rules: + +- 🛑 NEVER generate content without user input +- 📖 CRITICAL: Read the complete step file before taking any action +- 🔄 CRITICAL: When loading next with 'C', ensure entire file is read +- 📋 YOU ARE A FACILITATOR, not a content generator +- ✅ Speak in `{communication_language}` + +### Role Reinforcement: + +- ✅ You are the **Module Builder** — documentation creator +- ✅ README is the user's first impression +- ✅ TODO tracks remaining work +- ✅ docs/ provides user-facing documentation + +--- + +## MANDATORY SEQUENCE + +### 1. Generate README.md + +Create `{targetLocation}/README.md`: + +```markdown +# {module_display_name} + +{brief_header} + +{subheader} + +--- + +## Overview + +{module_overview_from_brief} + +--- + +## Installation + +```bash +bmad install {module_code} +``` + +--- + +## Quick Start + +{quick_start_from_brief} + +**For detailed documentation, see [docs/](docs/).** + +--- + +## Components + +### Agents + +{agent_list_from_brief} + +### Workflows + +{workflow_list_from_brief} + +--- + +## Configuration + +The module supports these configuration options (set during installation): + +{config_variables_from_module_yaml} + +--- + +## Module Structure + +``` +{module_code}/ +├── module.yaml +├── README.md +├── TODO.md +├── docs/ +│ ├── getting-started.md +│ ├── agents.md +│ ├── workflows.md +│ └── examples.md +├── agents/ +├── workflows/ +└── _module-installer/ +``` + +--- + +## Documentation + +For detailed user guides and documentation, see the **[docs/](docs/)** folder: +- [Getting Started](docs/getting-started.md) +- [Agents Reference](docs/agents.md) +- [Workflows Reference](docs/workflows.md) +- [Examples](docs/examples.md) + +--- + +## Development Status + +This module is currently in development. The following components are planned: + +- [ ] Agents: {agent_count} agents +- [ ] Workflows: {workflow_count} workflows + +See TODO.md for detailed status. + +--- + +## Author + +Created via BMAD Module workflow + +--- + +## License + +Part of the BMAD framework. +``` + +### 2. Generate TODO.md + +Create `{targetLocation}/TODO.md`: + +```markdown +# TODO: {module_display_name} + +Development roadmap for {module_code} module. + +--- + +## Agents to Build + +{for each agent} +- [ ] {agent_name} ({agent_title}) + - Use: `bmad:bmb:agents:agent-builder` + - Spec: `agents/{agent_name}.spec.md` + +--- + +## Workflows to Build + +{for each workflow} +- [ ] {workflow_name} + - Use: `bmad:bmb:workflows:workflow` or `/workflow` + - Spec: `workflows/{workflow_name}/{workflow_name}.spec.md` + +--- + +## Installation Testing + +- [ ] Test installation with `bmad install` +- [ ] Verify module.yaml prompts work correctly +- [ ] Test installer.js (if present) +- [ ] Test IDE-specific handlers (if present) + +--- + +## Documentation + +- [ ] Complete README.md with usage examples +- [ ] Enhance docs/ folder with more guides +- [ ] Add troubleshooting section +- [ ] Document configuration options + +--- + +## Next Steps + +1. Build agents using create-agent workflow +2. Build workflows using create-workflow workflow +3. Test installation and functionality +4. Iterate based on testing + +--- + +_Last updated: {date}_ +``` + +### 3. Create docs/ Folder + +Create `{targetLocation}/docs/` folder with user documentation: + +### 3.1. getting-started.md + +```markdown +# Getting Started with {module_display_name} + +Welcome to {module_code}! This guide will help you get up and running. + +--- + +## What This Module Does + +{module_purpose_from_brief} + +--- + +## Installation + +If you haven't installed the module yet: + +```bash +bmad install {module_code} +``` + +Follow the prompts to configure the module for your needs. + +--- + +## First Steps + +{first_steps_from_brief} + +--- + +## Common Use Cases + +{common_use_cases_from_brief} + +--- + +## What's Next? + +- Check out the [Agents Reference](agents.md) to meet your team +- Browse the [Workflows Reference](workflows.md) to see what you can do +- See [Examples](examples.md) for real-world usage + +--- + +## Need Help? + +If you run into issues: +1. Check the troubleshooting section in examples.md +2. Review your module configuration +3. Consult the broader BMAD documentation +``` + +### 3.2. agents.md + +```markdown +# Agents Reference + +{module_code} includes {agent_count} specialized agents: + +--- + +{for each agent} +## {agent_title} + +**ID:** `{agent_id}` +**Icon:** {agent_icon} + +**Role:** +{agent_role_from_spec} + +**When to Use:** +{when_to_use_from_spec} + +**Key Capabilities:** +{agent_capabilities_from_spec} + +**Menu Trigger(s):** +{menu_triggers_from_spec} + +--- +``` + +### 3.3. workflows.md + +```markdown +# Workflows Reference + +{module_code} includes {workflow_count} workflows: + +--- + +{for each workflow} +## {workflow_title} + +**ID:** `{workflow_id}` +**Workflow:** `{workflow_name}` + +**Purpose:** +{workflow_purpose_from_spec} + +**When to Use:** +{when_to_use_from_spec} + +**Key Steps:** +{workflow_steps_outline_from_spec} + +**Agent(s):** +{associated_agents_from_spec} + +--- +``` + +### 3.4. examples.md + +```markdown +# Examples & Use Cases + +This section provides practical examples for using {module_display_name}. + +--- + +## Example Workflows + +{example_workflows_from_brief} + +--- + +## Common Scenarios + +{common_scenarios_from_brief} + +--- + +## Tips & Tricks + +{tips_from_brief} + +--- + +## Troubleshooting + +### Common Issues + +{troubleshooting_from_brief} + +--- + +## Getting More Help + +- Review the main BMAD documentation +- Check module configuration in module.yaml +- Verify all agents and workflows are properly installed +``` + +### 4. Update Build Tracking + +Update `{buildTrackingFile}`: +- Add 'step-07-docs' to stepsCompleted +- Note: README.md, TODO.md, and docs/ folder created + +### 5. Report Success + +"**✓ Documentation created:**" + +- README.md — module overview and navigation +- TODO.md — development roadmap +- docs/ — user documentation folder + - getting-started.md — quick start guide + - agents.md — agent reference + - workflows.md — workflow reference + - examples.md — practical examples + +"**User documentation is valuable even with placeholder agent/workflow specs — users will understand what each component does and how to use them.**" + +"**TODO.md tracks the remaining work:**" +- Build {agent_count} agents +- Build {workflow_count} workflows +- Test installation + +### 6. MENU OPTIONS + +**Select an Option:** [C] Continue + +- IF C: Update tracking, load `{nextStepFile}` +- IF Any other: Help, then redisplay menu + +--- + +## Success Metrics + +✅ README.md created with all sections +✅ TODO.md created with agent/workflow checklist +✅ docs/ folder created with user documentation +✅ Build tracking updated diff --git a/src/modules/bmb/workflows/module/steps-c/step-08-complete.md b/src/modules/bmb/workflows/module/steps-c/step-08-complete.md new file mode 100644 index 00000000..a5d0657e --- /dev/null +++ b/src/modules/bmb/workflows/module/steps-c/step-08-complete.md @@ -0,0 +1,123 @@ +--- +name: 'step-08-complete' +description: 'Finalize, offer to run validation' + +buildTrackingFile: '{bmb_creations_output_folder}/modules/module-build-{module_code}.md' +targetLocation: '{build_tracking_targetLocation}' +validationWorkflow: '../steps-v/step-01-validate.md' +--- + +# Step 8: Complete + +## STEP GOAL: + +Finalize the module build, update tracking, and offer to run validation. + +## MANDATORY EXECUTION RULES: + +### Universal Rules: + +- 📖 CRITICAL: Read the complete step file before taking any action +- ✅ Speak in `{communication_language}` + +### Role Reinforcement: + +- ✅ You are the **Module Builder** — completing the build +- ✅ Celebrate what was created +- ✅ Guide next steps + +--- + +## MANDATORY SEQUENCE + +### 1. Final Build Summary + +"**🎉 Module structure build complete!**" + +**Module:** {moduleName} ({moduleCode}) +**Type:** {moduleType} +**Location:** {targetLocation} + +**What was created:** + +| Component | Count | Location | +|-----------|-------|----------| +| Agent specs | {count} | agents/ | +| Workflow specs | {count} | workflows/ | +| Configuration | 1 | module.yaml | +| Documentation | 2 | README.md, TODO.md | +| Installer | {yes/no} | _module-installer/ | + +### 2. Update Build Tracking + +Update `{buildTrackingFile}`: +```yaml +--- +moduleCode: {module_code} +moduleName: {name} +moduleType: {type} +targetLocation: {location} +stepsCompleted: ['step-01-load-brief', 'step-02-structure', 'step-03-config', 'step-04-installer', 'step-05-agents', 'step-06-workflows', 'step-07-docs', 'step-08-complete'] +created: {created_date} +completed: {date} +status: COMPLETE +--- +``` + +### 3. Next Steps + +"**Your module structure is ready! Here's what to do next:**" + +1. **Review the build** — Check {targetLocation} +2. **Build agents** — Use `bmad:bmb:agents:agent-builder` for each agent spec +3. **Build workflows** — Use `bmad:bmb:workflows:workflow` for each workflow spec +4. **Test installation** — Run `bmad install {module_code}` +5. **Iterate** — Refine based on testing + +### 4. Offer Validation + +"**Would you like to run validation on the module structure?**" + +Validation checks: +- File structure compliance +- module.yaml correctness +- Spec completeness +- Installation readiness + +### 5. MENU OPTIONS + +**Select an Option:** [V] Validate Module [D] Done + +#### EXECUTION RULES: + +- ALWAYS halt and wait for user input + +#### Menu Handling Logic: + +- IF V: Load `{validationWorkflow}` to run validation +- IF D: Celebration message, workflow complete +- IF Any other: Help user, then redisplay menu + +### 6. Completion Message (if Done selected) + +"**🚀 You've built a module structure for BMAD!**" + +"**Module:** {moduleName} ({moduleCode})" +"**Location:** {targetLocation}" +"**Status:** Ready for agent and workflow implementation" + +"**The journey from idea to installable module continues:** +- Agent specs → create-agent workflow +- Workflow specs → create-workflow workflow +- Full module → `bmad install` + +"**Great work! Let's build something amazing.** ✨" + +--- + +## Success Metrics + +✅ Build tracking marked COMPLETE +✅ Summary presented to user +✅ Next steps clearly explained +✅ Validation offered (optional) diff --git a/src/modules/bmb/workflows/module/steps-e/step-01-load-target.md b/src/modules/bmb/workflows/module/steps-e/step-01-load-target.md new file mode 100644 index 00000000..40ee3a50 --- /dev/null +++ b/src/modules/bmb/workflows/module/steps-e/step-01-load-target.md @@ -0,0 +1,81 @@ +--- +name: 'step-01-load-target' +description: 'Load target for editing' + +nextStepFile: './step-02-select-edit.md' +moduleStandardsFile: '../../data/module-standards.md' +--- + +# Step 1: Load Target (Edit Mode) + +## STEP GOAL: + +Load the target (brief, module.yaml, agent specs, or workflow specs) for editing. + +## MANDATORY EXECUTION RULES: + +### Universal Rules: +- 📖 CRITICAL: Read the complete step file before taking any action +- ✅ Speak in `{communication_language}` + +### Role Reinforcement: +- ✅ You are the **Module Editor** — helpful, ready to assist +- ✅ Understand what we're editing + +--- + +## MANDATORY SEQUENCE + +### 1. Determine Edit Target + +"**What would you like to edit?**" + +Options: +- **[B]rief** — Module brief from Brief mode +- **[Y]aml** — module.yaml configuration +- **[A]gents** — Agent specifications +- **[W]orkflows** — Workflow specifications +- **[D]ocs** — README.md or TODO.md + +### 2. Load Target + +Based on selection, load the target file(s). + +**IF Brief:** +- Path: `{bmb_creations_output_folder}/modules/module-brief-{code}.md` + +**IF Yaml:** +- Path: `src/modules/{code}/module.yaml` + +**IF Agents:** +- Path: `src/modules/{code}/agents/` +- List available agent specs + +**IF Workflows:** +- Path: `src/modules/{code}/workflows/` +- List available workflow specs + +**IF Docs:** +- Path: `src/modules/{code}/README.md` or `TODO.md` + +### 3. Display Current Content + +Show the current content of the target file. + +"**Here's the current content:**" + +{display relevant sections or summary} + +### 4. Proceed to Selection + +"**What would you like to change?**" + +Load `{nextStepFile}` to select the edit type. + +--- + +## Success Metrics + +✅ Target loaded +✅ Current content displayed +✅ Ready to select edit type diff --git a/src/modules/bmb/workflows/module/steps-e/step-02-select-edit.md b/src/modules/bmb/workflows/module/steps-e/step-02-select-edit.md new file mode 100644 index 00000000..be1baf74 --- /dev/null +++ b/src/modules/bmb/workflows/module/steps-e/step-02-select-edit.md @@ -0,0 +1,77 @@ +--- +name: 'step-02-select-edit' +description: 'Select edit type and gather changes' + +nextStepFile: './step-03-apply-edit.md' +--- + +# Step 2: Select Edit Type + +## STEP GOAL: + +Select the type of edit and gather the changes to make. + +## MANDATORY EXECUTION RULES: + +### Universal Rules: +- 📖 CRITICAL: Read the complete step file before taking any action +- ✅ Speak in `{communication_language}` + +### Role Reinforcement: +- ✅ You are the **Module Editor** — precise, collaborative +- ✅ Understand the change before making it + +--- + +## MANDATORY SEQUENCE + +### 1. Select Edit Type + +"**What type of edit would you like to make?**" + +- **[M]odify** — Change existing content +- **[A]dd** — Add new content +- **[D]elete** — Remove content +- **[R]eplace** — Replace section entirely + +### 2. Gather Edit Details + +**IF Modify:** +"**Which section do you want to modify?**" +"What should it change to?" + +**IF Add:** +"**What do you want to add?**" +"**Where should it go?**" + +**IF Delete:** +"**What do you want to remove?**" + +**IF Replace:** +"**What section should be replaced?**" +"**What's the new content?**" + +### 3. Confirm Change + +"**Please confirm the edit:**" + +**Type:** {edit_type} +**Target:** {section or content} +**Change:** {description of change} + +"**Is this correct?**" + +### 4. Store Edit Plan + +Store the edit plan for the next step. + +Load `{nextStepFile}` to apply the edit. + +--- + +## Success Metrics + +✅ Edit type selected +✅ Change details gathered +✅ User confirmed +✅ Edit plan stored diff --git a/src/modules/bmb/workflows/module/steps-e/step-03-apply-edit.md b/src/modules/bmb/workflows/module/steps-e/step-03-apply-edit.md new file mode 100644 index 00000000..a6dd6afa --- /dev/null +++ b/src/modules/bmb/workflows/module/steps-e/step-03-apply-edit.md @@ -0,0 +1,77 @@ +--- +name: 'step-03-apply-edit' +description: 'Apply the edit and save' + +nextStepFile: './step-04-review.md' +--- + +# Step 3: Apply Edit + +## STEP GOAL: + +Apply the confirmed edit to the target file and save. + +## MANDATORY EXECUTION RULES: + +### Universal Rules: +- 📖 CRITICAL: Read the complete step file before taking any action +- ✅ Speak in `{communication_language}` + +### Role Reinforcement: +- ✅ You are the **Module Editor** — making changes +- ✅ Apply edits precisely + +--- + +## MANDATORY SEQUENCE + +### 1. Load Target File + +Read the complete target file. + +### 2. Apply Edit + +Based on the edit plan from step 2: + +**IF Modify:** +- Locate the section +- Apply the modification +- Preserve surrounding context + +**IF Add:** +- Find the insertion point +- Insert new content +- Maintain formatting + +**IF Delete:** +- Locate the content +- Remove it +- Clean up any gaps + +**IF Replace:** +- Locate the section +- Replace with new content +- Ensure proper formatting + +### 3. Save Changes + +Write the modified content back to the target file. + +### 4. Report Success + +"**✓ Edit applied!**" + +**File:** {file_path} +**Change:** {summary_of_change} + +### 5. Proceed to Review + +Load `{nextStepFile}` to review the changes. + +--- + +## Success Metrics + +✅ Edit applied correctly +✅ File saved +✅ Change summary provided diff --git a/src/modules/bmb/workflows/module/steps-e/step-04-review.md b/src/modules/bmb/workflows/module/steps-e/step-04-review.md new file mode 100644 index 00000000..6c0e79c9 --- /dev/null +++ b/src/modules/bmb/workflows/module/steps-e/step-04-review.md @@ -0,0 +1,80 @@ +--- +name: 'step-04-review' +description: 'Review changes and offer validation' + +nextStepFile: './step-05-confirm.md' +validationWorkflow: '../steps-v/step-01-load-target.md' +--- + +# Step 4: Review Changes + +## STEP GOAL: + +Review the applied changes and offer to run validation. + +## MANDATORY EXECUTION RULES: + +### Universal Rules: +- 📖 CRITICAL: Read the complete step file before taking any action +- ✅ Speak in `{communication_language}` + +### Role Reinforcement: +- ✅ You are the **Module Editor** — confirming changes +- ✅ Ensure user is satisfied + +--- + +## MANDATORY SEQUENCE + +### 1. Show Diff + +Display what changed: + +"**Here's what changed:**" + +**Before:** +{before_content} + +**After:** +{after_content} + +### 2. Confirm Satisfaction + +"**Are you happy with this change?**" + +- **[Y]es** — Keep the change +- **[N]o** — Revert and redo +- **[M]odify** — Make further adjustments + +### 3. Handle Response + +**IF Yes:** +- Mark edit as complete +- Proceed to step 5 + +**IF No:** +- Revert the change +- Return to step 2 to gather new edit + +**IF Modify:** +- Make additional adjustments +- Show updated diff +- Ask again + +### 4. Offer Validation + +"**Would you like to run validation after this edit?**" + +- Validation can check for any issues introduced + +### 5. Proceed to Confirm + +Load `{nextStepFile}` to confirm completion. + +--- + +## Success Metrics + +✅ Changes reviewed +✅ User satisfaction confirmed +✅ Validation offered diff --git a/src/modules/bmb/workflows/module/steps-e/step-05-confirm.md b/src/modules/bmb/workflows/module/steps-e/step-05-confirm.md new file mode 100644 index 00000000..486fb9d4 --- /dev/null +++ b/src/modules/bmb/workflows/module/steps-e/step-05-confirm.md @@ -0,0 +1,75 @@ +--- +name: 'step-05-confirm' +description: 'Confirm completion and offer next steps' + +validationWorkflow: '../steps-v/step-01-load-target.md' +--- + +# Step 5: Confirm Completion + +## STEP GOAL: + +Confirm edit completion and offer next steps including validation. + +## MANDATORY EXECUTION RULES: + +### Universal Rules: +- 📖 CRITICAL: Read the complete step file before taking any action +- ✅ Speak in `{communication_language}` + +### Role Reinforcement: +- ✅ You are the **Module Editor** — completing the job +- ✅ Guide next steps + +--- + +## MANDATORY SEQUENCE + +### 1. Summary of Changes + +"**✓ Edit complete!**" + +**File edited:** {file_path} +**Edit type:** {edit_type} +**Summary:** {summary_of_change} + +### 2. Offer Next Actions + +"**What would you like to do next?**" + +- **[V]alidate** — Run validation to check for issues +- **[E]dit more** — Make additional changes +- **[D]one** — Complete edit session + +### 3. Handle Response + +**IF Validate:** +"**Loading validation workflow...**" +Load `{validationWorkflow}` + +**IF Edit more:** +"**Loading edit selection...**" +Return to step 1 + +**IF Done:** +"**Edit session complete!**" +Summary of what was accomplished. + +### 4. Complete Session + +If Done selected: + +"**Thanks for using the Module Edit workflow!**" + +"**Summary:**" +- Files edited: {count} +- Changes made: {summary} + +--- + +## Success Metrics + +✅ Edit confirmed complete +✅ Next actions offered +✅ Validation accessible +✅ Session properly closed diff --git a/src/modules/bmb/workflows/module/steps-v/step-01-load-target.md b/src/modules/bmb/workflows/module/steps-v/step-01-load-target.md new file mode 100644 index 00000000..08237f3e --- /dev/null +++ b/src/modules/bmb/workflows/module/steps-v/step-01-load-target.md @@ -0,0 +1,96 @@ +--- +name: 'step-01-load-target' +description: 'Load target for validation' + +nextStepFile: './step-02-file-structure.md' +validationReportOutput: '{bmb_creations_output_folder}/modules/validation-report-{target_code}-{timestamp}.md' +--- + +# Step 1: Load Target (Validate Mode) + +## STEP GOAL: + +Load the target (brief, module, agent specs, or workflow specs) for validation. + +## MANDATORY EXECUTION RULES: + +### Universal Rules: +- 📖 CRITICAL: Read the complete step file before taking any action +- ✅ Speak in `{communication_language}` + +### Role Reinforcement: +- ✅ You are the **Quality Assurance** — thorough, systematic +- ✅ Understand what we're validating + +--- + +## MANDATORY SEQUENCE + +### 1. Determine Validation Target + +"**What would you like to validate?**" + +Options: +- **[B]rief** — Module brief from Brief mode +- **[M]odule** — Built module structure +- **[A]gents** — Agent specifications +- **[W]orkflows** — Workflow specifications +- **[F]ull** — Everything (brief + module + specs) + +### 2. Load Target + +Based on selection, load the target: + +**IF Brief:** +- Path: `{bmb_creations_output_folder}/modules/module-brief-{code}.md` +- Ask for module code if not specified + +**IF Module:** +- Path: `src/modules/{code}/` +- Ask for module code if not specified + +**IF Agents:** +- Path: `src/modules/{code}/agents/` +- Load all `.spec.md` or `.agent.yaml` files + +**IF Workflows:** +- Path: `src/modules/{code}/workflows/` +- Load all `.spec.md` files + +**IF Full:** +- Load everything above for a module + +### 3. Confirm Target + +"**Validating:** {target_type} for {module_code}" +"**Location:** {path}" + +"**Shall I proceed?**" + +### 4. Initialize Validation Report + +Create the validation report structure: + +```yaml +--- +validationDate: {timestamp} +targetType: {target_type} +moduleCode: {module_code} +targetPath: {path} +status: IN_PROGRESS +--- +``` + +### 5. Proceed to Validation + +"**Starting validation checks...**" + +Load `{nextStepFile}` to begin file structure validation. + +--- + +## Success Metrics + +✅ Target loaded +✅ Validation report initialized +✅ User confirmed diff --git a/src/modules/bmb/workflows/module/steps-v/step-02-file-structure.md b/src/modules/bmb/workflows/module/steps-v/step-02-file-structure.md new file mode 100644 index 00000000..3253964c --- /dev/null +++ b/src/modules/bmb/workflows/module/steps-v/step-02-file-structure.md @@ -0,0 +1,94 @@ +--- +name: 'step-02-file-structure' +description: 'Validate file structure compliance' + +nextStepFile: './step-03-module-yaml.md' +moduleStandardsFile: '../../data/module-standards.md' +validationReportOutput: '{validation_report_output}' +--- + +# Step 2: File Structure Validation + +## STEP GOAL: + +Validate file structure against module standards. + +## MANDATORY EXECUTION RULES: + +### Universal Rules: +- 📖 CRITICAL: Read the complete step file before taking any action +- ✅ Speak in `{communication_language}` + +### Role Reinforcement: +- ✅ You are the **Quality Assurance** — checking structure +- ✅ Reference standards, ensure compliance + +--- + +## MANDATORY SEQUENCE + +### 1. Load Standards + +Load `{moduleStandardsFile}` for reference. + +### 2. Perform Structure Checks + +Check based on target type: + +**For Modules:** +- [ ] module.yaml exists +- [ ] README.md exists +- [ ] agents/ folder exists (if agents specified) +- [ ] workflows/ folder exists (if workflows specified) +- [ ] _module-installer/ folder (if installer specified) + +**For Briefs:** +- [ ] Brief file exists +- [ ] Required sections present + +**For Agent Specs:** +- [ ] All expected spec files exist + +**For Workflow Specs:** +- [ ] All expected spec files exist + +### 3. Check Module Type Compliance + +**IF Extension Module:** +- [ ] Code matches base module +- [ ] Folder name is unique (not conflicting) + +**IF Global Module:** +- [ ] Global flag documented + +### 4. Record Results + +Append to `{validationReportOutput}`: + +```markdown +## File Structure Validation + +**Status:** {PASS/FAIL/WARNINGS} + +**Checks:** +{list each check with result} + +**Issues Found:** +{any structural problems} +``` + +### 5. Auto-Proceed + +"**✓ File structure check complete.**" + +Proceeding to next validation... + +Load `{nextStepFile}` + +--- + +## Success Metrics + +✅ All structure checks performed +✅ Results recorded +✅ Auto-proceeds to next validation diff --git a/src/modules/bmb/workflows/module/steps-v/step-03-module-yaml.md b/src/modules/bmb/workflows/module/steps-v/step-03-module-yaml.md new file mode 100644 index 00000000..ba6a13c0 --- /dev/null +++ b/src/modules/bmb/workflows/module/steps-v/step-03-module-yaml.md @@ -0,0 +1,99 @@ +--- +name: 'step-03-module-yaml' +description: 'Validate module.yaml against conventions' + +nextStepFile: './step-04-agent-specs.md' +moduleYamlConventionsFile: '../../data/module-yaml-conventions.md' +validationReportOutput: '{validation_report_output}' +targetPath: '{validation_target_path}' +--- + +# Step 3: module.yaml Validation + +## STEP GOAL: + +Validate module.yaml formatting and conventions. + +## MANDATORY EXECUTION RULES: + +### Universal Rules: +- 📖 CRITICAL: Read the complete step file before taking any action +- ✅ Speak in `{communication_language}` + +### Role Reinforcement: +- ✅ You are the **Quality Assurance** — checking configuration +- ✅ Ensure proper YAML syntax + +--- + +## MANDATORY SEQUENCE + +### 1. Load module.yaml + +Read `{targetPath}/module.yaml` + +**IF not present:** +- Record as FAIL (required file) +- Skip to next validation + +### 2. Validate Required Fields + +Check for required frontmatter: +- [ ] `code:` present and valid (kebab-case, 2-20 chars) +- [ ] `name:` present +- [ ] `header:` present +- [ ] `subheader:` present +- [ ] `default_selected:` present (boolean) + +### 3. Validate Custom Variables + +For each custom variable: +- [ ] `prompt:` present +- [ ] `default:` present (or explicitly omitted) +- [ ] `result:` template valid +- [ ] Variable naming correct (kebab-case) + +**For single-select:** +- [ ] `single-select:` array present +- [ ] All options have `value:` and `label:` + +**For multi-select:** +- [ ] `multi-select:` array present +- [ ] All options have `value:` and `label:` + +### 4. Validate Extension Module Code + +**IF Extension:** +- [ ] `code:` matches base module code +- [ ] This is intentional (not an error) + +### 5. Record Results + +Append to `{validationReportOutput}`: + +```markdown +## module.yaml Validation + +**Status:** {PASS/FAIL/WARNINGS} + +**Required Fields:** {status} +**Custom Variables:** {count} variables +**Issues Found:** +{list any issues} +``` + +### 6. Auto-Proceed + +"**✓ module.yaml check complete.**" + +Proceeding to next validation... + +Load `{nextStepFile}` + +--- + +## Success Metrics + +✅ All module.yaml checks performed +✅ Results recorded +✅ Auto-proceeds to next validation diff --git a/src/modules/bmb/workflows/module/steps-v/step-04-agent-specs.md b/src/modules/bmb/workflows/module/steps-v/step-04-agent-specs.md new file mode 100644 index 00000000..3a2d931e --- /dev/null +++ b/src/modules/bmb/workflows/module/steps-v/step-04-agent-specs.md @@ -0,0 +1,152 @@ +--- +name: 'step-04-agent-specs' +description: 'Validate agent specifications and built agents' + +nextStepFile: './step-05-workflow-specs.md' +agentSpecTemplate: '../../templates/agent-spec-template.md' +agentArchitectureFile: '../../data/agent-architecture.md' +agentValidationWorkflow: '{project-root}/_bmad/bmb/workflows/agent/steps-v/step-01-validate.md' +validationReportOutput: '{validation_report_output}' +targetPath: '{validation_target_path}' +--- + +# Step 4: Agent Specs Validation + +## STEP GOAL: + +Validate agent specifications and/or built agents, distinguishing between placeholder specs and fully implemented agents. + +## MANDATORY EXECUTION RULES: + +### Universal Rules: +- 📖 CRITICAL: Read the complete step file before taking any action +- ✅ Speak in `{communication_language}` + +### Role Reinforcement: +- ✅ You are the **Quality Assurance** — dual-mode checking +- ✅ Specs are expected, built agents are great +- ✅ Track status of each agent + +--- + +## MANDATORY SEQUENCE + +### 1. Load Agent Files + +Find all agent files in `{targetPath}/agents/`: +- `.spec.md` files (placeholder specs) +- `.agent.yaml` files (built agents) + +### 2. Categorize Agents + +For each agent found, determine status: + +**Built Agents (.agent.yaml):** +- Full implementation with complete persona, menu YAML +- Can be validated in-depth via agent validation workflow + +**Spec Agents (.spec.md):** +- High-level placeholder/blueprint +- Awaiting creation via agent-builder workflow + +Track counts: +- Total agents: {count} +- Built agents: {count} +- Spec agents: {count} + +### 3. Validate Spec Agents (.spec.md) + +For each spec agent, check: + +**Required Sections:** +- [ ] Agent metadata (id, name, title, icon, module) +- [ ] Role defined +- [ ] Identity or communication style +- [ ] Menu triggers documented +- [ ] hasSidecar decision documented + +**Menu Triggers:** +- [ ] At least one trigger per agent +- [ ] Trigger → workflow mapping clear +- [ ] No duplicate triggers (warn if found) + +**hasSidecar Documentation:** +- [ ] Decision documented (true or false) +- [ ] Rationale if true (why memory needed) + +**Placeholder Note:** These are specs awaiting agent-builder. + +### 4. Validate Built Agents (.agent.yaml) + +For each built agent, check: + +**Frontmatter Completeness:** +- [ ] agent.metadata exists +- [ ] agent.persona exists +- [ ] agent.menu exists + +**YAML Structure:** +- [ ] Valid YAML syntax +- [ ] Required fields present + +**Status:** These are complete implementations and can be validated in detail via sub-process. + +### 5. Record Results + +Append to `{validationReportOutput}`: + +```markdown +## Agent Specs Validation + +**Status:** {PASS/FAIL/WARNINGS} + +**Agent Summary:** +- Total Agents: {count} +- Built Agents: {count} {list} +- Spec Agents: {count} {list} + +**Built Agents:** +{for each built agent} +- **{name}**: {status} - Ready for detailed validation via agent workflow + +**Spec Agents:** +{for each spec agent} +- **{name}**: {status} - Placeholder awaiting agent-builder + +**Issues Found:** +{list any issues} + +**Recommendations:** +{if specs exist} +- Use `bmad:bmb:agents:agent-builder` to create {spec agent names} +- After building agents, re-run validation to verify compliance +{endif} +``` + +### 6. Note Sub-Process Opportunity + +**IF built agents exist:** + +"**The following built agents can be validated in detail:**" + +{list built agents} + +"**After this validation completes, I can spawn sub-processes to run the agent validation workflow on each built agent for deeper compliance checking.**" + +### 7. Auto-Proceed + +"**✓ Agent specs check complete.**" + +Proceeding to next validation... + +Load `{nextStepFile}` + +--- + +## Success Metrics + +✅ All agent files checked +✅ Status tracked (spec vs built) +✅ hasSidecar decisions validated +✅ Recommendations for specs documented +✅ Sub-process opportunity noted diff --git a/src/modules/bmb/workflows/module/steps-v/step-05-workflow-specs.md b/src/modules/bmb/workflows/module/steps-v/step-05-workflow-specs.md new file mode 100644 index 00000000..24490bdf --- /dev/null +++ b/src/modules/bmb/workflows/module/steps-v/step-05-workflow-specs.md @@ -0,0 +1,152 @@ +--- +name: 'step-05-workflow-specs' +description: 'Validate workflow specifications and built workflows' + +nextStepFile: './step-06-documentation.md' +workflowSpecTemplate: '../../templates/workflow-spec-template.md' +workflowValidationWorkflow: '{project-root}/_bmad/bmb/workflows/workflow/steps-v/step-01-validate.md' +validationReportOutput: '{validation_report_output}' +targetPath: '{validation_target_path}' +--- + +# Step 5: Workflow Specs Validation + +## STEP GOAL: + +Validate workflow specifications and/or built workflows, distinguishing between placeholder specs and fully implemented workflows. + +## MANDATORY EXECUTION RULES: + +### Universal Rules: +- 📖 CRITICAL: Read the complete step file before taking any action +- ✅ Speak in `{communication_language}` + +### Role Reinforcement: + +- ✅ You are the **Quality Assurance** — dual-mode checking +- ✅ Specs are expected, built workflows are great +- ✅ Track status of each workflow + +--- + +## MANDATORY SEQUENCE + +### 1. Load Workflow Files + +Find all workflow files in `{targetPath}/workflows/`: +- `.spec.md` files (placeholder specs) +- `workflow.md` files (built workflows) + +### 2. Categorize Workflows + +For each workflow found, determine status: + +**Built Workflows (workflow.md with steps/ folder):** +- Full implementation with step files, data, templates +- Can be validated in-depth via workflow validation workflow + +**Spec Workflows (.spec.md):** +- High-level placeholder/blueprint +- Awaiting creation via workflow-builder workflow + +Track counts: +- Total workflows: {count} +- Built workflows: {count} +- Spec workflows: {count} + +### 3. Validate Spec Workflows (.spec.md) + +For each spec workflow, check: + +**Required Sections:** +- [ ] Workflow goal defined +- [ ] Description present +- [ ] Workflow type indicated +- [ ] Step list or outline present +- [ ] Agent association clear + +**Inputs/Outputs:** +- [ ] Input requirements documented +- [ ] Output format specified + +**Agent Integration:** +- [ ] Primary agent identified +- [ ] Multi-agent collaboration noted (if applicable) + +**Placeholder Note:** These are specs awaiting workflow-builder. + +### 4. Validate Built Workflows (workflow.md) + +For each built workflow, check: + +**Workflow Structure:** +- [ ] workflow.md exists with proper frontmatter +- [ ] steps/ folder exists (steps-c/, steps-e/, steps-v/ as appropriate) +- [ ] Step files follow naming conventions + +**Step File Compliance:** +- [ ] Each step has proper frontmatter +- [ ] Step files within size limits +- [ ] Menu handling follows standards + +**Status:** These are complete implementations and can be validated in detail via sub-process. + +### 5. Record Results + +Append to `{validationReportOutput}`: + +```markdown +## Workflow Specs Validation + +**Status:** {PASS/FAIL/WARNINGS} + +**Workflow Summary:** +- Total Workflows: {count} +- Built Workflows: {count} {list} +- Spec Workflows: {count} {list} + +**Built Workflows:** +{for each built workflow} +- **{name}**: {status} - Ready for detailed validation via workflow workflow + +**Spec Workflows:** +{for each spec workflow} +- **{name}**: {status} - Placeholder awaiting workflow-builder + +**Issues Found:** +{list any issues} + +**Recommendations:** +{if specs exist} +- Use `bmad:bmb:workflows:workflow` or `/workflow` to create {spec workflow names} +- After building workflows, re-run validation to verify compliance +{endif} +``` + +### 6. Note Sub-Process Opportunity + +**IF built workflows exist:** + +"**The following built workflows can be validated in detail:**" + +{list built workflows} + +"**After this validation completes, I can spawn sub-processes to run the workflow validation workflow on each built workflow for deeper compliance checking.**" + +### 7. Auto-Proceed + +"**✓ Workflow specs check complete.**" + +Proceeding to next validation... + +Load `{nextStepFile}` + +--- + +## Success Metrics + +✅ All workflow files checked +✅ Status tracked (spec vs built) +✅ Agent associations validated +✅ Recommendations for specs documented +✅ Sub-process opportunity noted diff --git a/src/modules/bmb/workflows/module/steps-v/step-06-documentation.md b/src/modules/bmb/workflows/module/steps-v/step-06-documentation.md new file mode 100644 index 00000000..d71a99eb --- /dev/null +++ b/src/modules/bmb/workflows/module/steps-v/step-06-documentation.md @@ -0,0 +1,143 @@ +--- +name: 'step-06-documentation' +description: 'Validate documentation (README.md, TODO.md, docs/)' + +nextStepFile: './step-07-installation.md' +validationReportOutput: '{validation_report_output}' +targetPath: '{validation_target_path}' +moduleBriefPath: '{module_brief_path}' +--- + +# Step 6: Documentation Validation + +## STEP GOAL: + +Validate module documentation completeness, including user-facing docs in docs/ folder. + +## MANDATORY EXECUTION RULES: + +### Universal Rules: +- 📖 CRITICAL: Read the complete step file before taking any action +- ✅ Speak in `{communication_language}` + +### Role Reinforcement: + +- ✅ You are the **Quality Assurance** — checking docs +- ✅ Documentation matters for usability +- ✅ User docs can be generated from placeholder plans + +--- + +## MANDATORY SEQUENCE + +### 1. Load Documentation Files + +Check for: +- `{targetPath}/README.md` (module overview) +- `{targetPath}/TODO.md` (development roadmap) +- `{targetPath}/docs/` (user documentation folder) + +### 2. Validate README.md + +**Required Sections:** +- [ ] Module name and description +- [ ] Installation instructions +- [ ] Components section (agents, workflows) +- [ ] Usage examples or quick start +- [ ] Module structure +- [ ] Link to docs/ folder + +**Quality Checks:** +- [ ] Clear description of what module does +- [ ] Installation command shown +- [ ] Agent/workflow lists complete +- [ ] References user documentation + +### 3. Validate TODO.md + +**Required Content:** +- [ ] Agent build checklist +- [ ] Workflow build checklist +- [ ] Testing section +- [ ] Next steps + +### 4. Validate docs/ Folder + +**For Custom Modules:** +- [ ] docs/ folder exists +- [ ] Contains user-facing documentation +- [ ] Documentation is clear and helpful + +**Valid docs/ Contents (may include):** +- `getting-started.md` — Quick start guide +- `agents.md` — Agent documentation +- `workflows.md` — Workflow documentation +- `examples.md` — Usage examples +- `configuration.md` — Setup/configuration guide +- `troubleshooting.md` — Common issues and solutions + +**Quality Check:** +- [ ] Even with placeholder agent/workflow specs, user docs should provide useful information +- [ ] Documentation references agents/workflows by name +- [ ] Clear what functionality exists vs what is planned + +### 5. Generate User Docs Recommendation + +**IF docs/ missing or incomplete:** + +"**User documentation can be generated from module brief and agent/workflow specs.**" + +"**Even with placeholder plans, you can create helpful user documentation that describes:** +- What each agent does and when to use it +- What workflows are available and their purpose +- How to get started with the module +- Configuration options (from module.yaml)" + +### 6. Record Results + +Append to `{validationReportOutput}`: + +```markdown +## Documentation Validation + +**Status:** {PASS/FAIL/WARNINGS} + +**Root Documentation:** +- **README.md:** {present/missing} - {status} +- **TODO.md:** {present/missing} - {status} + +**User Documentation (docs/):** +- **docs/ folder:** {present/missing} - {status} +- **Documentation files:** {count} files found + +**Docs Contents:** +{list files in docs/ folder} + +**Issues Found:** +{list any issues} + +**Recommendations:** +{if docs/ missing or incomplete} +- Generate user documentation from module brief and specs +- Create getting-started.md, agents.md, workflows.md +- User docs are valuable even with placeholder plans +{endif} +``` + +### 7. Auto-Proceed + +"**✓ Documentation check complete.**" + +Proceeding to installation validation... + +Load `{nextStepFile}` + +--- + +## Success Metrics + +✅ All documentation checked +✅ Required sections validated +✅ docs/ folder presence verified +✅ User documentation quality assessed +✅ Recommendations documented diff --git a/src/modules/bmb/workflows/module/steps-v/step-07-installation.md b/src/modules/bmb/workflows/module/steps-v/step-07-installation.md new file mode 100644 index 00000000..ee11e163 --- /dev/null +++ b/src/modules/bmb/workflows/module/steps-v/step-07-installation.md @@ -0,0 +1,113 @@ +--- +name: 'step-07-installation' +description: 'Installation readiness check' + +nextStepFile: './step-08-report.md' +moduleInstallerStandardsFile: '../../data/module-installer-standards.md' +validationReportOutput: '{validation_report_output}' +targetPath: '{validation_target_path}' +--- + +# Step 7: Installation Readiness + +## STEP GOAL: + +Check if the module is ready for installation. + +## MANDATORY EXECUTION RULES: + +### Universal Rules: +- 📖 CRITICAL: Read the complete step file before taking any action +- ✅ Speak in `{communication_language}` + +### Role Reinforcement: + +- ✅ You are the **Quality Assurance** — checking readiness +- ✅ Installation should work + +--- + +## MANDATORY SEQUENCE + +### 1. Check Installer + +**IF `_module-installer/` exists:** +- [ ] `installer.js` present +- [ ] Has valid `install()` function +- [ ] Platform-specific handlers (if any IDEs supported) + +**IF `_module-installer/` doesn't exist:** +- Note: Module may not need installer +- Check if this is intentional + +### 2. Validate installer.js (if present) + +Load `{moduleInstallerStandardsFile}` and check: + +**Function Signature:** +- [ ] `async function install(options)` +- [ ] Accepts: projectRoot, config, installedIDEs, logger +- [ ] Returns: Promise + +**Error Handling:** +- [ ] Try/catch block present +- [ ] Error logging present + +**Platform Validation:** +- [ ] Uses platformCodes for IDE validation +- [ ] Graceful handling of unknown platforms + +### 3. Check module.yaml Install Variables + +**IF custom variables exist:** +- [ ] All variables have prompts +- [ ] Defaults are reasonable +- [ ] Result templates are valid + +**Path Variables:** +- [ ] Paths use `{project-root}/` prefix +- [ ] Output paths are user-configurable + +### 4. Module Type Installation + +**IF Extension:** +- [ ] `code:` matches base (for proper merge) +- [ ] Folder name is unique + +**IF Global:** +- [ ] `global: true` or documented +- [ ] Global impact is minimal/intentional + +### 5. Record Results + +Append to `{validationReportOutput}`: + +```markdown +## Installation Readiness + +**Status:** {PASS/FAIL/WARNINGS} + +**Installer:** {present/missing} - {status} +**Install Variables:** {count} variables +**Ready to Install:** {yes/no} + +**Issues Found:** +{list any issues} +``` + +### 6. Auto-Proceed + +"**✓ Installation readiness check complete.**" + +Proceeding to final report... + +Load `{nextStepFile}` + +--- + +## Success Metrics + +✅ Installation readiness assessed +✅ Installer validated (if present) +✅ Module type compatibility checked +✅ Results recorded diff --git a/src/modules/bmb/workflows/module/steps-v/step-08-report.md b/src/modules/bmb/workflows/module/steps-v/step-08-report.md new file mode 100644 index 00000000..f5211592 --- /dev/null +++ b/src/modules/bmb/workflows/module/steps-v/step-08-report.md @@ -0,0 +1,197 @@ +--- +name: 'step-08-report' +description: 'Generate final validation report' + +validationReportOutput: '{validation_report_output}' +agentValidationWorkflow: '{project-root}/_bmad/bmb/workflows/agent/steps-v/step-01-validate.md' +workflowValidationWorkflow: '{project-root}/_bmad/bmb/workflows/workflow/steps-v/step-01-validate.md' +--- + +# Step 8: Validation Report + +## STEP GOAL: + +Compile all validation results into a final report with actionable recommendations, including sub-process validation opportunities for built agents and workflows. + +## MANDATORY EXECUTION RULES: + +### Universal Rules: +- 📖 CRITICAL: Read the complete step file before taking any action +- ✅ Speak in `{communication_language}` + +### Role Reinforcement: + +- ✅ You are the **Quality Assurance** — reporting results +- ✅ Clear, actionable feedback +- ✅ Sub-process validation for built components + +--- + +## MANDATORY SEQUENCE + +### 1. Compile Overall Status + +Review all validation sections and determine overall status: + +**PASS:** All checks passed, ready to proceed +**WARNINGS:** Minor issues found, can proceed with fixes +**FAIL:** Critical issues found, must fix before proceeding + +### 2. Generate Summary + +Add to `{validationReportOutput}`: + +```markdown +--- + +## Overall Summary + +**Status:** {PASS/WARNINGS/FAIL} + +**Breakdown:** +- File Structure: {status} +- module.yaml: {status} +- Agent Specs: {status} ({built_count} built, {spec_count} specs) +- Workflow Specs: {status} ({built_count} built, {spec_count} specs) +- Documentation: {status} +- Installation Readiness: {status} + +--- + +## Component Status + +### Agents +- **Built Agents:** {count} — {list} +- **Spec Agents:** {count} — {list} + +### Workflows +- **Built Workflows:** {count} — {list} +- **Spec Workflows:** {count} — {list} + +--- + +## Recommendations + +{priority-listed-recommendations} + +### Priority 1 - Critical (must fix) + +{critical_issues} + +### Priority 2 - High (should fix) + +{high_priority_issues} + +### Priority 3 - Medium (nice to have) + +{medium_priority_issues} + +--- + +## Sub-Process Validation + +{if built_agents_exist} +### Built Agent Deep Validation + +The following built agents can be validated in detail using the agent validation workflow: + +{for each built_agent} +- **{agent_name}** — Use `{agentValidationWorkflow}` + +**Recommendation:** Run agent validation workflow on each built agent to verify: +- Frontmatter completeness +- Persona quality +- Menu structure compliance +- Sidecar validation + +**After fixing any module-level issues, I can spawn sub-processes to validate each built agent in parallel.** +{endif} + +{if built_workflows_exist} +### Built Workflow Deep Validation + +The following built workflows can be validated in detail using the workflow validation workflow: + +{for each built_workflow} +- **{workflow_name}** — Use `{workflowValidationWorkflow}` + +**Recommendation:** Run workflow validation workflow on each built workflow to verify: +- Step file compliance +- Tri-modal structure (steps-c/steps-e/steps-v/) +- Frontmatter completeness +- Size limits compliance + +**After fixing any module-level issues, I can spawn sub-processes to validate each built workflow in parallel.** +{endif} + +--- + +## Next Steps + +{based_on_status} + +{if specs_exist} +### Build Spec Components + +**Spec Agents:** {spec_count} +- Use `bmad:bmb:agents:agent-builder` to create: {spec_agent_names} + +**Spec Workflows:** {spec_count} +- Use `bmad:bmb:workflows:workflow` to create: {spec_workflow_names} + +**After building specs, re-run validation to verify compliance.** +{endif} + +--- + +**Validation Completed:** {timestamp} +``` + +### 3. Present Report + +"**✓ Validation complete!**" + +**Overall Status:** {overall_status} + +**Report saved to:** `{validationReportOutput}` + +{if built_components_exist} +"**Built components found:**" +- Built Agents: {count} +- Built Workflows: {count} + +"**These can be validated in depth via sub-process.**" +{endif} + +### 4. Offer Next Actions + +"**What would you like to do?**" + +- **[R]ead report** — Show the full validation report +- **[S]ub-process validation** — Run deep validation on built agents/workflows +- **[F]ix issues** — Edit mode to fix identified problems +- **[D]one** — Complete validation + +### 5. Menu Handling + +- IF R: Display the full report +- IF S: + - {if built_components_exist} + - Offer to run agent validation on built agents + - Offer to run workflow validation on built workflows + - Can run in parallel for efficiency + - {else} + - "No built components found for sub-process validation." + - {endif} +- IF F: Offer to load Edit mode +- IF D: Complete validation session + +--- + +## Success Metrics + +✅ Overall status determined +✅ Complete report generated +✅ Actionable recommendations provided +✅ Sub-process validation opportunities identified +✅ Next steps offered diff --git a/src/modules/bmb/workflows/module/templates/brief-template.md b/src/modules/bmb/workflows/module/templates/brief-template.md new file mode 100644 index 00000000..01ad3f3d --- /dev/null +++ b/src/modules/bmb/workflows/module/templates/brief-template.md @@ -0,0 +1,154 @@ +# Module Brief: {module_code} + +**Date:** {date} +**Author:** {user_name} +**Module Code:** {module_code} +**Module Type:** {module_type} +**Status:** Ready for Development + +--- + +## Executive Summary + +{module_vision} + +**Module Category:** {module_category} +**Target Users:** {target_users} +**Complexity Level:** {complexity_level} + +--- + +## Module Identity + +### Module Code & Name + +- **Code:** `{module_code}` +- **Name:** `{module_name}` + +### Core Concept + +{module_identity} + +### Personality Theme + +{personality_theme} + +--- + +## Module Type + +**Type:** {module_type} + +{module_type_explanation} + +--- + +## Unique Value Proposition + +**What makes this module special:** + +{unique_value_proposition} + +**Why users would choose this module:** + +{value_proposition_details} + +--- + +## User Scenarios + +### Target Users + +{target_users} + +### Primary Use Case + +{primary_use_case} + +### User Journey + +{user_journey} + +--- + +## Agent Architecture + +### Agent Count Strategy + +{agent_count_strategy} + +### Agent Roster + +| Agent | Name | Role | Expertise | +|-------|------|------|-----------| +{agent_roster_table} + +### Agent Interaction Model + +{agent_interaction_model} + +### Agent Communication Style + +{agent_communication_style} + +--- + +## Workflow Ecosystem + +### Core Workflows (Essential) + +{core_workflows} + +### Feature Workflows (Specialized) + +{feature_workflows} + +### Utility Workflows (Support) + +{utility_workflows} + +--- + +## Tools & Integrations + +### MCP Tools + +{mcp_tools} + +### External Services + +{external_services} + +### Integrations with Other Modules + +{module_integrations} + +--- + +## Creative Features + +### Personality & Theming + +{creative_personality} + +### Easter Eggs & Delighters + +{easter_eggs} + +### Module Lore + +{module_lore} + +--- + +## Next Steps + +1. **Review this brief** — Ensure the vision is clear +2. **Run create-module workflow** — Build the module structure +3. **Create agents** — Use create-agent workflow for each agent +4. **Create workflows** — Use create-workflow workflow for each workflow +5. **Test module** — Install and verify functionality + +--- + +_brief created on {date} by {user_name} using the BMAD Module workflow_ diff --git a/src/modules/bmb/workflows/module/templates/workflow-spec-template.md b/src/modules/bmb/workflows/module/templates/workflow-spec-template.md new file mode 100644 index 00000000..40133a8b --- /dev/null +++ b/src/modules/bmb/workflows/module/templates/workflow-spec-template.md @@ -0,0 +1,96 @@ +# Workflow Specification: {workflow_name} + +**Module:** {module_code} +**Status:** Placeholder — To be created via create-workflow workflow +**Created:** {date} + +--- + +## Workflow Overview + +**Goal:** {workflow_goal} + +**Description:** {workflow_description} + +**Workflow Type:** {workflow_type} + +--- + +## Workflow Structure + +### Entry Point + +```yaml +--- +name: {workflow_name} +description: {workflow_description} +web_bundle: true +installed_path: '{project-root}/_bmad/{module_code}/workflows/{workflow_folder_name}' +--- +``` + +### Mode + +- [ ] Create-only (steps-c/) +- [ ] Tri-modal (steps-c/, steps-e/, steps-v/) + +--- + +## Planned Steps + +| Step | Name | Goal | +|------|------|------| +{workflow_steps_table} + +--- + +## Workflow Inputs + +### Required Inputs + +{required_inputs} + +### Optional Inputs + +{optional_inputs} + +--- + +## Workflow Outputs + +### Output Format + +- [ ] Document-producing +- [ ] Non-document + +### Output Files + +{output_files} + +--- + +## Agent Integration + +### Primary Agent + +{primary_agent} + +### Other Agents + +{other_agents} + +--- + +## Implementation Notes + +**Use the create-workflow workflow to build this workflow.** + +Inputs needed: +- Workflow name and description +- Step structure and sequence +- Input/output specifications +- Agent associations + +--- + +_Spec created on {date} via BMAD Module workflow_ diff --git a/src/modules/bmb/workflows/module/workflow.md b/src/modules/bmb/workflows/module/workflow.md new file mode 100644 index 00000000..98a93694 --- /dev/null +++ b/src/modules/bmb/workflows/module/workflow.md @@ -0,0 +1,100 @@ +--- +name: module +description: Quad-modal workflow for creating BMAD modules (Brief + Create + Edit + Validate) +web_bundle: true +installed_path: '{project-root}/_bmad/bmb/workflows/module' +--- + +# Module Workflow + +The module workflow guides users through creating complete, installable BMAD modules through a quad-modal process: **Brief → Create → Edit → Validate**. + +## What This Workflow Does + +- **Brief mode** — Collaboratively explore and design your module vision +- **Create mode** — Build the module structure from a brief +- **Edit mode** — Modify existing briefs or modules +- **Validate mode** — Check compliance and completeness + +## Role + +You are the **Module Architect** — a specialist in BMAD module design. You understand that modules are complex entities requiring careful planning before implementation. + +--- + +## INITIALIZATION SEQUENCE + +### 1. Mode Determination + +**Check invocation context:** +- Look for existing module brief or plan +- Check if user is starting fresh or continuing work +- Determine what mode they need + +**Ask the user:** + +**"Welcome to the Module workflow! What would you like to do?"** + +- **[B] Brief** — Create a module brief (exploratory, creative discovery) +- **[C] Create** — Build a module from a brief +- **[E] Edit** — Modify an existing brief or module +- **[V] Validate** — Validate a brief or module + +### 2. Route to First Step + +**IF mode == brief (B):** +Load `{installed_path}/steps-b/step-01-welcome.md` + +**IF mode == create (C):** +Ask: "Where is the module brief?" → Load `{installed_path}/steps-c/step-01-load-brief.md` + +**IF mode == edit (E):** +Ask: "What would you like to edit?" → Load `{installed_path}/steps-e/step-01-assess.md` + +**IF mode == validate (V):** +Ask: "What would you like to validate?" → Load `{installed_path}/steps-v/step-01-validate.md` + +--- + +## Configuration + +This workflow references: +- `{installed_path}/data/` — Module standards and templates +- `{installed_path}/templates/` — Output templates + +--- + +## Workflow Structure + +``` +module/ +├── workflow.md # This file - mode routing +├── data/ # Shared standards +│ ├── module-standards.md +│ ├── module-yaml-conventions.md +│ ├── agent-architecture.md +│ └── module-installer-standards.md +├── templates/ # Output templates +│ ├── brief-template.md +│ ├── agent-spec-template.md +│ └── workflow-spec-template.md +├── steps-b/ # Brief mode (13 steps) +├── steps-c/ # Create mode (8 steps) +├── steps-e/ # Edit mode +└── steps-v/ # Validate mode +``` + +--- + +## Output + +**Brief mode produces:** +- `module-brief-{code}.md` — Complete module vision document + +**Create mode produces:** +- Module directory structure +- `module.yaml` with install configuration +- `_module-installer/` folder (if needed) +- Agent placeholder/spec files +- Workflow placeholder/spec files +- `README.md` and `TODO.md` diff --git a/src/modules/bmb/workflows/workflow-compliance-check/steps/step-01-validate-goal.md b/src/modules/bmb/workflows/workflow-compliance-check/steps/step-01-validate-goal.md deleted file mode 100644 index 912a554e..00000000 --- a/src/modules/bmb/workflows/workflow-compliance-check/steps/step-01-validate-goal.md +++ /dev/null @@ -1,152 +0,0 @@ ---- -name: 'step-01-validate-goal' -description: 'Confirm workflow path and validation goals before proceeding' - -# Path Definitions -workflow_path: '{project-root}/_bmad/bmb/workflows/workflow-compliance-check' - -# File References -thisStepFile: '{workflow_path}/steps/step-01-validate-goal.md' -nextStepFile: '{workflow_path}/steps/step-02-workflow-validation.md' -workflowFile: '{workflow_path}/workflow.md' -complianceReportFile: '{output_folder}/workflow-compliance-report-{workflow_name}.md' - -# Template References -complianceReportTemplate: '{workflow_path}/templates/compliance-report.md' - -# Documentation References -stepTemplate: '{project-root}/_bmad/bmb/docs/workflows/templates/step-template.md' -workflowTemplate: '{project-root}/_bmad/bmb/docs/workflows/templates/workflow-template.md' ---- - -# Step 1: Goal Confirmation and Workflow Target - -## STEP GOAL: - -Confirm the target workflow path and validation objectives before proceeding with systematic compliance analysis. - -## MANDATORY EXECUTION RULES (READ FIRST): - -### Universal Rules: - -- 🛑 NEVER generate content without user input -- 📖 CRITICAL: Read the complete step file before taking any action -- 🔄 CRITICAL: When loading next step with 'C', ensure entire file is read -- 📋 YOU ARE A FACILITATOR, not a content generator - -### Role Reinforcement: - -- ✅ You are a compliance validator and quality assurance specialist -- ✅ If you already have been given a name, communication_style and persona, continue to use those while playing this new role -- ✅ We engage in collaborative dialogue, not command-response -- ✅ You bring compliance expertise and systematic validation skills -- ✅ User brings their workflow and specific compliance concerns - -### Step-Specific Rules: - -- 🎯 Focus only on confirming workflow path and validation scope -- 🚫 FORBIDDEN to proceed without clear target confirmation -- 💬 Approach: Systematic and thorough confirmation of validation objectives -- 📋 Ensure user understands the compliance checking process and scope - -## EXECUTION PROTOCOLS: - -- 🎯 Confirm target workflow path exists and is accessible -- 💾 Establish clear validation objectives and scope -- 📖 Explain the three-phase compliance checking process -- 🚫 FORBIDDEN to proceed without user confirmation of goals - -## CONTEXT BOUNDARIES: - -- Available context: User-provided workflow path and validation concerns -- Focus: Goal confirmation and target validation setup -- Limits: No actual compliance analysis yet, just setup and confirmation -- Dependencies: Clear workflow path and user agreement on validation scope - -## Sequence of Instructions (Do not deviate, skip, or optimize) - -### 1. Workflow Target Confirmation - -Present this to the user: - -"I'll systematically validate your workflow against BMAD standards through three phases: - -1. **Workflow.md Validation** - Against workflow-template.md standards -2. **Step-by-Step Compliance** - Each step against step-template.md -3. **Holistic Analysis** - Flow optimization and goal alignment" - -IF {user_provided_path} has NOT been provided, ask the user: - -**What workflow should I validate?** Please provide the full path to the workflow.md file." - -### 2. Workflow Path Validation - -Once user provides path: - -"Validating workflow path: `{user_provided_path}`" -[Check if path exists and is readable] - -**If valid:** "✅ Workflow found and accessible. Ready to begin compliance analysis." -**If invalid:** "❌ Cannot access workflow at that path. Please check the path and try again." - -### 3. Validation Scope Confirmation - -"**Compliance Scope:** I will check: - -- ✅ Frontmatter structure and required fields -- ✅ Mandatory execution rules and sections -- ✅ Menu patterns and continuation logic -- ✅ Path variable format consistency -- ✅ Template usage appropriateness -- ✅ Workflow flow and goal alignment -- ✅ Meta-workflow failure analysis - -**Report Output:** I'll generate a detailed compliance report with: - -- Severity-ranked violations (Critical/Major/Minor) -- Specific template references for each violation -- Recommended fixes (automated where possible) -- Meta-feedback for create/edit workflow improvements - -**Is this validation scope acceptable?**" - -### 4. Final Confirmation - -"**Ready to proceed with compliance check of:** - -- **Workflow:** `{workflow_name}` -- **Validation:** Full systematic compliance analysis -- **Output:** Detailed compliance report with fix recommendations - -**Select an Option:** [C] Continue [X] Exit" - -## Menu Handling Logic: - -- IF C: Initialize compliance report, update frontmatter, then load, read entire file, then execute {nextStepFile} -- IF X: End workflow gracefully with guidance on running again later -- IF Any other comments or queries: help user respond then [Redisplay Menu Options](#4-final-confirmation) - -## CRITICAL STEP COMPLETION NOTE - -ONLY WHEN [C continue option] is selected and [workflow path validated and scope confirmed], will you then load and read fully `{nextStepFile}` to execute and begin workflow.md validation phase. - ---- - -## 🚨 SYSTEM SUCCESS/FAILURE METRICS - -### ✅ SUCCESS: - -- Workflow path successfully validated and accessible -- User confirms validation scope and objectives -- Compliance report initialization prepared -- User understands the three-phase validation process -- Clear next steps established for systematic analysis - -### ❌ SYSTEM FAILURE: - -- Proceeding without valid workflow path confirmation -- Not ensuring user understands validation scope and process -- Starting compliance analysis without proper setup -- Failing to establish clear reporting objectives - -**Master Rule:** Skipping steps, optimizing sequences, or not following exact instructions is FORBIDDEN and constitutes SYSTEM FAILURE. diff --git a/src/modules/bmb/workflows/workflow-compliance-check/steps/step-02-workflow-validation.md b/src/modules/bmb/workflows/workflow-compliance-check/steps/step-02-workflow-validation.md deleted file mode 100644 index 6028ee28..00000000 --- a/src/modules/bmb/workflows/workflow-compliance-check/steps/step-02-workflow-validation.md +++ /dev/null @@ -1,243 +0,0 @@ ---- -name: 'step-02-workflow-validation' -description: 'Validate workflow.md against workflow-template.md standards' - -# Path Definitions -workflow_path: '{project-root}/_bmad/bmb/workflows/workflow-compliance-check' - -# File References -thisStepFile: '{workflow_path}/steps/step-02-workflow-validation.md' -nextStepFile: '{workflow_path}/steps/step-03-step-validation.md' -workflowFile: '{workflow_path}/workflow.md' -complianceReportFile: '{output_folder}/workflow-compliance-report-{workflow_name}.md' -targetWorkflowFile: '{target_workflow_path}' - -# Template References -complianceReportTemplate: '{workflow_path}/templates/compliance-report.md' - -# Documentation References -stepTemplate: '{project-root}/_bmad/bmb/docs/workflows/templates/step-template.md' -workflowTemplate: '{project-root}/_bmad/bmb/docs/workflows/templates/workflow-template.md' ---- - -# Step 2: Workflow.md Validation - -## STEP GOAL: - -Perform adversarial validation of the target workflow.md against workflow-template.md standards, identifying all violations with severity rankings and specific fix recommendations. - -## MANDATORY EXECUTION RULES (READ FIRST): - -### Universal Rules: - -- 🛑 NEVER generate content without user input -- 📖 CRITICAL: Read the complete step file before taking any action -- 🔄 CRITICAL: When loading next step with 'C', ensure entire file is read -- 📋 YOU ARE A FACILITATOR, not a content generator - -### Role Reinforcement: - -- ✅ You are a compliance validator and quality assurance specialist -- ✅ If you already have been given a name, communication_style and persona, continue to use those while playing this new role -- ✅ We engage in collaborative dialogue, not command-response -- ✅ You bring adversarial validation expertise - your success is finding violations -- ✅ User brings their workflow and needs honest, thorough validation - -### Step-Specific Rules: - -- 🎯 Focus only on workflow.md validation against template standards -- 🚫 FORBIDDEN to skip or minimize any validation checks -- 💬 Approach: Systematic, thorough adversarial analysis -- 📋 Document every violation with template reference and severity ranking - -## EXECUTION PROTOCOLS: - -- 🎯 Load and compare target workflow.md against workflow-template.md -- 💾 Document all violations with specific template references -- 📖 Rank violations by severity (Critical/Major/Minor) -- 🚫 FORBIDDEN to overlook any template violations - -## CONTEXT BOUNDARIES: - -- Available context: Validated workflow path and target workflow.md -- Focus: Systematic validation of workflow.md structure and content -- Limits: Only workflow.md validation, not step files yet -- Dependencies: Successful completion of goal confirmation step - -## Sequence of Instructions (Do not deviate, skip, or optimize) - -### 1. Initialize Compliance Report - -"Beginning **Phase 1: Workflow.md Validation** -Target: `{target_workflow_name}` - -**COMPLIANCE STANDARD:** All validation performed against `{workflowTemplate}` - this is THE authoritative standard for workflow.md compliance. - -Loading workflow templates and target files for systematic analysis..." -[Load workflowTemplate, targetWorkflowFile] - -### 2. Frontmatter Structure Validation - -**Check these elements systematically:** - -"**Frontmatter Validation:**" - -- Required fields: name, description, web_bundle -- Proper YAML format and syntax -- Boolean value format for web_bundle -- Missing or invalid fields - -For each violation found: - -- **Template Reference:** Section "Frontmatter Structure" in workflow-template.md -- **Severity:** Critical (missing required) or Major (format issues) -- **Specific Fix:** Exact correction needed - -### 3. Role Description Validation - -**Check role compliance:** - -"**Role Description Validation:**" - -- Follows partnership format: "In addition to your name, communication_style, and persona, you are also a [role] collaborating with [user type]. This is a partnership, not a client-vendor relationship. You bring [your expertise], while the user brings [their expertise]. Work together as equals." -- Role accurately describes workflow function -- User type correctly identified -- Partnership language present - -For violations: - -- **Template Reference:** "Your Role" section in workflow-template.md -- **Severity:** Major (deviation from standard) or Minor (incomplete) -- **Specific Fix:** Exact wording or structure correction - -### 4. Workflow Architecture Validation - -**Validate architecture section:** - -"**Architecture Validation:**" - -- Core Principles section matches template exactly -- Step Processing Rules includes all 6 rules from template -- Critical Rules section matches template exactly (NO EXCEPTIONS) - -For each deviation: - -- **Template Reference:** "WORKFLOW ARCHITECTURE" section in workflow-template.md -- **Severity:** Critical (modified core principles) or Major (missing rules) -- **Specific Fix:** Restore template-compliant text - -### 5. Initialization Sequence Validation - -**Check initialization:** - -"**Initialization Validation:**" - -- Configuration Loading uses correct path format: `{project-root}/_bmad/[module]/config.yaml` (variable substitution pattern) -- First step follows pattern: `step-01-init.md` OR documented deviation -- Required config variables properly listed -- Variables use proper substitution pattern: {project-root}, _bmad, {workflow_path}, etc. - -For violations: - -- **Template Reference:** "INITIALIZATION SEQUENCE" section in workflow-template.md -- **Severity:** Major (incorrect paths or missing variables) or Minor (format issues) -- **Specific Fix:** Use proper variable substitution patterns for flexible installation - -### 6. Document Workflow.md Findings - -"**Workflow.md Validation Complete** -Found [X] Critical, [Y] Major, [Z] Minor violations - -**Summary:** - -- Critical violations must be fixed before workflow can function -- Major violations impact workflow reliability and maintainability -- Minor violations are cosmetic but should follow standards - -**Next Phase:** Step-by-step validation of all step files..." - -### 7. Update Compliance Report - -Append to {complianceReportFile}: - -```markdown -## Phase 1: Workflow.md Validation Results - -### Template Adherence Analysis - -**Reference Standard:** {workflowTemplate} - -### Frontmatter Structure Violations - -[Document each violation with severity and specific fix] - -### Role Description Violations - -[Document each violation with template reference and correction] - -### Workflow Architecture Violations - -[Document each deviation from template standards] - -### Initialization Sequence Violations - -[Document each path or reference issue] - -### Phase 1 Summary - -**Critical Issues:** [number] -**Major Issues:** [number] -**Minor Issues:** [number] - -### Phase 1 Recommendations - -[Prioritized fix recommendations with specific actions] -``` - -### 8. Continuation Confirmation - -"**Phase 1 Complete:** Workflow.md validation finished with detailed violation analysis. - -**Ready for Phase 3:** Step-by-step validation against step-template.md - -This will check each step file for: - -- Frontmatter completeness and format -- MANDATORY EXECUTION RULES compliance -- Menu pattern and continuation logic -- Path variable consistency -- Template appropriateness - -**Select an Option:** [C] Continue to Step Validation [X] Exit" - -## Menu Handling Logic: - -- IF C: Save workflow.md findings to report, update frontmatter, then load, read entire file, then execute {nextStepFile} -- IF X: Save current findings and end workflow with guidance for resuming -- IF Any other comments or queries: respond and redisplay menu - -## CRITICAL STEP COMPLETION NOTE - -ONLY WHEN [C continue option] is selected and [workflow.md validation complete with all violations documented], will you then load and read fully `{nextStepFile}` to execute and begin step-by-step validation phase. - ---- - -## 🚨 SYSTEM SUCCESS/FAILURE METRICS - -### ✅ SUCCESS: - -- Complete workflow.md validation against workflow-template.md -- All violations documented with severity rankings and template references -- Specific fix recommendations provided for each violation -- Compliance report updated with Phase 1 findings -- User confirms understanding before proceeding - -### ❌ SYSTEM FAILURE: - -- Skipping any workflow.md validation sections -- Not documenting violations with specific template references -- Failing to rank violations by severity -- Providing vague or incomplete fix recommendations -- Proceeding without user confirmation of findings - -**Master Rule:** Skipping steps, optimizing sequences, or not following exact instructions is FORBIDDEN and constitutes SYSTEM FAILURE. diff --git a/src/modules/bmb/workflows/workflow-compliance-check/steps/step-03-step-validation.md b/src/modules/bmb/workflows/workflow-compliance-check/steps/step-03-step-validation.md deleted file mode 100644 index d72f5886..00000000 --- a/src/modules/bmb/workflows/workflow-compliance-check/steps/step-03-step-validation.md +++ /dev/null @@ -1,274 +0,0 @@ ---- -name: 'step-03-step-validation' -description: 'Validate each step file against step-template.md standards' - -# Path Definitions -workflow_path: '{project-root}/_bmad/bmb/workflows/workflow-compliance-check' - -# File References -thisStepFile: '{workflow_path}/steps/step-03-step-validation.md' -nextStepFile: '{workflow_path}/steps/step-04-file-validation.md' -workflowFile: '{workflow_path}/workflow.md' -complianceReportFile: '{output_folder}/workflow-compliance-report-{workflow_name}.md' -targetWorkflowStepsPath: '{target_workflow_steps_path}' - -# Template References -complianceReportTemplate: '{workflow_path}/templates/compliance-report.md' - -# Documentation References -stepTemplate: '{project-root}/_bmad/bmb/docs/workflows/templates/step-template.md' -workflowTemplate: '{project-root}/_bmad/bmb/docs/workflows/templates/workflow-template.md' ---- - -# Step 3: Step-by-Step Validation - -## STEP GOAL: - -Perform systematic adversarial validation of each step file against step-template.md standards, documenting all violations with specific template references and severity rankings. - -## MANDATORY EXECUTION RULES (READ FIRST): - -### Universal Rules: - -- 🛑 NEVER generate content without user input -- 📖 CRITICAL: Read this complete step file before taking any action -- 🔄 CRITICAL: When loading next step with 'C', ensure entire file is read -- 📋 YOU ARE A FACILITATOR, not a content generator - -### Role Reinforcement: - -- ✅ You are a compliance validator and quality assurance specialist -- ✅ If you already have been given a name, communication_style and persona, continue to use those while playing this new role -- ✅ We engage in collaborative dialogue, not command-response -- ✅ You bring adversarial step-by-step validation expertise -- ✅ User brings their workflow steps and needs thorough validation - -### Step-Specific Rules: - -- 🎯 Focus only on step file validation against step-template.md -- 🚫 FORBIDDEN to skip any step files or validation checks -- 💬 Approach: Systematic file-by-file adversarial analysis -- 📋 Document every violation against each step file with template reference and specific proposed fixes - -## EXECUTION PROTOCOLS: - -- 🎯 Load and validate each step file individually against step-template.md -- 💾 Document violations by file with severity rankings -- 📖 Check for appropriate template usage based on workflow type -- 🚫 FORBIDDEN to overlook any step file or template requirement - -## CONTEXT BOUNDARIES: - -- Available context: Target workflow step files and step-template.md -- Focus: Systematic validation of all step files against template standards -- Limits: Only step file validation, holistic analysis comes next -- Dependencies: Completed workflow.md validation from previous phase - -## Sequence of Instructions (Do not deviate, skip, or optimize) - -### 1. Initialize Step Validation Phase - -"Beginning **Phase 2: Step-by-Step Validation** -Target: `{target_workflow_name}` - [number] step files found - -**COMPLIANCE STANDARD:** All validation performed against `{stepTemplate}` - this is THE authoritative standard for step file compliance. - -Loading step template and validating each step systematically..." -[Load stepTemplate, enumerate all step files]. Utilize sub processes if available but ensure all rules are passed in and all findings are returned from the sub process to collect and record the results. - -### 2. Systematic Step File Analysis - -For each step file in order: - -"**Validating step:** `{step_filename}`" - -**A. Frontmatter Structure Validation:** -Check each required field: - -```yaml ---- -name: 'step-[number]-[name]' # Single quotes, proper format -description: '[description]' # Single quotes -workflowFile: '{workflow_path}/workflow.md' # REQUIRED - often missing -outputFile: [if appropriate for workflow type] -# All other path references and variables -# Template References section (even if empty) -# Task References section ---- -``` - -**Violations to document:** - -- Missing `workflowFile` reference (Critical) -- Incorrect YAML format (missing quotes, etc.) (Major) -- Inappropriate `outputFile` for workflow type (Major) -- Missing `Template References` section (Major) - -**B. MANDATORY EXECUTION RULES Validation:** -Check for complete sections: - -```markdown -## MANDATORY EXECUTION RULES (READ FIRST): - -### Universal Rules: - -- 🛑 NEVER generate content without user input -- 📖 CRITICAL: Read the complete step file before taking any action -- 🔄 CRITICAL: When loading next step with 'C', ensure entire file is read -- 📋 YOU ARE A FACILITATOR, not a content generator - -### Role Reinforcement: - -[Complete role reinforcement section] - -### Step-Specific Rules: - -[Step-specific rules with proper emoji usage] -``` - -**Violations to document:** - -- Missing Universal Rules (Critical) -- Modified/skipped Universal Rules (Critical) -- Missing Role Reinforcement (Major) -- Improper emoji usage in rules (Minor) - -**C. Task References Validation:** -Check for proper references: - -```yaml -# Task References -advancedElicitationTask: '{project-root}/_bmad/core/tasks/advanced-elicitation.xml' -partyModeWorkflow: '{project-root}/_bmad/core/workflows/party-mode/workflow.md' -``` - -**Violations to document:** - -- Missing Task References section (Major) -- Incorrect paths in task references (Major) -- Missing standard task references (Minor) - -**D. Menu Pattern Validation:** -Check menu structure: - -```markdown -Display: "**Select an Option:** [A] Advanced Elicitation [P] Party Mode [C] Continue" - -#### Menu Handling Logic: - -- IF A: Execute {advancedElicitationTask} -- IF P: Execute {partyModeWorkflow} -- IF C: Save content to {outputFile}, update frontmatter, then only then load, read entire file, then execute {nextStepFile} -``` - -**Violations to document:** - -- Non-standard menu format (Major) -- Missing Menu Handling Logic section (Major) -- Incorrect "load, read entire file, then execute" pattern (Major) -- Improper continuation logic (Critical) - -### 3. Workflow Type Appropriateness Check - -"**Template Usage Analysis:**" - -- **Document Creation Workflows:** Should have outputFile references, templates -- **Editing Workflows:** Should NOT create unnecessary outputs, direct action focus -- **Validation/Analysis Workflows:** Should emphasize systematic checking - -For each step: - -- **Type Match:** Does step content match workflow type expectations? -- **Template Appropriate:** Are templates/outputs appropriate for this workflow type? -- **Alternative Suggestion:** What would be more appropriate? - -### 4. Path Variable Consistency Check - -"**Path Variable Validation:**" - -- Check format: `{project-root}/_bmad/bmb/...` vs `{project-root}/bmb/...` -- Ensure consistent variable usage across all step files -- Validate relative vs absolute path usage - -Document inconsistencies and standard format requirements. - -### 5. Document Step Validation Results - -For each step file with violations: - -```markdown -### Step Validation: step-[number]-[name].md - -**Critical Violations:** - -- [Violation] - Template Reference: [section] - Fix: [specific action] - -**Major Violations:** - -- [Violation] - Template Reference: [section] - Fix: [specific action] - -**Minor Violations:** - -- [Violation] - Template Reference: [section] - Fix: [specific action] - -**Workflow Type Assessment:** - -- Appropriate: [Yes/No] - Reason: [analysis] -- Recommended Changes: [specific suggestions] -``` - -### 6. Phase Summary and Continuation - -"**Phase 2 Complete:** Step-by-step validation finished - -- **Total Steps Analyzed:** [number] -- **Critical Violations:** [number] across [number] steps -- **Major Violations:** [number] across [number] steps -- **Minor Violations:** [number] across [number] steps - -**Most Common Violations:** - -1. [Most frequent violation type] -2. [Second most frequent] -3. [Third most frequent] - -**Ready for Phase 4:** File Validation workflow analysis - -- Flow optimization assessment -- Goal alignment verification -- Meta-workflow failure analysis - -**Select an Option:** [C] Continue to File Validation [X] Exit" - -## Menu Handling Logic: - -- IF C: Save step validation findings to report, update frontmatter, then load, read entire file, then execute {nextStepFile} -- IF X: Save current findings and end with guidance for resuming -- IF Any other comments or queries: respond and redisplay menu - -## CRITICAL STEP COMPLETION NOTE - -ONLY WHEN [C continue option] is selected and [all step files validated with violations documented], will you then load and read fully `{nextStepFile}` to execute and begin holistic analysis phase. - ---- - -## 🚨 SYSTEM SUCCESS/FAILURE METRICS - -### ✅ SUCCESS: - -- All step files systematically validated against step-template.md -- Every violation documented with specific template reference and severity -- Workflow type appropriateness assessed for each step -- Path variable consistency checked across all files -- Common violation patterns identified and prioritized -- Compliance report updated with complete Phase 2 findings - -### ❌ SYSTEM FAILURE: - -- Skipping step files or validation sections -- Not documenting violations with specific template references -- Failing to assess workflow type appropriateness -- Missing path variable consistency analysis -- Providing incomplete or vague fix recommendations - -**Master Rule:** Skipping steps, optimizing sequences, or not following exact instructions is FORBIDDEN and constitutes SYSTEM FAILURE. diff --git a/src/modules/bmb/workflows/workflow-compliance-check/steps/step-04-file-validation.md b/src/modules/bmb/workflows/workflow-compliance-check/steps/step-04-file-validation.md deleted file mode 100644 index fe3c1f3f..00000000 --- a/src/modules/bmb/workflows/workflow-compliance-check/steps/step-04-file-validation.md +++ /dev/null @@ -1,295 +0,0 @@ ---- -name: 'step-04-file-validation' -description: 'Validate file sizes, markdown formatting, and CSV data files' - -# Path Definitions -workflow_path: '{project-root}/_bmad/bmb/workflows/workflow-compliance-check' - -# File References -thisStepFile: '{workflow_path}/steps/step-04-file-validation.md' -nextStepFile: '{workflow_path}/steps/step-05-intent-spectrum-validation.md' -workflowFile: '{workflow_path}/workflow.md' -complianceReportFile: '{output_folder}/workflow-compliance-report-{workflow_name}.md' -targetWorkflowPath: '{target_workflow_path}' - -# Template References -complianceReportTemplate: '{workflow_path}/templates/compliance-report.md' - -# Documentation References -stepTemplate: '{project-root}/_bmad/bmb/docs/workflows/templates/step-template.md' -workflowTemplate: '{project-root}/_bmad/bmb/docs/workflows/templates/workflow-template.md' -csvStandards: '{project-root}/_bmad/bmb/docs/workflows/csv-data-file-standards.md' ---- - -# Step 4: File Size, Formatting, and Data Validation - -## STEP GOAL: - -Validate file sizes, markdown formatting standards, and CSV data file compliance to ensure optimal workflow performance and maintainability. - -## MANDATORY EXECUTION RULES (READ FIRST): - -### Universal Rules: - -- 🛑 NEVER generate content without user input -- 📖 CRITICAL: Read the complete step file before taking any action -- 🔄 CRITICAL: When loading next step with 'C', ensure entire file is read -- 📋 YOU ARE A FACILITATOR, not a content generator - -### Role Reinforcement: - -- ✅ You are a compliance validator and quality assurance specialist -- ✅ If you already have been given a name, communication_style, and persona, continue to use those while playing this new role -- ✅ We engage in collaborative dialogue, not command-response -- ✅ You bring file optimization and formatting validation expertise -- ✅ User brings their workflow files and needs performance optimization - -### Step-Specific Rules: - -- 🎯 Focus on file sizes, markdown formatting, and CSV validation -- 🚫 FORBIDDEN to skip file size analysis or CSV validation when present -- 💬 Approach: Systematic file analysis with optimization recommendations -- 📋 Ensure all findings include specific recommendations for improvement - -## EXECUTION PROTOCOLS: - -- 🎯 Validate file sizes against optimal ranges (≤5K best, 5-7K good, 7-10K acceptable, 10-12K concern, >15K action required) -- 💾 Check markdown formatting standards and conventions -- 📖 Validate CSV files against csv-data-file-standards.md when present -- 🚫 FORBIDDEN to overlook file optimization opportunities - -## CONTEXT BOUNDARIES: - -- Available context: Target workflow files and their sizes/formats -- Focus: File optimization, formatting standards, and CSV data validation -- Limits: File analysis only, holistic workflow analysis comes next -- Dependencies: Completed step-by-step validation from previous phase - -## Sequence of Instructions (Do not deviate, skip, or optimize) - -### 1. Initialize File Validation Phase - -"Beginning **File Size, Formatting, and Data Validation** -Target: `{target_workflow_name}` - -Analyzing workflow files for: - -- File size optimization (smaller is better for performance) -- Markdown formatting standards compliance -- CSV data file standards validation (if present) -- Overall file maintainability and performance..." - -### 2. File Size Analysis - -**A. Step File Size Validation:** -For each step file: - -"**File Size Analysis:** `{step_filename}`" - -- **Size:** [file size in KB] -- **Optimization Rating:** [Optimal/Good/Acceptable/Concern/Action Required] -- **Performance Impact:** [Minimal/Moderate/Significant/Severe] - -**Size Ratings:** - -- **≤ 5K:** ✅ Optimal - Excellent performance and maintainability -- **5K-7K:** ✅ Good - Good balance of content and performance -- **7K-10K:** ⚠️ Acceptable - Consider content optimization -- **10K-12K:** ⚠️ Concern - Content should be consolidated or split -- **> 15K:** ❌ Action Required - File must be optimized (split content, remove redundancy) - -**Document optimization opportunities:** - -- Content that could be moved to templates -- Redundant explanations or examples -- Overly detailed instructions that could be condensed -- Opportunities to use references instead of inline content - -### 3. Markdown Formatting Validation - -**A. Heading Structure Analysis:** -"**Markdown Formatting Analysis:**" - -For each file: - -- **Heading Hierarchy:** Proper H1 → H2 → H3 structure -- **Consistent Formatting:** Consistent use of bold, italics, lists -- **Code Blocks:** Proper markdown code block formatting -- **Link References:** Valid internal and external links -- **Table Formatting:** Proper table structure when used - -**Common formatting issues to document:** - -- Missing blank lines around headings -- Inconsistent list formatting (numbered vs bullet) -- Improper code block language specifications -- Broken or invalid markdown links -- Inconsistent heading levels or skipping levels - -### 4. CSV Data File Validation (if present) - -**A. Identify CSV Files:** -"**CSV Data File Analysis:**" -Check for CSV files in workflow directory: - -- Look for `.csv` files in main directory -- Check for `data/` subdirectory containing CSV files -- Identify any CSV references in workflow configuration - -**B. Validate Against Standards:** -For each CSV file found, validate against `{csvStandards}`: - -**Purpose Validation:** - -- Does CSV contain essential data that LLMs cannot generate or web-search? -- Is all CSV data referenced and used in the workflow? -- Is data domain-specific and valuable? -- Does CSV optimize context usage (knowledge base indexing, workflow routing, method selection)? -- Does CSV reduce workflow complexity or step count significantly? -- Does CSV enable dynamic technique selection or smart resource routing? - -**Structural Validation:** - -- Valid CSV format with proper quoting -- Consistent column counts across all rows -- No missing data or properly marked empty values -- Clear, descriptive header row -- Proper UTF-8 encoding - -**Content Validation:** - -- No LLM-generated content (generic phrases, common knowledge) -- Specific, concrete data entries -- Consistent data formatting -- Verifiable and factual data - -**Column Standards:** - -- Clear, descriptive column headers -- Consistent data types per column -- All columns referenced in workflow -- Appropriate column width and focus - -**File Size and Performance:** - -- Efficient structure under 1MB when possible -- No redundant or duplicate rows -- Optimized data representation -- Fast loading characteristics - -**Documentation Standards:** - -- Purpose and usage documentation present -- Column descriptions and format specifications -- Data source documentation -- Update procedures documented - -### 5. File Validation Reporting - -For each file with issues: - -```markdown -### File Validation: {filename} - -**File Size Analysis:** - -- Size: {size}KB - Rating: {Optimal/Good/Concern/etc.} -- Performance Impact: {assessment} -- Optimization Recommendations: {specific suggestions} - -**Markdown Formatting:** - -- Heading Structure: {compliant/issues found} -- Common Issues: {list of formatting problems} -- Fix Recommendations: {specific corrections} - -**CSV Data Validation:** - -- Purpose Validation: {compliant/needs review} -- Structural Issues: {list of problems} -- Content Standards: {compliant/violations} -- Recommendations: {improvement suggestions} -``` - -### 6. Aggregate File Analysis Summary - -"**File Validation Summary:** - -**File Size Distribution:** - -- Optimal (≤5K): [number] files -- Good (5K-7K): [number] files -- Acceptable (7K-10K): [number] files -- Concern (10K-12K): [number] files -- Action Required (>15K): [number] files - -**Markdown Formatting Issues:** - -- Heading Structure: [number] files with issues -- List Formatting: [number] files with inconsistencies -- Code Blocks: [number] files with formatting problems -- Link References: [number] broken or invalid links - -**CSV Data Files:** - -- Total CSV files: [number] -- Compliant with standards: [number] -- Require attention: [number] -- Critical issues: [number] - -**Performance Impact Assessment:** - -- Overall workflow performance: [Excellent/Good/Acceptable/Concern/Poor] -- Most critical file size issue: {file and size} -- Primary formatting concerns: {main issues}" - -### 7. Continuation Confirmation - -"**File Validation Complete:** Size, formatting, and CSV analysis finished - -**Key Findings:** - -- **File Optimization:** [summary of size optimization opportunities] -- **Formatting Standards:** [summary of markdown compliance issues] -- **Data Validation:** [summary of CSV standards compliance] - -**Ready for Phase 5:** Intent Spectrum Validation analysis - -- Flow validation and goal alignment -- Meta-workflow failure analysis -- Strategic recommendations and improvement planning - -**Select an Option:** [C] Continue to Intent Spectrum Validation [X] Exit" - -## Menu Handling Logic: - -- IF C: Save file validation findings to report, update frontmatter, then load, read entire file, then execute {nextStepFile} -- IF X: Save current findings and end with guidance for resuming -- IF Any other comments or queries: respond and redisplay menu - -## CRITICAL STEP COMPLETION NOTE - -ONLY WHEN [C continue option] is selected and [all file sizes analyzed, markdown formatting validated, and CSV files checked against standards], will you then load and read fully `{nextStepFile}` to execute and begin Intent Spectrum Validation phase. - ---- - -## 🚨 SYSTEM SUCCESS/FAILURE METRICS - -### ✅ SUCCESS: - -- All workflow files analyzed for optimal size ranges with specific recommendations -- Markdown formatting validated against standards with identified issues -- CSV data files validated against csv-data-file-standards.md when present -- Performance impact assessed with optimization opportunities identified -- File validation findings documented with specific fix recommendations -- User ready for holistic workflow analysis - -### ❌ SYSTEM FAILURE: - -- Skipping file size analysis or markdown formatting validation -- Not checking CSV files against standards when present -- Failing to provide specific optimization recommendations -- Missing performance impact assessment -- Overlooking critical file size violations (>15K) - -**Master Rule:** Skipping steps, optimizing sequences, or not following exact instructions is FORBIDDEN and constitutes SYSTEM FAILURE. diff --git a/src/modules/bmb/workflows/workflow-compliance-check/steps/step-05-intent-spectrum-validation.md b/src/modules/bmb/workflows/workflow-compliance-check/steps/step-05-intent-spectrum-validation.md deleted file mode 100644 index 0f53be96..00000000 --- a/src/modules/bmb/workflows/workflow-compliance-check/steps/step-05-intent-spectrum-validation.md +++ /dev/null @@ -1,264 +0,0 @@ ---- -name: 'step-05-intent-spectrum-validation' -description: 'Dedicated analysis and validation of intent vs prescriptive spectrum positioning' - -# Path Definitions -workflow_path: '{project-root}/_bmad/bmb/workflows/workflow-compliance-check' - -# File References -thisStepFile: '{workflow_path}/steps/step-05-intent-spectrum-validation.md' -nextStepFile: '{workflow_path}/steps/step-06-web-subprocess-validation.md' -workflowFile: '{workflow_path}/workflow.md' -complianceReportFile: '{output_folder}/workflow-compliance-report-{workflow_name}.md' -targetWorkflowPath: '{target_workflow_path}' - -# Template References -complianceReportTemplate: '{workflow_path}/templates/compliance-report.md' - -# Documentation References -stepTemplate: '{project-root}/_bmad/bmb/docs/workflows/templates/step-template.md' -workflowTemplate: '{project-root}/_bmad/bmb/docs/workflows/templates/workflow-template.md' -intentSpectrum: '{project-root}/_bmad/bmb/docs/workflows/intent-vs-prescriptive-spectrum.md' ---- - -# Step 5: Intent vs Prescriptive Spectrum Validation - -## STEP GOAL: - -Analyze the workflow's position on the intent vs prescriptive spectrum, provide expert assessment, and confirm with user whether the current positioning is appropriate or needs adjustment. - -## MANDATORY EXECUTION RULES (READ FIRST): - -### Universal Rules: - -- 🛑 NEVER generate content without user input -- 📖 CRITICAL: Read the complete step file before taking any action -- 🔄 CRITICAL: When loading next step with 'C', ensure entire file is read -- 📋 YOU ARE A FACILITATOR, not a content generator - -### Role Reinforcement: - -- ✅ You are a compliance validator and design philosophy specialist -- ✅ If you already have been given a name, communication_style, and persona, continue to use those while playing this new role -- ✅ We engage in collaborative dialogue, not command-response -- ✅ You bring expertise in intent vs prescriptive design principles -- ✅ User brings their workflow and needs guidance on spectrum positioning - -### Step-Specific Rules: - -- 🎯 Focus only on spectrum analysis and user confirmation -- 🚫 FORBIDDEN to make spectrum decisions without user input -- 💬 Approach: Educational, analytical, and collaborative -- 📋 Ensure user understands spectrum implications before confirming - -## EXECUTION PROTOCOLS: - -- 🎯 Analyze workflow's current spectrum position based on all previous findings -- 💾 Provide expert assessment with specific examples and reasoning -- 📖 Educate user on spectrum implications for their workflow type -- 🚫 FORBIDDEN to proceed without user confirmation of spectrum position - -## CONTEXT BOUNDARIES: - -- Available context: Complete analysis from workflow, step, and file validation phases -- Focus: Intent vs prescriptive spectrum analysis and user confirmation -- Limits: Spectrum analysis only, holistic workflow analysis comes next -- Dependencies: Successful completion of file size and formatting validation - -## Sequence of Instructions (Do not deviate, skip, or optimize) - -### 1. Initialize Spectrum Analysis - -"Beginning **Intent vs Prescriptive Spectrum Validation** -Target: `{target_workflow_name}` - -**Reference Standard:** Analysis based on `{intentSpectrum}` - -This step will help ensure your workflow's approach to LLM guidance is intentional and appropriate for its purpose..." - -### 2. Spectrum Position Analysis - -**A. Current Position Assessment:** -Based on analysis of workflow.md, all step files, and implementation patterns: - -"**Current Spectrum Analysis:** -Based on my review of your workflow, I assess its current position as: - -**[Highly Intent-Based / Balanced Middle / Highly Prescriptive]**" - -**B. Evidence-Based Reasoning:** -Provide specific evidence from the workflow analysis: - -"**Assessment Evidence:** - -- **Instruction Style:** [Examples of intent-based vs prescriptive instructions found] -- **User Interaction:** [How user conversations are structured] -- **LLM Freedom:** [Level of creative adaptation allowed] -- **Consistency Needs:** [Workflow requirements for consistency vs creativity] -- **Risk Factors:** [Any compliance, safety, or regulatory considerations]" - -**C. Workflow Type Analysis:** -"**Workflow Type Analysis:** - -- **Primary Purpose:** {workflow's main goal} -- **User Expectations:** {What users likely expect from this workflow} -- **Success Factors:** {What makes this workflow successful} -- **Risk Level:** {Compliance, safety, or risk considerations}" - -### 3. Recommended Spectrum Position - -**A. Expert Recommendation:** -"**My Professional Recommendation:** -Based on the workflow's purpose, user needs, and implementation, I recommend positioning this workflow as: - -**[Highly Intent-Based / Balanced Middle / Highly Prescriptive]**" - -**B. Recommendation Rationale:** -"**Reasoning for Recommendation:** - -- **Purpose Alignment:** {Why this position best serves the workflow's goals} -- **User Experience:** {How this positioning enhances user interaction} -- **Risk Management:** {How this position addresses any compliance or safety needs} -- **Success Optimization:** {Why this approach will lead to better outcomes}" - -**C. Specific Examples:** -Provide concrete examples of how the recommended position would look: - -"**Examples at Recommended Position:** -**Intent-Based Example:** "Help users discover their creative potential through..." -**Prescriptive Example:** "Ask exactly: 'Have you experienced any of the following...'" - -**Current State Comparison:** -**Current Instructions Found:** [Examples from actual workflow] -**Recommended Instructions:** [How they could be improved]" - -### 4. Spectrum Education and Implications - -**A. Explain Spectrum Implications:** -"**Understanding Your Spectrum Choice:** - -**If Intent-Based:** Your workflow will be more creative, adaptive, and personalized. Users will have unique experiences, but interactions will be less predictable. - -**If Prescriptive:** Your workflow will be consistent, controlled, and predictable. Every user will have similar experiences, which is ideal for compliance or standardization. - -**If Balanced:** Your workflow will provide professional expertise with some adaptation, offering consistent quality with personalized application." - -**B. Context-Specific Guidance:** -"**For Your Specific Workflow Type:** -{Provide tailored guidance based on whether it's creative, professional, compliance, technical, etc.}" - -### 5. User Confirmation and Decision - -**A. Present Findings and Recommendation:** -"**Spectrum Analysis Summary:** - -**Current Assessment:** [Current position with confidence level] -**Expert Recommendation:** [Recommended position with reasoning] -**Key Considerations:** [Main factors to consider] - -**My Analysis Indicates:** [Brief summary of why I recommend this position] - -**The Decision is Yours:** While I provide expert guidance, the final spectrum position should reflect your vision for the workflow." - -**B. User Choice Confirmation:** -"**Where would you like to position this workflow on the Intent vs Prescriptive Spectrum?** - -**Options:** - -1. **Keep Current Position** - [Current position] - Stay with current approach -2. **Move to Recommended** - [Recommended position] - Adopt my expert recommendation -3. **Move Toward Intent-Based** - Increase creative freedom and adaptation -4. **Move Toward Prescriptive** - Increase consistency and control -5. **Custom Position** - Specify your preferred approach - -**Please select your preferred spectrum position (1-5):**" - -### 6. Document Spectrum Decision - -**A. Record User Decision:** -"**Spectrum Position Decision:** -**User Choice:** [Selected option] -**Final Position:** [Confirmed spectrum position] -**Rationale:** [User's reasoning, if provided] -**Implementation Notes:** [What this means for workflow design]" - -**B. Update Compliance Report:** -Append to {complianceReportFile}: - -```markdown -## Intent vs Prescriptive Spectrum Analysis - -### Current Position Assessment - -**Analyzed Position:** [Current spectrum position] -**Evidence:** [Specific examples from workflow analysis] -**Confidence Level:** [High/Medium/Low based on clarity of patterns] - -### Expert Recommendation - -**Recommended Position:** [Professional recommendation] -**Reasoning:** [Detailed rationale for recommendation] -**Workflow Type Considerations:** [Specific to this workflow's purpose] - -### User Decision - -**Selected Position:** [User's confirmed choice] -**Rationale:** [User's reasoning or preferences] -**Implementation Guidance:** [What this means for workflow] - -### Spectrum Validation Results - -✅ Spectrum position is intentional and understood -✅ User educated on implications of their choice -✅ Implementation guidance provided for final position -✅ Decision documented for future reference -``` - -### 7. Continuation Confirmation - -"**Spectrum Validation Complete:** - -- **Final Position:** [Confirmed spectrum position] -- **User Understanding:** Confirmed implications and benefits -- **Implementation Ready:** Guidance provided for maintaining position - -**Ready for Phase 6:** Web Subprocess Validation analysis - -- Flow validation and completion paths -- Goal alignment and optimization assessment -- Meta-workflow failure analysis and improvement recommendations - -**Select an Option:** [C] Continue to Web Subprocess Validation [X] Exit" - -## Menu Handling Logic: - -- IF C: Save spectrum decision to report, update frontmatter, then load, read entire file, then execute {nextStepFile} -- IF X: Save current spectrum findings and end with guidance for resuming -- IF Any other comments or queries: respond and redisplay menu - -## CRITICAL STEP COMPLETION NOTE - -ONLY WHEN [C continue option] is selected and [spectrum position confirmed with user understanding], will you then load and read fully `{nextStepFile}` to execute and begin Web Subprocess Validation phase. - ---- - -## 🚨 SYSTEM SUCCESS/FAILURE METRICS - -### ✅ SUCCESS: - -- Comprehensive spectrum position analysis with evidence-based reasoning -- Expert recommendation provided with specific rationale and examples -- User educated on spectrum implications for their workflow type -- User makes informed decision about spectrum positioning -- Spectrum decision documented with implementation guidance -- User understands benefits and trade-offs of their choice - -### ❌ SYSTEM FAILURE: - -- Making spectrum recommendations without analyzing actual workflow content -- Not providing evidence-based reasoning for assessment -- Failing to educate user on spectrum implications -- Proceeding without user confirmation of spectrum position -- Not documenting user decision for future reference - -**Master Rule:** Skipping steps, optimizing sequences, or not following exact instructions is FORBIDDEN and constitutes SYSTEM FAILURE. diff --git a/src/modules/bmb/workflows/workflow-compliance-check/steps/step-06-web-subprocess-validation.md b/src/modules/bmb/workflows/workflow-compliance-check/steps/step-06-web-subprocess-validation.md deleted file mode 100644 index 1468a5bf..00000000 --- a/src/modules/bmb/workflows/workflow-compliance-check/steps/step-06-web-subprocess-validation.md +++ /dev/null @@ -1,360 +0,0 @@ ---- -name: 'step-06-web-subprocess-validation' -description: 'Analyze web search utilization and subprocess optimization opportunities across workflow steps' - -# Path Definitions -workflow_path: '{project-root}/_bmad/bmb/workflows/workflow-compliance-check' - -# File References -thisStepFile: '{workflow_path}/steps/step-06-web-subprocess-validation.md' -nextStepFile: '{workflow_path}/steps/step-07-holistic-analysis.md' -workflowFile: '{workflow_path}/workflow.md' -complianceReportFile: '{output_folder}/workflow-compliance-report-{workflow_name}.md' -targetWorkflowStepsPath: '{target_workflow_steps_path}' - -# Template References -complianceReportTemplate: '{workflow_path}/templates/compliance-report.md' - -# Documentation References -stepTemplate: '{project-root}/_bmad/bmb/docs/workflows/templates/step-template.md' -workflowTemplate: '{project-root}/_bmad/bmb/docs/workflows/templates/workflow-template.md' -intentSpectrum: '{project-root}/_bmad/bmb/docs/workflows/intent-vs-prescriptive-spectrum.md' ---- - -# Step 6: Web Search & Subprocess Optimization Analysis - -## STEP GOAL: - -Analyze each workflow step for optimal web search utilization and subprocess usage patterns, ensuring LLM resources are used efficiently while avoiding unnecessary searches or processing delays. - -## MANDATORY EXECUTION RULES (READ FIRST): - -### Universal Rules: - -- 🛑 NEVER generate content without user input -- 📖 CRITICAL: Read the complete step file before taking any action -- 🔄 CRITICAL: When loading next step with 'C', ensure entire file is read -- 📋 YOU ARE A FACILITATOR, not a content generator - -### Role Reinforcement: - -- ✅ You are a performance optimization specialist and resource efficiency analyst -- ✅ If you already have been given a name, communication_style, and persona, continue to use those while playing this new role -- ✅ We engage in collaborative dialogue, not command-response -- ✅ You bring expertise in LLM optimization, web search strategy, and subprocess utilization -- ✅ User brings their workflow and needs efficiency recommendations - -### Step-Specific Rules: - -- 🎯 Focus only on web search necessity and subprocess optimization opportunities -- 🚫 FORBIDDEN to recommend web searches when LLM knowledge is sufficient -- 💬 Approach: Analytical and optimization-focused with clear efficiency rationale -- 📋 Use subprocesses when analyzing multiple steps to improve efficiency - -## EXECUTION PROTOCOLS: - -- 🎯 Analyze each step for web search appropriateness vs. LLM knowledge sufficiency -- 💾 Identify subprocess optimization opportunities for parallel processing -- 📖 Use subprocesses/subagents when analyzing multiple steps for efficiency -- 🚫 FORBIDDEN to overlook inefficiencies or recommend unnecessary searches - -## CONTEXT BOUNDARIES: - -- Available context: All workflow step files and subprocess availability -- Focus: Web search optimization and subprocess utilization analysis -- Limits: Resource optimization analysis only, holistic workflow analysis comes next -- Dependencies: Completed Intent Spectrum validation from previous phase - -## Sequence of Instructions (Do not deviate, skip, or optimize) - -### 1. Initialize Web Search & Subprocess Analysis - -"Beginning **Phase 5: Web Search & Subprocess Optimization Analysis** -Target: `{target_workflow_name}` - -Analyzing each workflow step for: - -- Appropriate web search utilization vs. unnecessary searches -- Subprocess optimization opportunities for efficiency -- LLM resource optimization patterns -- Performance bottlenecks and speed improvements - -**Note:** Using subprocess analysis for efficient multi-step evaluation..." - -### 2. Web Search Necessity Analysis - -**A. Intelligent Search Assessment Criteria:** - -For each step, analyze web search appropriateness using these criteria: - -"**Web Search Appropriateness Analysis:** - -- **Knowledge Currency:** Is recent/real-time information required? -- **Specific Data Needs:** Are there specific facts/data not in LLM training? -- **Verification Requirements:** Does the task require current verification? -- **LLM Knowledge Sufficiency:** Can LLM adequately handle with existing knowledge? -- **Search Cost vs. Benefit:** Is search time worth the information gain?" - -**B. Step-by-Step Web Search Analysis:** - -Using subprocess for parallel analysis of multiple steps: - -"**Analyzing [number] steps for web search optimization...**" - -For each step file: - -```markdown -**Step:** {step_filename} - -**Current Web Search Usage:** - -- [Explicit web search instructions found] -- [Search frequency and scope] -- [Search-specific topics/queries] - -**Intelligent Assessment:** - -- **Appropriate Searches:** [Searches that are truly necessary] -- **Unnecessary Searches:** [Searches LLM could handle internally] -- **Optimization Opportunities:** [How to improve search efficiency] - -**Recommendations:** - -- **Keep:** [Essential web searches] -- **Remove:** [Unnecessary searches that waste time] -- **Optimize:** [Searches that could be more focused/efficient] -``` - -### 3. Subprocess & Parallel Processing Analysis - -**A. Subprocess Opportunity Identification:** - -"**Subprocess Optimization Analysis:** -Looking for opportunities where multiple steps or analyses can run simultaneously..." - -**Analysis Categories:** - -- **Parallel Step Execution:** Can any steps run simultaneously? -- **Multi-faceted Analysis:** Can single step analyses be broken into parallel sub-tasks? -- **Batch Processing:** Can similar operations be grouped for efficiency? -- **Background Processing:** Can any analyses run while user interacts? - -**B. Implementation Patterns:** - -```markdown -**Subprocess Implementation Opportunities:** - -**Multi-Step Validation:** -"Use subprocesses when checking 6+ validation items - just need results back" - -- Current: Sequential processing of all validation checks -- Optimized: Parallel subprocess analysis for faster completion - -**Parallel User Assistance:** - -- Can user interaction continue while background processing occurs? -- Can multiple analyses run simultaneously during user wait times? - -**Batch Operations:** - -- Can similar file operations be grouped? -- Can multiple data sources be processed in parallel? -``` - -### 4. LLM Resource Optimization Analysis - -**A. Context Window Optimization:** - -"**LLM Resource Efficiency Analysis:** -Analyzing how each step uses LLM resources efficiently..." - -**Optimization Areas:** - -- **JIT Loading:** Are references loaded only when needed? -- **Context Management:** Is context used efficiently vs. wasted? -- **Memory Efficiency:** Can large analyses be broken into smaller, focused tasks? -- **Parallel Processing:** Can LLM instances work simultaneously on different aspects? - -**B. Speed vs. Quality Trade-offs:** - -"**Performance Optimization Assessment:** - -- **Speed-Critical Steps:** Which steps benefit most from subprocess acceleration? -- **Quality-Critical Steps:** Which steps need focused LLM attention? -- **Parallel Candidates:** Which analyses can run without affecting user experience? -- **Background Processing:** What can happen while user is reading/responding?" - -### 5. Step-by-Step Optimization Recommendations - -**A. Using Subprocess for Efficient Analysis:** - -"**Processing all steps for optimization opportunities using subprocess analysis...**" - -**For each workflow step, analyze:** - -**1. Web Search Optimization:** - -```markdown -**Step:** {step_name} -**Current Search Usage:** {current_search_instructions} -**Intelligent Assessment:** {is_search_necessary} -**Recommendation:** - -- **Keep essential searches:** {specific_searches_to_keep} -- **Remove unnecessary searches:** {searches_to_remove} -- **Optimize search queries:** {improved_search_approach} -``` - -**2. Subprocess Opportunities:** - -```markdown -**Parallel Processing Potential:** - -- **Can run with user interaction:** {yes/no_specifics} -- **Can batch with other steps:** {opportunities} -- **Can break into sub-tasks:** {subtask_breakdown} -- **Background processing:** {what_can_run_in_background} -``` - -**3. LLM Efficiency:** - -```markdown -**Resource Optimization:** - -- **Context efficiency:** {current_vs_optimal} -- **Processing time:** {estimated_improvements} -- **User experience impact:** {better/same/worse} -``` - -### 6. Aggregate Optimization Analysis - -**A. Web Search Optimization Summary:** - -"**Web Search Optimization Results:** - -- **Total Steps Analyzed:** [number] -- **Steps with Web Searches:** [number] -- **Unnecessary Searches Found:** [number] -- **Optimization Opportunities:** [number] -- **Estimated Time Savings:** [time_estimate]" - -**B. Subprocess Implementation Summary:** - -"**Subprocess Optimization Results:** - -- **Parallel Processing Opportunities:** [number] -- **Batch Processing Groups:** [number] -- **Background Processing Tasks:** [number] -- **Estimated Performance Improvement:** [percentage_improvement]" - -### 7. User-Facing Optimization Report - -**A. Key Efficiency Findings:** - -"**Optimization Analysis Summary:** - -**Web Search Efficiency:** - -- **Current Issues:** [unnecessary searches wasting time] -- **Recommendations:** [specific improvements] -- **Expected Benefits:** [faster response, better user experience] - -**Processing Speed Improvements:** - -- **Parallel Processing Gains:** [specific opportunities] -- **Background Processing Benefits:** [user experience improvements] -- **Resource Optimization:** [LLM efficiency gains] - -**Implementation Priority:** - -1. **High Impact, Low Effort:** [Quick wins] -2. **High Impact, High Effort:** [Major improvements] -3. **Low Impact, Low Effort:** [Fine-tuning] -4. **Future Considerations:** [Advanced optimizations]" - -### 8. Document Optimization Findings - -Append to {complianceReportFile}: - -```markdown -## Web Search & Subprocess Optimization Analysis - -### Web Search Optimization - -**Unnecessary Searches Identified:** [number] -**Essential Searches to Keep:** [specific_list] -**Optimization Recommendations:** [detailed_suggestions] -**Estimated Time Savings:** [time_improvement] - -### Subprocess Optimization Opportunities - -**Parallel Processing:** [number] opportunities identified -**Batch Processing:** [number] grouping opportunities -**Background Processing:** [number] background task opportunities -**Performance Improvement:** [estimated_improvement_percentage]% - -### Resource Efficiency Analysis - -**Context Optimization:** [specific_improvements] -**LLM Resource Usage:** [efficiency_gains] -**User Experience Impact:** [positive_changes] - -### Implementation Recommendations - -**Immediate Actions:** [quick_improvements] -**Strategic Improvements:** [major_optimizations] -**Future Enhancements:** [advanced_optimizations] -``` - -### 9. Continuation Confirmation - -"**Web Search & Subprocess Analysis Complete:** - -- **Web Search Optimization:** [summary of improvements] -- **Subprocess Opportunities:** [number of optimization areas] -- **Performance Impact:** [expected efficiency gains] -- **User Experience Benefits:** [specific improvements] - -**Ready for Phase 7:** Holistic workflow analysis - -- Flow validation and completion paths -- Goal alignment with optimized resources -- Meta-workflow failure analysis -- Strategic recommendations with efficiency considerations - -**Select an Option:** [C] Continue to Holistic Analysis [X] Exit" - -## Menu Handling Logic: - -- IF C: Save optimization findings to report, update frontmatter, then load, read entire file, then execute {nextStepFile} -- IF X: Save current findings and end with guidance for resuming -- IF Any other comments or queries: respond and redisplay menu - -## CRITICAL STEP COMPLETION NOTE - -ONLY WHEN [C continue option] is selected and [web search and subprocess analysis complete with optimization recommendations documented], will you then load and read fully `{nextStepFile}` to execute and begin holistic analysis phase. - ---- - -## 🚨 SYSTEM SUCCESS/FAILURE METRICS - -### ✅ SUCCESS: - -- Intelligent assessment of web search necessity vs. LLM knowledge sufficiency -- Identification of unnecessary web searches that waste user time -- Discovery of subprocess optimization opportunities for parallel processing -- Analysis of LLM resource efficiency patterns -- Specific, actionable optimization recommendations provided -- Performance impact assessment with estimated improvements -- User experience benefits clearly articulated - -### ❌ SYSTEM FAILURE: - -- Recommending web searches when LLM knowledge is sufficient -- Missing subprocess optimization opportunities -- Not using subprocess analysis when evaluating multiple steps -- Overlooking LLM resource inefficiencies -- Providing vague or non-actionable optimization recommendations -- Failing to assess impact on user experience - -**Master Rule:** Skipping steps, optimizing sequences, or not following exact instructions is FORBIDDEN and constitutes SYSTEM FAILURE. diff --git a/src/modules/bmb/workflows/workflow-compliance-check/steps/step-07-holistic-analysis.md b/src/modules/bmb/workflows/workflow-compliance-check/steps/step-07-holistic-analysis.md deleted file mode 100644 index 47b366eb..00000000 --- a/src/modules/bmb/workflows/workflow-compliance-check/steps/step-07-holistic-analysis.md +++ /dev/null @@ -1,258 +0,0 @@ ---- -name: 'step-07-holistic-analysis' -description: 'Analyze workflow flow, goal alignment, and meta-workflow failures' - -# Path Definitions -workflow_path: '{project-root}/_bmad/bmb/workflows/workflow-compliance-check' - -# File References -thisStepFile: '{workflow_path}/steps/step-07-holistic-analysis.md' -nextStepFile: '{workflow_path}/steps/step-08-generate-report.md' -workflowFile: '{workflow_path}/workflow.md' -complianceReportFile: '{output_folder}/workflow-compliance-report-{workflow_name}.md' -targetWorkflowFile: '{target_workflow_path}' - -# Template References -complianceReportTemplate: '{workflow_path}/templates/compliance-report.md' - -# Documentation References -stepTemplate: '{project-root}/_bmad/bmb/docs/workflows/templates/step-template.md' -workflowTemplate: '{project-root}/_bmad/bmb/docs/workflows/templates/workflow-template.md' -intentSpectrum: '{project-root}/_bmad/bmb/docs/workflows/intent-vs-prescriptive-spectrum.md' ---- - -# Step 7: Holistic Workflow Analysis - -## STEP GOAL: - -Perform comprehensive workflow analysis including flow validation, goal alignment assessment, optimization opportunities, and meta-workflow failure identification to provide complete compliance picture. - -## MANDATORY EXECUTION RULES (READ FIRST): - -### Universal Rules: - -- 🛑 NEVER generate content without user input -- 📖 CRITICAL: Read the complete step file before taking any action -- 🔄 CRITICAL: When loading next step with 'C', ensure entire file is read -- 📋 YOU ARE A FACILITATOR, not a content generator - -### Role Reinforcement: - -- ✅ You are a compliance validator and quality assurance specialist -- ✅ If you already have been given a name, communication_style and persona, continue to use those while playing this new role -- ✅ We engage in collaborative dialogue, not command-response -- ✅ You bring holistic workflow analysis and optimization expertise -- ✅ User brings their workflow and needs comprehensive assessment - -### Step-Specific Rules: - -- 🎯 Focus on holistic analysis beyond template compliance -- 🚫 FORBIDDEN to skip flow validation or optimization assessment -- 💬 Approach: Systematic end-to-end workflow analysis -- 📋 Identify meta-workflow failures and improvement opportunities - -## EXECUTION PROTOCOLS: - -- 🎯 Analyze complete workflow flow from start to finish -- 💾 Validate goal alignment and optimization opportunities -- 📖 Identify what meta-workflows (create/edit) should have caught -- 🚫 FORBIDDEN to provide superficial analysis without specific recommendations - -## CONTEXT BOUNDARIES: - -- Available context: Complete workflow analysis from previous phases -- Focus: Holistic workflow optimization and meta-process improvement -- Limits: Analysis phase only, report generation comes next -- Dependencies: Completed workflow.md and step validation phases - -## Sequence of Instructions (Do not deviate, skip, or optimize) - -### 1. Initialize Holistic Analysis - -"Beginning **Phase 3: Holistic Workflow Analysis** -Target: `{target_workflow_name}` - -Analyzing workflow from multiple perspectives: - -- Flow and completion validation -- Goal alignment assessment -- Optimization opportunities -- Meta-workflow failure analysis..." - -### 2. Workflow Flow Validation - -**A. Completion Path Analysis:** -Trace all possible paths through the workflow: - -"**Flow Validation Analysis:**" - -- Does every step have a clear continuation path? -- Do all menu options have valid destinations? -- Are there any orphaned steps or dead ends? -- Can the workflow always reach a successful completion? - -**Document issues:** - -- **Critical:** Steps without completion paths -- **Major:** Inconsistent menu handling or broken references -- **Minor:** Inefficient flow patterns - -**B. Sequential Logic Validation:** -Check step sequence logic: - -- Does step order make logical sense? -- Are dependencies properly structured? -- Is information flow between steps optimal? -- Are there unnecessary steps or missing functionality? - -### 3. Goal Alignment Assessment - -**A. Stated Goal Analysis:** -Compare workflow.md goal with actual implementation: - -"**Goal Alignment Analysis:**" - -- **Stated Goal:** [quote from workflow.md] -- **Actual Implementation:** [what the workflow actually does] -- **Alignment Score:** [percentage match] -- **Gap Analysis:** [specific misalignments] - -**B. User Experience Assessment:** -Evaluate workflow from user perspective: - -- Is the workflow intuitive and easy to follow? -- Are user inputs appropriately requested? -- Is feedback clear and timely? -- Is the workflow efficient for the stated purpose? - -### 4. Optimization Opportunities - -**A. Efficiency Analysis:** -"**Optimization Assessment:**" - -- **Step Consolidation:** Could any steps be combined? -- **Parallel Processing:** Could any operations run simultaneously? -- **JIT Loading:** Are references loaded optimally? -- **User Experience:** Where could user experience be improved? - -**B. Architecture Improvements:** - -- **Template Usage:** Are templates used optimally? -- **Output Management:** Are outputs appropriate and necessary? -- **Error Handling:** Is error handling comprehensive? -- **Extensibility:** Can the workflow be easily extended? - -### 5. Meta-Workflow Failure Analysis - -**CRITICAL SECTION:** Identify what create/edit workflows should have caught - -"**Meta-Workflow Failure Analysis:** -**Issues that should have been prevented by create-workflow/edit-workflow:**" - -**A. Create-Workflow Failures:** - -- Missing frontmatter fields that should be validated during creation -- Incorrect path variable formats that should be standardized -- Template usage violations that should be caught during design -- Menu pattern deviations that should be enforced during build -- Workflow type mismatches that should be detected during planning - -**B. Edit-Workflow Failures (if applicable):** - -- Introduced compliance violations during editing -- Breaking template structure during modifications -- Inconsistent changes that weren't validated -- Missing updates to dependent files/references - -**C. Systemic Process Improvements:** -"**Recommended Improvements for Meta-Workflows:**" - -**For create-workflow:** - -- Add validation step for frontmatter completeness -- Implement path variable format checking -- Add workflow type template usage validation -- Include menu pattern enforcement -- Add flow validation before finalization -- **Add Intent vs Prescriptive spectrum selection early in design process** -- **Include spectrum education for users during workflow creation** -- **Validate spectrum consistency throughout workflow design** - -**For edit-workflow:** - -- Add compliance validation before applying changes -- Include template structure checking during edits -- Implement cross-file consistency validation -- Add regression testing for compliance -- **Validate that edits maintain intended spectrum position** -- **Check for unintended spectrum shifts during modifications** - -### 6. Severity-Based Recommendations - -"**Strategic Recommendations by Priority:**" - -**IMMEDIATE (Critical) - Must Fix for Workflow to Function:** - -1. [Most critical issue with specific fix] -2. [Second critical issue with specific fix] - -**HIGH PRIORITY (Major) - Significantly Impacts Quality:** - -1. [Major issue affecting maintainability] -2. [Major issue affecting user experience] - -**MEDIUM PRIORITY (Minor) - Standards Compliance:** - -1. [Minor template compliance issue] -2. [Cosmetic or consistency improvements] - -### 7. Continuation Confirmation - -"**Phase 5 Complete:** Holistic analysis finished - -- **Flow Validation:** [summary findings] -- **Goal Alignment:** [alignment percentage and key gaps] -- **Optimization Opportunities:** [number key improvements identified] -- **Meta-Workflow Failures:** [number issues that should have been prevented] - -**Ready for Phase 8:** Comprehensive compliance report generation - -- All findings compiled into structured report -- Severity-ranked violation list -- Specific fix recommendations -- Meta-workflow improvement suggestions - -**Select an Option:** [C] Continue to Report Generation [X] Exit" - -## Menu Handling Logic: - -- IF C: Save holistic analysis findings to report, update frontmatter, then load, read entire file, then execute {nextStepFile} -- IF X: Save current findings and end with guidance for resuming -- IF Any other comments or queries: respond and redisplay menu - -## CRITICAL STEP COMPLETION NOTE - -ONLY WHEN [C continue option] is selected and [holistic analysis complete with meta-workflow failures identified], will you then load and read fully `{nextStepFile}` to execute and begin comprehensive report generation. - ---- - -## 🚨 SYSTEM SUCCESS/FAILURE METRICS - -### ✅ SUCCESS: - -- Complete workflow flow validation with all paths traced -- Goal alignment assessment with specific gap analysis -- Optimization opportunities identified with prioritized recommendations -- Meta-workflow failures documented with improvement suggestions -- Strategic recommendations provided by severity priority -- User ready for comprehensive report generation - -### ❌ SYSTEM FAILURE: - -- Skipping flow validation or goal alignment analysis -- Not identifying meta-workflow failure opportunities -- Failing to provide specific, actionable recommendations -- Missing strategic prioritization of improvements -- Providing superficial analysis without depth - -**Master Rule:** Skipping steps, optimizing sequences, or not following exact instructions is FORBIDDEN and constitutes SYSTEM FAILURE. diff --git a/src/modules/bmb/workflows/workflow-compliance-check/steps/step-08-generate-report.md b/src/modules/bmb/workflows/workflow-compliance-check/steps/step-08-generate-report.md deleted file mode 100644 index bd330e7b..00000000 --- a/src/modules/bmb/workflows/workflow-compliance-check/steps/step-08-generate-report.md +++ /dev/null @@ -1,301 +0,0 @@ ---- -name: 'step-08-generate-report' -description: 'Generate comprehensive compliance report with fix recommendations' - -# Path Definitions -workflow_path: '{project-root}/_bmad/bmb/workflows/workflow-compliance-check' - -# File References -thisStepFile: '{workflow_path}/steps/step-08-generate-report.md' -workflowFile: '{workflow_path}/workflow.md' -complianceReportFile: '{output_folder}/workflow-compliance-report-{workflow_name}.md' -targetWorkflowFile: '{target_workflow_path}' - -# Template References -complianceReportTemplate: '{workflow_path}/templates/compliance-report.md' - -# Documentation References -stepTemplate: '{project-root}/_bmad/bmb/docs/workflows/templates/step-template.md' -workflowTemplate: '{project-root}/_bmad/bmb/docs/workflows/templates/workflow-template.md' ---- - -# Step 8: Comprehensive Compliance Report Generation - -## STEP GOAL: - -Generate comprehensive compliance report compiling all validation findings, provide severity-ranked fix recommendations, and offer concrete next steps for achieving full compliance. - -## MANDATORY EXECUTION RULES (READ FIRST): - -### Universal Rules: - -- 🛑 NEVER generate content without user input -- 📖 CRITICAL: Read the complete step file before taking any action -- 📋 YOU ARE A FACILITATOR, not a content generator - -### Role Reinforcement: - -- ✅ You are a compliance validator and quality assurance specialist -- ✅ If you already have been given a name, communication_style and persona, continue to use those while playing this new role -- ✅ We engage in collaborative dialogue, not command-response -- ✅ You bring report generation and strategic recommendation expertise -- ✅ User brings their validated workflow and needs actionable improvement plan - -### Step-Specific Rules: - -- 🎯 Focus only on compiling comprehensive compliance report -- 🚫 FORBIDDEN to generate report without including all findings from previous phases -- 💬 Approach: Systematic compilation with clear, actionable recommendations -- 📋 Ensure report is complete, accurate, and immediately useful - -## EXECUTION PROTOCOLS: - -- 🎯 Compile all findings from previous validation phases -- 💾 Generate structured compliance report with clear sections -- 📖 Provide severity-ranked recommendations with specific fixes -- 🚫 FORBIDDEN to overlook any validation findings or recommendations - -## CONTEXT BOUNDARIES: - -- Available context: Complete validation findings from all previous phases -- Focus: Comprehensive report generation and strategic recommendations -- Limits: Report generation only, no additional validation -- Dependencies: Successful completion of all previous validation phases - -## Sequence of Instructions (Do not deviate, skip, or optimize) - -### 1. Initialize Report Generation - -"**Phase 5: Comprehensive Compliance Report Generation** -Target: `{target_workflow_name}` - -Compiling all validation findings into structured compliance report with actionable recommendations..." - -### 2. Generate Compliance Report Structure - -Create comprehensive report at {complianceReportFile}: - -```markdown -# Workflow Compliance Report - -**Workflow:** {target_workflow_name} -**Date:** {current_date} -**Standards:** BMAD workflow-template.md and step-template.md - ---- - -## Executive Summary - -**Overall Compliance Status:** [PASS/FAIL/PARTIAL] -**Critical Issues:** [number] - Must be fixed immediately -**Major Issues:** [number] - Significantly impacts quality/maintainability -**Minor Issues:** [number] - Standards compliance improvements - -**Compliance Score:** [percentage]% based on template adherence - ---- - -## Phase 1: Workflow.md Validation Results - -### Critical Violations - -[Critical issues with template references and specific fixes] - -### Major Violations - -[Major issues with template references and specific fixes] - -### Minor Violations - -[Minor issues with template references and specific fixes] - ---- - -## Phase 2: Step-by-Step Validation Results - -### Summary by Step - -[Each step file with its violation summary] - -### Most Common Violations - -1. [Most frequent violation type with count] -2. [Second most frequent with count] -3. [Third most frequent with count] - -### Workflow Type Assessment - -**Workflow Type:** [editing/creation/validation/etc.] -**Template Appropriateness:** [appropriate/needs improvement] -**Recommendations:** [specific suggestions] - ---- - -## Phase 3: Holistic Analysis Results - -### Flow Validation - -[Flow analysis findings with specific issues] - -### Goal Alignment - -**Alignment Score:** [percentage]% -**Stated vs. Actual:** [comparison with gaps] - -### Optimization Opportunities - -[Priority improvements with expected benefits] - ---- - -## Meta-Workflow Failure Analysis - -### Issues That Should Have Been Prevented - -**By create-workflow:** - -- [Specific issues that should have been caught during creation] -- [Suggested improvements to create-workflow] - -**By edit-workflow (if applicable):** - -- [Specific issues introduced during editing] -- [Suggested improvements to edit-workflow] - -### Recommended Meta-Workflow Improvements - -[Specific actionable improvements for meta-workflows] - ---- - -## Severity-Ranked Fix Recommendations - -### IMMEDIATE - Critical (Must Fix for Functionality) - -1. **[Issue Title]** - [File: filename.md] - - **Problem:** [Clear description] - - **Template Reference:** [Specific section] - - **Fix:** [Exact action needed] - - **Impact:** [Why this is critical] - -### HIGH PRIORITY - Major (Significantly Impacts Quality) - -1. **[Issue Title]** - [File: filename.md] - - **Problem:** [Clear description] - - **Template Reference:** [Specific section] - - **Fix:** [Exact action needed] - - **Impact:** [Quality/maintainability impact] - -### MEDIUM PRIORITY - Minor (Standards Compliance) - -1. **[Issue Title]** - [File: filename.md] - - **Problem:** [Clear description] - - **Template Reference:** [Specific section] - - **Fix:** [Exact action needed] - - **Impact:** [Standards compliance] - ---- - -## Automated Fix Options - -### Fixes That Can Be Applied Automatically - -[List of violations that can be automatically corrected] - -### Fixes Requiring Manual Review - -[List of violations requiring human judgment] - ---- - -## Next Steps Recommendation - -**Recommended Approach:** - -1. Fix all Critical issues immediately (workflow may not function) -2. Address Major issues for reliability and maintainability -3. Implement Minor issues for full standards compliance -4. Update meta-workflows to prevent future violations - -**Estimated Effort:** - -- Critical fixes: [time estimate] -- Major fixes: [time estimate] -- Minor fixes: [time estimate] -``` - -### 3. Final Report Summary - -"**Compliance Report Generated:** `{complianceReportFile}` - -**Report Contents:** - -- ✅ Complete violation analysis from all validation phases -- ✅ Severity-ranked recommendations with specific fixes -- ✅ Meta-workflow failure analysis with improvement suggestions -- ✅ Automated vs manual fix categorization -- ✅ Strategic next steps and effort estimates - -**Key Findings:** - -- **Overall Compliance Score:** [percentage]% -- **Critical Issues:** [number] requiring immediate attention -- **Major Issues:** [number] impacting quality -- **Minor Issues:** [number] for standards compliance - -**Meta-Workflow Improvements Identified:** [number] specific suggestions - -### 4. Offer Next Steps - -"**Phase 6 Complete:** Comprehensive compliance analysis finished -All 8 validation phases completed with full report generation - -**Compliance Analysis Complete. What would you like to do next?**" - -**Available Options:** - -- **[A] Apply Automated Fixes** - I can automatically correct applicable violations -- **[B] Launch edit-agent** - Edit the workflow with this compliance report as guidance -- **[C] Manual Review** - Use the report for manual fixes at your pace -- **[D] Update Meta-Workflows** - Strengthen create/edit workflows with identified improvements - -**Recommendation:** Start with Critical issues, then proceed through High and Medium priority items systematically." - -### 5. Report Completion Options - -Display: "**Select an Option:** [A] Apply Automated Fixes [B] Launch Edit-Agent [C] Manual Review [D] Update Meta-Workflows [X] Exit" - -## Menu Handling Logic: - -- IF A: Begin applying automated fixes from the report -- IF B: Launch edit-agent workflow with this compliance report as context -- IF C: End workflow with guidance for manual review using the report -- IF D: Provide specific recommendations for meta-workflow improvements -- IF X: Save report and end workflow gracefully - -## CRITICAL STEP COMPLETION NOTE - -The workflow is complete when the comprehensive compliance report has been generated and the user has selected their preferred next step. The report contains all findings, recommendations, and strategic guidance needed to achieve full BMAD compliance. - ---- - -## 🚨 SYSTEM SUCCESS/FAILURE METRICS - -### ✅ SUCCESS: - -- Comprehensive compliance report generated with all validation findings -- Severity-ranked fix recommendations provided with specific actions -- Meta-workflow failure analysis completed with improvement suggestions -- Clear next steps offered based on user preferences -- Report saved and accessible for future reference -- User has actionable plan for achieving full compliance - -### ❌ SYSTEM FAILURE: - -- Generating incomplete report without all validation findings -- Missing severity rankings or specific fix recommendations -- Not providing clear next steps or options -- Failing to include meta-workflow improvement suggestions -- Creating report that is not immediately actionable - -**Master Rule:** Skipping steps, optimizing sequences, or not following exact instructions is FORBIDDEN and constitutes SYSTEM FAILURE. diff --git a/src/modules/bmb/workflows/workflow-compliance-check/templates/compliance-report.md b/src/modules/bmb/workflows/workflow-compliance-check/templates/compliance-report.md deleted file mode 100644 index 2fd5e8a4..00000000 --- a/src/modules/bmb/workflows/workflow-compliance-check/templates/compliance-report.md +++ /dev/null @@ -1,140 +0,0 @@ -# Workflow Compliance Report Template - -**Workflow:** {workflow_name} -**Date:** {validation_date} -**Standards:** BMAD workflow-template.md and step-template.md -**Report Type:** Comprehensive Compliance Validation - ---- - -## Executive Summary - -**Overall Compliance Status:** {compliance_status} -**Critical Issues:** {critical_count} - Must be fixed immediately -**Major Issues:** {major_count} - Significantly impacts quality/maintainability -**Minor Issues:** {minor_count} - Standards compliance improvements - -**Compliance Score:** {compliance_score}% based on template adherence - -**Workflow Type Assessment:** {workflow_type} - {type_appropriateness} - ---- - -## Phase 1: Workflow.md Validation Results - -### Template Adherence Analysis - -**Reference Standard:** {workflow_template_path} - -### Critical Violations - -{critical_violations} - -### Major Violations - -{major_violations} - -### Minor Violations - -{minor_violations} - ---- - -## Phase 2: Step-by-Step Validation Results - -### Summary by Step - -{step_validation_summary} - -### Most Common Violations - -1. {most_common_violation_1} -2. {most_common_violation_2} -3. {most_common_violation_3} - -### Workflow Type Appropriateness - -**Analysis:** {workflow_type_analysis} -**Recommendations:** {type_recommendations} - ---- - -## Phase 3: Holistic Analysis Results - -### Flow Validation - -{flow_validation_results} - -### Goal Alignment - -**Stated Goal:** {stated_goal} -**Actual Implementation:** {actual_implementation} -**Alignment Score:** {alignment_score}% -**Gap Analysis:** {gap_analysis} - -### Optimization Opportunities - -{optimization_opportunities} - ---- - -## Meta-Workflow Failure Analysis - -### Issues That Should Have Been Prevented - -**By create-workflow:** -{create_workflow_failures} - -**By edit-workflow:** -{edit_workflow_failures} - -### Recommended Meta-Workflow Improvements - -{meta_workflow_improvements} - ---- - -## Severity-Ranked Fix Recommendations - -### IMMEDIATE - Critical (Must Fix for Functionality) - -{critical_recommendations} - -### HIGH PRIORITY - Major (Significantly Impacts Quality) - -{major_recommendations} - -### MEDIUM PRIORITY - Minor (Standards Compliance) - -{minor_recommendations} - ---- - -## Automated Fix Options - -### Fixes That Can Be Applied Automatically - -{automated_fixes} - -### Fixes Requiring Manual Review - -{manual_fixes} - ---- - -## Next Steps Recommendation - -**Recommended Approach:** -{recommended_approach} - -**Estimated Effort:** - -- Critical fixes: {critical_effort} -- Major fixes: {major_effort} -- Minor fixes: {minor_effort} - ---- - -**Report Generated:** {timestamp} -**Validation Engine:** BMAD Workflow Compliance Checker -**Next Review Date:** {next_review_date} diff --git a/src/modules/bmb/workflows/workflow-compliance-check/workflow.md b/src/modules/bmb/workflows/workflow-compliance-check/workflow.md deleted file mode 100644 index 1f95ea1d..00000000 --- a/src/modules/bmb/workflows/workflow-compliance-check/workflow.md +++ /dev/null @@ -1,58 +0,0 @@ ---- -name: workflow-compliance-check -description: Systematic validation of workflows against BMAD standards with adversarial analysis and detailed reporting -web_bundle: false ---- - -# Workflow Compliance Check - -**Goal:** Systematically validate workflows against BMAD standards through adversarial analysis, generating detailed compliance reports with severity-ranked violations and improvement recommendations. - -**Your Role:** In addition to your name, communication_style, and persona, you are also a compliance validator and quality assurance specialist collaborating with a workflow owner. This is a partnership, not a client-vendor relationship. You bring expertise in BMAD standards, workflow architecture, and systematic validation, while the user brings their workflow and specific compliance concerns. Work together as equals. - ---- - -## WORKFLOW ARCHITECTURE - -This uses **step-file architecture** for disciplined execution: - -### Core Principles - -- **Micro-file Design**: Each step is a self contained instruction file that is a part of an overall workflow that must be followed exactly -- **Just-In-Time Loading**: Only the current step file is in memory - never load future step files until told to do so -- **Sequential Enforcement**: Sequence within the step files must be completed in order, no skipping or optimization allowed -- **State Tracking**: Document progress in context for compliance checking (no output file frontmatter needed) -- **Append-Only Building**: Build compliance reports by appending content as directed to the output file - -### Step Processing Rules - -1. **READ COMPLETELY**: Always read the entire step file before taking any action -2. **FOLLOW SEQUENCE**: Execute all numbered sections in order, never deviate -3. **WAIT FOR INPUT**: If a menu is presented, halt and wait for user selection -4. **CHECK CONTINUATION**: If the step has a menu with Continue as an option, only proceed to next step when user selects 'C' (Continue) -5. **SAVE STATE**: Update `stepsCompleted` in frontmatter before loading next step -6. **LOAD NEXT**: When directed, load, read entire file, then execute the next step file - -### Critical Rules (NO EXCEPTIONS) - -- 🛑 **NEVER** load multiple step files simultaneously -- 📖 **ALWAYS** read entire step file before execution -- 🚫 **NEVER** skip steps or optimize the sequence -- 💾 **ALWAYS** update frontmatter of output files when writing the final output for a specific step -- 🎯 **ALWAYS** follow the exact instructions in the step file -- ⏸️ **ALWAYS** halt at menus and wait for user input -- 📋 **NEVER** create mental todo lists from future steps - ---- - -## INITIALIZATION SEQUENCE - -### 1. Configuration Loading - -Load and read full config from {project-root}/_bmad/bmb/config.yaml and resolve: - -- `project_name`, `output_folder`, `user_name`, `communication_language`, `document_output_language` - -### 2. First Step EXECUTION - -Load, read the full file and then execute `{workflow_path}/steps/step-01-validate-goal.md` to begin the workflow. If the path to a workflow was provided, set `user_provided_path` to that path. diff --git a/src/modules/bmb/workflows/workflow/data/architecture.md b/src/modules/bmb/workflows/workflow/data/architecture.md new file mode 100644 index 00000000..d594c61a --- /dev/null +++ b/src/modules/bmb/workflows/workflow/data/architecture.md @@ -0,0 +1,152 @@ +# Workflow Architecture + +**Purpose:** Core structural patterns for BMAD workflows. + +--- + +## Structure + +``` +workflow-folder/ +├── workflow.md # Entry point, configuration +├── steps-c/ # Create flow steps +│ ├── step-01-init.md +│ ├── step-02-[name].md +│ └── step-N-[name].md +├── steps-e/ # Edit flow (if needed) +├── steps-v/ # Validate flow (if needed) +├── data/ # Shared reference files +└── templates/ # Output templates (if needed) +``` + +--- + +## workflow.md File Standards + +**CRITICAL:** The workflow.md file MUST be lean. It is the entry point and should NOT contain: + +- ❌ **Listing of all steps** - This defeats progressive disclosure +- ❌ **Detailed descriptions of what each step does** - Steps are self-documenting +- ❌ **Validation checklists** - These belong in steps-v/, not workflow.md +- ❌ **Implementation details** - These belong in step files + +**The workflow.md SHOULD contain:** +- ✅ Frontmatter: name, description, web_bundle +- ✅ Goal: What the workflow accomplishes +- ✅ Role: Who the AI embodies when running this workflow +- ✅ Meta-context: Background about the architecture (if demonstrating a pattern) +- ✅ Core architecture principles (step-file design, JIT loading, etc.) +- ✅ Initialization/routing: How to start and which step to load first + +**Progressive Disclosure Rule:** +Users should ONLY know about the current step they're executing. The workflow.md routes to the first step, and each step routes to the next. No step lists in workflow.md! + +--- + +## Core Principles + +### 1. Micro-File Design +- Each step is a focused file (~80-200 lines) +- One concept per step +- Self-contained instructions + +### 2. Just-In-Time Loading +- Only current step file is in memory +- Never load future steps until user selects 'C' +- Progressive disclosure - LLM stays focused + +### 3. Sequential Enforcement +- Steps execute in order +- No skipping, no optimization +- Each step completes before next loads + +### 4. State Tracking +For continuable workflows: +```yaml +stepsCompleted: ['step-01-init', 'step-02-gather', 'step-03-design'] +lastStep: 'step-03-design' +lastContinued: '2025-01-02' +``` + +Each step appends its name to `stepsCompleted` before loading next. + +--- + +## Execution Flow + +### Fresh Start +``` +workflow.md → step-01-init.md → step-02-[name].md → ... → step-N-final.md +``` + +### Continuation (Resumed) +``` +workflow.md → step-01-init.md (detects existing) → step-01b-continue.md → [appropriate next step] +``` + +--- + +## Frontmatter Variables + +### Standard (All Workflows) +```yaml +workflow_path: '{project-root}/_bmad/[module]/workflows/[name]' +thisStepFile: './step-[N]-[name].md' +nextStepFile: './step-[N+1]-[name].md' +outputFile: '{output_folder}/[output].md' +``` + +### Module-Specific +```yaml +# BMB example: +bmb_creations_output_folder: '{project-root}/_bmad/bmb-creations' +``` + +### Critical Rules +- ONLY variables used in step body go in frontmatter +- All file references use `{variable}` format +- Paths within workflow folder are relative + +--- + +## Menu Pattern + +```markdown +### N. Present MENU OPTIONS + +Display: "**Select:** [A] [action] [P] [action] [C] Continue" + +#### Menu Handling Logic: +- IF A: Execute {task}, then redisplay menu +- IF P: Execute {task}, then redisplay menu +- IF C: Save to {outputFile}, update frontmatter, then load {nextStepFile} +- IF Any other: help user, then redisplay menu + +#### EXECUTION RULES: +- ALWAYS halt and wait for user input +- ONLY proceed to next step when user selects 'C' +``` + +**A/P not needed in:** Step 1 (init), validation sequences, simple data gathering + +--- + +## Output Pattern + +Every step writes to a document BEFORE loading next step: + +1. **Plan-then-build:** Steps append to plan.md → build step consumes plan +2. **Direct-to-final:** Steps append directly to final document + +See: `output-format-standards.md` + +--- + +## Critical Rules + +- 🛑 NEVER load multiple step files simultaneously +- 📖 ALWAYS read entire step file before execution +- 🚫 NEVER skip steps or optimize the sequence +- 💾 ALWAYS update frontmatter when step completes +- ⏸️ ALWAYS halt at menus and wait for input +- 📋 NEVER create mental todos from future steps diff --git a/src/modules/bmb/docs/workflows/common-workflow-tools.csv b/src/modules/bmb/workflows/workflow/data/common-workflow-tools.csv similarity index 93% rename from src/modules/bmb/docs/workflows/common-workflow-tools.csv rename to src/modules/bmb/workflows/workflow/data/common-workflow-tools.csv index 2ab6cef4..cc68b7ed 100644 --- a/src/modules/bmb/docs/workflows/common-workflow-tools.csv +++ b/src/modules/bmb/workflows/workflow/data/common-workflow-tools.csv @@ -1,6 +1,6 @@ propose,type,tool_name,description,url,requires_install always,workflow,party-mode,"Enables collaborative idea generation by managing turn-taking, summarizing contributions, and synthesizing ideas from multiple AI personas in structured conversation sessions about workflow steps or work in progress.",{project-root}/_bmad/core/workflows/party-mode/workflow.md,no -always,task,advanced-elicitation,"Employs diverse elicitation strategies such as Socratic questioning, role-playing, and counterfactual analysis to critically evaluate and enhance LLM outputs, forcing assessment from multiple perspectives and techniques.",{project-root}/_bmad/core/tasks/advanced-elicitation.xml,no +always,workflow,advanced-elicitation,"Employs diverse elicitation strategies such as Socratic questioning, role-playing, and counterfactual analysis to critically evaluate and enhance LLM outputs, forcing assessment from multiple perspectives and techniques.",{project-root}/_bmad/core/workflows/advanced-elicitation/workflow.xml,no always,task,brainstorming,"Facilitates idea generation by prompting users with targeted questions, encouraging divergent thinking, and synthesizing concepts into actionable insights through collaborative creative exploration.",{project-root}/_bmad/core/tasks/brainstorming.xml,no always,llm-tool-feature,web-browsing,"Provides LLM with capabilities to perform real-time web searches, extract relevant data, and incorporate current information into responses when up-to-date information is required beyond training knowledge.",,no always,llm-tool-feature,file-io,"Enables LLM to manage file operations such as creating, reading, updating, and deleting files, facilitating seamless data handling, storage, and document management within user environments.",,no diff --git a/src/modules/bmb/workflows/workflow/data/csv-data-file-standards.md b/src/modules/bmb/workflows/workflow/data/csv-data-file-standards.md new file mode 100644 index 00000000..8b2df4ca --- /dev/null +++ b/src/modules/bmb/workflows/workflow/data/csv-data-file-standards.md @@ -0,0 +1,81 @@ +# CSV Data File Standards + +**Purpose:** When workflows need structured data that LLMs cannot generate. + +--- + +## When to Use CSV + +Use CSV for data that is: +- Domain-specific and not in training data +- Too large for prompt context +- Needs structured lookup/reference +- Must be consistent across sessions + +**Don't use for:** +- Web-searchable information +- Common programming syntax +- General knowledge +- Things LLMs can generate + +--- + +## CSV Structure + +```csv +category,name,pattern,description +"collaboration","Think Aloud Protocol","user speaks thoughts → facilitator captures","Make thinking visible during work" +"creative","SCAMPER","substitute→combine→adapt→modify→put→eliminate→reverse","Systematic creative thinking" +``` + +**Rules:** +- Header row required, descriptive column names +- Consistent data types per column +- UTF-8 encoding +- All columns must be used in workflow + +--- + +## Common Use Cases + +### 1. Method Registry +Advanced Elicitation uses CSV to select techniques dynamically: +```csv +category,name,pattern +collaboration,Think Aloud,user speaks thoughts → facilitator captures +advanced,Six Thinking Hats,view problem from 6 perspectives +``` + +### 2. Knowledge Base Index +Map keywords to document locations for surgical lookup: +```csv +keywords,document_path,section +"nutrition,macros",data/nutrition-reference.md,## Daily Targets +``` + +### 3. Configuration Lookup +Map scenarios to parameters: +```csv +scenario,required_steps,output_sections +"2D Platformer",step-01,step-03,step-07,movement,physics,collision +``` + +--- + +## Best Practices + +- Keep files small (<1MB if possible) +- No unused columns +- Document each CSV's purpose +- Validate data quality +- Use efficient encoding (codes vs full descriptions) + +--- + +## Validation Checklist + +For each CSV file: +- [ ] Purpose is essential (can't be generated by LLM) +- [ ] All columns are used somewhere +- [ ] Properly formatted (consistent, UTF-8) +- [ ] Documented with examples diff --git a/src/modules/bmb/workflows/workflow/data/frontmatter-standards.md b/src/modules/bmb/workflows/workflow/data/frontmatter-standards.md new file mode 100644 index 00000000..86432a92 --- /dev/null +++ b/src/modules/bmb/workflows/workflow/data/frontmatter-standards.md @@ -0,0 +1,225 @@ +# Frontmatter Standards + +**Purpose:** Variables, paths, and frontmatter rules for workflow steps. + +--- + +## Golden Rules + +1. **Only variables USED in the step** may be in frontmatter +2. **All file references MUST use `{variable}` format** - no hardcoded paths +3. **Paths within workflow folder MUST be relative** - NO `workflow_path` variable allowed + +--- + +## Standard Variables (Always Available) + +| Variable | Example Value | +| ---------------------------- | ------------------------------------ | +| `{project-root}` | `/Users/user/dev/BMAD-METHOD` | +| `{project_name}` | `my-project` | +| `{output_folder}` | `/Users/user/dev/BMAD-METHOD/output` | +| `{user_name}` | `Brian` | +| `{communication_language}` | `english` | +| `{document_output_language}` | `english` | + +--- + +## Module-Specific Variables + +Workflows in a MODULE can access additional variables from its `module.yaml`. + +**BMB Module example:** +```yaml +bmb_creations_output_folder: '{project-root}/_bmad/bmb-creations' +``` + +**Standalone workflows:** Only have access to standard variables. + +--- + +## Frontmatter Structure + +### Required Fields +```yaml +--- +name: 'step-[N]-[name]' +description: '[what this step does]' +--- +``` + +### File References - ONLY variables used in this step +```yaml +--- +# Step to step (SAME folder) - use ./filename.md +nextStepFile: './step-02-vision.md' + +# Step to template (PARENT folder) - use ../filename.md +productBriefTemplate: '../product-brief.template.md' + +# Step to data (SUBFOLDER) - use ./data/filename.md +someData: './data/config.csv' + +# Output files - use variable +outputFile: '{planning_artifacts}/product-brief-{{project_name}}-{{date}}.md' + +# External references - use {project-root} +advancedElicitationTask: '{project-root}/_bmad/core/workflows/advanced-elicitation/workflow.xml' +partyModeWorkflow: '{project-root}/_bmad/core/workflows/party-mode/workflow.md' +--- +``` + +--- + +## Critical Rule: Unused Variables Forbidden + +### ❌ VIOLATION - Variable defined but never used +```yaml +--- +outputFile: '{output_folder}/output.md' +thisStepFile: './step-01-init.md' # ❌ NEVER USED in body +workflowFile: './workflow.md' # ❌ NEVER USED in body +--- +# Step body never mentions {thisStepFile} or {workflowFile} +``` + +### ✅ CORRECT - Only variables that are used +```yaml +--- +outputFile: '{output_folder}/output.md' +nextStepFile: './step-02-foo.md' +--- +# Step body uses {outputFile} and {nextStepFile} +``` + +**Detection Rule:** For EVERY variable in frontmatter, search the step body for `{variableName}`. If not found, it's a violation. + +--- + +## Path Rules - NO EXCEPTIONS + +### 1. Step to Step (SAME folder) = ./filename.md +```yaml +# ❌ WRONG +nextStepFile: './step-02.md' +nextStepFile: '{project-root}/_bmad/bmm/workflows/foo/steps/step-02.md' + +# ✅ CORRECT +nextStepFile: './step-02-vision.md' +``` + +### 2. Step to Template (PARENT folder) = ../filename.md +```yaml +# ❌ WRONG +someTemplate: '{workflow_path}/templates/template.md' + +# ✅ CORRECT +someTemplate: '../template.md' +``` + +### 3. Step to Subfolder = ./subfolder/file.md +```yaml +# ❌ WRONG +dataFile: '{workflow_path}/data/config.csv' + +# ✅ CORRECT +dataFile: './data/config.csv' +``` + +### 4. External References = {project-root}/... +```yaml +# ✅ CORRECT +advancedElicitationTask: '{project-root}/_bmad/core/workflows/advanced-elicitation/workflow.xml' +``` + +### 5. Output Files = Use folder variable +```yaml +# ✅ CORRECT +outputFile: '{planning_artifacts}/workflow-output-{project_name}.md' +outputFile: '{output_folder}/output.md' +``` + +--- + +## ❌ FORBIDDEN Patterns + +These patterns are **NEVER ALLOWED** in workflow step frontmatter: + +| Pattern | Why It's Wrong | +| ------------------------------------- | ----------------------------------------------------- | +| `workflow_path: '{project-root}/...'` | Use relative paths instead | +| `thisStepFile: './step-XX.md'` | Almost never used - remove unless actually referenced | +| `workflowFile: './workflow.md'` | Almost never used - remove unless actually referenced | +| `./...` | Use `./step-XX.md` (same folder) | +| `{workflow_path}/templates/...` | Use `../template.md` (parent folder) | +| `{workflow_path}/data/...` | Use `./data/file.md` (subfolder) | + +--- + +## Variable Naming + +Use `snake_case` with descriptive prefixes: + +| Pattern | Usage | Example | +| -------------- | ------------------- | ---------------------------- | +| `{*_File}` | File references | `outputFile`, `nextStepFile` | +| `{*_Task}` | Task references | `advancedElicitationTask` | +| `{*_Workflow}` | Workflow references | `partyModeWorkflow` | +| `{*_Template}` | Templates | `productBriefTemplate` | +| `{*_Data}` | Data files | `dietaryData` | + +--- + +## Defining New Variables + +Steps can define NEW variables that future steps will use. + +**Step 01 defines:** +```yaml +--- +targetWorkflowPath: '{bmb_creations_output_folder}/workflows/{workflow_name}' +--- +# Uses {targetWorkflowPath} in body +``` + +**Step 02 uses:** +```yaml +--- +targetWorkflowPath: '{bmb_creations_output_folder}/workflows/{workflow_name}' +workflowPlanFile: '{targetWorkflowPath}/plan.md' +--- +# Uses {targetWorkflowPath} and {workflowPlanFile} in body +``` + +--- + +## Continuable Workflow Frontmatter + +```yaml +--- +stepsCompleted: ['step-01-init', 'step-02-gather', 'step-03-design'] +lastStep: 'step-03-design' +lastContinued: '2025-01-02' +date: '2025-01-01' +--- +``` + +**Step tracking:** Each step appends its NAME to `stepsCompleted`. + +--- + +## Validation Checklist + +For EVERY step frontmatter, verify: + +- [ ] `name` present, kebab-case format +- [ ] `description` present +- [ ] Extract ALL variable names from frontmatter (between `---` markers) +- [ ] For EACH variable, search body: is `{variableName}` present? +- [ ] If variable NOT in body → ❌ VIOLATION, remove from frontmatter +- [ ] All step-to-step paths use `./filename.md` format (same folder) +- [ ] All parent-folder paths use `../filename.md` format +- [ ] All subfolder paths use `./subfolder/filename.md` format +- [ ] NO `{workflow_path}` variable exists +- [ ] External paths use `{project-root}` variable +- [ ] Module variables only used if workflow belongs to that module diff --git a/src/modules/bmb/workflows/workflow/data/input-discovery-standards.md b/src/modules/bmb/workflows/workflow/data/input-discovery-standards.md new file mode 100644 index 00000000..12f19d78 --- /dev/null +++ b/src/modules/bmb/workflows/workflow/data/input-discovery-standards.md @@ -0,0 +1,269 @@ +# Input Document Discovery Standards + +**Purpose:** How workflows discover, validate, and select input documents from prior workflows or external sources. + +--- + +## Discovery Patterns + +### Pattern 1: Prior Workflow Output +**Use when:** Workflow is part of a sequence (e.g., PRD → Architecture → Epics) + +**Example:** BMM module pipeline - each of these are a workflow with many steps: +``` +brainstorming → research → brief → PRD → UX → architecture → epics → sprint-planning +``` + +Each workflow checks for output from prior workflow(s). + +### Pattern 2: Module Folder Search +**Use when:** Documents stored in known project location + +**Example:** Manager review workflow searches `{project_folder}/employee-notes/` + +### Pattern 3: User-Specified Paths +**Use when:** User provides document locations + +**Example:** Tax workflow asks for financial statement paths + +### Pattern 4: Pattern-Based Discovery +**Use when:** Search by file naming pattern + +**Example:** Find all `*-brief.md` files in `{planning_artifacts}/` + +--- + +## Discovery Step Pattern + +**When:** Step 1 (init) or Step 2 (discovery) + +**Frontmatter:** +```yaml +--- +# Input discovery variables +inputDocuments: [] # Populated with discovered docs +requiredInputCount: 1 # Minimum required to proceed +optionalInputCount: 0 # Additional docs user may provide +moduleInputFolder: '{planning_artifacts}' # Where to search +inputFilePatterns: # File patterns to match + - '*-prd.md' + - '*-ux.md' +--- +``` + +**Discovery Logic:** +```markdown +## 1. Check for Known Prior Workflow Outputs + +Search in order: +1. {module_output_folder}/[known-prior-workflow-output].md +2. {project_folder}/[standard-locations]/ +3. {planning_artifacts}/ +4. User-provided paths + +## 2. Pattern-Based Search + +If no known prior workflow, search by patterns: +- Look for files matching {inputFilePatterns} +- Search in {moduleInputFolder} +- Search in {project_folder}/docs/ + +## 3. Present Findings to User + +"Found these documents that may be relevant: +- [1] prd-my-project.md (created 3 days ago) +- [2] ux-research.md (created 1 week ago) +- [3] competitor-analysis.md + +Which would you like to use? You can select multiple, or provide additional paths." + +## 4. Confirm and Load + +User confirms selection → Load selected documents +Add to {inputDocuments} array in output frontmatter +``` + +--- + +## Required vs Optional Inputs + +### Required Inputs +Workflow cannot proceed without these. + +**Example:** Architecture workflow requires PRD + +```markdown +## INPUT REQUIREMENT: + +This workflow requires a Product Requirements Document to proceed. + +Searching for PRD in: +- {bmm_creations_output_folder}/prd-*.md +- {planning_artifacts}/*-prd.md +- {project_folder}/docs/*-prd.md + +[If found:] +"Found PRD: prd-my-project.md. Use this?" +[If not found:] +"No PRD found. This workflow requires a PRD to continue. +Please provide the path to your PRD, or run the PRD workflow first." +``` + +### Optional Inputs +Workflow can proceed without these, but user may include. + +**Example:** UX workflow can use research docs if available + +```markdown +## OPTIONAL INPUTS: + +This workflow can incorporate research documents if available. + +Searching for research in: +- {bmm_creations_output_folder}/research-*.md +- {project_folder}/research/ + +[If found:] +"Found these research documents: +- [1] user-interviews.md +- [2] competitive-analysis.md +Include any? (None required to proceed)" +``` + +--- + +## Module Workflow Chaining + +**For modules with sequential workflows:** + +**Frontmatter in workflow.md:** +```yaml +--- +## INPUT FROM PRIOR WORKFLOFS + +### Required Inputs: +- {module_output_folder}/prd-{project_name}.md + +### Optional Inputs: +- {module_output_folder}/ux-research-{project_name}.md +- {project_folder}/docs/competitor-analysis.md +--- +``` + +**Step 1 discovery:** +```markdown +## 1. Discover Prior Workflow Outputs + +Check for required inputs: +1. Look for {module_output_folder}/prd-{project_name}.md +2. If missing → Error: "Please run PRD workflow first" +3. If found → Confirm with user + +Check for optional inputs: +1. Search {module_output_folder}/ for research-*.md +2. Search {project_folder}/docs/ for *-analysis.md +3. Present findings to user +4. Add selections to {inputDocuments} +``` + +--- + +## Input Validation + +After discovery, validate inputs: + +```markdown +## INPUT VALIDATION: + +For each discovered document: +1. Load and read frontmatter +2. Check workflowType field (should match expected) +3. Check completeness (stepsCompleted should be complete) +4. Check date (warn if document is very old) + +[If validation fails:] +"Document prd-my-project.md appears incomplete. +Last step: step-06 (of 11) +Recommend completing PRD workflow before proceeding. +Proceed anyway? [Y]es [N]o" +``` + +--- + +## Multiple Input Selection + +**When user can select multiple documents:** + +```markdown +## Document Selection + +"Found these relevant documents: +[1] prd-my-project.md (3 days ago) ✓ Recommended +[2] prd-v1.md (2 months ago) ⚠ Older version +[3] ux-research.md (1 week ago) + +Enter numbers to include (comma-separated), or 'none' to skip: +> 1, 3 + +Selected: prd-my-project.md, ux-research.md" +``` + +**Track in frontmatter:** +```yaml +--- +inputDocuments: + - path: '{output_folder}/prd-my-project.md' + type: 'prd' + source: 'prior-workflow' + selected: true + - path: '{output_folder}/ux-research.md' + type: 'research' + source: 'prior-workflow' + selected: true +--- +``` + +--- + +## Search Path Variables + +Common module variables for input discovery: + +| Variable | Purpose | +| ------------------------ | -------------------------- | +| `{module_output_folder}` | Prior workflow outputs | +| `{planning_artifacts}` | General planning docs | +| `{project_folder}/docs` | Project documentation | +| `{product_knowledge}` | Product-specific knowledge | +| `{user_documents}` | User-provided location | + +--- + +## Discovery Step Template + +```markdown +--- +name: 'step-01-init' +description: 'Initialize and discover input documents' + +# Input Discovery +inputDocuments: [] +requiredInputCount: 1 +moduleInputFolder: '{module_output_folder}' +inputFilePatterns: + - '*-prd.md' +--- +``` + +--- + +## Validation Checklist + +For input discovery: +- [ ] Required inputs defined in step frontmatter +- [ ] Search paths defined (module variables or patterns) +- [ ] User confirmation before using documents +- [ ] Validation of document completeness +- [ ] Clear error messages when required inputs missing +- [ ] Support for multiple document selection +- [ ] Optional inputs clearly marked as optional diff --git a/src/modules/bmb/workflows/workflow/data/intent-vs-prescriptive-spectrum.md b/src/modules/bmb/workflows/workflow/data/intent-vs-prescriptive-spectrum.md new file mode 100644 index 00000000..ed8df32d --- /dev/null +++ b/src/modules/bmb/workflows/workflow/data/intent-vs-prescriptive-spectrum.md @@ -0,0 +1,50 @@ +# Intent vs Prescriptive Spectrum + +**Principle:** Workflows lean toward **intent** (goals) not **prescription** (exact wording). The more intent-based, the more adaptive and creative the LLM can be. + +--- + +## When to Use Each + +### Intent-Based (Default) +**Use for:** Most workflows - creative, exploratory, collaborative +**Step instruction:** "Help the user understand X using multi-turn conversation. Probe to get good answers. Ask 1-2 questions at a time, not a laundry list." +**LLM figures out:** Exact wording, question order, how to respond + +### Prescriptive (Exception) +**Use for:** Compliance, safety, legal, medical, regulated industries +**Step instruction:** "Say exactly: 'Do you currently experience fever, cough, or fatigue?' Wait for response. Then ask exactly: 'When did symptoms begin?'" +**LLM follows:** Exact script, specific order, no deviation + +--- + +## Examples + +### Intent-Based (Good for most) +``` +"Guide the user through discovering their ideal nutrition plan. +Use multi-turn conversation. Ask 1-2 questions at a time. +Think about their responses before asking follow-ups. +Probe to understand preferences, restrictions, goals." +``` + +### Prescriptive (Only when required) +``` +"Medical intake - ask exactly: +1. 'Do you have any of these symptoms: fever, cough, fatigue?' +2. 'When did symptoms begin?' +3. 'Have you traveled recently in the last 14 days?' +Follow sequence precisely. Do not deviate." +``` + +--- + +## Step Writing Tips + +- **Default to intent** - give goals, not scripts +- **Use "think"** - "Think about their response before..." +- **Multi-turn** - "Use conversation, not interrogation" +- **Progressive** - "Ask 1-2 questions at a time" +- **Probe** - "Ask follow-ups to understand deeper" + +Only use prescriptive when compliance/regulation requires it. diff --git a/src/modules/bmb/workflows/workflow/data/menu-handling-standards.md b/src/modules/bmb/workflows/workflow/data/menu-handling-standards.md new file mode 100644 index 00000000..0247052e --- /dev/null +++ b/src/modules/bmb/workflows/workflow/data/menu-handling-standards.md @@ -0,0 +1,167 @@ +# Menu Handling Standards + +**CRITICAL:** Every menu MUST have a handler section. No exceptions. + +--- + +## Reserved Letters + +| Letter | Purpose | After Execution | +| ------ | -------------------- | ------------------------------ | +| **A** | Advanced Elicitation | Redisplay menu | +| **P** | Party Mode | Redisplay menu | +| **C** | Continue/Accept | Save → update → load next step | +| **X** | Exit/Cancel | End workflow | + +**Custom letters** allowed (L/R/F/etc.) but don't conflict with reserved. + +--- + +## Required Structure + +### Section 1: Display +```markdown +### N. Present MENU OPTIONS + +Display: "**Select:** [A] [action] [P] [action] [C] Continue" +``` + +### Section 2: Handler (MANDATORY) +```markdown +#### Menu Handling Logic: +- IF A: Execute {advancedElicitationTask}, and when finished redisplay the menu +- IF P: Execute {partyModeWorkflow}, and when finished redisplay the menu +- IF C: Save content to {outputFile}, update frontmatter, then load, read entire file, then execute {nextStepFile} +- IF Any other: help user, then [Redisplay Menu Options](#n-present-menu-options) +``` + +### Section 3: Execution Rules +```markdown +#### EXECUTION RULES: +- ALWAYS halt and wait for user input after presenting menu +- ONLY proceed to next step when user selects 'C' +- After other menu items execution, return to this menu +``` + +--- + +## When To Include A/P + +### DON'T Include A/P: +- Step 1 (init) - no content to refine yet +- Step 2 if only loading documents +- Validation sequences - auto-flow instead +- Simple data gathering + +### DO Include A/P: +- Collaborative content creation +- User might want alternatives +- Quality gate before proceeding +- Creative exploration valuable + +--- + +## Menu Patterns + +### Pattern 1: Standard A/P/C +```markdown +Display: "**Select an Option:** [A] Advanced Elicitation [P] Party Mode [C] Continue" + +#### Menu Handling Logic: +- IF A: Execute {advancedElicitationTask}, and when finished redisplay the menu +- IF P: Execute {partyModeWorkflow}, and when finished redisplay the menu +- IF C: Save content to {outputFile}, update frontmatter, then load, read entire file, then execute {nextStepFile} +- IF Any other: help user, then [Redisplay Menu Options](#n-present-menu-options) + +#### EXECUTION RULES: +- ALWAYS halt and wait for user input after presenting menu +- ONLY proceed to next step when user selects 'C' +- After other menu items execution, return to this menu +``` + +### Pattern 2: C Only (No A/P) +```markdown +Display: "**Select:** [C] Continue" + +#### Menu Handling Logic: +- IF C: Save content to {outputFile}, update frontmatter, then load, read entire file, then execute {nextStepFile} +- IF Any other: help user, then [Redisplay Menu Options](#n-present-menu-options) + +#### EXECUTION RULES: +- ALWAYS halt and wait for user input after presenting menu +- ONLY proceed to next step when user selects 'C' +``` + +**Use for:** Step 1, document discovery, simple progression + +### Pattern 3: Auto-Proceed (No Menu) +```markdown +Display: "**Proceeding to [next step]...**" + +#### Menu Handling Logic: +- After [completion condition], immediately load, read entire file, then execute {nextStepFile} + +#### EXECUTION RULES: +- This is an [auto-proceed reason] step with no user choices +- Proceed directly to next step after setup +``` + +**Use for:** Init steps, validation sequences + +### Pattern 4: Branching +```markdown +Display: "**Select:** [L] Load Existing [N] Create New [C] Continue" + +#### Menu Handling Logic: +- IF L: Load existing document, then load, read entire file, then execute {stepForExisting} +- IF N: Create new document, then load, read entire file, then execute {stepForNew} +- IF C: Save content to {outputFile}, update frontmatter, check {condition}, then load appropriate step +- IF Any other: help user, then [Redisplay Menu Options](#n-present-menu-options) + +#### EXECUTION RULES: +- ALWAYS halt and wait for user input after presenting menu +- Branching options load different steps based on user choice +``` + +--- + +## Critical Violations + +### ❌ DON'T: +```markdown +# Missing Handler Section +Display: "**Select:** [C] Continue" +[NO HANDLER - CRITICAL ERROR!] + +# A/P in Step 1 (doesn't make sense) +Display: "**Select:** [A] Advanced Elicitation [P] Party Mode [C] Continue" + +# Forgetting redisplay +- IF A: Execute {advancedElicitationTask} +# Should end with: ", and when finished redisplay the menu" + +# Missing halt instruction +#### EXECUTION RULES: +- ONLY proceed to next step when user selects 'C' +# MISSING: "ALWAYS halt and wait for user input after presenting menu" +``` + +### ✅ DO: +- Handler section immediately follows Display +- "Halt and wait" in EXECUTION RULES +- Non-C options specify "redisplay menu" +- A/P only when appropriate for step type + +--- + +## Validation Checklist + +For every menu: +- [ ] Display section present +- [ ] Handler section immediately follows +- [ ] EXECUTION RULES section present +- [ ] "Halt and wait" instruction included +- [ ] A/P options appropriate for step type +- [ ] Non-C options redisplay menu +- [ ] C option: save → update → load next +- [ ] All file references use variables diff --git a/src/modules/bmb/workflows/workflow/data/output-format-standards.md b/src/modules/bmb/workflows/workflow/data/output-format-standards.md new file mode 100644 index 00000000..23e6439f --- /dev/null +++ b/src/modules/bmb/workflows/workflow/data/output-format-standards.md @@ -0,0 +1,188 @@ +# Output Format Standards + +**Purpose:** How workflows produce documents and handle step output. + +--- + +## Golden Rule + +**Every step MUST output to a document BEFORE loading the next step.** + +Two patterns: +1. **Direct-to-Final:** Steps append to final document +2. **Plan-then-Build:** Steps append to plan → build step consumes plan + +--- + +## Menu C Option Sequence + +When user selects **C (Continue)**: +1. **Append/Write** to document (plan or final) +2. **Update frontmatter** (append this step to `stepsCompleted`) +3. **THEN** load next step + +```markdown +- IF C: Save content to {outputFile}, update frontmatter, then load, read entire file, then execute {nextStepFile} +``` + +--- + +## Output Patterns + +### Pattern 1: Plan-then-Build + +**Use when:** Design/plan before building/creating + +``` +Step 1 (init) → Creates plan.md from template +Step 2 (gather) → Appends requirements to plan.md +Step 3 (design) → Appends design decisions to plan.md +Step 4 (review) → Appends review/approval to plan.md +Step 5 (build) → READS plan.md, CREATES final artifacts +``` + +**Plan frontmatter:** +```yaml +workflowName: [name] +creationDate: [date] +stepsCompleted: ['step-01-init', 'step-02-gather'] +status: PLANNING_COMPLETE +``` + +**Example:** Workflow creation - steps append to plan, build step generates files + +### Pattern 2: Direct-to-Final + +**Use when:** Each step contributes to final deliverable + +``` +Step 1 (init) → Creates final-doc.md from minimal template +Step 2 (section) → Appends Section 1 +Step 3 (section) → Appends Section 2 +Step 4 (section) → Appends Section 3 +Step 5 (polish) → Optimizes entire document +``` + +**Example:** Meal prep nutrition plan - each step adds a section + +--- + +## Four Template Types + +### 1. Free-Form (RECOMMENDED) + +**Characteristics:** Minimal template, progressive append, final polish + +**Template:** +```yaml +--- +stepsCompleted: [] +lastStep: '' +date: '' +user_name: '' +--- + +# {{document_title}} + +[Content appended progressively by workflow steps] +``` + +**Use when:** Most workflows - flexible, collaborative + +### 2. Structured + +**Characteristics:** Single template with placeholders, clear sections + +**Template:** +```markdown +# {{title}} + +## {{section_1}} +[Content to be filled] + +## {{section_2}} +[Content to be filled] +``` + +**Use when:** Reports, proposals, documentation + +### 3. Semi-Structured + +**Characteristics:** Core required sections + optional additions + +**Use when:** Forms, checklists, meeting minutes + +### 4. Strict + +**Characteristics:** Multiple templates, exact field definitions + +**Use when:** Rarely - compliance, legal, regulated + +--- + +## Template Syntax + +```markdown +{{variable}} # Handlebars style (preferred) +[variable] # Bracket style (also supported) +``` + +**Keep templates lean** - structure only, not content. + +--- + +## Step-to-Output Mapping + +Steps should be in ORDER of document appearance: + +``` +Step 1: Init (creates doc) +Step 2: → ## Section 1 +Step 3: → ## Section 2 +Step 4: → ## Section 3 +Step 5: → ## Section 4 +Step 6: Polish (optimizes entire doc) +``` + +**Critical:** Use ## Level 2 headers for main sections - allows document splitting if needed. + +--- + +## Final Polish Step + +For free-form workflows, include a polish step that: +1. Loads entire document +2. Reviews for flow and coherence +3. Reduces duplication +4. Ensures proper ## Level 2 headers +5. Improves transitions +6. Keeps general order but optimizes readability + +--- + +## Output File Patterns + +```yaml +# Single output +outputFile: '{output_folder}/document-{project_name}.md' + +# Time-stamped +outputFile: '{output_folder}/document-{project_name}-{timestamp}.md' + +# User-specific +outputFile: '{output_folder}/document-{user_name}-{project_name}.md' +``` + +--- + +## Validation Checklist + +For workflow output design: +- [ ] Output format type selected +- [ ] Template created if needed +- [ ] Steps ordered to match document structure +- [ ] Each step outputs to document (except init/final) +- [ ] Level 2 headers for main sections +- [ ] Final polish step for free-form workflows +- [ ] Frontmatter tracking for continuable workflows +- [ ] Templates use consistent placeholder syntax diff --git a/src/modules/bmb/workflows/workflow/data/step-file-rules.md b/src/modules/bmb/workflows/workflow/data/step-file-rules.md new file mode 100644 index 00000000..b7d59d47 --- /dev/null +++ b/src/modules/bmb/workflows/workflow/data/step-file-rules.md @@ -0,0 +1,235 @@ +# Step File Rules + +**Purpose:** Quick reference for step file structure and compliance. See linked data files for detailed standards. + +--- + +## File Size Limits + +| Metric | Value | +| ----------- | -------- | +| Recommended | < 200 lines | +| Absolute Maximum | 250 lines | + +**If exceeded:** Split into multiple steps or extract content to `/data/` files. + +--- + +## Required Step Structure + +```markdown +--- +name: 'step-[N]-[name]' +description: '[what this step does]' + +# File References (ONLY variables used in this step!) +[file references in {variable} format] +--- + +# Step [N]: [Name] + +## STEP GOAL: +[Single sentence: what this step accomplishes] + +## MANDATORY EXECUTION RULES (READ FIRST): +### Universal Rules: +- 🛑 NEVER generate content without user input +- 📖 CRITICAL: Read the complete step file before taking any action +- 🔄 CRITICAL: When loading next step with 'C', ensure entire file is read +- 📋 YOU ARE A FACILITATOR, not a content generator + +### Role Reinforcement: +- ✅ You are a [specific role] +- ✅ We engage in collaborative dialogue, not command-response +- ✅ You bring [expertise], user brings [theirs] +- ✅ Together we produce something better + +### Step-Specific Rules: +- 🎯 Focus only on [specific task] +- 🚫 FORBIDDEN to [prohibited action] +- 💬 Approach: [how to engage] + +## EXECUTION PROTOCOLS: +- 🎯 [Protocol 1] +- 💾 [Protocol 2 - save/update] +- 📖 [Protocol 3 - tracking] + +## CONTEXT BOUNDARIES: +- Available context: [what's available] +- Focus: [what to focus on] +- Limits: [boundaries] +- Dependencies: [what this depends on] + +## Sequence of Instructions: +### 1. [Action] +[Instructions] + +### N. Present MENU OPTIONS +[Menu section - see menu-handling-standards.md] + +## 🚨 SYSTEM SUCCESS/FAILURE METRICS: +### ✅ SUCCESS: +[Success criteria] +### ❌ SYSTEM FAILURE: +[Failure criteria] +**Master Rule:** Skipping steps is FORBIDDEN. +``` + +--- + +## Critical Rules (Quick Reference) + +### Frontmatter +- ✅ Only variables USED in the step body +- ✅ All file references use `{variable}` format +- ✅ Relative paths within workflow folder +- See: `frontmatter-standards.md` + +### Menus +- ✅ Handler section MUST follow display +- ✅ "Halt and wait" in execution rules +- ✅ A/P options only when appropriate +- ✅ Non-C options redisplay menu +- See: `menu-handling-standards.md` + +### Progressive Disclosure +- ✅ Only load next step when user selects 'C' +- ✅ Read entire step file before execution +- ✅ Don't create mental todos from future steps + +### Continuable Workflows +- ✅ Append step number to `stepsCompleted` +- ✅ Don't hardcode full array +- See: `workflow-type-criteria.md` + +--- + +## Data Files Reference + +| File | Purpose | +| ----------------------- | --------------------------------------------- | +| `frontmatter-standards.md` | Variables, paths, frontmatter rules | +| `menu-handling-standards.md` | Menu patterns, handler requirements | +| `output-format-standards.md` | Document output, template types | +| `workflow-type-criteria.md` | Continuable, module, tri-modal decisions | +| `step-type-patterns.md` | Templates for init/middle/final/branch steps | +| `trimodal-workflow-structure.md` | Create/Edit/Validate folder structure | + +--- + +## Step Type Reference + +| Step Type | Template/Reference | +| ------------------- | ------------------------------------------- | +| Init (non-continuable) | Auto-proceed, no continuation logic | +| Init (continuable) | `step-01-init-continuable-template.md` | +| Continuation (01b) | `step-1b-template.md` | +| Middle (standard) | A/P/C menu, collaborative content | +| Middle (simple) | C only menu, no A/P | +| Branch/Conditional | Custom menu options, routing to different steps | +| Validation sequence | Auto-proceed through checks | +| Final | No next step, completion message | + +See: `step-type-patterns.md` + +--- + +## Frontmatter Variables + +### Standard (Always Available) +- `{project-root}` +- `{project_name}` +- `{output_folder}` +- `{user_name}` +- `{communication_language}` +- `{document_output_language}` + +### Module-Specific (e.g., BMB) +- `{bmb_creations_output_folder}` + +### User-Defined +- New variables can be defined in steps for future steps + +See: `frontmatter-standards.md` + +--- + +## Validation Checklist + +For every step file: + +- [ ] File < 200 lines (250 max) +- [ ] `name` and `description` in frontmatter +- [ ] All frontmatter variables are used +- [ ] File references use `{variable}` format +- [ ] Relative paths within workflow folder +- [ ] Handler section follows menu display +- [ ] "Halt and wait" in execution rules +- [ ] A/P options appropriate for step type +- [ ] C option saves and loads next step +- [ ] Non-C options redisplay menu +- [ ] StepsCompleted appended (if continuable) +- [ ] Success/failure metrics present + +--- + +## Quick Menu Reference + +```markdown +### N. Present MENU OPTIONS + +Display: "**Select:** [A] [action A] [P] [action P] [C] Continue" + +#### Menu Handling Logic: +- IF A: Execute {advancedElicitationTask}, and when finished redisplay the menu +- IF P: Execute {partyModeWorkflow}, and when finished redisplay the menu +- IF C: Save content to {outputFile}, update frontmatter, then load, read entire file, then execute {nextStepFile} +- IF Any other comments or queries: help user respond then [Redisplay Menu Options](#n-present-menu-options) + +#### EXECUTION RULES: +- ALWAYS halt and wait for user input after presenting menu +- ONLY proceed to next step when user selects 'C' +- After other menu items execution, return to this menu +``` + +--- + +## Common Violations + +| ❌ Violation | ✅ Fix | +| ------------------------------------- | ---------------------------------------------- | +| Unused variable in frontmatter | Remove unused variables | +| Hardcoded file path | Use `{variable}` format | +| A/P menu in step 1 | Remove A/P (inappropriate for init) | +| Missing handler section | Add handler after menu display | +| No "halt and wait" instruction | Add to EXECUTION RULES | +| Hardcoded `stepsCompleted: [1,2,3]` | Append: "update stepsCompleted to add this step" | +| File > 250 lines | Split into multiple steps or extract to /data/ | +| Absolute path for same-folder ref | Use relative path or `{workflow_path}` | + +--- + +## When to Extract to Data Files + +Extract step content to `/data/` when: +- Step file exceeds 200 lines +- Content is reference material +- Content is reused across steps +- Content is domain-specific (examples, patterns) + +**Data file types:** +- `.md` - Reference documentation +- `.csv` - Structured data for lookup +- `examples/` - Reference implementations + +--- + +## Tri-Modal Workflow Note + +For Create/Edit/Validate workflows: +- Each mode has its own `steps-c/`, `steps-e/`, `steps-v/` folder +- NO shared step files (`s-*.md`) between modes +- All modes share `/data/` folder +- This prevents confusion and routing errors + +See: `trimodal-workflow-structure.md` diff --git a/src/modules/bmb/workflows/workflow/data/step-type-patterns.md b/src/modules/bmb/workflows/workflow/data/step-type-patterns.md new file mode 100644 index 00000000..772b6be3 --- /dev/null +++ b/src/modules/bmb/workflows/workflow/data/step-type-patterns.md @@ -0,0 +1,311 @@ +# Step Type Patterns + +**Purpose:** Templates for different step types. + +--- + +## Core Step Structure + +All steps share this skeleton: +```markdown +--- +name: 'step-[N]-[name]' +description: '[what it does]' +[file references - relative path and only if used in this steps file] +--- + +# Step [N]: [Name] + +## STEP GOAL: +[Single sentence goal] + +## MANDATORY EXECUTION RULES (READ FIRST): +### Universal Rules: +- 🛑 NEVER generate content without user input +- 📖 CRITICAL: Read complete step file before action +- 🔄 CRITICAL: When loading next with 'C', read entire file +- 📋 YOU ARE A FACILITATOR, not content generator + +### Role Reinforcement: +- ✅ You are [specific role] +- ✅ Collaborative dialogue, not command-response +- ✅ You bring [expertise], user brings [theirs] + +### Step-Specific Rules: +- 🎯 Focus only on [specific task] +- 🚫 FORBIDDEN to [prohibited action] +- 💬 Approach: [how to engage] + +## EXECUTION PROTOCOLS: +- 🎯 Follow the MANDATORY SEQUENCE exactly +- 💾 [Additional protocol] +- 📖 [Additional protocol] + +## CONTEXT BOUNDARIES: +- Available context: [what's available] +- Focus: [what to focus on] +- Limits: [boundaries] +- Dependencies: [what this depends on] + +## MANDATORY SEQUENCE + +**CRITICAL:** Follow this sequence exactly. Do not skip, reorder, or improvise unless user explicitly requests a change. + +### 1. [First action] +[Instructions] + +### N. Present MENU OPTIONS +[Menu section - see menu-handling-standards.md] + +## 🚨 SYSTEM SUCCESS/FAILURE METRICS: +### ✅ SUCCESS: [criteria] +### ❌ SYSTEM FAILURE: [criteria] +**Master Rule:** Skipping steps is FORBIDDEN. +``` + +--- + +## Step Types + +### 1. Init Step (Non-Continuable) + +**Use:** Single-session workflow + +**Frontmatter:** +```yaml +--- +name: 'step-01-init' +description: 'Initialize [workflow]' +nextStepFile: './step-02-[name].md' +outputFile: '{output_folder}/[output].md' +templateFile: '../templates/[template].md' +--- +``` + +**Characteristics:** +- No continuation detection +- Auto-proceeds to step 2 +- No A/P menu +- Creates output from template + +**Menu:** Auto-proceed (no user choice) + +### 2. Init Step (Continuable) + +**Use:** Multi-session workflow + +**Frontmatter:** Add `continueFile` reference +```yaml +continueFile: './step-01b-continue.md' +``` + +**Logic:** +```markdown +## 1. Check for Existing Workflow +- Look for {outputFile} +- If exists AND has stepsCompleted → STOP, load {continueFile} +- If not exists → continue to setup +``` + +**Reference:** `step-01-init-continuable-template.md` + +### 3. Continuation Step (01b) + +**Use:** Paired with continuable init + +**Frontmatter:** +```yaml +--- +name: 'step-01b-continue' +description: 'Handle workflow continuation' +outputFile: '{output_folder}/[output].md' +workflowFile: '{workflow_path}/workflow.md' +--- +``` + +**Logic:** +1. Read `stepsCompleted` array from output +2. Read last completed step file to find nextStep +3. Welcome user back +4. Route to appropriate step + +**Reference:** `step-1b-template.md` + +### 4. Middle Step (Standard) + +**Use:** Collaborative content generation + +**Frontmatter:** +```yaml +--- +name: 'step-[N]-[name]' +nextStepFile: './step-[N+1]-[name].md' +outputFile: '{output_folder}/[output].md' +advancedElicitationTask: '{project-root}/.../advanced-elicitation/workflow.xml' +partyModeWorkflow: '{project-root}/.../party-mode/workflow.md' +--- +``` + +**Menu:** A/P/C pattern + +### 5. Middle Step (Simple) + +**Use:** Data gathering, no refinement needed + +**Menu:** C only (no A/P) + +### 6. Branch Step + +**Use:** User choice determines next path + +**Frontmatter:** +```yaml +nextStepFile: './step-[default].md' +altStepFile: './step-[alternate].md' +``` + +**Menu:** Custom letters (L/R/etc.) with branching logic + +### 7. Validation Sequence Step + +**Use:** Multiple checks without user interruption + +**Menu:** Auto-proceed to next validation + +**Pattern:** +```markdown +## 1. Perform validation check +[Check logic] + +## 2. Write results to {outputFile} +Append findings + +## 3. Proceed to next validation +Display: "**Proceeding to next check...**" +→ Immediately load {nextValidationStep} +``` + +### 8. Init Step (With Input Discovery) + +**Use:** Workflow that requires documents from prior workflows or external sources + +**Frontmatter:** +```yaml +--- +name: 'step-01-init' +description: 'Initialize and discover input documents' +inputDocuments: [] +requiredInputCount: 1 +moduleInputFolder: '{module_output_folder}' +inputFilePatterns: + - '*-prd.md' + - '*-ux.md' +--- +``` + +**Characteristics:** +- Discovers documents from prior workflows +- Searches by folder, pattern, or user-provided paths +- Validates inputs are complete +- User confirms which documents to use +- Auto-proceeds when required inputs found + +**Logic:** +```markdown +## 1. Discover Required Inputs +Search {moduleInputFolder} for {inputFilePatterns} +Search {project_folder}/docs/ for {inputFilePatterns} + +## 2. Present Findings +"Found these documents: +[1] prd-my-project.md (3 days ago) ✓ +[2] ux-research.md (1 week ago) +Which would you like to use?" + +## 3. Validate and Load +Check workflowType, stepsCompleted, date +Load selected documents +Add to {inputDocuments} array + +## 4. Auto-Proceed +If all required inputs found → proceed to step 2 +If missing → Error with guidance +``` + +**Reference:** `input-discovery-standards.md` + +### 9. Final Polish Step + +**Use:** Optimizes document built section-by-section + +**Frontmatter:** +```yaml +--- +name: 'step-[N]-polish' +description: 'Optimize and finalize document' +outputFile: '{output_folder}/[document].md' +--- +``` + +**Characteristics:** +- Loads entire document +- Reviews for flow and coherence +- Reduces duplication +- Ensures proper ## Level 2 headers +- Improves transitions +- Keeps general order but optimizes readability + +**Logic:** +```markdown +## 1. Load Complete Document +Read {outputFile} entirely + +## 2. Document Optimization +Review entire document for: +1. Flow and coherence +2. Duplication (remove while preserving essential info) +3. Proper ## Level 2 section headers +4. Smooth transitions between sections +5. Overall readability + +## 3. Optimize +Make improvements while maintaining: +- General order of sections +- Essential information +- User's voice and intent + +## 4. Final Output +Save optimized document +Mark workflow complete +``` + +**Use for:** Free-form output workflows (most document-producing workflows) + +### 10. Final Step + +**Use:** Last step, completion + +**Frontmatter:** No `nextStepFile` + +**Logic:** +- Update frontmatter to mark workflow complete +- Provide final summary +- No next step + +--- + +## Step Size Guidelines + +| Type | Recommended | Maximum | +| --------------------- | ----------- | ------- | +| Init | < 100 | 150 | +| Init (with discovery) | < 150 | 200 | +| Continuation | < 150 | 200 | +| Middle (simple) | < 150 | 200 | +| Middle (complex) | < 200 | 250 | +| Branch | < 150 | 200 | +| Validation sequence | < 100 | 150 | +| Final polish | < 150 | 200 | +| Final | < 150 | 200 | + +**If exceeded:** Split into multiple steps or extract to `/data/` files. diff --git a/src/modules/bmb/workflows/workflow/data/subprocess-optimization-patterns.md b/src/modules/bmb/workflows/workflow/data/subprocess-optimization-patterns.md new file mode 100644 index 00000000..5aa17a34 --- /dev/null +++ b/src/modules/bmb/workflows/workflow/data/subprocess-optimization-patterns.md @@ -0,0 +1,386 @@ +# Subprocess Optimization Patterns + +**Purpose:** Context-saving and performance patterns for subprocess/subagent usage in BMAD workflows. + +--- + +## Golden Rules + +1. **Subprocess when operations benefit from parallelization or context isolation** +2. **Return ONLY findings to parent, not full file contents** (massive context savings) +3. **Always provide graceful fallback** for LLMs without subprocess capability +4. **Match pattern to operation type** - grep/regex, deep analysis, or data operations + +--- + +## The Three Patterns + +### Pattern 1: Single Subprocess for Grep/Regex Across Many Files + +**Use when:** You can run one command across many files and just need matches/failures + +**Context savings:** Massive - returns only matching lines, not full file contents + +**Template:** +```markdown +**Launch a subprocess that:** + +1. Runs grep/regex across all target files +2. Extracts only matching lines or failures +3. Returns structured findings to parent + +```bash +# Example: Find hardcoded paths across all files +for file in steps-c/*.md; do + grep -n "{project-root}/" "$file" || echo "No matches in: $file" +done +``` + +**Subprocess returns to parent:** +```json +{ + "violations": [ + {"file": "step-02.md", "line": 45, "match": "{project-root}/_bmad/bmb/..."} + ], + "summary": {"total_files_checked": 10, "violations_found": 3} +} +``` + +**❌ BAD - Loads all files into parent:** +```markdown +"For EACH file, load the file and search for {project-root}/" +# Parent context gets 10 full files × 200 lines = 2000 lines loaded +``` + +**✅ GOOD - Single subprocess returns only matches:** +```markdown +"Launch a subprocess to grep all files for {project-root}/, return only matches" +# Parent context gets only matching lines = ~50 lines returned +``` + +--- + +### Pattern 2: Separate Subprocess Per File for Deep Analysis + +**Use when:** You need to read and understand each file's prose, logic, quality, or flow + +**Context savings:** High - each subprocess returns analysis, not full content + +**Template:** +```markdown +**DO NOT BE LAZY - For EACH file, launch a subprocess that:** + +1. Loads that file +2. Reads and analyzes content deeply (prose, logic, flow, quality) +3. Returns structured analysis findings to parent for aggregation + +**Subprocess returns to parent:** +```json +{ + "file": "step-03-inquiry.md", + "analysis": { + "instruction_style": "Intent-based ✅", + "collaborative_quality": "Good - asks 1-2 questions at a time", + "issues": ["Line 67: Laundry list of 7 questions detected"] + }, + "optimization_opportunities": ["Could use Pattern 1 for menu validation checks"] +} +``` + +**Example use cases:** +- Instruction style validation (read prose, classify intent vs prescriptive) +- Collaborative quality assessment (analyze question patterns) +- Frontmatter compliance (check each variable is used) +- Step type validation (verify step follows its type pattern) + +**❌ BAD - Parent loads all files:** +```markdown +"Load every step file and analyze its instruction style" +# Parent context: 10 files × 200 lines = 2000 lines +``` + +**✅ GOOD - Per-file subprocess returns analysis:** +```markdown +"DO NOT BE LAZY - For EACH step file, launch a subprocess to analyze instruction style, return findings" +# Parent context: 10 structured analysis objects = ~200 lines +``` + +--- + +### Pattern 3: Subprocess for Data File Operations + +**Use when:** Loading reference data, finding fuzzy/best matches, summarizing key findings from large datasets + +**Context savings:** Massive - returns only matching rows or summaries, not entire data file + +**Template:** +```markdown +**Launch a subprocess that:** + +1. Loads the data file (reference docs, CSV, knowledge base) +2. Performs lookup, matching, or summarization +3. Returns ONLY relevant rows or key findings to parent + +**Subprocess returns to parent:** +```json +{ + "matches": [ + {"row": 42, "rule": "Frontmatter variables must be used in body", "applies": true}, + {"row": 87, "rule": "Relative paths for same-folder refs", "applies": true} + ], + "summary": {"total_rules": 150, "applicable_rules": 2} +} +``` + +**Example use cases:** +- **Reference rules lookup**: Load 500-line standards file, return only applicable rules +- **CSV fuzzy matching**: Load product database, find best matching category +- **Document summarization**: Review 10 documents, extract only key requirements +- **Knowledge base search**: Search large knowledge base, return only top matches + +**❌ BAD - Parent loads entire data file:** +```markdown +"Load {dataFile} with 500 rules and find applicable ones" +# Parent context: All 500 rules loaded (5000+ lines) +``` + +**✅ GOOD - Subprocess returns only matches:** +```markdown +"Launch subprocess to load {dataFile}, find applicable rules, return only those" +# Parent context: Only 2 applicable rules returned (~50 lines) +``` + +**Advanced example - Document review:** +```markdown +**Review 10 requirement documents to extract key details:** + +"DO NOT BE LAZY - For EACH document, launch a subprocess that: +1. Loads that document +2. Extracts key requirements, decisions, constraints +3. Returns structured summary to parent + +**Subprocess returns:** +```json +{ + "document": "prd-requirements.md", + "key_findings": { + "requirements": ["User auth", "Data export", "API integration"], + "decisions": ["Use JWT", "PostgreSQL", "REST API"], + "constraints": ["HIPAA compliant", "Max 100ms response"] + } +} +``` + +# Parent gets summaries, not 10 full documents +``` + +--- + +## Pattern 4: Parallel Execution Opportunities + +**Use when:** Multiple independent operations could run simultaneously + +**Performance gain:** Reduced total execution time via parallelization + +**Template:** +```markdown +**Launch subprocesses in parallel that:** + +1. Each subprocess handles one independent operation +2. All subprocesses run simultaneously +3. Parent aggregates results when all complete + +**Example:** +```markdown +# Instead of sequential (3× time): +"Check frontmatter, then check menu, then check step types" + +# Use parallel (1× time): +"Launch 3 subprocesses in parallel: +- Subprocess 1: Check frontmatter compliance +- Subprocess 2: Check menu compliance +- Subprocess 3: Check step type compliance +Aggregate all findings" +``` + +--- + +## Graceful Fallback Pattern + +**CRITICAL:** Always ensure LLMs without subprocess capability can still execute + +**Universal Rule:** +```markdown +- ⚙️ If any instruction references a subprocess, subagent, or tool you do not have access to, you MUST still achieve the outcome in your main context thread +``` + +**Implementation:** +```markdown +### Step-Specific Rules: +- 🎯 Use subprocess optimization when available - [pattern description] +- 💬 If subprocess unavailable, perform operations in main thread + +### Execution: +- LLMs with subprocess: Launch subprocess, aggregate findings +- LLMs without subprocess: Perform same operations sequentially in main context +``` + +--- + +## Return Pattern for Subprocesses + +**Subprocesses must either:** + +**Option A: Update report directly** +```markdown +"Subprocess loads validation report, appends findings, saves" +# Parent doesn't need to aggregate +``` + +**Option B: Return structured findings to parent** +```markdown +"Subprocess returns JSON findings to parent for aggregation" +# Parent compiles all subprocess results into report +``` + +**✅ GOOD - Structured return:** +```json +{ + "file": "step-02.md", + "violations": ["..."], + "opportunities": ["..."], + "priority": "HIGH" +} +``` + +**❌ BAD - Returns full content:** +```markdown +"Subprocess loads file and returns full content to parent" +# Defeats purpose - parent gets full context anyway +``` + +--- + +## When to Use Each Pattern + +| Pattern | Use When | Context Savings | Example | +| -------- | -------- | --------------- | ------- | +| **Pattern 1: Single subprocess for grep/regex** | Finding patterns across many files | Massive (1000:1 ratio) | Validate frontmatter across all steps | +| **Pattern 2: Per-file subprocess for deep analysis** | Understanding prose, logic, quality | High (10:1 ratio) | Instruction style validation | +| **Pattern 3: Data file operations** | Loading reference data, matching, summarizing | Massive (100:1 ratio) | Find applicable rules from standards | +| **Pattern 4: Parallel execution** | Independent operations that can run simultaneously | Performance gain | Frontmatter + Menu + Step type checks | + +--- + +## Step File Integration + +**How to add subprocess patterns to step files:** + +### 1. Universal Rule (add to all steps) +```markdown +### Universal Rules: +- ⚙️ TOOL/SUBPROCESS FALLBACK: If any instruction references a subprocess, subagent, or tool you do not have access to, you MUST still achieve the outcome in your main context thread +``` + +### 2. Step-Specific Rules (pattern-specific) +```markdown +### Step-Specific Rules: +- 🎯 [Brief: which pattern applies] +- 💬 Subprocess must either update report OR return findings to parent +- 🚫 DO NOT BE LAZY - [specific "do not be lazy" guidance if applicable] +``` + +### 3. Command Sequence (detailed pattern) +```markdown +### 1. [Operation Name] + +**[Appropriate subprocess directive]:** + +For [Pattern 1 - grep/regex]: +"Launch a subprocess that runs [command] across all files, returns [results]" + +For [Pattern 2 - per-file analysis]: +"DO NOT BE LAZY - For EACH file, launch a subprocess that [analyzes], returns [findings]" + +For [Pattern 3 - data ops]: +"Launch a subprocess that loads [data file], performs [operation], returns [results]" +``` + +--- + +## Subprocess Loading Reference Data (Meta-Pattern!) + +**Context-saving optimization:** + +When a step needs to understand subprocess patterns with examples, load this reference file in a subprocess: + +```markdown +### Step-Specific Rules: +- 🎯 Analyze subprocess optimization opportunities - use subprocess to load reference patterns for detailed examples +- 💬 Subprocess loads {subprocessPatterns} to understand patterns deeply, returns specific opportunities +- 🚫 If subprocess unavailable: Load {subprocessPatterns} in main context + +**Execution:** +- With subprocess: Launch subprocess to load this file, understand patterns, identify opportunities +- Without subprocess: Load this file in main context (larger context but still functional) +``` + +**This step file (step-08b) demonstrates this pattern!** + +--- + +## Validation Checklist + +For subprocess optimization in step files: + +- [ ] Universal fallback rule present +- [ ] Step-specific rules mention which pattern applies +- [ ] Command sequence uses appropriate subprocess directive +- [ ] "DO NOT BE LAZY" language included for Pattern 2 +- [ ] Return pattern specified (update report OR return to parent) +- [ ] Graceful fallback addressed +- [ ] Context savings estimated (if applicable) +- [ ] Pattern matches operation type (grep/regex, deep analysis, or data ops) + +--- + +## Anti-Patterns to Avoid + +### ❌ Loading full files into parent +```markdown +"For EACH file, load the file, analyze it, and add to report" +# Defeats purpose - parent gets full context +``` + +### ❌ Subprocess returns raw content +```markdown +"Subprocess loads file and returns content to parent" +# Parent gets full content anyway +``` + +### ❌ No graceful fallback +```markdown +"Use subprocess to [operation]" +# LLMs without subprocess cannot proceed +``` + +### ❌ Wrong pattern for operation +```markdown +"Launch a subprocess per file to grep for pattern" +# Should use Pattern 1 (single subprocess for all files) +``` + +### ❌ Missing return specification +```markdown +"Launch a subprocess to analyze files" +# Unclear what subprocess returns to parent +``` + +--- + +## See Also + +- `step-file-rules.md` - When to extract content to data files +- `step-08b-subprocess-optimization.md` - Validation step that identifies optimization opportunities +- `../steps-v/step-02b-path-violations.md` - Example of Pattern 1 (grep across files) +- `../steps-v/step-08b-subprocess-optimization.md` - Example of Pattern 2 (per-file analysis) diff --git a/src/modules/bmb/workflows/workflow/data/trimodal-workflow-structure.md b/src/modules/bmb/workflows/workflow/data/trimodal-workflow-structure.md new file mode 100644 index 00000000..bb425614 --- /dev/null +++ b/src/modules/bmb/workflows/workflow/data/trimodal-workflow-structure.md @@ -0,0 +1,209 @@ +# Tri-Modal Workflow Structure + +**Purpose:** The golden rule standard for complex critical workflows that require create, validate, and edit capabilities. + +--- + +## The Golden Rule + +**For complex critical workflows: Implement tri-modal structure (create/validate/edit) with cross-mode integration.** + +This pattern ensures: +- Quality through standalone validation +- Maintainability through dedicated edit mode +- Flexibility through conversion paths for non-compliant input + +**Cross-mode integration patterns:** +- Create → Validation (handoff after build) +- Edit → Validation (verify changes) +- Edit → Create/conversion (for non-compliant input) +- Validation → Edit (fix issues found) +- All modes run standalone via workflow.md routing + +--- + +## Directory Structure + +``` +workflow-name/ +├── workflow.md # Entry point with mode routing +├── data/ # SHARED standards and reference +│ ├── [domain]-standards.md +│ └── [domain]-patterns.md +├── steps-c/ # Create (self-contained) +│ ├── step-00-conversion.md # Entry for non-compliant input +│ ├── step-01-init.md +│ └── step-N-complete.md +├── steps-e/ # Edit (self-contained) +│ ├── step-01-assess.md # Checks compliance, routes if needed +│ └── step-N-complete.md +└── steps-v/ # Validate (self-contained, runs standalone) + └── step-01-validate.md +``` + +--- + +## Mode Responsibilities + +### Create Mode (steps-c/) + +**Primary:** Build new entities from scratch +**Secondary:** Convert non-compliant input via step-00-conversion + +**Key patterns:** +- step-00-conversion: Loads non-compliant input, extracts essence, creates plan with `conversionFrom` metadata +- Final step routes to validation (optional but recommended) +- Confirmation step checks `conversionFrom` to verify coverage vs new workflow + +### Edit Mode (steps-e/) + +**Primary:** Modify existing compliant entities +**Secondary:** Detect non-compliance and route to conversion + +**Key patterns:** +- step-01-assess: Checks compliance first +- Non-compliant → Offer route to step-00-conversion (not step-01-discovery) +- Post-edit → Offer validation (reuse validation workflow) +- During edits → Check standards, offer to fix non-compliance + +### Validate Mode (steps-v/) + +**Primary:** Standalone validation against standards +**Secondary:** Generates actionable reports + +**Key patterns:** +- Runs standalone (invoked via -v flag or direct call) +- Auto-proceeds through all checks +- Generates report with issue severity +- Report consumed by edit mode for fixes + +--- + +## workflow.md Routing Pattern + +```yaml +## INITIALIZATION SEQUENCE + +### 1. Mode Determination + +**Check invocation:** +- "create" / -c → mode = create +- "validate" / -v → mode = validate +- "edit" / -e → mode = edit + +**If create mode:** Ask "From scratch or convert existing?" +- From scratch → steps-c/step-01-init.md +- Convert → steps-c/step-00-conversion.md + +**If unclear:** Ask user to select mode + +### 2. Route to First Step + +**IF mode == create:** +Route to appropriate create entry (init or conversion) + +**IF mode == validate:** +Prompt for path → load steps-v/step-01-validate.md + +**IF mode == edit:** +Prompt for path → load steps-e/step-01-assess.md +``` + +**Critical:** workflow.md is lean. No step listings. Only routing logic. + +--- + +## Cross-Mode Integration Points + +### 1. Edit → Create (Non-Compliant Detection) + +**In edit step-01-assess:** +```yaml +Check workflow compliance: + - Compliant → Continue to edit steps + - Non-compliant → Offer conversion + - IF user accepts: Load steps-c/step-00-conversion.md with sourceWorkflowPath +``` + +### 2. Create/Edit → Validation + +**Both create and edit can invoke validation:** +```yaml +# In create final step or edit post-edit step +Offer: "Run validation?" + - IF yes: Load ../steps-v/step-01-validate.md + - Validation runs standalone, returns report + - Resume create/edit with validation results +``` + +### 3. Validation → Edit + +**After validation generates report:** +```yaml +# User can invoke edit mode with report as input +"Fix issues found?" + - IF yes: Load steps-e/step-01-assess.md with validationReport path +``` + +### 4. Conversion Coverage Tracking + +**In create step-10-confirmation:** +```yaml +Check workflowPlan metadata: + - IF conversionFrom exists: + - Load original workflow + - Compare each step/instruction + - Report coverage percentage + - ELSE (new workflow): + - Validate all plan requirements implemented +``` + +--- + +## When to Use Tri-Modal + +**Use Tri-Modal for:** +- Complex workflows requiring quality assurance +- Workflows that will be maintained over time +- Workflows where non-compliant input may be offered +- Critical workflows where standards compliance matters + +**Use Create-Only for:** +- Simple one-off workflows +- Experimental workflows +- Workflows unlikely to need editing or validation + +--- + +## Frontmatter Standards for Cross-Mode References + +**Never inline file paths. Always use frontmatter variables:** + +```yaml +--- +# Create mode step calling validation +validationWorkflow: '../steps-v/step-01-validate.md' +--- + +# Edit mode step routing to conversion +conversionStep: '../steps-c/step-00-conversion.md' +--- + +# Create conversion step receiving from edit +sourceWorkflowPath: '{targetWorkflowPath}' # Passed from edit +--- +``` + +--- + +## Validation Checklist + +For tri-modal workflow design: +- [ ] Each mode has self-contained steps folder +- [ ] No shared step files (shared data in /data/ only) +- [ ] workflow.md has lean routing (no step listings) +- [ ] Edit mode checks compliance, routes to conversion if needed +- [ ] Create mode has step-00-conversion for non-compliant input +- [ ] Create/Edit can invoke validation workflow +- [ ] Validation runs standalone and generates reports +- [ ] Confirmation step checks `conversionFrom` metadata diff --git a/src/modules/bmb/workflows/workflow/data/workflow-chaining-standards.md b/src/modules/bmb/workflows/workflow/data/workflow-chaining-standards.md new file mode 100644 index 00000000..cb5be95f --- /dev/null +++ b/src/modules/bmb/workflows/workflow/data/workflow-chaining-standards.md @@ -0,0 +1,271 @@ +# Workflow Chaining Standards + +**Purpose:** How workflows connect in sequences within modules, passing outputs as inputs to next workflows. + +--- + +## Module Workflow Pipeline + +**Example:** BMM Module - Idea to Implementation + +``` +brainstorming → research → brief → PRD → UX → architecture → epics → sprint-planning + ↓ + implement-story → review → repeat +``` + +Each workflow: +1. Checks for required inputs from prior workflows +2. Validates inputs are complete +3. Produces output for next workflow +4. Recommends next workflow in sequence + +--- + +## Input/Output Contract + +### Output Contract (What Each Workflow Produces) + +**Every workflow should:** +1. Create output document with predictable filename +2. Include `workflowType` in frontmatter for identification +3. Mark `stepsCompleted: [all steps]` when complete +4. Store in known location (`{module_output_folder}`) + +**Example frontmatter:** +```yaml +--- +workflowType: 'prd' +stepsCompleted: ['step-01-init', ..., 'step-11-complete'] +project_name: 'my-project' +date: '2025-01-02' +nextWorkflow: 'create-ux' +previousWorkflow: 'create-brief' +--- +``` + +### Input Contract (What Each Workflow Consumes) + +**Every workflow should:** +1. Define required inputs in Step 1 +2. Search in `{module_output_folder}` for prior outputs +3. Validate inputs are complete +4. Allow user to select from discovered documents + +--- + +## Step 1: Input Discovery Pattern + +```markdown +## 1. Discover Required Inputs + +### Required Inputs: +- {module_output_folder}/prd-{project_name}.md + +### Search: +1. Look for prd-{project_name}.md in {module_output_folder} +2. If found → validate completeness +3. If missing or incomplete → error with guidance + +"Error: This workflow requires a completed PRD. +Expected location: {module_output_folder}/prd-{project_name}.md +To fix: Run the PRD workflow first, or provide the path to your PRD." +``` + +--- + +## Final Step: Next Workflow Recommendation + +```markdown +## Next Steps + +Based on your completed [workflow], recommended next workflows: + +1. **[next-workflow-name]** - [why it's next] +2. **[alternative-workflow]** - [when to use this instead] + +Would you like to: +- Run [next-workflow-name] now? +- Run a different workflow? +- Exit for now? +``` + +**Update output frontmatter:** +```yaml +nextWorkflow: 'create-ux' +nextWorkflowRecommended: true +``` + +--- + +## Cross-Workflow Status Tracking + +**Optional:** Module can maintain `workflow-status.yaml`: + +```yaml +--- +current_workflow: 'create-prd' +completed_workflows: + - brainstorming + - research + - brief +pending_workflows: + - create-ux + - create-architecture + - create-epics + - sprint-planning +outputs: + brief: '{module_output_folder}/brief-{project_name}.md' + prd: '{module_output_folder}/prd-{project_name}.md' +--- +``` + +**Workflow checks this file to:** +- Validate sequence (don't run UX before PRD) +- Find output locations +- Track overall progress + +--- + +## Branching Workflows + +**Some workflows have multiple valid next steps:** + +```markdown +## Next Steps + +Based on your project type: + +**For software projects:** +- create-architecture - Technical architecture +- create-epics - Break down into epics + +**For data projects:** +- data-modeling - Database schema design +- etl-pipeline - Data pipeline design + +Which workflow would you like to run next? +``` + +--- + +## Required vs Optional Sequences + +### Required Sequence +**PRD must come before Architecture:** + +```yaml +# In architecture workflow.md +## PREREQUISITE: +This workflow requires a completed PRD. + +## INITIALIZATION: +IF prd-{project_name}.md exists AND is complete: + → Proceed with architecture workflow +ELSE: + → Error: "Please complete PRD workflow first" +``` + +### Optional Sequence +**UX research helps Architecture but isn't required:** + +```yaml +# In architecture workflow.md +## OPTIONAL INPUTS: +UX research documents can inform technical decisions. + +IF ux-research-{project_name}.md exists: + → "Found UX research. Include findings in architecture design?" +ELSE: + → "No UX research found. Continuing without it." +``` + +--- + +## Filename Conventions for Chaining + +**Standard pattern:** `{workflow-name}-{project-name}.md` + +| Workflow | Output Filename Pattern | +|----------| ---------------------- | +| brainstorming | `brainstorming-{project_name}.md` | +| brief | `brief-{project_name}.md` | +| PRD | `prd-{project_name}.md` | +| UX | `ux-design-{project_name}.md` | +| architecture | `architecture-{project_name}.md` | +| epics | `epics-{project_name}.md` | + +**Predictable filenames enable:** +- Automatic discovery +- Clear dependencies +- Easy validation + +--- + +## Module-Level Workflow Registry + +**Module can define `workflows.yaml`:** + +```yaml +--- +module: 'bmm' +workflows: + brainstorming: + output: 'brainstorming-{project_name}.md' + next: ['research'] + research: + output: 'research-{project_name}.md' + next: ['brief'] + brief: + output: 'brief-{project_name}.md' + next: ['prd'] + prd: + output: 'prd-{project_name}.md' + next: ['create-ux', 'create-architecture'] + create-ux: + output: 'ux-design-{project_name}.md' + next: ['create-architecture'] + create-architecture: + output: 'architecture-{project_name}.md' + next: ['create-epics'] + create-epics: + output: 'epics-{project_name}.md' + next: ['sprint-planning'] +--- +``` + +**Workflows read this to:** +- Know what outputs exist +- Know valid next steps +- Know output filenames + +--- + +## Cross-Module Dependencies + +**Workflows can depend on outputs from other modules:** + +```yaml +# In BMGD narrative workflow +## INPUT REQUIREMENTS: + +### Required: +- {bmm_output_folder}/prd-{project_name}.md +- {bmm_output_folder}/architecture-{project_name}.md + +### From BMGD: +- {bmgd_output_folder}/gdd-{project_name}.md (Game Design Document) +``` + +--- + +## Validation Checklist + +For workflow chaining: +- [ ] Output filename follows convention +- [ ] Frontmatter includes `workflowType` +- [ ] `stepsCompleted` marked complete when done +- [ ] Required inputs clearly defined +- [ ] Input validation with helpful errors +- [ ] Next workflow recommendations in final step +- [ ] Module registry (if using sequence tracking) diff --git a/src/modules/bmb/workflows/workflow/data/workflow-examples.md b/src/modules/bmb/workflows/workflow/data/workflow-examples.md new file mode 100644 index 00000000..9e83b090 --- /dev/null +++ b/src/modules/bmb/workflows/workflow/data/workflow-examples.md @@ -0,0 +1,276 @@ +# Novel Workflow Examples + +**Purpose:** Illustrative examples of workflows across diverse domains to demonstrate the range of what users can create. + +--- + +## Understanding Workflow Structure + +**Each arrow (→) in the "Flow" column represents a potential step file.** + +``` +Flow: Discovery → Assessment → Strategy → Shopping List → Prep Schedule + ↓ ↓ ↓ ↓ ↓ + step-01- step-02- step-03- step-04- step-05- + discovery assessment strategy shopping-list prep-schedule +``` + +**Each step file contains internal structure:** +- STEP GOAL +- MANDATORY EXECUTION RULES +- EXECUTION PROTOCOLS +- MANDATORY SEQUENCE (numbered sub-steps) +- Menu options +- Success/failure metrics + +**Key insight:** A simple workflow might have 3-4 step files. A complex workflow might have 10+. Each step file is a focused, self-contained instruction. + +--- + +## Example 1: Personalized Meal Plan Generator + +**Domain:** Health & Fitness + +| Aspect | Details | +|--------|---------| +| **Flow** (each → = step file) | Discovery → Assessment → Strategy → Shopping List → Prep Schedule | +| **Step Files** | ~5 files: step-01-discovery, step-02-assessment, step-03-strategy, step-04-shopping, step-05-prep | +| **Output** | Direct-to-final document, each step appends a section | +| **Intent/Prescriptive** | Intent-based - Facilitates discovery of preferences | +| **Planning** | No - builds final meal plan directly | +| **Continuable** | Yes - Can be 200+ tokens, users may need multiple sessions | +| **Structure** | Linear, 5 steps, no branching | +| **Conversation** | Open-ended with progressive questioning (1-2 at a time, probe preferences) | + +**Description:** Helps users create personalized weekly meal plans based on dietary restrictions, health goals, and cooking habits. + +--- + +## Example 2: Year-End Tax Organizer + +**Domain:** Finance + +| Aspect | Details | +|--------|---------| +| **Flow** (each → = step file) | Input Discovery → Document Categorization → Missing Document Alert → Final Summary | +| **Step Files** | 4 files: step-01-input-discovery, step-02-categorize, step-03-missing-alerts, step-04-summary | +| **Output** | Analysis-only + checklist of missing docs | +| **Intent/Prescriptive** | Highly Prescriptive - Tax compliance, exact categories | +| **Planning** | N/A | +| **Continuable** | No - Simple single-session checklist | +| **Structure** | Linear, 4 steps | +| **Conversation** | Focused - specific questions, document what user provides | + +**Description:** Organizes financial documents for tax preparation, categorizes income/deductions, alerts to missing documents. + +--- + +## Example 3: Employee Termination Checklist + +**Domain:** Legal / HR / Compliance + +| Aspect | Details | +|--------|---------| +| **Flow** (each → = step file) | Context → Regulatory Check → Document Requirements → Notification Timeline → Final Checklist | +| **Step Files** | 5 files: step-01-context, step-02-regulatory, step-03-documents, step-04-timeline, step-05-checklist. Some steps branch internally based on reason/location. | +| **Output** | Direct-to-final compliance checklist | +| **Intent/Prescriptive** | Highly Prescriptive - Legal compliance, state-specific | +| **Planning** | No | +| **Continuable** | No - Focused, single-session | +| **Structure** | Branching - Different paths within steps based on: reason, location, employee count | +| **Conversation** | Focused - specific classification questions, present requirements | + +**Description:** Generates legally-compliant termination checklists that vary by state, termination reason, and employee count. + +--- + +## Example 4: Tabletop RPG Campaign Builder + +**Domain:** Entertainment / Games + +| Aspect | Details | +|--------|---------| +| **Flow** (each → = step file) | Session Concept → NPC Creation → Scene Setup → Key Beats → Generate → [Repeat for next session] | +| **Step Files** | 4 core files: step-01-concept, step-02-npc, step-03-scene, step-04-beats, step-05-generate. Same files reused each session. | +| **Output** | Per-session document, maintains campaign continuity | +| **Intent/Prescriptive** | Intent-based - Creative facilitation | +| **Planning** | No - Each session builds directly to playable content | +| **Continuable** | Yes - Campaign has many sessions over months | +| **Structure** | Repeating loop - Same steps, new content each session | +| **Conversation** | Open-ended creative facilitation, "What if..." prompts | + +**Description:** Helps Game Masters create individual RPG session content while tracking campaign continuity across multiple sessions. + +--- + +## Example 5: Course Syllabus Creator + +**Domain:** Education + +| Aspect | Details | +|--------|---------| +| **Flow** | Course Type → Learning Objectives → Module Breakdown → Assessment → [Branch: academic] → Accreditation → [Branch: vocational] → Certification → Final | +| **Output** | Direct-to-final syllabus document | +| **Intent/Prescriptive** | Balanced - Framework prescriptive, content flexible | +| **Planning** | No | +| **Continuable** | Yes - Complex syllabus may require multiple sessions | +| **Structure** | Branching - Course type determines different sections | +| **Conversation** | Mixed - Framework questions (prescriptive) + content discovery (intent) | + +**Description:** Creates course syllabi that adapt based on course type (academic, vocational, self-paced) with appropriate accreditation requirements. + +--- + +## Example 6: SOP Writer + +**Domain:** Business Process + +| Aspect | Details | +|--------|---------| +| **Flow** | Process Selection → Scope Definition → Documentation → Review → [Generate] → "Create another?" → If yes, repeat | +| **Output** | Each SOP is independent, stored in `{sop_folder}/` | +| **Intent/Prescriptive** | Prescriptive - SOPs must be exact, unambiguous | +| **Planning** | No - Each SOP generated directly | +| **Continuable** | No - Single SOP per run, but workflow is repeatable | +| **Structure** | Repeating - Can create multiple SOPs in one session | +| **Conversation** | Focused on process details - "Walk me through step 1" | + +**Description:** Generates Standard Operating Procedure documents for business processes. Can create multiple SOPs in one session, each stored independently. + +--- + +## Example 7: Novel Outliner + +**Domain:** Creative Writing + +| Aspect | Details | +|--------|---------| +| **Flow** | Structure Selection → Character Arcs → Beat Breakdown → Pacing Review → Final Polish | +| **Output** | Free-form with Final Polish step to ensure flow and coherence | +| **Intent/Prescriptive** | Intent-based - "What does your character want?" | +| **Planning** | No - Builds outline directly | +| **Continuable** | Yes - Long-form creative work, sessions span weeks | +| **Structure** | Branching - Different flows based on structure choice | +| **Conversation** | Open-ended creative coaching, provocations | + +**Description:** Helps authors create novel outlines with proper story structure (3-Act, Hero's Journey, etc.), character arcs, and beat sheets. + +--- + +## Example 8: Wedding Itinerary Coordinator + +**Domain:** Event Planning + +| Aspect | Details | +|--------|---------| +| **Flow** | Venue Type → Vendor Coordination → Timeline → Guest Experience → [Branch: hybrid] → Virtual Setup → Day-of Schedule | +| **Output** | Direct-to-final itinerary | +| **Intent/Prescriptive** | Intent-based - Facilitates couple's vision | +| **Planning** | No | +| **Continuable** | Yes - Wedding planning takes months | +| **Structure** | Branching - Venue type affects required sections | +| **Conversation** | Open-ended discovery of preferences, budget, constraints | + +**Description:** Creates detailed wedding day itineraries, adapting to venue type (indoor/outdoor/hybrid) and guest experience goals. + +--- + +## Example 9: Annual Life Review + +**Domain:** Personal Development + +| Aspect | Details | +|--------|---------| +| **Flow** | Input Discovery (last year's goals) → Life Areas Assessment → Reflections → Goal Setting → Action Planning → Final Polish | +| **Output** | Free-form with Final Polish, discovers prior review first | +| **Intent/Prescriptive** | Intent-based - Coaching questions | +| **Planning** | No - Direct to life plan document | +| **Continuable** | Yes - Deep reflection may need multiple sessions | +| **Structure** | Linear with Input Discovery at start | +| **Conversation** | Open-ended coaching, progressive questioning | + +**Description:** Annual review workflow that discovers prior year's goals, facilitates reflection across life areas, and sets intentional goals for coming year. + +--- + +## Example 10: Room Renovation Planner + +**Domain:** Home Improvement + +| Aspect | Details | +|--------|---------| +| **Flow** | Room Type → Budget Assessment → Phase Planning → Materials → Contractor Timeline → [Branch: DIY] → Instructions | +| **Output** | Direct-to-final renovation plan | +| **Intent/Prescriptive** | Balanced - Code compliance prescriptive, design intent-based | +| **Planning** | No | +| **Continuable** | Yes - Complex planning, multi-session | +| **Structure** | Branching - Room type and DIY vs pro affect content | +| **Conversation** | Mixed - "What's your budget?" + "Describe your vision" | + +**Description:** Creates room-specific renovation plans with material selection, contractor coordination, and optional DIY instructions. + +--- + +## Pattern Analysis + +### Structure Types + +| Type | Count | Examples | +|------|-------|----------| +| Linear | 5 | Meal Plan, Tax, Termination, Life Review, Renovation | +| Branching | 5 | Termination, Syllabus, Novel, Wedding, Renovation | +| Repeating Loop | 2 | RPG Campaign, SOP Writer | + +### Intent Spectrum + +| Type | Count | Examples | +|------|-------|----------| +| Intent-based | 7 | Meal Plan, RPG Campaign, Syllabus (partial), Novel, Wedding, Life Review, Renovation (partial) | +| Prescriptive | 1 | Tax, Termination, SOP | +| Balanced | 2 | Syllabus, Renovation | + +### Continuable vs Single-Session + +| Type | Count | Examples | +|------|-------|----------| +| Continuable | 7 | Meal Plan, RPG Campaign, Syllabus, Novel, Wedding, Life Review, Renovation | +| Single-Session | 3 | Tax, Termination, SOP (repeatable but single-output) | + +### Output Patterns + +| Type | Count | Examples | +|------|-------|----------| +| Direct-to-Final | 9 | All except Tax | +| Analysis Only | 1 | Tax | +| With Final Polish | 1 | Novel | +| Input Discovery | 1 | Life Review | +| Repeating Output | 2 | RPG Campaign (sessions), SOP Writer (multiple SOPs) | + +--- + +## Key Insights + +1. **Continuable workflows are the norm** - 7 of 10 examples are continuable +2. **Intent-based dominates** - 7 of 10 are primarily intent-based facilitation +3. **Branching is common** - 5 of 10 have conditional paths based on user choices +4. **Input discovery matters** - Workflows in sequences (like BMM pipeline) need to find prior documents +5. **Final polish is critical** - Complex documents built section-by-section need optimization step +6. **Repeating loops exist** - Some workflows generate multiple outputs per session or repeat across sessions +7. **Mixed conversation styles** - Most use focused questions for data, open-ended for creative + +--- + +## Workflow Design Questions + +When creating a new workflow, ask: + +1. **Domain:** What problem space does this operate in? +2. **Output:** What does this workflow produce? (Document, checklist, analysis, physical output?) +3. **Intent:** Is this prescriptive (compliance) or intent-based (creative)? +4. **Planning:** Plan-then-build or direct-to-final? +5. **Continuable:** Could this take multiple sessions or consume many tokens? +6. **Structure:** Linear, branching, or repeating loop? +7. **Inputs:** Does this require documents from prior workflows or external sources? +8. **Chaining:** Is this part of a module sequence? What comes before/after? +9. **Polish:** Does the final output need optimization for flow and coherence? +10. **Conversation:** Focused questions or open-ended facilitation? diff --git a/src/modules/bmb/workflows/workflow/data/workflow-type-criteria.md b/src/modules/bmb/workflows/workflow/data/workflow-type-criteria.md new file mode 100644 index 00000000..6d823471 --- /dev/null +++ b/src/modules/bmb/workflows/workflow/data/workflow-type-criteria.md @@ -0,0 +1,172 @@ +# Workflow Type Criteria + +**Purpose:** Key decisions when designing a workflow. + +--- + +## Key Decisions + +1. **Module affiliation** - Standalone or part of a module? +2. **Continuable** - Can it span multiple sessions? +3. **Edit/Validate support** - Will it have edit and validate flows? +4. **Document output** - Does it produce a document? + +--- + +## 1. Module Affiliation + +### Standalone Workflow +- NOT part of any module +- Stored in user's custom location +- Only standard variables available + +### Module-Based Workflow +- Part of a specific module (e.g., BMB) +- Has access to module-specific variables +- Stored in module's workflows directory + +**BMB additional variable:** `{bmb_creations_output_folder}` + +--- + +## 2. Continuable or Single-Session? + +### Continuable (Multi-Session) +**Use when:** Workflow might consume MASSIVE tokens, complex, many steps + +**Required:** +- `step-01-init.md` with continuation detection +- `step-01b-continue.md` for resuming +- `stepsCompleted` tracking in output frontmatter + +**Frontmatter:** +```yaml +stepsCompleted: ['step-01-init', 'step-02-gather'] +lastStep: 'step-02-gather' +lastContinued: '2025-01-02' +``` + +**Rule:** Each step appends its NAME to `stepsCompleted` + +### Single-Session +**Use when:** Simple, quick (<15 min), token-efficient + +**Required:** +- Standard `step-01-init.md` (no continuation logic) +- No `stepsCompleted` tracking needed + +--- + +## 3. Edit/Validate Support + +### Create-Only +``` +workflow-folder/ +├── workflow.md +├── data/ +└── steps-c/ + ├── step-01-init.md + └── step-N-final.md +``` + +**Use when:** Simple workflows, experimental, one-off + +### Create + Edit + Validate (Tri-Modal) +``` +workflow-folder/ +├── workflow.md +├── data/ # SHARED +├── steps-c/ # Create +├── steps-e/ # Edit +└── steps-v/ # Validate +``` + +**Key:** +- Each mode is SELF-CONTAINED +- NO shared step files between modes +- DATA folder is SHARED (prevents drift) +- Duplicative steps OK (better than confusion) + +**Use when:** Complex workflows that will be maintained + +--- + +## 4. Document Output + +### Document-Producing +- Creates persistent output file +- Uses templates for structure +- Each step contributes to document +- Consider final polish step + +### Non-Document +- Performs actions without persistent output +- May produce temporary files +- Focus on execution, not creation + +--- + +## Decision Tree + +``` +START: Creating a workflow +│ +├─ Part of a module? +│ ├─ YES → Module-based (include module variables) +│ └─ NO → Standalone (standard variables only) +│ +├─ Could this take multiple sessions / lots of tokens? +│ ├─ YES → Continuable (add step-01b-continue.md) +│ └─ NO → Single-session (simpler init) +│ +└─ Will users need to edit/validate this workflow? + ├─ YES → Tri-modal (steps-c/, steps-e/, steps-v/) + └─ NO → Create-only (steps-c/ only) +``` + +--- + +## Questions to Ask User + +**Module:** +"Is this workflow standalone or part of a specific module (BMB, BMM, CIS, BMGD)?" + +**Continuable:** +"Could this workflow consume many tokens or require multiple sessions? +- If YES: Add continuation support +- If NO: Keep it simple for single-session" + +**Edit/Validate:** +"Will this workflow need edit and validate capabilities, or just create? +- Create only: Simpler, faster +- Create + Edit + Validate: More robust, maintainable" + +**Document:** +"Does this workflow produce a document/output file?" +- If YES: Use free-form template (recommended) +- If NO: What does it produce? + +--- + +## Output Format Decision + +| Workflow Type | Init Template | Output Format | +| ----------------------- | ------------------------ | ------------- | +| Continuable + Document | step-01-init-continuable | Free-form | +| Single-Session + Document| Standard init | Free-form | +| Continuable + No Doc | step-01-init-continuable | N/A | +| Single-Session + No Doc | Standard init | N/A | + +**Free-form template** (recommended): +```yaml +--- +stepsCompleted: [] +lastStep: '' +date: '' +user_name: '' +--- + +# {{document_title}} + +[Content appended progressively] +``` diff --git a/src/modules/bmb/workflows/workflow/steps-c/step-00-conversion.md b/src/modules/bmb/workflows/workflow/steps-c/step-00-conversion.md new file mode 100644 index 00000000..a9e2e001 --- /dev/null +++ b/src/modules/bmb/workflows/workflow/steps-c/step-00-conversion.md @@ -0,0 +1,262 @@ +--- +name: 'step-00-conversion' +description: 'Convert existing workflow to BMAD compliant format by reading all instructions and extracting plan' + +nextStepFile: './step-02-classification.md' +workflowPlanFile: '{bmb_creations_output_folder}/workflows/{new_workflow_name}/workflow-plan-{new_workflow_name}.md' +--- + +# Step 0: Workflow Conversion + +## STEP GOAL: + +Convert an existing workflow (any format) to BMAD compliant format by fully reading and understanding every instruction, extracting the essence, and creating a plan document. + +## MANDATORY EXECUTION RULES (READ FIRST): + +### Universal Rules: + +- 🛑 NEVER skip reading the entire source workflow +- 📖 CRITICAL: Read the complete step file before taking any action +- 📋 YOU ARE A FACILITATOR, not an autonomous converter +- ✅ YOU MUST ALWAYS SPEAK OUTPUT In your Agent communication style with the config `{communication_language}` + +### Role Reinforcement: + +- ✅ You are a workflow analyst and conversion specialist +- ✅ If you already have been given communication or persona patterns, continue to use those while playing this new role +- ✅ We engage in collaborative dialogue, not command-response +- ✅ You bring workflow architecture expertise, user brings their existing workflow +- ✅ Together we will extract the essence and rebuild compliantly + +### Step-Specific Rules: + +- 🎯 Focus on understanding the COMPLETE existing workflow +- 🚫 FORBIDDEN to skip any instruction or file +- 💬 Read EVERYTHING - instructions.md, workflow.yaml, step files, templates +- 📋 Document the essence succinctly + +## EXECUTION PROTOCOLS: + +- 🎯 Load and read the ENTIRE source workflow +- 💾 Extract: goal, steps, output, input requirements +- 📖 Create plan with conversionFrom metadata +- 🚫 FORBIDDEN to proceed without complete understanding + +## CONTEXT BOUNDARIES: + +- User provides existing workflow path (from routing or direct) +- This REPLACES step-01-discovery - we skip to step-02-classification +- The source workflow can be ANY format (legacy XML, partial, other systems) + +## MANDATORY SEQUENCE + +**CRITICAL:** Follow this sequence exactly. Do not skip, reorder, or improvise. + +### 1. Get Source Workflow Path + +**If path was passed from routing (e.g., from edit workflow):** +- Use `{sourceWorkflowPath}` provided + +**If no path was passed:** + +"I can help you convert an existing workflow to BMAD compliant format. + +**Please provide the path to the workflow you want to convert:** + +This could be: +- A folder containing workflow.md +- A folder with workflow.yaml (legacy format) +- A folder with instructions.md +- Any workflow from another system + +**Path:** {user provides path}" + +### 2. Load EVERYTHING - DO NOT BE LAZY + +"**Loading source workflow for complete analysis...** + +**CRITICAL:** I will read EVERY file in this workflow to understand it completely." + +**Load these files based on what exists:** + +**If workflow.md exists:** +- Load workflow.md completely +- Load all step files (steps/*, steps-c/*, steps-v/*, steps-e/*) +- Load all data files (data/*) +- Load all templates (templates/*) + +**If workflow.yaml exists (legacy XML format):** +- Load workflow.yaml completely +- Load instructions.md completely +- Load all step files, templates, data + +**If other format:** +- Load every file that exists +- Read everything to understand the structure + +**⚠️ DO NOT BE LAZY - Load and READ COMPLETELY:** + +For each step file, read: +- The STEP GOAL +- All MANDATORY EXECUTION RULES +- All instructions in EXECUTION PROTOCOLS +- All menu options +- All templates and outputs + +"**✅ Source workflow loaded completely** + +**Files read:** {count} files +**Format detected:** {format} +**Structure identified:** {brief description}" + +### 3. Extract and Document Workflow Essence + +Create the workflow plan with complete extraction: + +"**Extracting workflow essence...**" + +Create `{workflowPlanFile}`: + +```markdown +--- +conversionFrom: '{sourceWorkflowPath}' +originalFormat: '{detected format}' +stepsCompleted: ['step-00-conversion'] +created: {current date} +status: CONVERSION +--- + +# Workflow Creation Plan + +## Conversion Source + +**Original Path:** {sourceWorkflowPath} +**Original Format:** {workflow.yaml / workflow.md / custom / etc.} +**Detected Structure:** {describe what was found} + +--- + +## Original Workflow Analysis + +### Goal (from source) + +{Extract the exact goal from the source workflow} + +### Original Steps (Complete List) + +{Create succinct bullet list of EVERY step from the source:} + +**Step 1:** {Step name} - {Brief purpose} +**Step 2:** {Step name} - {Brief purpose} +**Step 3:** {Step name} - {Brief purpose} +... +**Step N:** {Step name} - {Brief purpose} + +### Output / Deliverable + +{What does this workflow produce?} + +### Input Requirements + +{What inputs does this workflow need from the user?} + +### Key Instructions to LLM + +{Extract the key instruction patterns - how does the workflow talk to the LLM? +What style? What level of detail? What collaborative approach?} + +--- + +## Conversion Notes + +**What works well in original:** +{List strengths to preserve} + +**What needs improvement:** +{List issues to address} + +**Compliance gaps identified:** +{List what's missing for BMAD compliance} +``` + +### 4. Present Extracted Information to User + +"**I've analyzed your existing workflow completely. Here's what I found:** + +--- + +**Workflow Goal:** +{goal from analysis} + +**Steps ({count}):** +{Display succinct bullet list} + +**Output:** +{what it produces} + +**Input Requirements:** +{what it needs from user} + +--- + +**Format:** {originalFormat} +**Compliance Status:** {compliant / non-compliant / partial} + +**Key observations:** +{Share 2-3 key insights about the workflow}" + +### 5. Discovery Questions for Conversion + +Even though this is a conversion, we need to understand some things: + +"**A few questions to ensure the conversion captures your intent:** + +1. **What's working well** in this workflow that we should definitely preserve? + +2. **What problems** have you encountered with this workflow that we should fix? + +3. **Any missing features** or improvements you'd like to add during conversion? + +4. **Who will use** the converted workflow - same audience or different?" + +### 6. Confirm and Proceed to Classification + +"**Based on my analysis and your answers, I'm ready to proceed with classification.** + +**Next step:** We'll classify the workflow type (document, action, interactive, autonomous, meta), determine structure (continuable or single-session), and decide if it needs validation steps. + +**Ready to proceed?** [C] Continue to Classification" + +#### Menu Handling Logic: + +- IF C: Update workflowPlanFile with conversion notes, then load, read entirely, then execute {nextStepFile} +- IF Any other: help user respond, then redisplay menu + +## CRITICAL STEP COMPLETION NOTE + +ONLY WHEN the entire source workflow has been read and analyzed, and the plan document contains the complete extraction (goal, steps, output, inputs) and conversionFrom metadata, will you then load and read fully `{nextStepFile}` to execute classification. + +--- + +## 🚨 SYSTEM SUCCESS/FAILURE METRICS + +### ✅ SUCCESS: + +- ENTIRE source workflow loaded and read +- Every step documented in plan +- Goal, output, inputs extracted +- conversionFrom metadata set +- User confirms understanding +- Proceeding to classification + +### ❌ SYSTEM FAILURE: + +- Not loading all files in source workflow +- Skipping step files +- Not reading instructions completely +- Missing steps in documentation +- Not setting conversionFrom metadata +- Proceeding without complete understanding + +**Master Rule:** DO NOT BE LAZY. Read EVERYTHING. Document the COMPLETE workflow essence. The conversion must capture ALL of the original workflow's intent and functionality. diff --git a/src/modules/bmb/workflows/workflow/steps-c/step-01-discovery.md b/src/modules/bmb/workflows/workflow/steps-c/step-01-discovery.md new file mode 100644 index 00000000..a2e35772 --- /dev/null +++ b/src/modules/bmb/workflows/workflow/steps-c/step-01-discovery.md @@ -0,0 +1,194 @@ +--- +name: 'step-01-discovery' +description: 'Discover and understand the user workflow idea through collaborative conversation' + +nextStepFile: './step-02-classification.md' +workflowExamples: '../data/workflow-examples.md' +workflowPlanFile: '{bmb_creations_output_folder}/workflows/{new_workflow_name}/workflow-plan-{new_workflow_name}.md' +--- + +# Step 1: Discovery + +## STEP GOAL: + +To understand the user's workflow idea through open-ended conversation, showing them what's possible, and discovering their vision before making any structural decisions. + +## MANDATORY EXECUTION RULES (READ FIRST): + +### Universal Rules: + +- 🛑 NEVER generate content without user input +- 📖 CRITICAL: Read the complete step file before taking any action +- 🔄 CRITICAL: When loading next step with 'C', ensure entire file is read +- 📋 YOU ARE A FACILITATOR, not a content generator +- ✅ YOU MUST ALWAYS SPEAK OUTPUT In your Agent communication style with the config `{communication_language}` + +### Role Reinforcement: + +- ✅ You are a workflow architect and systems designer +- ✅ If you already have been given communication or persona patterns, continue to use those while playing this new role +- ✅ We engage in collaborative dialogue, not command-response +- ✅ You bring workflow design expertise, user brings their vision +- ✅ Together we will discover what they need + +### Step-Specific Rules: + +- 🎯 Focus ONLY on understanding their idea +- 🚫 FORBIDDEN to ask for name, module, or technical decisions in this step +- 💬 Ask 1-2 questions at a time, think about their response before probing deeper +- 🚪 DON'T rush to classification - understand first + +## EXECUTION PROTOCOLS: + +- 🎯 Load examples FIRST to show what's possible +- 💬 Start with open-ended "Tell me about your idea..." +- 📖 Update frontmatter stepsCompleted when complete +- 🚫 FORBIDDEN to load next step until we understand their vision + +## CONTEXT BOUNDARIES: + +- Variables from workflow.md are available in memory +- This is pure discovery - no decisions yet +- Don't ask technical questions yet +- Focus on the problem space and user's vision + +## MANDATORY SEQUENCE + +**CRITICAL:** Follow this sequence exactly. Do not skip, reorder, or improvise unless user explicitly requests a change. + +### 1. Load Context FIRST + +Load `{workflowExamples}` BEFORE talking to the user. + +**Note:** You already understand workflow architecture from having read workflow.md to get here. The step-file architecture you just experienced (micro-file design, JIT loading, sequential enforcement, state tracking) is exactly what we'll be helping users create. + +**From workflowExamples**, you now know 10 diverse workflow examples across domains: +- Health & Fitness (Meal Plan) +- Finance (Tax Organizer) +- Legal/HR (Termination Checklist) +- Entertainment (RPG Campaign) +- Education (Syllabus Creator) +- Business (SOP Writer) +- Creative (Novel Outliner) +- Events (Wedding Itinerary) +- Personal Development (Life Review) +- Home Improvement (Renovation Planner) + +This context helps you understand whatever the user describes and guide them effectively. + +### 2. Open-Ended Invitation + +Start with: + +"**Welcome! I'm here to help you create a workflow.** + +Let me start by sharing what's possible: Workflows can help with everything from meal planning to tax preparation, from creative writing to project management. They're structured processes that guide you (or others) through a task step-by-step. + +**Tell me about your idea** - what problem are you trying to solve? What's the vision?" + +### 3. Listen and Probe + +As they describe their idea: + +**DO:** +- Listen carefully +- Ask 1-2 follow-up questions at a time +- Think about their response before asking more +- Probe for: Who is this for? What's the outcome? What's the challenge they're facing? +- Use "Think about their response before..." pattern + +**DON'T:** +- Ask about module, name, or technical details +- Rapid-fire questions +- Jump to solutions +- Rush this step + +### 4. Deepen Understanding + +Once you have the basic idea, probe deeper: + +"That's really interesting. Let me understand better: + +- Walk me through a scenario where someone would use this workflow +- What does success look like at the end? +- Who would be running this workflow - you, your team, customers? +- Is this something you'd do once, or repeat over time? + +**Think about their response before continuing...**" + +### 5. Check Understanding + +Before moving on, confirm you understand: + +"Let me make sure I've got this right: + +[Summarize your understanding in 2-3 sentences] + +Did I capture that correctly? What should I adjust?" + +### 6. Create Initial Plan Document + +Create `{workflowPlanFile}` with initial discovery notes: + +```markdown +--- +stepsCompleted: ['step-01-discovery'] +created: [current date] +status: DISCOVERY +--- + +# Workflow Creation Plan + +## Discovery Notes + +**User's Vision:** +[Summarize the problem they're solving and their vision] + +**Who It's For:** +[Users/audience] + +**What It Produces:** +[The outcome/deliverable] + +**Key Insights:** +[Any important context gathered] +``` + +### 7. Transition to Classification + +"Great! I understand what you're trying to build. Now let's figure out the technical details - what type of workflow this is, how it should be structured, and where it will live." + +### 8. Present MENU OPTIONS + +Display: **Proceeding to workflow classification...** + +#### EXECUTION RULES: + +- This is a discovery step with no user choices at the end +- Proceed directly to next step after discovery is complete +- Always halt if user wants to continue discussing their idea + +#### Menu Handling Logic: + +- After discovery complete and plan document created, immediately load and execute `{nextStepFile}` to begin classification +- IF user wants to keep discussing their idea: continue conversation, then repeat menu check + +--- + +## 🚨 SYSTEM SUCCESS/FAILURE METRICS + +### ✅ SUCCESS: + +- User's vision clearly understood +- Discovery notes captured in plan document +- User feels heard and understood +- Ready to proceed to classification + +### ❌ SYSTEM FAILURE: + +- Rushing to technical decisions before understanding +- Asking for name/module in this step +- Not loading examples first +- Rapid-fire questions without thinking about responses + +**Master Rule:** Understand first, classify second. Discovery comes before structure. diff --git a/src/modules/bmb/workflows/workflow/steps-c/step-01b-continuation.md b/src/modules/bmb/workflows/workflow/steps-c/step-01b-continuation.md new file mode 100644 index 00000000..f3280dbd --- /dev/null +++ b/src/modules/bmb/workflows/workflow/steps-c/step-01b-continuation.md @@ -0,0 +1,3 @@ +# TODO - THIS IS A PLACE HOLDER NOT IMPLEMENTED YET IN THIS FLOW + +YOU CAN CALL OUT AS A WARNING IN ANY VALIDATION CHECKS of this specific workflow - but this is a known pending todo to implement. diff --git a/src/modules/bmb/workflows/workflow/steps-c/step-02-classification.md b/src/modules/bmb/workflows/workflow/steps-c/step-02-classification.md new file mode 100644 index 00000000..131afbb5 --- /dev/null +++ b/src/modules/bmb/workflows/workflow/steps-c/step-02-classification.md @@ -0,0 +1,269 @@ +--- +name: 'step-02-classification' +description: 'Classify the workflow by answering the 4 key structural decisions' + +nextStepFile: './step-03-requirements.md' +workflowTypeCriteria: '../data/workflow-type-criteria.md' +workflowPlanFile: '{bmb_creations_output_folder}/workflows/{new_workflow_name}/workflow-plan-{new_workflow_name}.md' +bmbCreationsOutputFolder: '{bmb_creations_output_folder}' +customWorkflowLocation: '{custom_workflow_location}' +--- + +# Step 2: Workflow Classification + +## STEP GOAL: + +To determine the 4 key structural decisions that define how the workflow will be built: module affiliation, continuable vs single-session, tri-modal vs create-only, and document output. + +## MANDATORY EXECUTION RULES (READ FIRST): + +### Universal Rules: + +- 🛑 NEVER generate content without user input +- 📖 CRITICAL: Read the complete step file before taking any action +- 🔄 CRITICAL: When loading next step with 'C', ensure entire file is read +- 📋 YOU ARE A FACILITATOR, not a content generator +- ✅ YOU MUST ALWAYS SPEAK OUTPUT In your Agent communication style with the config `{communication_language}` + +### Role Reinforcement: + +- ✅ You are a workflow architect helping classify their workflow +- ✅ Explain the trade-offs of each decision clearly +- ✅ Help them make informed choices +- ✅ These 4 decisions affect the entire workflow structure + +### Step-Specific Rules: + +- 🎯 Focus ONLY on the 4 key structural decisions +- 🚫 FORBIDDEN to skip any of the 4 decisions +- 💬 Explain each decision in plain language before asking +- 🚪 These decisions determine file structure, naming, and location + +## EXECUTION PROTOCOLS: + +- 🎯 Load workflowTypeCriteria for the decision framework +- 💾 Document each decision in the plan +- 📖 Update frontmatter stepsCompleted when complete +- 🚫 FORBIDDEN to load next step until all 4 decisions are made + +## CONTEXT BOUNDARIES: + +- Discovery from Step 1 informs these decisions +- These are STRUCTURAL decisions that affect everything else +- Once made, changing them is difficult +- Take time to explain trade-offs + +## MANDATORY SEQUENCE + +**CRITICAL:** Follow this sequence exactly. Do not skip, reorder, or improvise unless user explicitly requests a change. + +### 0. Load Decision Framework + +Load `{workflowTypeCriteria}` to understand the 4 key decisions and their implications. + +### 1. Decision 1: Document Output (FIRST - It's Fundamental) + +"**Let's classify your workflow. I'll walk you through 4 key decisions that determine how it's built.** + +**Decision 1: What does your workflow produce?** + +Based on your idea from discovery, let me clarify:" + +- [If unclear from discovery] "Does this workflow produce a document or file at the end? A report, a plan, a story, a checklist?" + +Present the two options: + +**A. Document-Producing** +- Creates a persistent output file +- Examples: reports, plans, stories, checklists, forms +- Uses templates for structure + +**B. Non-Document** +- Performs actions without creating a document +- Examples: refactoring code, running tests, orchestrating tools +- May produce temporary files but no persistent output + +"Which describes your workflow?" + +**Think about their response before continuing...** + +Once decided: +- Document: `workflowProducesDocuments: true` +- Non-document: `workflowProducesDocuments: false` + +### 2. Decision 2: Module Affiliation + +"**Decision 2: Where will this workflow live?** + +Workflows can be standalone or part of a module:" + +**Standalone:** +- NOT part of any module +- Stored in your custom location +- Only standard variables available + +**Module-Based (BMB, BMM, CIS, BMGD, etc.):** +- Part of a specific module +- Has access to module-specific variables +- Stored in that module's workflows directory + +"Is this workflow: +- **A)** Standalone - just for you/custom use +- **B)** Part of a module - which one?" + +**If they don't know modules:** +"Modules are specialized areas: +- **BMB** - Module building workflows +- **BMM** - Software development workflows (PRDs, architecture, etc.) +- **CIS** - Innovation and creative workflows +- **BMGD** - Game development workflows +- **Custom** - Your own workflows + +Does your workflow fit into one of these areas, or is it standalone?" + +Document the result. + +### 3. Decision 3: Continuable or Single-Session + +"**Decision 3: Could this workflow take multiple sessions to complete?** + +Think about: Will this workflow consume many tokens or take a long time? Might users need to pause and come back later?" + +**Single-Session:** +- Quick, focused workflows (15-30 minutes) +- Simpler structure +- No continuation logic needed + +**Continuable:** +- Can span multiple sessions +- Complex, many steps +- Saves progress, can resume later +- Needs `step-01b-continue.md` + +"Is your workflow: +- **A)** Single-session - quick and focused +- **B)** Continuable - could take multiple sessions" + +**Help them think:** +- "Walk me through how long you think this would take..." +- "What happens if someone gets halfway through and has to stop?" + +Document the result. + +### 4. Decision 4: Create-Only or Tri-Modal + +"**Decision 4: Will this workflow need Edit and Validate capabilities?** + +Some workflows are simple - you create them once and use them. Others need full lifecycle support:** + +**Create-Only:** +- Just `steps-c/` (create steps) +- Simpler, faster to build +- Good for: experimental workflows, one-off use, simple tools + +**Tri-Modal (Create + Edit + Validate):** +- Has `steps-c/`, `steps-e/` (edit), and `steps-v/` (validate) +- Full lifecycle support +- Can be modified and validated after creation +- Good for: complex workflows, maintained workflows, team use + +"Do you envision: +- **A)** Create-only - build it and use it +- **B)** Tri-modal - create, edit, AND validate capabilities" + +**If they're unsure:** +"Think: Will you or others want to modify this workflow later? Does it need quality checking/validation?" + +Document the result. + +### 5. Name the Workflow + +"Now that we understand what this workflow IS, let's name it properly. + +Based on everything we've discovered, what would you call this? + +Some guidance: +- Use kebab-case: `my-workflow-name` +- Be descriptive but concise +- Think: What would someone search for to find this? + +[Offer suggestions based on their vision]" + +**Check for uniqueness:** +- Look for folder at `{bmb_creationsOutputFolder}/workflows/{proposed-name}/` +- If exists: "That name is taken. Want to try a variant like...?" +- Loop until unique name confirmed + +Document the final name. + +### 6. Confirm Target Location + +Based on module decision, confirm and document the target path: + +**For standalone/custom:** +- Target: `{customWorkflowLocation}/{workflow-name}/` +- Typically: `_bmad/custom/src/workflows/{workflow-name}/` + +**For modules:** +- Check module's workflow location from module.yaml +- Confirm path with user + +Document: `targetWorkflowPath: [confirmed path]` + +### 7. Update Plan with Classification + +Update `{workflowPlanFile}`: + +```markdown +## Classification Decisions + +**Workflow Name:** {name} +**Target Path:** {targetWorkflowPath} + +**4 Key Decisions:** +1. **Document Output:** {true/false} +2. **Module Affiliation:** {standalone/module-name} +3. **Session Type:** {single-session/continuable} +4. **Lifecycle Support:** {create-only/tri-modal} + +**Structure Implications:** +- [Document what this means: e.g., "Needs steps-c/, steps-e/, steps-v/", "Needs step-01b-continue.md", etc.] +``` + +### 8. Present MENU OPTIONS + +Display: **Select an Option:** [A] Advanced Elicitation [P] Party Mode [C] Continue + +#### EXECUTION RULES: + +- ALWAYS halt and wait for user input +- ONLY proceed to next step when user selects 'C' +- User can chat or ask questions - always respond and redisplay menu + +#### Menu Handling Logic: + +- IF A: Execute {project-root}/_bmad/core/workflows/advanced-elicitation/workflow.xml +- IF P: Execute {project-root}/_bmad/core/workflows/party-mode/workflow.md +- IF C: Update plan frontmatter with stepsCompleted and classification, then load `{nextStepFile}` +- IF Any other: Help user, then redisplay menu + +--- + +## 🚨 SYSTEM SUCCESS/FAILURE METRICS + +### ✅ SUCCESS: + +- All 4 key decisions made and documented +- Workflow named appropriately +- Target location confirmed +- Structural implications understood +- Plan updated with classification + +### ❌ SYSTEM FAILURE: + +- Skipping any of the 4 key decisions +- Naming before understanding (old pattern) +- Not explaining trade-offs +- Not checking for name conflicts + +**Master Rule:** The 4 key decisions determine everything else. Get them right before proceeding. diff --git a/src/modules/bmb/workflows/workflow/steps-c/step-03-requirements.md b/src/modules/bmb/workflows/workflow/steps-c/step-03-requirements.md new file mode 100644 index 00000000..32c26747 --- /dev/null +++ b/src/modules/bmb/workflows/workflow/steps-c/step-03-requirements.md @@ -0,0 +1,282 @@ +--- +name: 'step-03-requirements' +description: 'Gather detailed requirements through collaborative conversation' + +nextStepFile: './step-04-tools.md' +workflowExamples: '../data/workflow-examples.md' +outputFormatStandards: '../data/output-format-standards.md' +workflowPlanFile: '{bmb_creations_output_folder}/workflows/{new_workflow_name}/workflow-plan-{new_workflow_name}.md' +advancedElicitationTask: '{project-root}/_bmad/core/workflows/advanced-elicitation/workflow.xml' +partyModeWorkflow: '{project-root}/_bmad/core/workflows/party-mode/workflow.md' +--- + +# Step 3: Requirements Gathering + +## STEP GOAL: + +To gather comprehensive requirements through conversation, building on the classification decisions, and document them in a standardized format for the design phase. + +## MANDATORY EXECUTION RULES (READ FIRST): + +### Universal Rules: + +- 🛑 NEVER generate content without user input +- 📖 CRITICAL: Read the complete step file before taking any action +- 🔄 CRITICAL: When loading next step with 'C', ensure entire file is read +- 📋 YOU ARE A FACILITATOR, not a content generator +- ✅ YOU MUST ALWAYS SPEAK OUTPUT In your Agent communication style with the config `{communication_language}` + +### Role Reinforcement: + +- ✅ You are a workflow architect gathering requirements +- ✅ Build on what we discovered and classified +- ✅ Ask 1-2 questions at a time, think about responses +- ✅ We already know the 4 key decisions - now we get details + +### Step-Specific Rules: + +- 🎯 Focus ONLY on requirements gathering +- 🚫 FORBIDDEN to propose workflow designs yet +- 💬 Ask conversationally, not like a form +- 📋 Use the standardized template (below) for consistent storage + +## EXECUTION PROTOCOLS: + +- 🎯 Load references as needed +- 💾 Store to standardized template in plan document +- 📖 Update frontmatter stepsCompleted when complete +- 🚫 FORBIDDEN to load next step until requirements are complete + +## CONTEXT BOUNDARIES: + +- Discovery (Step 1) gave us the vision +- Classification (Step 2) gave us the 4 key decisions +- Now we gather detailed requirements +- Don't design workflow steps yet - that's Step 6 + +## MANDATORY SEQUENCE + +**CRITICAL:** Follow this sequence exactly. Do not skip, reorder, or improvise unless user explicitly requests a change. + +### 1. Initialize Requirements + +"**Let's gather the requirements for your workflow.** + +We already know: +- [Summarize vision from discovery] +- [Summarize 4 key decisions from classification] + +Now I need to understand the details of how this workflow should work." + +### 2. Workflow Flow and Structure + +Load `{workflowExamples}` to reference diverse patterns. + +"**How should this workflow flow?** + +From our examples, workflows can be structured differently:" + +**Flow Patterns:** +- **Linear:** Step 1 → Step 2 → Step 3 → Finish +- **Looping:** Generate → Review → Generate more... until done +- **Branching:** Different paths based on user choices +- **Repeating:** Same steps, new content each session + +"Think about your workflow: +- Should it go straight through, or loop/branch? +- How many logical phases does it need? +- What are the major milestones?" + +**Think about their response...** + +### 3. User Interaction Style + +"**How collaborative should this be?** + +Think about the person running this workflow:" + +- **Highly Collaborative:** AI asks questions, guides, facilitates at each step +- **Mostly Autonomous:** AI does the work with occasional checkpoints +- **Guided Session:** AI leads through a structured experience +- **Mixed:** Some steps collaborative, some autonomous + +"Where does your workflow fit on this spectrum? + +And are there specific decision points where the user MUST choose something?" + +### 4. Input Requirements + +"**What does this workflow need to start?**" + +- What documents or data must be provided? +- Are there prerequisites or dependencies? +- Will users need to provide specific information? +- Any optional inputs that enhance the workflow? + +"**Think about their response before continuing...**" + +### 5. Output Specifications (IF document-producing) + +**ONLY if `workflowProducesDocuments: true` from classification:** + +Load `{outputFormatStandards}` and discuss: + +"**What should the output look like?** + +Since your workflow produces a document, let's decide the format:" + +**Four Template Types:** + +1. **Free-form (Recommended)** - Minimal structure, content-driven + - Use for: Most collaborative workflows + - Has: Basic frontmatter, progressive content, final polish step + +2. **Structured** - Required sections, flexible within each + - Use for: Reports, proposals, documentation + - Has: Clear section headers, consistent structure + +3. **Semi-structured** - Core sections + optional additions + - Use for: Forms, checklists, meeting minutes + - Has: Required fields, optional extras + +4. **Strict** - Exact format, specific fields + - Use for: Compliance, legal, regulated (rare) + - Has: Precise requirements, validation + +"Which format fits your workflow best?" + +**If Free-form (most common):** +- "We'll use a minimal template with basic frontmatter. The workflow will build the document section by section, with a final polish step to optimize flow." + +**If Structured/Semi-structured:** +- "What sections are required? Any optional sections?" + +**If Strict:** +- "Do you have an existing template to follow, or should we design one?" + +Document the output format decision. + +### 6. Output Specifications (IF non-document) + +**ONLY if `workflowProducesDocuments: false` from classification:** + +"**What does this workflow produce if not a document?** + +- Actions performed? +- Changes made to code/files? +- A decision or recommendation? +- A temporary artifact?" + +Document what the workflow produces. + +### 7. Success Criteria + +"**How will we know this workflow succeeded?** + +Think about the end result: +- What does 'done' look like? +- What would make a user satisfied? +- Are there quality criteria? +- Can we measure success?" + +"**Think about their response...**" + +### 8. Instruction Style (NOW, Not Earlier) + +**We ask this NOW because we understand the workflow:** + +"**How should the AI executing this workflow behave?**" + +**Intent-Based (Recommended for most):** +- Steps describe goals and principles +- AI adapts conversation naturally +- More flexible and responsive +- Example: "Guide user to define requirements through open-ended discussion" + +**Prescriptive:** +- Steps provide exact instructions +- More controlled and predictable +- Example: "Ask: 'What is your primary goal? A) Growth B) Efficiency C) Quality'" + +**Mixed:** +- Some steps prescriptive, others intent-based +- Use prescriptive for critical/required steps +- Use intent-based for creative/facilitative steps + +"Which style fits your workflow, or should it be mixed?" + +### 9. Store to Standardized Template + +Update `{workflowPlanFile}` with the requirements section: + +```markdown +## Requirements + +**Flow Structure:** +- Pattern: [linear/looping/branching/repeating] +- Phases: [list major phases] +- Estimated steps: [rough count] + +**User Interaction:** +- Style: [highly collaborative/mostly autonomous/guided/mixed] +- Decision points: [where user must choose] +- Checkpoint frequency: [how often to pause] + +**Inputs Required:** +- Required: [list] +- Optional: [list] +- Prerequisites: [list] + +**Output Specifications:** +- Type: [document/action/decision/temporary] +- Format: [free-form/structured/semi-structured/strict OR describe non-document output] +- Sections: [if structured] +- Frequency: [single/batch/continuous] + +**Success Criteria:** +- [list what success looks like] + +**Instruction Style:** +- Overall: [intent-based/prescriptive/mixed] +- Notes: [any specific style requirements] +``` + +### 10. Present MENU OPTIONS + +Display: **Select an Option:** [A] Advanced Elicitation [P] Party Mode [C] Continue + +#### EXECUTION RULES: + +- ALWAYS halt and wait for user input +- ONLY proceed when user selects 'C' +- User can chat or ask questions - always respond and redisplay menu + +#### Menu Handling Logic: + +- IF A: Execute {advancedElicitationTask} +- IF P: Execute {partyModeWorkflow} +- IF C: Save requirements to plan, update frontmatter, then load `{nextStepFile}` +- IF Any other: Help user, then redisplay menu + +--- + +## 🚨 SYSTEM SUCCESS/FAILURE METRICS + +### ✅ SUCCESS: + +- Requirements gathered through conversation (not interrogation) +- Flow structure clearly understood +- Input/output specifications defined +- Output format decided (if document-producing) +- Success criteria established +- Instruction style determined +- All stored in standardized template + +### ❌ SYSTEM FAILURE: + +- Asking for instruction style before understanding the workflow +- Skipping output format discussion +- Not storing to standardized template +- Proceeding without understanding the flow + +**Master Rule:** Requirements build on classification. Use the standardized template so the next steps can read consistent data. diff --git a/src/modules/bmb/workflows/workflow/steps-c/step-04-tools.md b/src/modules/bmb/workflows/workflow/steps-c/step-04-tools.md new file mode 100644 index 00000000..2ffb3a20 --- /dev/null +++ b/src/modules/bmb/workflows/workflow/steps-c/step-04-tools.md @@ -0,0 +1,281 @@ +--- +name: 'step-04-tools' +description: 'Preview workflow structure, then configure tools with context' + +nextStepFile: './step-05-plan-review.md' +commonToolsCsv: '../data/common-workflow-tools.csv' +workflowPlanFile: '{bmb_creations_output_folder}/workflows/{new_workflow_name}/workflow-plan-{new_workflow_name}.md' +advancedElicitationTask: '{project-root}/_bmad/core/workflows/advanced-elicitation/workflow.xml' +partyModeWorkflow: '{project-root}/_bmad/core/workflows/party-mode/workflow.md' +--- + +# Step 4: Tools Configuration + +## STEP GOAL: + +To preview the workflow structure FIRST, then configure tools with clear context on where and how they'll be used. + +## MANDATORY EXECUTION RULES (READ FIRST): + +### Universal Rules: + +- 🛑 NEVER generate content without user input +- 📖 CRITICAL: Read the complete step file before taking any action +- 🔄 CRITICAL: When loading next step with 'C', ensure entire file is read +- 📋 YOU ARE A FACILITATOR, not a content generator +- ✅ YOU MUST ALWAYS SPEAK OUTPUT In your Agent communication style with the config `{communication_language}` + +### Role Reinforcement: + +- ✅ You are a workflow architect +- ✅ Tools need context to be configured intelligently +- ✅ We preview structure BEFORE deciding tool integration points + +### Step-Specific Rules: + +- 🎯 Preview workflow structure BEFORE configuring tools +- 🚫 FORBIDDEN to skip the preview - tools can't be configured without it +- 💬 Use the preview to make tool discussions concrete +- 🚫 Load tools from CSV, don't hardcode descriptions + +## EXECUTION PROTOCOLS: + +- 🎯 Present design preview based on requirements +- 💬 Discuss tools WITHIN the context of the preview +- 💾 Document tool decisions with integration points +- 📖 Update frontmatter stepsCompleted when complete +- 🚫 FORBIDDEN to load next step until tools are configured + +## CONTEXT BOUNDARIES: + +- Discovery → Classification → Requirements are complete +- We know the flow pattern, phases, interaction style +- NOW we can talk about tools with concrete examples +- This creates an intelligent tool configuration + +## MANDATORY SEQUENCE + +**CRITICAL:** Follow this sequence exactly. Do not skip, reorder, or improvise unless user explicitly requests a change. + +### 1. Present Design Preview + +"**Before we configure tools, let me preview what your workflow structure might look like.** + +Based on everything we've gathered, here's a rough outline:" + +Create a concrete preview showing: + +```markdown +## Workflow Structure Preview: {workflow-name} + +**Phase 1: Initialization** +- Welcome user, explain the workflow +- Gather any starting inputs +- [Specific to this workflow] + +**Phase 2: [Name from requirements]** +- [What happens in this phase] +- [User interaction point] + +**Phase 3: [Name from requirements]** +- [What happens in this phase] +- [User interaction point] + +**Phase 4: Completion** +- [What happens at the end] +- [Output/final step] +``` + +"This is just a preview - we'll design the actual steps in detail next. But this gives us context for discussing tools." + +**Ask:** "Does this structure feel right? Any major phases I'm missing?" + +### 2. Initialize Tools Discussion + +"**Now let's configure the tools and integrations for your workflow.** + +Since we can see the structure, we can talk about tools concretely: 'Party Mode could fit here in Phase 2 for creative brainstorming...' instead of abstractly." + +### 3. Load and Present Available Tools + +Load `{commonToolsCsv}` and present by category: + +"**Available BMAD Tools:** + +**Core Tools:** +- [List from CSV with descriptions] + +**Optional Tools:** +- [List from CSV with descriptions]" + +### 4. Configure Core Tools WITH Context + +Go through each core tool, referencing the preview: + +"**Party Mode** - For creative, unrestricted exploration + +Looking at your workflow structure, I see potential in: +- [Specific phase from preview] for [specific reason] + +Should we include Party Mode? If so, where would it fit best?" + +"**Advanced Elicitation** - For deep exploration and quality + +This could work well in: +- [Specific phase] for [specific reason] + +Should we include Advanced Elicitation? Where would you want quality gates or deeper exploration?" + +"**Brainstorming** - For idea generation + +In your workflow, this might fit in: +- [Specific phase if applicable] + +Should we include Brainstorming?" + +### 5. Configure LLM Features WITH Context + +"**LLM Features to enhance your workflow:**" + +"**Web-Browsing** - For real-time information + +Would your workflow benefit from: +- Current data/information +- Research during execution +- Live references + +If yes, where in the structure would this be needed?" + +"**File I/O** - For reading/writing files + +Your workflow [will/won't] need file operations based on: +- [Input requirements from requirements] +- [Output specifications from requirements] + +Any specific file operations needed?" + +"**Sub-Agents** - For delegating specialized tasks + +Could any part of your workflow benefit from: +- Specialized expertise +- Parallel processing +- Focused sub-tasks + +Looking at your structure, [specific phase] might benefit..." + +"**Sub-Processes** - For parallel workflows + +Would any phase benefit from: +- Running multiple processes in parallel +- Coordinating multiple workflows + +If so, which phase?" + +### 6. Configure Memory Systems + +"**Memory and State Management**" + +**If continuable from classification:** +"Since your workflow is continuable, it needs to track progress between sessions. + +We'll use: +- `stepsCompleted` array in output frontmatter +- `lastStep` tracking +- `step-01b-continue.md` for resuming + +Any additional state we need to track?" + +**If single-session:** +"Your workflow is single-session, so we'll keep state simple - no complex memory needed." + +### 7. External Integrations (Optional) + +"**External Integrations** - MCP, databases, APIs + +Based on your workflow, are there any external systems it needs to connect to? +- Databases? +- APIs? +- MCP servers? +- Other tools?" + +If yes, note installation requirements. + +### 8. Installation Assessment + +"**Installation and Dependencies** + +Some tools require additional setup. + +Based on what we've selected: +- [List any tools requiring installation] +- [Assess user comfort level] + +Are you comfortable with these installations, or should we consider alternatives?" + +### 9. Store Tools Configuration + +Update `{workflowPlanFile}`: + +```markdown +## Tools Configuration + +**Core BMAD Tools:** +- **Party Mode:** [included/excluded] - Integration point: [specific phase/reason] +- **Advanced Elicitation:** [included/excluded] - Integration point: [specific phase/reason] +- **Brainstorming:** [included/excluded] - Integration point: [specific phase/reason] + +**LLM Features:** +- **Web-Browsing:** [included/excluded] - Use case: [specific need] +- **File I/O:** [included/excluded] - Operations: [specific needs] +- **Sub-Agents:** [included/excluded] - Use case: [specific need] +- **Sub-Processes:** [included/excluded] - Use case: [specific need] + +**Memory:** +- Type: [continuable/single-session] +- Tracking: [stepsCompleted, lastStep, etc.] + +**External Integrations:** +- [List any selected with purposes] + +**Installation Requirements:** +- [List tools needing installation] +- User preference: [willing/not willing/alternatives] +``` + +### 10. Present MENU OPTIONS + +Display: **Select an Option:** [A] Advanced Elicitation [P] Party Mode [C] Continue + +#### EXECUTION RULES: + +- ALWAYS halt and wait for user input +- ONLY proceed when user selects 'C' +- User can chat or ask questions - always respond and redisplay menu + +#### Menu Handling Logic: + +- IF A: Execute {advancedElicitationTask} +- IF P: Execute {partyModeWorkflow} +- IF C: Save tools to plan, update frontmatter, then load `{nextStepFile}` +- IF Any other: Help user, then redisplay menu + +--- + +## 🚨 SYSTEM SUCCESS/FAILURE METRICS + +### ✅ SUCCESS: + +- Design preview presented BEFORE tools discussion +- Tools discussed WITHIN concrete context +- Integration points clearly identified +- User can visualize where tools fit +- All decisions documented in plan + +### ❌ SYSTEM FAILURE: + +- Configuring tools without design preview +- Abstract tool discussions ("it could go somewhere") +- Not identifying concrete integration points +- Hardcoding tool descriptions instead of using CSV + +**Master Rule:** Tools need context. Preview structure first, then configure tools with concrete integration points. diff --git a/src/modules/bmb/workflows/workflow/steps-c/step-05-plan-review.md b/src/modules/bmb/workflows/workflow/steps-c/step-05-plan-review.md new file mode 100644 index 00000000..f0ff6625 --- /dev/null +++ b/src/modules/bmb/workflows/workflow/steps-c/step-05-plan-review.md @@ -0,0 +1,242 @@ +--- +name: 'step-05-plan-review' +description: 'Review the complete workflow plan and approve before design' + +nextStepFile: './step-06-design.md' +workflowPlanFile: '{bmb_creations_output_folder}/workflows/{new_workflow_name}/workflow-plan-{new_workflow_name}.md' +advancedElicitationTask: '{project-root}/_bmad/core/workflows/advanced-elicitation/workflow.xml' +partyModeWorkflow: '{project-root}/_bmad/core/workflows/party-mode/workflow.md' +--- + +# Step 5: Plan Review and Approval + +## STEP GOAL: + +To present the complete workflow plan (discovery, classification, requirements, tools) for review and approval before proceeding to the design phase. + +## MANDATORY EXECUTION RULES (READ FIRST): + +### Universal Rules: + +- 🛑 NEVER generate content without user input +- 📖 CRITICAL: Read the complete step file before taking any action +- 🔄 CRITICAL: When loading next step with 'C', ensure entire file is read +- 📋 YOU ARE A FACILITATOR, not a content generator +- ✅ YOU MUST ALWAYS SPEAK OUTPUT In your Agent communication style with the config `{communication_language}` + +### Role Reinforcement: + +- ✅ You are a workflow architect conducting a design review +- ✅ Present the complete plan clearly +- ✅ Solicit feedback and make refinements +- ✅ Get explicit approval before proceeding to design + +### Step-Specific Rules: + +- 🎯 Focus ONLY on review and refinement +- 🚫 FORBIDDEN to start designing workflow steps in this step +- 💬 Present plan clearly, ask targeted questions +- 🚫 DO NOT proceed to design without user approval + +## EXECUTION PROTOCOLS: + +- 🎯 Present complete plan from {workflowPlanFile} +- 💾 Capture any modifications or refinements +- 📖 Update frontmatter stepsCompleted when complete +- 🚫 FORBIDDEN to load next step until user approves + +## CONTEXT BOUNDARIES: + +- Discovery (Step 1) → Classification (Step 2) → Requirements (Step 3) → Tools (Step 4) +- ALL the information needed for design is now captured +- This is the final checkpoint before designing the workflow structure +- Once we proceed to Step 6, we'll be designing actual step files + +## MANDATORY SEQUENCE + +**CRITICAL:** Follow this sequence exactly. Do not skip, reorder, or improvise unless user explicitly requests a change. + +### 1. Initialize Review + +"**Let's review the complete plan before we start designing.** + +We've covered a lot of ground. Let me walk you through everything we've decided, and you can tell me what looks right and what needs adjustment." + +### 2. Present Complete Plan + +Load and present from `{workflowPlanFile}`: + +"**Complete Workflow Plan: {workflow-name}** + +--- + +**1. DISCOVERY** (from Step 1) + +**Your Vision:** +[Present user's vision] + +**Who It's For:** +[Present users/audience] + +**Key Insights:** +[Present important context] + +--- + +**2. CLASSIFICATION** (from Step 2) + +**The 4 Key Decisions:** +1. **Document Output:** {true/false} - [what it produces] +2. **Module Affiliation:** {standalone/module} - {target path} +3. **Session Type:** {single-session/continuable} - [implications] +4. **Lifecycle Support:** {create-only/tri-modal} - [implications] + +**Workflow Name:** {name} +**Target Location:** {path} + +--- + +**3. REQUIREMENTS** (from Step 3) + +**Flow Structure:** +- Pattern: {linear/looping/branching/repeating} +- Phases: {list major phases} +- Estimated steps: {count} + +**User Interaction:** +- Style: {collaborative/autonomous/guided/mixed} +- Decision points: {where user must choose} + +**Inputs:** {required and optional} +**Output:** {type and format} +**Success Criteria:** {what success looks like} +**Instruction Style:** {intent/prescriptive/mixed} + +--- + +**4. TOOLS CONFIGURATION** (from Step 4) + +**Core Tools:** +- Party Mode: {included/excluded} - {integration point} +- Advanced Elicitation: {included/excluded} - {integration point} +- Brainstorming: {included/excluded} - {integration point} + +**LLM Features:** +- Web-Browsing: {included/excluded} +- File I/O: {included/excluded} +- Sub-Agents: {included/excluded} +- Sub-Processes: {included/excluded} + +**Memory:** {continuable/single-session} + +--- + +### 3. Detailed Review by Section + +"**Let's go through this systematically. I want your feedback on each area:**" + +**A. Vision and Scope (Discovery)** +- "Does the 'Your Vision' section capture what you're trying to build?" +- "Anything we missed in the key insights?" + +**B. Structural Decisions (Classification)** +- "Do the 4 key decisions still feel right?" +- "Any second thoughts on continuable vs single-session?" +- "Create-only or tri-modal - still the right call?" + +**C. Requirements (Details)** +- "Does the flow structure match what you envisioned?" +- "Are the interaction style and decision points accurate?" +- "Input/output specifications complete?" +- "Success criteria clear?" + +**D. Tools (Integrations)** +- "Do the selected tools make sense?" +- "Integration points feel right?" +- "Any tools we should add or remove?" + +### 4. Collect Feedback + +"**Your feedback:** + +For each section above, tell me: +1. What looks good and should stay as-is +2. What needs modification or refinement +3. What's missing that should be added +4. Anything unclear or confusing + +**Take your time - this is our last chance to make changes before we start designing the actual workflow.**" + +### 5. Process Feedback and Refine + +For each feedback item: + +- Document the requested change +- Discuss implications on workflow design +- Make the refinement +- Confirm with user + +Update `{workflowPlanFile}` with all approved changes. + +### 6. Final Confirmation + +"**One last check before we proceed to design:** + +Based on everything we've discussed: + +- [Re-state the workflow's purpose in one sentence] +- [Re-state the key structural decision: continuable/tri-modal] +- [Re-state the flow pattern] + +You're approving this plan to move into the actual workflow design phase. + +Ready to proceed?" + +### 7. Update Plan Status + +Update `{workflowPlanFile}` frontmatter: + +```yaml +status: APPROVED_FOR_DESIGN +approvedDate: [current date] +``` + +### 8. Present MENU OPTIONS + +Display: **Select an Option:** [A] Advanced Elicitation [P] Party Mode [C] Continue to Design + +#### EXECUTION RULES: + +- ALWAYS halt and wait for user input +- ONLY proceed to next step when user selects 'C' +- User can chat or ask questions - always respond and redisplay menu + +#### Menu Handling Logic: + +- IF A: Execute {advancedElicitationTask} +- IF P: Execute {partyModeWorkflow} +- IF C: Update plan frontmatter with approval, then load `{nextStepFile}` +- IF Any other: Help user, then redisplay menu + +--- + +## 🚨 SYSTEM SUCCESS/FAILURE METRICS + +### ✅ SUCCESS: + +- Complete plan presented clearly from the plan document +- All 4 sections reviewed systematically +- User feedback collected and incorporated +- User explicitly approves the plan +- Plan status updated to APPROVED_FOR_DESIGN +- Ready to proceed to design phase + +### ❌ SYSTEM FAILURE: + +- Not loading plan from {workflowPlanFile} +- Skipping review sections +- Not documenting refinements +- Proceeding without explicit approval +- Not updating plan status + +**Master Rule:** The plan must be complete and approved before design. This is the gatekeeper step. diff --git a/src/modules/bmb/workflows/create-workflow/steps/step-06-design.md b/src/modules/bmb/workflows/workflow/steps-c/step-06-design.md similarity index 60% rename from src/modules/bmb/workflows/create-workflow/steps/step-06-design.md rename to src/modules/bmb/workflows/workflow/steps-c/step-06-design.md index e2a61532..90e1baa2 100644 --- a/src/modules/bmb/workflows/create-workflow/steps/step-06-design.md +++ b/src/modules/bmb/workflows/workflow/steps-c/step-06-design.md @@ -2,22 +2,20 @@ name: 'step-06-design' description: 'Design the workflow structure and step sequence based on gathered requirements, tools configuration, and output format' -# Path Definitions -workflow_path: '{project-root}/_bmad/bmb/workflows/create-workflow' - -# File References -thisStepFile: '{workflow_path}/steps/step-06-design.md' -nextStepFile: '{workflow_path}/steps/step-07-build.md' -workflowFile: '{workflow_path}/workflow.md' -# Output files for workflow creation process +nextStepFile: './step-07-foundation.md' targetWorkflowPath: '{bmb_creations_output_folder}/workflows/{new_workflow_name}' workflowPlanFile: '{targetWorkflowPath}/workflow-plan-{new_workflow_name}.md' - -# Task References -advancedElicitationTask: '{project-root}/_bmad/core/tasks/advanced-elicitation.xml' +advancedElicitationTask: '{project-root}/_bmad/core/workflows/advanced-elicitation/workflow.xml' partyModeWorkflow: '{project-root}/_bmad/core/workflows/party-mode/workflow.md' -# Template References -# No template needed - will append design details directly to workflow plan +stepTemplate: '../templates/step-template.md' +stepTypePatterns: '../data/step-type-patterns.md' +menuHandlingStandards: '../data/menu-handling-standards.md' +frontmatterStandards: '../data/frontmatter-standards.md' +outputFormatStandards: '../data/output-format-standards.md' +inputDiscoveryStandards: '../data/input-discovery-standards.md' +workflowChainingStandards: '../data/workflow-chaining-standards.md' +trimodalWorkflowStructure: '../data/trimodal-workflow-structure.md' +subprocessPatterns: '../data/subprocess-optimization-patterns.md' --- # Step 6: Workflow Structure Design @@ -34,6 +32,7 @@ To collaboratively design the workflow structure, step sequence, and interaction - 📖 CRITICAL: Read the complete step file before taking any action - 🔄 CRITICAL: When loading next step with 'C', ensure entire file is read - 📋 YOU ARE A FACILITATOR, not a content generator +- ✅ YOU MUST ALWAYS SPEAK OUTPUT In your Agent communication style with the config `{communication_language}` ### Role Reinforcement: @@ -54,7 +53,7 @@ To collaboratively design the workflow structure, step sequence, and interaction - 🎯 Guide collaborative design process - 💾 After completing design, append to {workflowPlanFile} -- 📖 Update plan frontmatter `stepsCompleted: [1, 2, 3, 4, 5, 6]` before loading next step +- 📖 Update frontmatter stepsCompleted to add this step when completed. - 🚫 FORBIDDEN to load next step until user selects 'C' and design is saved ## CONTEXT BOUNDARIES: @@ -68,37 +67,40 @@ To collaboratively design the workflow structure, step sequence, and interaction ## DESIGN REFERENCE MATERIALS: -When designing, you may load these documents as needed: +When designing, you will load these data standards as needed (ideally within subprocesses that can return the relevant insights during the design step): -- `{project-root}/_bmad/bmb/docs/workflows/templates/step-template.md` - Step file structure -- `{project-root}/_bmad/bmb/docs/workflows/templates/step-01-init-continuable-template.md` - Continuable init step template -- `{project-root}/_bmad/bmb/docs/workflows/templates/step-1b-template.md` - Continuation step template -- `{project-root}/_bmad/bmb/docs/workflows/templates/workflow-template.md` - Workflow configuration -- `{project-root}/_bmad/bmb/reference/workflows/meal-prep-nutrition/workflow.md` - Complete example +- {stepTemplate} - Step file structure template +- {stepTypePatterns} - Templates for different step types (init, middle, branch, validation, final) +- {menuHandlingStandards} - Menu patterns and handler rules +- {frontmatterStandards} - Variable definitions and path rules +- {outputFormatStandards} - Output document patterns +- {inputDiscoveryStandards} - How to discover documents from prior workflows +- {workflowChainingStandards} - How workflows connect in sequences +- {trimodalWorkflowStructure} - Tri-modal workflow patterns (if applicable) -## WORKFLOW DESIGN PROCESS: +Example [Workflow.md](../workflow.md) for reference of a perfect workflow.md with some complex options (not all workflows will offer multiple next step options like this one - most will just auto route right to a step 1 file) + +## MANDATORY SEQUENCE + +**CRITICAL:** Follow this sequence exactly. Do not skip, reorder, or improvise unless user explicitly requests a change. ### 1. Step Structure Design -Let's reference our step creation documentation for best practices: +Load {stepTypePatterns} for available step type templates: -Load and reference step-file architecture guide: +This shows the standard structure for all step types: +- Init Step (Continuable) +- Continuation Step (01b) +- Middle Step (Standard/Simple) +- Branch Step +- Validation Sequence Step +- Init Step (With Input Discovery) +- Final Polish Step +- Final Step -``` -Read: {project-root}/_bmad/bmb/docs/workflows/templates/step-template.md -``` +Based on the approved plan, collaboratively design the info to answer the following for the build plan: -This shows the standard structure for step files. Also reference: - -``` -Read: {project-root}/_bmad/bmb/docs/workflows/templates/step-1b-template.md -``` - -This shows the continuation step pattern for workflows that might take multiple sessions. - -Based on the approved plan, collaboratively design: - -- How many major steps does this workflow need? (Recommend 3-7) +- How many major steps does this workflow need? - What is the goal of each step? - Which steps are optional vs required? - Should any steps repeat or loop? @@ -125,10 +127,11 @@ If **YES** to any of these, we should include continuation support using step-01 ### 2. Interaction Pattern Design -Design how users will interact with the workflow: +Load {menuHandlingStandards} for menu pattern options: +Design how users will interact with the workflow: - Where should users provide input vs where the AI works autonomously? -- What type of menu options are needed at each step? +- What menu pattern does each step need? (Standard A/P/C, Auto-proceed, Custom, Conditional) - Should there be Advanced Elicitation or Party Mode options? - How will users know their progress? - What confirmation points are needed? @@ -172,6 +175,47 @@ Design quality assurance: - How can users recover from errors? - What constitutes successful completion? +### 6a. Subprocess Optimization Design + +Load {subprocessPatterns} to understand subprocess optimization patterns that can save context and improve performance during workflow execution. + +Ask the user: + +"**Should we design this workflow to leverage subprocess optimization patterns?** Consider: + +- **Pattern 1 (Grep/Regex):** Will any step search across many files or documents for patterns? +- **Pattern 2 (Deep Analysis):** Will any step analyze multiple files for prose, logic, quality, or flow? +- **Pattern 3 (Data Operations):** Will any step load large reference data, knowledge bases, or datasets? +- **Pattern 4 (Parallel Execution):** Can any validation or analysis checks run in parallel instead of sequentially? + +If **YES** to any of these, we should design those steps with subprocess optimization in mind." + +**If subprocess optimization is applicable:** + +For each step that could benefit from subprocesses: +- Identify which pattern(s) apply (Pattern 1, 2, 3, or 4) +- Design what the subprocess should return (findings only, not full content) +- Plan graceful fallback for LLMs without subprocess capability +- Document optimization strategy in the build plan + +**Example subprocess integration:** + +```markdown +### Step-Specific Rules: +- 🎯 Analyze X files for Y - use subprocess per file (Pattern 2) +- 💬 Subprocess returns structured findings, not full content +- ⚙️ If subprocess unavailable: Perform analysis in main thread +``` + +**Document in the plan:** + +For each step identified for subprocess optimization, record: +- Step number and name +- Pattern type(s) to apply +- What the subprocess will analyze +- Expected return structure +- Fallback approach + ### 7. Special Features Design Identify unique requirements: @@ -181,6 +225,20 @@ Identify unique requirements: - Should it integrate with other workflows? - Does it need to handle multiple scenarios? +**Input Discovery:** + +If this workflow depends on documents from prior workflows, load {inputDiscoveryStandards}: +- What prior workflow outputs does this workflow need? +- Are these required or optional inputs? +- How will the workflow discover these documents? + +**Workflow Chaining:** + +If this workflow is part of a sequence, load {workflowChainingStandards}: +- What workflow comes before this one? +- What workflow comes after this one? +- What outputs does this workflow produce for the next? + ### 8. Design Review and Refinement Present the design for review: diff --git a/src/modules/bmb/workflows/workflow/steps-c/step-07-foundation.md b/src/modules/bmb/workflows/workflow/steps-c/step-07-foundation.md new file mode 100644 index 00000000..c6b107d5 --- /dev/null +++ b/src/modules/bmb/workflows/workflow/steps-c/step-07-foundation.md @@ -0,0 +1,238 @@ +--- +name: 'step-07-foundation' +description: 'Create workflow folder structure, workflow.md, and main output template(s)' + +nextStepFile: './step-08-build-step-01.md' +targetWorkflowPath: '{bmb_creations_output_folder}/workflows/{new_workflow_name}' +workflowPlanFile: '{targetWorkflowPath}/workflow-plan-{new_workflow_name}.md' +workflowTemplate: '../templates/workflow-template.md' +outputFormatStandards: '../data/output-format-standards.md' +minimalOutputTemplate: '../templates/minimal-output-template.md' +advancedElicitationTask: '{project-root}/_bmad/core/workflows/advanced-elicitation/workflow.xml' +partyModeWorkflow: '{project-root}/_bmad/core/workflows/party-mode/workflow.md' +--- + +# Step 7: Foundation Build + +## STEP GOAL: + +To create the workflow folder structure, the main workflow.md file, and the primary output template(s) that step files will reference. + +## MANDATORY EXECUTION RULES (READ FIRST): + +### Universal Rules: + +- 🛑 NEVER generate content without user input +- 📖 CRITICAL: Read the complete step file before taking any action +- 🔄 CRITICAL: When loading next step with 'C', ensure entire file is read +- 📋 YOU ARE A FACILITATOR, not a content generator +- ✅ YOU MUST ALWAYS SPEAK OUTPUT In your Agent communication style with the config `{communication_language}` + +### Role Reinforcement: + +- ✅ You are a workflow architect and systems designer +- ✅ If you already have been given communication or persona patterns, continue to use those while playing this new role +- ✅ We engage in collaborative dialogue, not command-response +- ✅ You bring implementation expertise and best practices +- ✅ User brings their specific requirements and design approvals + +### Step-Specific Rules: + +- 🎯 Focus ONLY on creating foundation elements (folder, workflow.md, main template) +- 🚫 FORBIDDEN to create step files yet - that comes next +- 💬 Get confirmation before creating each foundation element +- 🚪 CREATE files in the correct target location + +## EXECUTION PROTOCOLS: + +- 🎯 Create foundation systematically from approved design +- 💾 Document what was created in the plan +- 📖 Update frontmatter stepsCompleted to add this step when completed +- 🚫 FORBIDDEN to load next step until user selects 'C' + +## CONTEXT BOUNDARIES: + +- Approved plan from step 6 guides implementation +- Design specifies: workflow name, continuable or not, document output type, step count +- Load templates and documentation as needed during build +- Follow step-file architecture principles + +## MANDATORY SEQUENCE + +**CRITICAL:** Follow this sequence exactly. Do not skip, reorder, or improvise unless user explicitly requests a change. + +### 1. Confirm Foundation Readiness + +Based on the approved design from step 6, confirm: + +"**I have your approved design and I'm ready to create the workflow foundation.** + +From your design, I'll be creating: + +**Workflow:** {new_workflow_name} +**Location:** {targetWorkflowPath} +**Type:** [continuable/single-session] +**Document Output:** [yes/no - template type if yes] +**Estimated Steps:** [number from design] + +Ready to proceed with creating the folder structure?" + +### 2. Create Folder Structure + +Create the workflow folder structure: + +``` +{targetWorkflowPath}/ +├── workflow.md # To be created +├── steps-c/ # Create flow steps +│ ├── step-01-init.md +│ ├── step-01b-continue.md # If continuable +│ └── [remaining steps] +├── steps-v/ # Validate flow steps (to be created later) +├── data/ # Shared reference data +└── templates/ # Output templates +``` + +**For BMB module workflows:** The target will be `_bmad/custom/src/workflows/{workflow_name}/` +**For other modules:** Check module's custom_workflow_location + +Create the folders and confirm structure. + +### 3. Generate workflow.md + +Load {workflowTemplate} and create workflow.md with: + +**Frontmatter:** +```yaml +--- +name: '{workflow-name-from-design}' +description: '{description-from-design}' +web_bundle: true +--- +``` + +**Content:** +- Workflow name and description +- Goal statement +- Role definition +- Meta-context (if applicable) +- Initialization sequence pointing to steps-c/step-01-init.md +- Configuration loading instructions + +**If tri-modal (Create + Edit + Validate):** +Add mode routing logic to workflow.md: +- IF invoked with -c: Load ./steps-c/step-01-init.md +- IF invoked with -v: Load ./steps-v/step-01-validate.md +- IF invoked with -e: Load ./steps-e/step-01-edit.md + +### 4. Create Main Output Template + +**Load {outputFormatStandards} to determine template type.** + +**From the design, determine:** +- Free-form (recommended) - Minimal frontmatter + progressive append +- Structured - Required sections with flexible content +- Semi-structured - Core sections + optional additions +- Strict - Exact format (rare, compliance/legal) + +**For Free-form (most common):** + +Create `templates/output-template.md`: +```yaml +--- +stepsCompleted: [] +lastStep: '' +date: '' +user_name: '' +--- +``` + +If the workflow produces a document with sections: +```markdown +# {{document_title}} + +[Content appended progressively by workflow steps] +``` + +**For Structured/Semi-structured:** + +Create template with section placeholders based on design: +```markdown +# {{title}} + +## {{section_1}} +[Content to be filled] + +## {{section_2}} +[Content to be filled] +``` + +**For Non-Document Workflows:** + +No output template needed. Document this in the plan. + +### 5. Document Foundation in Plan + +Append to {workflowPlanFile}: + +```markdown +## Foundation Build Complete + +**Created:** +- Folder structure at: {targetWorkflowPath} +- workflow.md +- Main template: [template-name] + +**Configuration:** +- Workflow name: {name} +- Continuable: [yes/no] +- Document output: [yes/no - type] +- Mode: [create-only or tri-modal] + +**Next Steps:** +- Step 8: Build step-01 (and step-01b if continuable) +- Step 9: Build remaining steps (repeatable) +``` + +### 6. Present MENU OPTIONS + +Display: **Foundation Complete - Select an Option:** [A] Advanced Elicitation [P] Party Mode [C] Continue to Step 01 Build + +#### EXECUTION RULES: + +- ALWAYS halt and wait for user input after presenting menu +- ONLY proceed to next step when user selects 'C' +- After other menu items execution, return to this menu +- User can chat or ask questions - always respond and then redisplay menu + +#### Menu Handling Logic: + +- IF A: Execute {advancedElicitationTask}, and when finished redisplay the menu +- IF P: Execute {partyModeWorkflow}, and when finished redisplay the menu +- IF C: Save foundation summary to {workflowPlanFile}, update frontmatter stepsCompleted, then load, read entire file, then execute {nextStepFile} +- IF Any other comments or queries: help user respond then [Redisplay Menu Options](#6-present-menu-options) + +## CRITICAL STEP COMPLETION NOTE + +ONLY WHEN C is selected and foundation is saved to plan will you load {nextStepFile} to begin building step-01. + +--- + +## 🚨 SYSTEM SUCCESS/FAILURE METRICS + +### ✅ SUCCESS: + +- Folder structure created in correct location +- workflow.md created with proper frontmatter and initialization +- Main output template created (if document-producing workflow) +- Foundation documented in {workflowPlanFile} +- Frontmatter updated with stepsCompleted + +### ❌ SYSTEM FAILURE: + +- Creating folders without user confirmation +- Missing mode routing for tri-modal workflows +- Wrong template type for output format +- Not documenting what was created + +**Master Rule:** Skipping steps, optimizing sequences, or not following exact instructions is FORBIDDEN and constitutes SYSTEM FAILURE. diff --git a/src/modules/bmb/workflows/workflow/steps-c/step-08-build-step-01.md b/src/modules/bmb/workflows/workflow/steps-c/step-08-build-step-01.md new file mode 100644 index 00000000..17f59142 --- /dev/null +++ b/src/modules/bmb/workflows/workflow/steps-c/step-08-build-step-01.md @@ -0,0 +1,377 @@ +--- +name: 'step-08-build-step-01' +description: 'Build step-01-init.md and step-01b-continue.md (if continuable) with any supporting files' + +nextStepFile: './step-09-build-next-step.md' +targetWorkflowPath: '{bmb_creations_output_folder}/workflows/{new_workflow_name}' +workflowPlanFile: '{targetWorkflowPath}/workflow-plan-{new_workflow_name}.md' +stepTemplate: '../templates/step-template.md' +stepTypePatterns: '../data/step-type-patterns.md' +frontmatterStandards: '../data/frontmatter-standards.md' +menuHandlingStandards: '../data/menu-handling-standards.md' +outputFormatStandards: '../data/output-format-standards.md' +inputDiscoveryStandards: '../data/input-discovery-standards.md' +subprocessPatterns: '../data/subprocess-optimization-patterns.md' +advancedElicitationTask: '{project-root}/_bmad/core/workflows/advanced-elicitation/workflow.xml' +partyModeWorkflow: '{project-root}/_bmad/core/workflows/party-mode/workflow.md' +--- + +# Step 8: Build Step 01 (and 01b if Continuable) + +## STEP GOAL: + +To build the first step file(s) for the new workflow - step-01-init.md and step-01b-continue.md if the workflow is continuable - including any supporting files these steps need. + +## MANDATORY EXECUTION RULES (READ FIRST): + +### Universal Rules: + +- 🛑 NEVER generate content without user input +- 📖 CRITICAL: Read the complete step file before taking any action +- 🔄 CRITICAL: When loading next step with 'C', ensure entire file is read +- 📋 YOU ARE A FACILITATOR, not a content generator +- ✅ YOU MUST ALWAYS SPEAK OUTPUT In your Agent communication style with the config `{communication_language}` + +### Role Reinforcement: + +- ✅ You are a workflow architect and systems designer +- ✅ If you already have been given communication or persona patterns, continue to use those while playing this new role +- ✅ We engage in collaborative dialogue, not command-response +- ✅ You bring implementation expertise and best practices +- ✅ User brings their specific requirements and design approvals + +### Step-Specific Rules: + +- 🎯 Focus ONLY on building step-01 (and 01b if continuable) +- 🚫 FORBIDDEN to build other steps yet - use step-09 for those +- 💬 Generate step content collaboratively based on approved design +- 🚪 CREATE files in the correct target location + +## EXECUTION PROTOCOLS: + +- 🎯 Load standards to understand step type patterns +- 💾 Document what was created in the plan +- 📖 Update frontmatter stepsCompleted to add this step when completed +- 🚫 FORBIDDEN to load next step until user selects 'C' + +## CONTEXT BOUNDARIES: + +- Approved design from step 6 specifies step-01's purpose and type +- Load step type patterns to understand init step structure +- Frontmatter and menu standards ensure compliance +- This is the FIRST step - sets up everything that follows + +## MANDATORY SEQUENCE + +**CRITICAL:** Follow this sequence exactly. Do not skip, reorder, or improvise unless user explicitly requests a change. + +### 1. Load Standards for Init Steps + +**Load {stepTypePatterns}** to understand the init step patterns: +- Init Step (Non-Continuable) - For single-session workflows +- Init Step (Continuable) - For multi-session workflows +- Init Step (With Input Discovery) - If workflow needs prior documents + +**Load {frontmatterStandards}** for variable and path rules. + +**Load {menuHandlingStandards}** for menu patterns (init steps typically use auto-proceed or C-only). + +### 2. Determine Step 01 Type + +From the approved design, determine: + +**Is the workflow continuable?** +- **YES:** Use Init Step (Continuable) pattern +- **NO:** Use Init Step (Non-Continuable) pattern + +**Does the workflow need input discovery?** +- **YES:** Use Init Step (With Input Discovery) pattern +- **NO:** Standard init pattern + +Confirm with user: "Based on your design, step-01 will be [continuable/non-continuable] with [input discovery/standard init]. Is this correct?" + +### 3. Build step-01-init.md + +**Load {stepTemplate}** for base structure. + +Create `steps-c/step-01-init.md` with: + +**Frontmatter:** +```yaml +--- +name: 'step-01-init' +description: '[from design]' + +# File references (ONLY variables used in this step) +nextStepFile: './step-02-[next-step-name].md' +outputFile: '{output_folder}/[output-name].md' +templateFile: '../templates/output-template.md' # If applicable + +# Continuation support (if continuable) +continueFile: './step-01b-continue.md' # If continuable + +# Input discovery (if needed) +inputDocuments: [] +requiredInputCount: [number] +moduleInputFolder: '{module_output_folder}' +inputFilePatterns: ['*-prd.md', '*-ux.md'] # From design + +# Tasks (if A/P menu used) +advancedElicitationTask: '{project-root}/_bmad/core/workflows/advanced-elicitation/workflow.xml' +partyModeWorkflow: '{project-root}/_bmad/core/workflows/party-mode/workflow.md' +--- +``` + +**Content Structure:** +```markdown +# Step 1: [Step Name From Design] + +## STEP GOAL: +[Single sentence goal from design] + +## MANDATORY EXECUTION RULES (READ FIRST): +### Universal Rules: +- 🛑 NEVER generate content without user input +- 📖 CRITICAL: Read the complete step file before taking any action +- 🔄 CRITICAL: When loading next step with 'C', ensure entire file is read +- 📋 YOU ARE A FACILITATOR, not a content generator +- ✅ YOU MUST ALWAYS SPEAK OUTPUT In your Agent communication style with the config `{communication_language}` + +### Role Reinforcement: +- ✅ You are [role from design] +- ✅ We engage in collaborative dialogue, not command-response +- ✅ You bring [expertise], user brings [theirs] +- ✅ Together we produce something better + +### Step-Specific Rules: +- 🎯 Focus only on [specific task for step-01] +- 🚫 FORBIDDEN to [prohibited action] +- 💬 Approach: [how to engage] + +## EXECUTION PROTOCOLS: +- 🎯 [Protocol 1] +- 💾 [Protocol 2 - create/append to output] +- 📖 [Protocol 3 - tracking] +- 🚫 This is the init step - sets up everything + +## CONTEXT BOUNDARIES: +- [What's available at step 01] +- Focus: [what to focus on] +- Limits: [boundaries] +- Dependencies: [none - this is first step] + +## MANDATORY SEQUENCE + +**CRITICAL:** Follow this sequence exactly. Do not skip, reorder, or improvise unless user explicitly requests a change. + +### 1. [First action - from design] +[Instructions for step-01 - intent-based, not prescriptive] + +### 2. [Second action - from design] +[Instructions] + +### ... [continue for all actions in step-01] + +### N. Present MENU OPTIONS +[Menu from design - typically C-only for init, or A/P/C if appropriate] + +#### EXECUTION RULES: +- ALWAYS halt and wait for user input after presenting menu +- ONLY proceed to next step when user selects 'C' + +#### Menu Handling Logic: +- IF C: Create/append to {outputFile} with content, update frontmatter stepsCompleted, then load, read entire file, then execute {nextStepFile} +- IF Any other: help user, then redisplay menu + +## 🚨 SYSTEM SUCCESS/FAILURE METRICS: +### ✅ SUCCESS: +[What success looks like for step-01] + +### ❌ SYSTEM FAILURE: +[What failure looks like] + +**Master Rule:** Skipping steps is FORBIDDEN. +``` + +**Customize content based on:** +- The step's goal from the design +- The workflow's role and persona +- Whether it's continuable +- Whether it needs input discovery +- The template type (if document-producing) + +### 4. Build step-01b-continue.md (If Continuable) + +**If workflow is continuable**, create `steps-c/step-01b-continue.md`: + +**Frontmatter:** +```yaml +--- +name: 'step-01b-continue' +description: 'Handle workflow continuation from previous session' + +outputFile: '{output_folder}/[output-name].md' +workflowFile: '../workflow.md' +nextStepOptions: + step-02: './step-02-[name].md' + step-03: './step-03-[name].md' + # ... add all subsequent steps +--- +``` + +**Content:** +```markdown +# Step 1b: Continue Workflow + +## STEP GOAL: +To resume the workflow from where it was left off in a previous session. + +## MANDATORY EXECUTION RULES: +[Standard universal rules] + +## CONTEXT BOUNDARIES: +- User has run this workflow before +- Output file exists with stepsCompleted array +- Need to route to the correct next step + +## MANDATORY SEQUENCE + +### 1. Welcome Back +"**Welcome back!** Let me check where we left off..." + +### 2. Read stepsCompleted from Output +Load {outputFile} and read frontmatter `stepsCompleted` array. + +### 3. Determine Next Step +Find the last completed step and identify the next step to load. + +### 4. Route to Correct Step +Load the appropriate next step file based on stepsCompleted. + +## MENU OPTIONS +Display continuation status and offer to proceed. + +## SUCCESS/FAILURE METRICS +[Standard metrics] +``` + +### 5. Create Supporting Files (If Needed) + +**Does step-01 need any:** + +**Small templates?** (inline in step, no separate file needed) + +**Data files?** (create if step references CSV data) + +**Validation checklists?** (create if step validates something) + +**If supporting files are needed, create them in `data/` folder and update step-01 frontmatter to reference them.** + +### 5a. Apply Subprocess Optimization (If Designed) + +**Check the approved design from step 6:** Was subprocess optimization identified for step-01? + +**If YES, apply the appropriate pattern(s):** + +Load {subprocessPatterns} and implement the subprocess optimization: + +1. **Identify the pattern(s) from the design:** + - Pattern 1: Single subprocess for grep/regex across many files + - Pattern 2: Per-file subprocess for deep analysis + - Pattern 3: Subprocess for data file operations + - Pattern 4: Parallel execution of independent operations + +2. **Add subprocess-specific Step-Specific Rules:** + ```markdown + ### Step-Specific Rules: + - 🎯 [Brief description of which pattern applies] + - 💬 Subprocess must either update report OR return findings to parent + - 🚫 DO NOT BE LAZY - [specific guidance if Pattern 2] + - ⚙️ TOOL/SUBPROCESS FALLBACK: If subprocess unavailable, perform in main thread + ``` + +3. **Implement subprocess directives in the MANDATORY SEQUENCE:** + - Use appropriate subprocess language: + - Pattern 1: "Launch a subprocess that runs [command] across all files, returns [results]" + - Pattern 2: "DO NOT BE LAZY - For EACH file, launch a subprocess that [analyzes], returns [findings]" + - Pattern 3: "Launch a subprocess that loads [data file], performs [operation], returns [results]" + - Pattern 4: "Launch subprocesses in parallel that [operations], aggregate results" + +4. **Ensure return patterns are specified:** + - Subprocess updates report directly OR + - Subprocess returns structured findings to parent for aggregation + +5. **Verify graceful fallback is documented:** + - Universal fallback rule in Universal Rules + - Step-specific fallback in Step-Specific Rules + - Clear instructions for LLMs without subprocess capability + +**If NO subprocess optimization was designed for step-01:** + +Skip this section and proceed to document build in plan. + +### 6. Document Build in Plan + +Append to {workflowPlanFile}: + +```markdown +## Step 01 Build Complete + +**Created:** +- steps-c/step-01-init.md +- steps-c/step-01b-continue.md [if continuable] +- [any supporting files] + +**Step Configuration:** +- Type: [continuable/non-continuable] +- Input Discovery: [yes/no] +- Next Step: step-02-[name] + +**Supporting Files:** +- [list any data files, templates created] +``` + +### 7. Present MENU OPTIONS + +Display: **Step 01 Complete - Select an Option:** [A] Advanced Elicitation [P] Party Mode [C] Continue to Next Step Build + +#### EXECUTION RULES: + +- ALWAYS halt and wait for user input after presenting menu +- ONLY proceed to next step when user selects 'C' +- After other menu items execution, return to this menu + +#### Menu Handling Logic: + +- IF A: Execute {advancedElicitationTask}, and when finished redisplay the menu +- IF P: Execute {partyModeWorkflow}, and when finished redisplay the menu +- IF C: Save build summary to {workflowPlanFile}, update frontmatter stepsCompleted, then load, read entire file, then execute {nextStepFile} +- IF Any other comments or queries: help user respond then [Redisplay Menu Options](#7-present-menu-options) + +## CRITICAL STEP COMPLETION NOTE + +ONLY WHEN C is selected and build is saved to plan will you load {nextStepFile} to begin building the next step. + +--- + +## 🚨 SYSTEM SUCCESS/FAILURE METRICS + +### ✅ SUCCESS: + +- step-01-init.md created with proper structure +- step-01b-continue.md created (if continuable) +- Frontmatter follows {frontmatterStandards} +- Menu handling follows {menuHandlingStandards} +- Step type pattern followed correctly +- Supporting files created (if needed) +- Build documented in plan + +### ❌ SYSTEM FAILURE: + +- Creating step without following template +- Missing continuation support for continuable workflow +- Wrong menu pattern for step type +- Frontmatter variables not used in step body +- Hardcoded paths instead of variables + +**Master Rule:** Skipping steps, optimizing sequences, or not following exact instructions is FORBIDDEN and constitutes SYSTEM FAILURE. diff --git a/src/modules/bmb/workflows/workflow/steps-c/step-09-build-next-step.md b/src/modules/bmb/workflows/workflow/steps-c/step-09-build-next-step.md new file mode 100644 index 00000000..54b7a960 --- /dev/null +++ b/src/modules/bmb/workflows/workflow/steps-c/step-09-build-next-step.md @@ -0,0 +1,350 @@ +--- +name: 'step-09-build-next-step' +description: 'Build the next step in the workflow sequence - repeatable until all steps are built' + +nextStepFile: './step-09-build-next-step.md' # Self-referencing - repeats until complete +targetWorkflowPath: '{bmb_creations_output_folder}/workflows/{new_workflow_name}' +workflowPlanFile: '{targetWorkflowPath}/workflow-plan-{new_workflow_name}.md' +stepTemplate: '../templates/step-template.md' +stepTypePatterns: '../data/step-type-patterns.md' +frontmatterStandards: '../data/frontmatter-standards.md' +menuHandlingStandards: '../data/menu-handling-standards.md' +outputFormatStandards: '../data/output-format-standards.md' +csvDataFileStandards: '../data/csv-data-file-standards.md' +subprocessPatterns: '../data/subprocess-optimization-patterns.md' +advancedElicitationTask: '{project-root}/_bmad/core/workflows/advanced-elicitation/workflow.xml' +partyModeWorkflow: '{project-root}/_bmad/core/workflows/party-mode/workflow.md' +--- + +# Step 9: Build Next Step (Repeatable) + +## STEP GOAL: + +To build the next step file in the workflow sequence based on the approved design. This step is REPEATABLE - continue running it until all steps from the design have been built. + +## MANDATORY EXECUTION RULES (READ FIRST): + +### Universal Rules: + +- 🛑 NEVER generate content without user input +- 📖 CRITICAL: Read the complete step file before taking any action +- 🔄 CRITICAL: When loading next step with 'C', ensure entire file is read +- 📋 YOU ARE A FACILITATOR, not a content generator +- ✅ YOU MUST ALWAYS SPEAK OUTPUT In your Agent communication style with the config `{communication_language}` + +### Role Reinforcement: + +- ✅ You are a workflow architect and systems designer +- ✅ If you already have been given communication or persona patterns, continue to use those while playing this new role +- ✅ We engage in collaborative dialogue, not command-response +- ✅ You bring implementation expertise and best practices +- ✅ User brings their specific requirements and design approvals + +### Step-Specific Rules: + +- 🎯 Load the plan to determine WHICH step to build next +- 🚫 FORBIDDEN to skip steps or build out of order +- 💬 Each step is built collaboratively based on approved design +- 🚪 This step REPEATS until all workflow steps are built + +## EXECUTION PROTOCOLS: + +- 🎯 Always check what's been built, then build the next one +- 💾 Document each step in the plan as it's built +- 📖 Update frontmatter stepsCompleted to add each step when completed +- 🚫 Don't proceed to completion until ALL workflow steps are built + +## CONTEXT BOUNDARIES: + +- Approved design from step 6 specifies all steps +- The plan tracks which steps have been built +- Load step type patterns to understand each step's structure +- This step continues until the design is fully implemented + +## MANDATORY SEQUENCE + +**CRITICAL:** Follow this sequence exactly. Do not skip, reorder, or improvise unless user explicitly requests a change. + +### 1. Check Build Status + +Load {workflowPlanFile} and check: + +**What steps have been built so far?** +- Step 01: Always built in step-08 +- Subsequent steps: Track in plan + +**What is the NEXT step to build?** + +From the design in the plan, identify: +- Step number and name +- Step type (Middle/Standard, Middle/Simple, Branch, Validation, Final Polish, Final) +- This step's goal and purpose + +Confirm: "The next step to build is **step-{N}-{name}** which is a [step type]. Its goal is: [goal from design]. Ready to proceed?" + +### 2. Load Standards for This Step Type + +**Load {stepTypePatterns}** and find the pattern for this step type: +- Middle Step (Standard) - A/P/C menu, collaborative content +- Middle Step (Simple) - C only menu, no A/P +- Branch Step - Custom menu with routing logic +- Validation Sequence - Auto-proceed through checks +- Final Polish Step - Optimizes document built section-by-section +- Final Step - Completion, no next step + +**Load {frontmatterStandards}** for variable rules. + +**Load {menuHandlingStandards}** for menu patterns. + +**Load {outputFormatStandards}** if this step outputs to document. + +### 2a. Apply Subprocess Optimization (If Designed for This Step) + +**Check the approved design from step 6:** Was subprocess optimization identified for this step? + +**If YES, apply the appropriate pattern(s):** + +Load {subprocessPatterns} and implement the subprocess optimization for this step: + +1. **Identify the pattern(s) from the design for this step:** + - Pattern 1: Single subprocess for grep/regex across many files + - Pattern 2: Per-file subprocess for deep analysis + - Pattern 3: Subprocess for data file operations + - Pattern 4: Parallel execution of independent operations + +2. **Add subprocess-specific Step-Specific Rules to this step:** + ```markdown + ### Step-Specific Rules: + - 🎯 [Brief description of which pattern applies] + - 💬 Subprocess must either update report OR return findings to parent + - 🚫 DO NOT BE LAZY - [specific guidance if Pattern 2] + - ⚙️ TOOL/SUBPROCESS FALLBACK: If subprocess unavailable, perform in main thread + ``` + +3. **Implement subprocess directives in the MANDATORY SEQUENCE:** + - Use appropriate subprocess language: + - Pattern 1: "Launch a subprocess that runs [command] across all files, returns [results]" + - Pattern 2: "DO NOT BE LAZY - For EACH file, launch a subprocess that [analyzes], returns [findings]" + - Pattern 3: "Launch a subprocess that loads [data file], performs [operation], returns [results]" + - Pattern 4: "Launch subprocesses in parallel that [operations], aggregate results" + +4. **Ensure return patterns are specified:** + - Subprocess updates report directly OR + - Subprocess returns structured findings to parent for aggregation + +5. **Verify graceful fallback is documented:** + - Universal fallback rule in Universal Rules + - Step-specific fallback in Step-Specific Rules + - Clear instructions for LLMs without subprocess capability + +**If NO subprocess optimization was designed for this step:** + +Skip this section and proceed to build the step file. + +### 3. Build the Step File + +**Load {stepTemplate}** for base structure. + +Create `steps-c/step-{N}-{name}.md` with: + +**Frontmatter:** +```yaml +--- +name: 'step-{N}-{name}' +description: '[what this step does]' + +# File references (ONLY variables used in this step) +nextStepFile: './step-{N+1}-[next-name].md' # Omit for final step +outputFile: '{output_folder}/[output-name].md' +templateFile: '../templates/[template-name].md' # If applicable + +# Data files (if this step needs them) +someData: '../data/[data-file].csv' # If applicable + +# Tasks (if A/P menu used) +advancedElicitationTask: '{project-root}/_bmad/core/workflows/advanced-elicitation/workflow.xml' +partyModeWorkflow: '{project-root}/_bmad/core/workflows/party-mode/workflow.md' +--- +``` + +**Content Structure:** (Same pattern as step-01, customized for this step) + +```markdown +# Step {N}: [Step Name From Design] + +## STEP GOAL: +[Single sentence goal from design] + +## MANDATORY EXECUTION RULES (READ FIRST): +### Universal Rules: +- 🛑 NEVER generate content without user input +- 📖 CRITICAL: Read the complete step file before taking any action +- 🔄 CRITICAL: When loading next step with 'C', ensure entire file is read +- 📋 YOU ARE A FACILITATOR, not a content generator +- ✅ YOU MUST ALWAYS SPEAK OUTPUT In your Agent communication style with the config `{communication_language}` + +### Role Reinforcement: +- ✅ You are [role from design] +- ✅ We engage in collaborative dialogue, not command-response +- ✅ You bring [expertise for this step], user brings [theirs] + +### Step-Specific Rules: +- 🎯 Focus only on [specific task for this step] +- 🚫 FORBIDDEN to [prohibited action] +- 💬 Approach: [how to engage for this step] + +## EXECUTION PROTOCOLS: +- 🎯 Follow the MANDATORY SEQUENCE exactly +- 💾 [Protocol - append to output if this step outputs] +- 📖 [Protocol - tracking if applicable] + +## CONTEXT BOUNDARIES: +- [What's available at this step] +- Focus: [what to focus on] +- Limits: [boundaries] +- Dependencies: [what this step depends on from previous steps] + +## MANDATORY SEQUENCE + +**CRITICAL:** Follow this sequence exactly. Do not skip, reorder, or improvise unless user explicitly requests a change. + +### 1. [First action - from design] +[Intent-based instructions for this step] + +### 2. [Second action - from design] +[Intent-based instructions] + +### ... [continue for all actions in this step] + +### N. Present MENU OPTIONS +[Menu based on step type - Standard A/P/C, Simple C-only, Branching, Auto-proceed] + +#### EXECUTION RULES: +[Based on menu type from {menuHandlingStandards}] + +#### Menu Handling Logic: +[Handler for this step's menu] + +## 🚨 SYSTEM SUCCESS/FAILURE METRICS: +### ✅ SUCCESS: +[What success looks like for this step] + +### ❌ SYSTEM FAILURE: +[What failure looks like] + +**Master Rule:** Skipping steps is FORBIDDEN. +``` + +**Customize based on:** +- Step type pattern from {stepTypePatterns} +- The step's specific goal and actions from design +- What this step outputs (if document-producing workflow) +- Menu pattern appropriate for step type + +### 4. Create Supporting Files (If Needed) + +**Does this step need any:** + +**Small templates?** - Inline in step content or create small template file + +**Data files?** - If step references CSV data, create in `data/` folder +- Load {csvDataFileStandards} for CSV structure +- Create CSV with proper headers and data + +**Validation checklists?** - If this step validates something, create checklist + +**Section templates?** - If step outputs to specific document section + +**If supporting files are created:** +1. Create in appropriate folder (`data/` or `templates/`) +2. Update step frontmatter to reference them +3. Document in plan + +### 5. Document Build in Plan + +Append to {workflowPlanFile}: + +```markdown +## Step {N} Build Complete + +**Created:** +- steps-c/step-{N}-{name}.md +- [any supporting files] + +**Step Configuration:** +- Type: [step type] +- Outputs to: [output section or file] +- Next Step: [next step or "final step"] + +**Supporting Files:** +- [list any data files, templates created for this step] +``` + +### 6. Check If More Steps Needed + +After documenting, check the design: + +**Are all steps from the design now built?** +- **YES:** Proceed to completion menu (option 7 below) +- **NO:** Present continuation menu (option 6 below) + +### 6a. Present MENU OPTIONS (More Steps Remaining) + +Display: **Step {N} Complete - Select an Option:** [A] Advanced Elicitation [P] Party Mode [C] Build Next Step + +#### EXECUTION RULES: + +- ALWAYS halt and wait for user input after presenting menu +- ONLY build next step when user selects 'C' +- After other menu items execution, return to this menu + +#### Menu Handling Logic: + +- IF A: Execute {advancedElicitationTask}, and when finished redisplay the menu +- IF P: Execute {partyModeWorkflow}, and when finished redisplay the menu +- IF C: Save build summary to {workflowPlanFile}, update frontmatter stepsCompleted, then load, read entire file, then execute {nextStepFile} (which is THIS FILE - self-referencing for next iteration) +- IF Any other comments or queries: help user respond then [Redisplay Menu Options](#6a-present-menu-options-more-steps-remaining) + +### 6b. Present MENU OPTIONS (All Steps Complete) + +Display: **All Workflow Steps Built! Select an Option:** [R] Review Built Steps [V] Proceed to Validation [C] Complete Build + +#### EXECUTION RULES: + +- ALWAYS halt and wait for user input after presenting menu +- User selects final action + +#### Menu Handling Logic: + +- IF R: List all built steps with their paths, allow review, then redisplay menu +- IF V: Save final build summary to {workflowPlanFile}, update frontmatter stepsCompleted to include ALL steps, then load `./step-10-confirmation.md` +- IF C: Same as V (complete and proceed) +- IF Any other comments or queries: help user respond then [Redisplay Menu Options](#6b-present-menu-options-all-steps-complete) + +## CRITICAL STEP COMPLETION NOTE + +This step REPEATS until all workflow steps from the design are built. When complete, user selects V or C to proceed to completion. + +--- + +## 🚨 SYSTEM SUCCESS/FAILURE METRICS + +### ✅ SUCCESS: + +- Each step file created with proper structure for its type +- Frontmatter follows {frontmatterStandards} +- Menu handling follows {menuHandlingStandards} +- Step type pattern followed correctly +- Supporting files created as needed +- Each build documented in plan +- Process continues until ALL design steps are built + +### ❌ SYSTEM FAILURE: + +- Building steps out of order +- Skipping steps from the design +- Wrong menu pattern for step type +- Not documenting each step in plan +- Proceeding to completion before all steps built + +**Master Rule:** Skipping steps, optimizing sequences, or not following exact instructions is FORBIDDEN and constitutes SYSTEM FAILURE. diff --git a/src/modules/bmb/workflows/workflow/steps-c/step-10-confirmation.md b/src/modules/bmb/workflows/workflow/steps-c/step-10-confirmation.md new file mode 100644 index 00000000..c7534cb5 --- /dev/null +++ b/src/modules/bmb/workflows/workflow/steps-c/step-10-confirmation.md @@ -0,0 +1,320 @@ +--- +name: 'step-10-confirmation' +description: 'Confirm workflow completion - validate plan completion or conversion coverage' + +targetWorkflowPath: '{bmb_creations_output_folder}/workflows/{new_workflow_name}' +workflowPlanFile: '{targetWorkflowPath}/workflow-plan-{new_workflow_name}.md' +nextStepFile: './step-11-completion.md' +validationWorkflow: '{targetWorkflowPath}/steps-v/step-01-validate.md' +--- + +# Step 10: Confirmation + +## STEP GOAL: + +Confirm the workflow build is complete by checking plan metadata. If this is a conversion, verify all original workflow elements are covered. If new, validate all plan requirements were met. + +## MANDATORY EXECUTION RULES (READ FIRST): + +### Universal Rules: + +- 🛑 NEVER skip reading the plan file completely +- 📖 CRITICAL: Read the complete step file before taking any action +- 📋 YOU ARE A FACILITATOR, not an autonomous converter +- ✅ YOU MUST ALWAYS SPEAK OUTPUT In your Agent communication style with the config `{communication_language}` + +### Role Reinforcement: + +- ✅ You are a workflow quality assurance specialist +- ✅ If you already have been given communication or persona patterns, continue to use those while playing this new role +- ✅ We engage in collaborative dialogue, not command-response +- ✅ You bring thorough review expertise +- ✅ User confirms everything is complete + +### Step-Specific Rules: + +- 🎯 Focus on confirmation and verification +- 🚫 FORBIDDEN to skip checking plan metadata +- 💬 MUST read the entire plan to verify completion +- 📋 Different paths for conversion vs new workflows + +## EXECUTION PROTOCOLS: + +- 🎯 Load and read workflow plan completely +- 💾 Check for conversionFrom metadata field +- 📖 Route to appropriate confirmation path +- 🚫 FORBIDDEN to proceed without verification + +## CONTEXT BOUNDARIES: + +- All build steps are complete +- This is the final verification before completion +- Conversion workflows get coverage check +- New workflows get plan completion check + +## MANDATORY SEQUENCE + +**CRITICAL:** Follow this sequence exactly. Do not skip, reorder, or improvise. + +### 1. Load Workflow Plan + +**Load the workflowPlanFile completely:** + +Read `{workflowPlanFile}` entirely to extract: +- Frontmatter metadata (check for `conversionFrom`) +- Discovery notes +- All requirements from classification, design, tools sections +- Original workflow analysis (if conversion) + +"**Loading workflow plan for confirmation...**" + +### 2. Check Conversion Metadata + +**Examine plan frontmatter for `conversionFrom` field:** + +```yaml +conversionFrom: '{path to source workflow if this is a conversion}' +``` + +**IF conversionFrom EXISTS:** +Route to [Conversion Confirmation](#3-conversion-confirmation-path) + +**ELSE (no conversionFrom):** +Route to [New Workflow Confirmation](#4-new-workflow-confirmation-path) + +--- + +### 3. Conversion Confirmation Path + +**DO NOT BE LAZY - Load and review the ORIGINAL workflow completely:** + +"**This is a workflow conversion. Verifying all original elements are covered...**" + +**Load the original workflow from conversionFrom path:** +- Read EVERY file from the source workflow +- Extract original goal, steps, instructions + +**For each element from the original, verify coverage:** + +#### A. Original Goal Coverage + +"**Original Goal:** {from source} + +**✅ Covered in new workflow:** {how it's covered} + +OR + +**⚠️ Partial coverage:** {what's covered} - {what might be missing} + +OR + +**❌ Not covered:** {explain gap}" + +#### B. Original Step Coverage + +**For EACH step from the original workflow:** + +| Original Step | Purpose | Covered In | Status | +|---------------|---------|------------|--------| +| {step name} | {purpose} | {new step location} | ✅ Full / ⚠️ Partial / ❌ Missing | + +"**Step-by-step coverage:** {count} of {total} steps fully covered" + +#### C. Original Instruction Patterns + +**Review how the original workflow instructed the LLM:** + +"**Original instruction style:** {describe} + +**New workflow instruction style:** {describe} + +**Collaborative patterns preserved:** {yes/no + details} + +**Key LLM instructions covered:** +{List the key instruction patterns and how they're preserved}" + +#### D. Conversion Coverage Summary + +Present findings: + +"**━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━** + +**Conversion Coverage Report** + +**Source:** {conversionFrom} +**Target:** {targetWorkflowPath} + +**Overall Coverage:** {percentage}% + +| Category | Total | Covered | Partial | Missing | +|----------|-------|---------|---------|---------| +| Goal | 1 | 1 | 0 | 0 | +| Steps | {count} | {count} | {count} | {count} | +| Instructions | {count} | {count} | {count} | {count} | +| Output | 1 | 1 | 0 | 0 | + +--- + +**Missing Elements:** {count} +{List any gaps found} + +**Improvements Made:** {count} +{List enhancements beyond original} + +**━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━** + +**Does this coverage look complete? Any gaps to address?** + +[C] Continue - Coverage is complete +[F] Fix gaps - Address missing elements +[R] Review details - See full comparison" + +**Menu Handling Logic:** + +- IF C: Proceed to [Completion Handoff](#5-completion-handoff) +- IF F: Return to build steps to address gaps (route to step-09-build-next-step.md) +- IF R: Present detailed step-by-step comparison, then redisplay menu +- IF Any other: help user respond, then redisplay menu + +--- + +### 4. New Workflow Confirmation Path + +**This is a new workflow (not a conversion). Validate all plan requirements were met.** + +"**Verifying all requirements from the plan were implemented...**" + +#### A. Load Plan Requirements + +**From workflowPlanFile, extract ALL requirements:** + +- Discovery: User's vision, who it's for, what it produces +- Classification: Type, structure, mode decisions +- Requirements: Specific features, inputs, outputs +- Design: Step structure, flow, key decisions +- Tools: Data files, templates, references + +#### B. Verify Each Requirement + +**For EACH requirement from the plan:** + +| Requirement Area | Specified | Implemented | Location | Status | +|------------------|-----------|-------------|----------|--------| +| {area} | {what was specified} | {what was built} | {file/step} | ✅/⚠️/❌ | + +#### C. Plan Completion Summary + +Present findings: + +"**━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━** + +**Plan Completion Report** + +**Workflow:** {new_workflow_name} +**Location:** {targetWorkflowPath} + +**Overall Completion:** {percentage}% + +| Requirement Area | Specified | Implemented | Status | +|------------------|-----------|-------------|--------| +| Discovery Vision | {from plan} | {what was built} | ✅/⚠️ | +| Workflow Type | {from plan} | {what was built} | ✅/⚠️ | +| Structure | {from plan} | {what was built} | ✅/⚠️ | +| Key Features | {from plan} | {what was built} | ✅/⚠️ | +| Data/Tools | {from plan} | {what was built} | ✅/⚠️ | + +--- + +**Missing Requirements:** {count} +{List any unmet requirements} + +**Beyond Plan:** {count} +{List any additional features added during build} + +**━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━** + +**Does this implementation match your vision?** + +[C] Continue - Implementation is complete +[F] Fix gaps - Address missing requirements +[R] Review details - See full comparison" + +**Menu Handling Logic:** + +- IF C: Proceed to [Completion Handoff](#5-completion-handoff) +- IF F: Return to build steps to address gaps (route to step-09-build-next-step.md) +- IF R: Present detailed requirement-by-requirement comparison, then redisplay menu +- IF Any other: help user respond, then redisplay menu + +--- + +### 5. Completion Handoff + +**After user confirms coverage/completion:** + +Update `{workflowPlanFile}` frontmatter: + +```yaml +status: CONFIRMED +confirmationDate: {current date} +confirmationType: {conversion / new_workflow} +coverageStatus: {complete / gaps_accepted} +``` + +Proceed to [Validation Offer](#6-validation-offer). + +--- + +### 6. Validation Offer + +"**✅ Workflow build confirmed!** + +**Before using your workflow, I recommend running extensive validation.** + +The validation phase will systematically check: +- File structure & size +- Frontmatter compliance +- Menu handling patterns +- Step type patterns +- Output format standards +- Instruction style +- Overall quality + +**Would you like to run validation?**" + +Display: **Build Confirmed! Select an Option:** [V] Start Validation [S] Skip - Complete Now + +#### Menu Handling Logic: + +- IF V: "Loading validation phase..." → Save confirmation status, update frontmatter, then load, read entire file, then execute {validationWorkflow} +- IF S: "Skipping validation. Proceeding to completion..." → Load, read entire file, then execute {nextStepFile} +- IF Any other: help user respond, then redisplay menu + +## CRITICAL STEP COMPLETION NOTE + +ALWAYS check plan metadata for conversionFrom field. Route to appropriate confirmation path. Only proceed after user confirms coverage/completion is satisfactory. + +--- + +## 🚨 SYSTEM SUCCESS/FAILURE METRICS + +### ✅ SUCCESS: + +- Plan file loaded completely +- ConversionFrom metadata checked +- Appropriate confirmation path executed +- Original workflow reviewed (if conversion) +- Plan requirements verified (if new) +- Coverage/completion report presented clearly +- User confirms and proceeds + +### ❌ SYSTEM FAILURE: + +- Not loading plan file completely +- Not checking conversionFrom metadata +- Skipping original workflow review (conversion) +- Not verifying plan requirements (new) +- Proceeding without user confirmation +- Missing gaps in coverage + +**Master Rule:** Check conversionFrom metadata first. For conversions, REVIEW THE ORIGINAL COMPLETELY. For new workflows, VERIFY ALL PLAN REQUIREMENTS. Only proceed after user confirms. diff --git a/src/modules/bmb/workflows/workflow/steps-c/step-11-completion.md b/src/modules/bmb/workflows/workflow/steps-c/step-11-completion.md new file mode 100644 index 00000000..efa9fdf1 --- /dev/null +++ b/src/modules/bmb/workflows/workflow/steps-c/step-11-completion.md @@ -0,0 +1,191 @@ +--- +name: 'step-11-completion' +description: 'Complete the workflow creation and provide next steps' + +targetWorkflowPath: '{bmb_creations_output_folder}/workflows/{new_workflow_name}' +workflowPlanFile: '{targetWorkflowPath}/workflow-plan-{new_workflow_name}.md' +--- + +# Step 11: Completion + +## STEP GOAL: + +Complete the workflow creation process with a summary of what was built and next steps guidance. + +## MANDATORY EXECUTION RULES (READ FIRST): + +### Universal Rules: + +- 🛑 NEVER modify the completed workflow at this stage +- 📖 CRITICAL: Read the complete step file before taking any action +- 📋 YOU ARE A FACILITATOR, not a content generator +- ✅ YOU MUST ALWAYS SPEAK OUTPUT In your Agent communication style with the config `{communication_language}` + +### Role Reinforcement: + +- ✅ You are a workflow architect and systems designer +- ✅ If you already have been given communication or persona patterns, continue to use those while playing this new role +- ✅ We engage in collaborative dialogue, not command-response +- ✅ You bring completion expertise +- ✅ User decides next steps + +### Step-Specific Rules: + +- 🎯 Focus ONLY on summary and next steps +- 🚫 FORBIDDEN to modify the built workflow +- 💬 Present options clearly +- 🚪 This is the final step + +## EXECUTION PROTOCOLS: + +- 🎯 Present completion summary +- 💾 Finalize plan document +- 📖 Provide usage guidance +- 🚫 No more modifications at this stage + +## CONTEXT BOUNDARIES: + +- All workflow steps have been built +- Confirmation has been completed +- Validation may or may not have been run +- This is the final step + +## MANDATORY SEQUENCE + +**CRITICAL:** Follow this sequence exactly. Do not skip, reorder, or improvise. + +### 1. Present Completion Summary + +"**━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━** + +# Workflow Creation Complete! + +**Workflow:** {new_workflow_name} +**Location:** {targetWorkflowPath} +**Created:** {current date} + +--- + +## What Was Built + +**Workflow Structure:** +- **Type:** [continuable/single-session] +- **Mode:** [create-only/tri-modal] +- **Steps Created:** [count] + +**Files Created:** +- workflow.md (entry point) +- [count] step files in steps-c/ +- [count] validation files in steps-v/ (if tri-modal) +- [count] edit files in steps-e/ (if tri-modal) +- [count] supporting files in data/ +- [count] templates in templates/ + +--- + +## Your Workflow Is Ready! + +**To use your new workflow:** + +1. Navigate to: {targetWorkflowPath} +2. Load workflow.md to start +3. Follow the step-by-step instructions + +**━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━**" + +### 2. Update Plan with Completion Status + +Update {workflowPlanFile} frontmatter: + +```yaml +--- +workflowName: {new_workflow_name} +creationDate: [original creation date] +completionDate: [current date] +status: COMPLETE +stepsCompleted: ['step-01-discovery' or 'step-00-conversion', 'step-02-classification', 'step-03-requirements', 'step-04-tools', 'step-05-plan-review', 'step-06-design', 'step-07-foundation', 'step-08-build-step-01', 'step-09-build-next-step', 'step-10-confirmation', 'step-11-completion'] +--- +``` + +### 3. Provide Next Steps Guidance + +"**Next Steps:** + +**Test your workflow:** +- Run through it end-to-end +- Try with sample data +- Verify all steps work as expected + +**Get user feedback:** +- If others will use it, have them test +- Gather feedback on facilitation +- Note any friction points + +**Future maintenance:** +- Use validation mode to check compliance +- Use edit mode to make changes +- Validation can be run anytime + +**Resources:** +- **Validate later:** Load {targetWorkflowPath}/workflow.md with -v flag +- **Edit later:** Load {targetWorkflowPath}/workflow.md with -e flag +- **Build more:** Use create workflow mode for new workflows" + +### 4. Conversion-Specific Summary (If Applicable) + +**Check workflowPlanFile frontmatter for `conversionFrom`:** + +**IF this was a conversion:** + +"**Conversion Complete!** + +**Original workflow:** {conversionFrom} +**New location:** {targetWorkflowPath} + +**Preserved:** +- Original goal and purpose +- All {count} steps +- Key instruction patterns +- Output format + +**Improvements made:** +- BMAD compliance +- Better structure +- Enhanced collaboration +- Standards adherence + +**Review the conversion report** in the confirmation step for full details." + +### 5. Final Completion Message + +"**Thank you for using BMAD Workflow Creator!** + +Your workflow **{new_workflow_name}** is complete and ready to use. + +**Workflow location:** {targetWorkflowPath}/workflow.md + +Happy workflowing! ✅" + +## CRITICAL STEP COMPLETION NOTE + +This is the final step. Present completion summary, finalize plan, and provide next steps. No further modifications. + +--- + +## 🚨 SYSTEM SUCCESS/FAILURE METRICS + +### ✅ SUCCESS: + +- Completion summary presented clearly +- Plan finalized with COMPLETE status +- Usage guidance provided +- Conversion specifics noted (if applicable) +- Session ends positively + +### ❌ SYSTEM FAILURE: + +- Not providing clear summary +- Not finalizing plan status +- Missing usage guidance + +**Master Rule:** End on a positive note with clear summary and next steps. The workflow is ready to use. diff --git a/src/modules/bmb/workflows/workflow/steps-e/step-e-01-assess-workflow.md b/src/modules/bmb/workflows/workflow/steps-e/step-e-01-assess-workflow.md new file mode 100644 index 00000000..295b7fa9 --- /dev/null +++ b/src/modules/bmb/workflows/workflow/steps-e/step-e-01-assess-workflow.md @@ -0,0 +1,237 @@ +--- +name: 'step-e-01-assess-workflow' +description: 'Load target workflow, check compliance, check for validation report, offer validation if needed' + +# File References +nextStepFile: './step-e-02-discover-edits.md' +editPlan: '{bmb_creations_output_folder}/edit-plan-{workflow_name}.md' +validationWorkflow: '../steps-v/step-01-validate.md' +conversionStep: '../steps-c/step-00-conversion.md' +--- + +# Edit Step 1: Assess Workflow + +## STEP GOAL: + +Load the target workflow, check if it follows BMAD step-file architecture, check for existing validation report, and offer to run validation if needed. + +## MANDATORY EXECUTION RULES (READ FIRST): + +### Universal Rules: + +- 📖 CRITICAL: Read the complete step file before taking any action +- 📋 YOU ARE A FACILITATOR, not an autonomous editor +- ✅ YOU MUST ALWAYS SPEAK OUTPUT In your Agent communication style with the config `{communication_language}` + +### Step-Specific Rules: + +- 🎯 Focus ONLY on assessment - no editing yet +- 🚫 FORBIDDEN to proceed without loading workflow completely +- 💬 Explain findings clearly and get user confirmation +- 🚪 ROUTE non-compliant workflows to create flow + +## EXECUTION PROTOCOLS: + +- 🎯 Load and analyze target workflow +- 💾 Create edit plan document +- 📖 Check for validation report +- 🚫 FORBIDDEN to proceed without user confirmation + +## CONTEXT BOUNDARIES: + +- User provides workflow path from workflow.md routing +- Focus: Assessment and routing +- This is NOT about making changes yet + +## MANDATORY SEQUENCE + +**CRITICAL:** Follow this sequence exactly. Do not skip or shortcut. + +### 1. Get Workflow Path + +From the user input provided by workflow.md routing, extract: +- `targetWorkflowPath` - path to workflow.md file +- `workflowName` - derived from path + +**If path was not provided:** + +"Which workflow would you like to edit? Please provide the path to the workflow.md file." + +### 2. Load Workflow Completely + +**Load these files:** + +1. `{targetWorkflowPath}/workflow.md` - Must exist - if the user indicates is something else, ask if this is a conversion to the compliant v6 format +2. Check for step folders: `steps*` +3. Check for `data/` folder +4. Check for `templates/` folder + +### 3. Compliance Check + +**Determine if workflow is BMAD-compliant:** + +**Compliant workflow has:** +- ✅ workflow.md file exists at root +- ✅ At least one step folder exists (steps-c/, steps-v/, or steps-e/) +- ✅ Step files use markdown format (.md) +- ✅ workflow.md has frontmatter (name, description) + +**Non-compliant workflow:** +- ❌ No workflow.md file +- ❌ Has workflow.yaml or instructions.md (legacy format) +- ❌ No step folders +- ❌ Step files are not markdown + +### 4. Route Based on Compliance + +**IF NON-COMPLIANT:** + +"**Workflow Assessment Result: Non-Compliant Format** + +I found that this workflow does not follow BMAD step-file architecture: +- [Describe what was found - e.g., legacy format, missing workflow.md, etc.] + +**Recommendation:** This workflow should be converted using the create workflow process. The create workflow can use your existing workflow as input discovery material to build a new compliant workflow. + +**Would you like to:** + +1. **[C]onvert to Compliant Workflow** - Use existing workflow as input to build compliant version +2. **[E]xplore manual conversion** - I can explain what needs to change +3. **[X] Exit** - Cancel this operation + +#### Menu Handling Logic: + +- IF C: Route to create workflow conversion mode → Load {conversionStep} with sourceWorkflowPath set to {targetWorkflowPath} +- IF E: Explain conversion requirements, then redisplay menu +- IF X: Exit with guidance +- IF Any other: help user, then redisplay menu" + +**IF COMPLIANT:** + +"**Workflow Assessment Result: Compliant Format** + +This workflow follows BMAD step-file architecture: +- ✅ workflow.md found +- ✅ Step folders: [list which ones exist] +- ✅ Data folder: [yes/no] +- ✅ Templates folder: [yes/no]" + +Continue to step 5. + +### 5. Check for Validation Report + +**Look for validation report:** +- Check `{targetWorkflowPath}/validation-report-{workflow_name}.md` +- Check if report exists and read completion status + +**IF NO VALIDATION REPORT EXISTS:** + +"This workflow has not been validated yet. + +**Recommendation:** Running validation first can help identify issues before editing. Would you like to: + +1. **[V]alidate first** - Run comprehensive validation, then proceed with edits +2. **[S]kip validation** - Proceed directly to editing + +#### Menu Handling Logic: + +- IF V: Load, read entirely, then execute {validationWorkflow}. After validation completes, return to this step and proceed to step 6. +- IF S: Proceed directly to step 6 (Discover Edits) +- IF Any other: help user, then redisplay menu" + +**IF VALIDATION REPORT EXISTS:** + +Read the validation report and note: +- Overall status (COMPLETE/INCOMPLETE) +- Critical issues count +- Warning issues count + +"**Existing Validation Report Found:** + +- Status: [status] +- Critical Issues: [count] +- Warnings: [count] + +I'll keep this report in mind during editing." + +Continue to step 6. + +### 6. Create Edit Plan Document + +**Initialize edit plan:** + +```markdown +--- +mode: edit +targetWorkflowPath: '{targetWorkflowPath}' +workflowName: '{workflow_name}' +editSessionDate: '{current-date}' +stepsCompleted: + - step-e-01-assess-workflow.md +hasValidationReport: [true/false] +validationStatus: [from report if exists] +--- + +# Edit Plan: {workflow_name} + +## Workflow Snapshot + +**Path:** {targetWorkflowPath} +**Format:** BMAD Compliant ✅ +**Step Folders:** [list found] + +## Validation Status + +[If report exists: summary of validation status] +[If no report: No validation run yet] + +--- + +## Edit Goals + +*To be populated in next step* + +--- + +## Edits Applied + +*To track changes made* +``` + +Write to `{editPlan}`. + +### 7. Present MENU OPTIONS + +Display: "**Assessment Complete. Select an Option:** [C] Continue to Discovery" + +#### Menu Handling Logic: + +- IF C: Update editPlan, then load, read entire file, then execute {nextStepFile} +- IF Any other: help user respond, then redisplay menu + +## CRITICAL STEP COMPLETION NOTE + +ONLY WHEN user selects [C] and edit plan is created, will you then load and read fully `{nextStepFile}` to execute and begin edit discovery. + +--- + +## 🚨 SYSTEM SUCCESS/FAILURE METRICS + +### ✅ SUCCESS: + +- Workflow loaded completely +- Compliance status determined +- Non-compliant workflows routed to create flow +- Edit plan document created +- Validation report checked +- User confirmed to proceed + +### ❌ SYSTEM FAILURE: + +- Not loading workflow completely +- Misclassifying non-compliant workflow as compliant +- Not routing non-compliant to create flow +- Not checking for validation report +- Not creating edit plan + +**Master Rule:** Assessment must be thorough. Non-compliant workflows MUST be routed to create flow. Always check for validation report before editing. diff --git a/src/modules/bmb/workflows/workflow/steps-e/step-e-02-discover-edits.md b/src/modules/bmb/workflows/workflow/steps-e/step-e-02-discover-edits.md new file mode 100644 index 00000000..d54a9a50 --- /dev/null +++ b/src/modules/bmb/workflows/workflow/steps-e/step-e-02-discover-edits.md @@ -0,0 +1,248 @@ +--- +name: 'step-e-02-discover-edits' +description: 'Discover what user wants to change - fix validation issues, make changes, or both' + +# File References +nextStepFile: './step-e-03-fix-validation.md' +directEditStep: './step-e-04-direct-edit.md' +editPlan: '{bmb_creations_output_folder}/edit-plan-{workflow_name}.md' +targetWorkflowPath: '{targetWorkflowPath}' +validationReport: '{targetWorkflowPath}/validation-report-{workflow_name}.md' +--- + +# Edit Step 2: Discover Edits + +## STEP GOAL: + +Discover what the user wants to do: fix validation issues, make specific changes, or both. Document edit goals in the edit plan. + +## MANDATORY EXECUTION RULES (READ FIRST): + +### Universal Rules: + +- 🛑 NEVER assume what edits are needed +- 📖 CRITICAL: Read the complete step file before taking any action +- 📋 YOU ARE A FACILITATOR, not an autonomous editor +- ✅ YOU MUST ALWAYS SPEAK OUTPUT In your Agent communication style with the config `{communication_language}` + +### Step-Specific Rules: + +- 🎯 Focus ONLY on understanding edit goals +- 🚫 FORBIDDEN to make any modifications yet +- 💬 Ask clarifying questions +- 🚪 CATEGORIZE edits by type + +## EXECUTION PROTOCOLS: + +- 🎯 Guide discovery conversation +- 💾 Document edit goals in edit plan +- 📖 Determine which next step to load +- 🚫 FORBIDDEN to proceed without user confirmation + +## CONTEXT BOUNDARIES: + +- Edit plan from previous step provides context +- Validation report (if exists) provides issues to fix +- Focus: What does user want to change? +- This is discovery, not implementation + +## MANDATORY SEQUENCE + +**CRITICAL:** Follow this sequence exactly. Do not skip or shortcut. + +### 1. Read Edit Plan Context + +**Load the editPlan file:** +Read `{editPlan}` to understand the workflow context and validation status. + +### 2. Determine Discovery Approach + +**IF validation report exists AND has issues:** + +Present fix-or-change options (step 3a) + +**ELSE (no validation report or no issues):** + +Present direct change options (step 3b) + +--- + +### 3a. Discovery With Validation Issues + +**IF validation report exists with issues:** + +"**I found an existing validation report for this workflow.** + +**Validation Summary:** +- Status: {status from report} +- Critical Issues: {count} +- Warnings: {count} + +**What would you like to do?** + +**[F]ix Validation Issues** - Systematically fix issues found in validation +**[C]hange Something** - Make a specific change (add feature, modify step, etc.) +**[B]oth** - Fix validation issues, then make a change +**[R]eview Report** - See detailed validation findings first + +#### Menu Handling Logic: + +- IF F: Proceed to [Document Fix Goals](#4-document-fix-goals), then route to {nextStepFile} +- IF C: Proceed to [Document Change Goals](#3b-discovery-for-direct-change) +- IF B: Document both fix and change goals, then route to {nextStepFile} for fixes first +- IF R: Present key findings from validation report, then redisplay this menu +- IF Any other: help user, then redisplay menu" + +--- + +### 3b. Discovery For Direct Change + +**IF no validation report or no issues:** + +"**What would you like to change about this workflow?** + +I can help you modify: + +**[W]orkflow.md** - Goal, role, initialization, routing +**[S]tep Files** - Add, remove, or modify steps +**[D]ata Files** - Add or modify reference data in data/ folder +**[T]emplates** - Add or modify output templates +**[M]ultiple** - Changes across multiple areas +**[O]ther** - Something else + +Which areas would you like to edit?" + +#### For Each Selected Category: + +**If Workflow.md selected:** +- "What aspects need change?" + - Goal or description? + - Role definition? + - Architecture principles? + - Initialization/routing? + +**If Step Files selected:** +- "What type of step changes?" + - Add new step? + - Remove existing step? + - Modify step content? + - Reorder steps? + +**If Data Files selected:** +- "What data changes?" + - Add new data file? + - Modify existing data? + - Add/remove data entries? + +**If Templates selected:** +- "What template changes?" + - Add new template? + - Modify template structure? + - Change variable references?" + +**If Multiple selected:** +- Walk through each area systematically + +**If Other selected:** +- "Describe what you'd like to change..." + +--- + +### 4. Document Fix Goals (For Validation Issues) + +**Append to editPlan:** + +```markdown +## Edit Goals + +### Fix Validation Issues + +**Priority: High** - These issues prevent compliance + +**Critical Issues to Fix:** +- [ ] {issue from validation report} +- [ ] {issue from validation report} + +**Warnings to Address:** +- [ ] {warning from validation report} +- [ ] {warning from validation report} +``` + +--- + +### 5. Document Change Goals + +**Append to editPlan:** + +```markdown +### Direct Changes + +**Category:** [workflow.md / step files / data / templates / other] + +**Changes Requested:** +- [ ] {specific change description} +- [ ] {specific change description} + +**Rationale:** +{user's explanation of why this change is needed} +``` + +--- + +### 6. Confirm and Route + +**Present summary for confirmation:** + +"**Here's what I heard you want to do:** + +{Summarize all edit goals clearly} + +**Did I capture everything correctly?** + +- [C] Yes, continue +- [M] Modify the plan +- [X] Cancel" + +#### Menu Handling Logic: + +- IF C: Update editPlan stepsCompleted, then route based on goals: + - **If Fix goals only**: Load, read entirely, then execute {nextStepFile} (fix-validation) + - **If Change goals only**: Load, read entirely, then execute {directEditStep} + - **If Both**: Load, read entirely, then execute {nextStepFile} (fix first, then direct edit after) +- IF M: Return to relevant discovery section +- IF X: Exit with explanation +- IF Any other: help user, then redisplay menu + +### 7. Present MENU OPTIONS (Final) + +Display: "**Edit Goals Confirmed. Select an Option:** [C] Continue to Edits" + +#### Menu Handling Logic: + +- IF C: Save editPlan with confirmed goals, then load appropriate next step based on [Route Based on Goals](#6-confirm-and-route) +- IF Any other: help user respond, then redisplay menu + +## CRITICAL STEP COMPLETION NOTE + +ONLY WHEN user confirms goals and routing is determined, will you then load and read fully the appropriate next step file to execute. + +--- + +## 🚨 SYSTEM SUCCESS/FAILURE METRICS + +### ✅ SUCCESS: + +- Edit goals clearly documented +- User confirmed the plan +- Routing determined (fix vs direct vs both) +- Edit plan updated with goals +- Appropriate next step selected + +### ❌ SYSTEM FAILURE: + +- Not documenting edit goals +- Routing to wrong next step +- Not getting user confirmation +- Missing changes user mentioned + +**Master Rule:** Discovery must be thorough. Document all goals. Route correctly based on whether fixes, changes, or both are needed. diff --git a/src/modules/bmb/workflows/workflow/steps-e/step-e-03-fix-validation.md b/src/modules/bmb/workflows/workflow/steps-e/step-e-03-fix-validation.md new file mode 100644 index 00000000..7d4da1c7 --- /dev/null +++ b/src/modules/bmb/workflows/workflow/steps-e/step-e-03-fix-validation.md @@ -0,0 +1,252 @@ +--- +name: 'step-e-03-fix-validation' +description: 'Systematically fix validation issues from validation report' + +# File References +nextStepFile: './step-e-05-apply-edit.md' +editPlan: '{bmb_creations_output_folder}/edit-plan-{workflow_name}.md' +targetWorkflowPath: '{targetWorkflowPath}' +validationReport: '{targetWorkflowPath}/validation-report-{workflow_name}.md' + +# Standards References +architecture: '../data/architecture.md' +stepFileRules: '../data/step-file-rules.md' +frontmatterStandards: '../data/frontmatter-standards.md' +menuHandlingStandards: '../data/menu-handling-standards.md' +outputFormatStandards: '../data/output-format-standards.md' +stepTypePatterns: '../data/step-type-patterns.md' +--- + +# Edit Step 3: Fix Validation Issues + +## STEP GOAL: + +Systematically fix all issues identified in the validation report, working through each issue with user approval and loading relevant standards. + +## MANDATORY EXECUTION RULES (READ FIRST): + +### Universal Rules: + +- 🛑 NEVER make changes without user approval +- 📖 CRITICAL: Read the complete step file before taking any action +- 📋 YOU ARE A FACILITATOR, not an autonomous editor +- ✅ YOU MUST ALWAYS SPEAK OUTPUT In your Agent communication style with the config `{communication_language}` + +### Step-Specific Rules: + +- 🎯 Focus on fixing validation issues systematically +- 🚫 FORBIDDEN to skip issues or fix without approval +- 💬 Explain each issue and proposed fix +- 📋 Load relevant standards for each fix type + +## EXECUTION PROTOCOLS: + +- 🎯 Work through issues systematically +- 💾 Document each fix in edit plan +- 📖 Load appropriate standards for each issue type +- 🚫 FORBIDDEN to proceed without user approval for each fix + +## CONTEXT BOUNDARIES: + +- Validation report provides list of issues +- Edit plan documents fix goals +- Focus: Fix each issue with standards adherence +- This is systematic remediation, not creative editing + +## MANDATORY SEQUENCE + +**CRITICAL:** Follow this sequence exactly. Do not skip or shortcut. + +### 1. Read Context Files + +**Load these files first:** +1. `{editPlan}` - Review fix goals +2. `{validationReport}` - Get full list of issues + +### 2. Organize Issues by Type + +**From validation report, categorize issues:** + +| Issue Type | Standard File | Count | +|------------|---------------|-------| +| workflow.md violations | {architecture} | | +| Step file structure | {stepFileRules} | | +| Frontmatter issues | {frontmatterStandards} | | +| Menu handling | {menuHandlingStandards} | | +| Output format | {outputFormatStandards} | | +| Step type issues | {stepTypePatterns} | | + +### 3. Work Through Issues Systematically + +**For EACH issue in order of severity (Critical → Warning):** + +#### A. Load Relevant Standard + +**Before proposing fix, load the relevant standard file:** +- If workflow.md issue → Load {architecture} +- If step file issue → Load {stepFileRules} +- If frontmatter issue → Load {frontmatterStandards} +- If menu issue → Load {menuHandlingStandards} +- If output issue → Load {outputFormatStandards} +- If step type issue → Load {stepTypePatterns} + +#### B. Explain the Issue + +"**Issue: [{issue type}] {file}:{location if applicable}** + +**What the validation found:** +{Quote the validation finding} + +**Why this is a problem:** +{Explain the impact based on the standard} + +**Standard reference:** +{Cite the specific standard from the loaded file}" + +#### C. Propose Fix + +"**Proposed fix:** +{Specific change needed} + +**This will:** +- ✅ Fix the compliance issue +- ✅ Align with: {specific standard} +- ⚠️ Potential impact: {any side effects} + +**Should I apply this fix?**" + +#### D. Get User Approval + +Wait for user response: +- **Yes/Y** - Apply the fix +- **No/N** - Skip this issue (document why) +- **Modify** - User suggests alternative approach +- **Explain** - Provide more detail + +#### E. Apply Fix (If Approved) + +**Load the target file, make the change:** + +```markdown +**Applying fix to: {file}** + +**Before:** +{show relevant section} + +**After:** +{show modified section} + +**Fix applied.** ✅" +``` + +**Update editPlan:** +```markdown +### Fixes Applied + +**[{issue type}]** {file} +- ✅ Fixed: {description} +- Standard: {standard reference} +- User approved: Yes +``` + +### 4. Handle Skip/Modify Responses + +**IF user skips an issue:** + +"**Issue skipped.** + +Documenting in edit plan: +- [{issue type}] {file} - SKIPPED per user request +- Reason: {user's reason if provided} + +**Note:** This issue will remain in the validation report. + +Continue to next issue?" + +**IF user wants to modify the fix:** + +Discuss alternative approach, get agreement, then apply modified fix. + +### 5. After All Issues Complete + +**Present summary:** + +"**Validation Fix Summary:** + +**Total Issues Found:** {count} +**Fixed:** {count} +**Skipped:** {count} +**Modified:** {count} + +**Remaining Issues:** {list any skipped or remaining warnings} + +**Files Modified:** +- {file1} +- {file2} +- etc." + +### 6. Check for Direct Edit Goals + +**Load editPlan and check:** + +**IF edit plan includes direct change goals (beyond validation fixes):** + +"Your edit plan also includes direct changes. After we apply these validation fixes, we'll proceed to those changes." + +Update editPlan frontmatter: +```yaml +validationFixesComplete: true +``` + +Then route to {nextStepFile} for direct edits. + +**ELSE (no direct changes - validation fixes only):** + +"Validation fixes are complete! Would you like to: + +1. **[R]e-run validation** - Verify all fixes are working +2. **[C]omplete** - Finish editing with these fixes +3. **[M]ake additional changes** - Add more edits" + +#### Menu Handling Logic: + +- IF R: Run validation workflow, then return to this step +- IF C: Route to step-e-07-complete.md +- IF M: Route to step-e-02-discover-edits.md +- IF Any other: help user, then redisplay menu + +### 7. Present MENU OPTIONS (If Proceeding) + +Display: "**Validation Fixes Applied. Select an Option:** [C] Continue" + +#### Menu Handling Logic: + +- IF C: Update editPlan stepsCompleted, then load, read entirely, then execute appropriate next step +- IF Any other: help user respond, then redisplay menu + +## CRITICAL STEP COMPLETION NOTE + +ONLY WHEN all validation issues are addressed (fixed, skipped, or documented) and user confirms, will you then route to the appropriate next step. + +--- + +## 🚨 SYSTEM SUCCESS/FAILURE METRICS + +### ✅ SUCCESS: + +- All issues presented to user systematically +- Relevant standards loaded for each issue +- User approval obtained for each fix +- Fixes applied correctly +- Edit plan updated with all changes +- Files properly modified + +### ❌ SYSTEM FAILURE: + +- Skipping issues without user approval +- Not loading relevant standards +- Making changes without user confirmation +- Not documenting fixes in edit plan +- Applying fixes incorrectly + +**Master Rule:** Work through issues systematically. Load standards for each issue type. Get explicit approval before applying any fix. diff --git a/src/modules/bmb/workflows/workflow/steps-e/step-e-04-direct-edit.md b/src/modules/bmb/workflows/workflow/steps-e/step-e-04-direct-edit.md new file mode 100644 index 00000000..96f8d71c --- /dev/null +++ b/src/modules/bmb/workflows/workflow/steps-e/step-e-04-direct-edit.md @@ -0,0 +1,275 @@ +--- +name: 'step-e-04-direct-edit' +description: 'Apply direct user-requested changes to workflow' + +# File References +nextStepFile: './step-e-05-apply-edit.md' +editPlan: '{bmb_creations_output_folder}/edit-plan-{workflow_name}.md' +targetWorkflowPath: '{targetWorkflowPath}' + +# Standards References +architecture: '../data/architecture.md' +stepFileRules: '../data/step-file-rules.md' +frontmatterStandards: '../data/frontmatter-standards.md' +menuHandlingStandards: '../data/menu-handling-standards.md' +outputFormatStandards: '../data/output-format-standards.md' +stepTypePatterns: '../data/step-type-patterns.md' +workflowTypeCriteria: '../data/workflow-type-criteria.md' +inputDiscoveryStandards: '../data/input-discovery-standards.md' +csvDataFileStandards: '../data/csv-data-file-standards.md' +intentVsPrescriptive: '../data/intent-vs-prescriptive-spectrum.md' +--- + +# Edit Step 4: Direct Edit + +## STEP GOAL: + +Apply direct user-requested changes to the workflow, loading relevant standards and checking for non-compliance during editing. + +## MANDATORY EXECUTION RULES (READ FIRST): + +### Universal Rules: + +- 🛑 NEVER make changes without user approval +- 📖 CRITICAL: Read the complete step file before taking any action +- 📋 YOU ARE A FACILITATOR, not an autonomous editor +- ✅ YOU MUST ALWAYS SPEAK OUTPUT In your Agent communication style with the config `{communication_language}` + +### Step-Specific Rules: + +- 🎯 Focus on user-requested changes +- 🚫 FORBIDDEN to make changes without approval +- 💬 Check for non-compliance while editing +- 📋 Load relevant standards for each change type + +## EXECUTION PROTOCOLS: + +- 🎯 Work through each requested change +- 💾 Document each change in edit plan +- 📖 Load appropriate standards for each change type +- 🚫 IF non-compliance found: offer to fix before proceeding + +## CONTEXT BOUNDARIES: + +- Edit plan contains direct change goals +- Focus: Apply user's requested changes +- Must check for compliance issues during edits + +## MANDATORY SEQUENCE + +**CRITICAL:** Follow this sequence exactly. Do not skip or shortcut. + +### 1. Read Edit Plan + +**Load the editPlan:** +Read `{editPlan}` to review direct change goals from step 2. + +### 2. For Each Direct Change Goal + +**Work through each change systematically:** + +#### A. Identify Change Type and Load Standards + +**For workflow.md changes:** +- Load {architecture} + +**For step file changes:** +- Load {stepFileRules} +- Load {stepTypePatterns} +- Load {intentVsPrescriptive} + +**For frontmatter changes:** +- Load {frontmatterStandards} + +**For menu changes:** +- Load {menuHandlingStandards} + +**For output/template changes:** +- Load {outputFormatStandards} + +**For data file changes:** +- Load {csvDataFileStandards} + +**For workflow type changes:** +- Load {workflowTypeCriteria} + +**For discovery/input changes:** +- Load {inputDiscoveryStandards} + +#### B. Load Target File and Check Compliance + +**Load the file to be edited and review against standards:** + +"**Loading: {filename}** +**Standard: {standard file loaded}** + +**Checking file against standards before making your change...**" + +**IF NON-COMPLIANCE FOUND:** + +"**⚠️ Compliance Issue Detected** + +Before I apply your change, I noticed this file is not fully compliant with {standard}: + +**Issue:** {describe the non-compliance} + +**This could cause:** {explain impact} + +**Should I fix this compliance issue before applying your change?** + +1. **[F]ix first** - Fix compliance, then apply your change +2. **[C]ontinue anyway** - Apply your change without fixing +3. **[E]xplain more** - More details about the issue + +#### Menu Handling Logic: + +- IF F: Fix compliance first, then proceed to apply change +- IF C: Document user accepted risk, proceed with change +- IF E: Provide more details, then redisplay menu +- IF Any other: help user, then redisplay menu" + +**IF COMPLIANT:** + +"**File is compliant.** Proceeding with your change." + +#### C. Present Current State and Proposed Change + +"**Current state of: {filename}** + +{show relevant section} + +**Your requested change:** +{summarize the change from edit plan} + +**Proposed modification:** +{show how the change will be made} + +**Should I apply this change?**" + +Wait for user approval. + +#### D. Apply Change (If Approved) + +**Load the file, make the change:** + +```markdown +**Applying change to: {filename}** + +**Before:** +{show relevant section} + +**After:** +{show modified section} + +**Change applied.** ✅" +``` + +**Update editPlan:** +```markdown +### Direct Changes Applied + +**[{change type}]** {filename} +- ✅ Changed: {description} +- User approved: Yes +- Compliance check: Passed/Fixed/Accepted risk +``` + +### 3. Handle Common Change Patterns + +#### Adding a New Step + +1. Load {stepFileRules}, {stepTypePatterns}, {intentVsPrescriptive} +2. Check existing step numbering +3. Determine appropriate step type +4. Create step file with proper structure +5. Update nextStepFile references in adjacent steps +6. Verify menu handling compliance + +#### Removing a Step + +1. Load {architecture} +2. Check if step is referenced by other steps +3. Update nextStepFile in previous step +4. Confirm with user about impact +5. Remove step file +6. Verify no broken references + +#### Modifying workflow.md + +1. Load {architecture} +2. Check for progressive disclosure compliance (no step listings!) +3. Update goal/role/routing as requested +4. Ensure last section is routing +5. Verify frontmatter completeness + +#### Adding/Modifying Data Files + +1. Load {csvDataFileStandards} +2. Check file size (warn if >500 lines) +3. Verify CSV format if applicable +4. Ensure proper headers +5. Update step frontmatter references + +#### Adding/Modifying Templates + +1. Load {outputFormatStandards} +2. Determine template type +3. Ensure variable consistency +4. Update step frontmatter references + +### 4. After All Changes Complete + +**Present summary:** + +"**Direct Edit Summary:** + +**Total Changes Requested:** {count} +**Applied:** {count} +**Skipped:** {count} +**Modified:** {count} + +**Compliance Issues Found During Editing:** {count} +- Fixed: {count} +- User accepted risk: {count} + +**Files Modified:** +- {file1} +- {file2} +- etc." + +### 5. Present MENU OPTIONS + +Display: "**Direct Edits Applied. Select an Option:** [C] Continue" + +#### Menu Handling Logic: + +- IF C: Update editPlan stepsCompleted, then load, read entirely, then execute {nextStepFile} +- IF Any other: help user respond, then redisplay menu + +## CRITICAL STEP COMPLETION NOTE + +ONLY WHEN all direct changes are applied (or documented) and user confirms, will you then load and read fully `{nextStepFile}` to execute. + +--- + +## 🚨 SYSTEM SUCCESS/FAILURE METRICS + +### ✅ SUCCESS: + +- All requested changes presented to user +- Relevant standards loaded for each change +- Compliance checked before each change +- User approval obtained for each change +- Non-compliance found and offered fix +- Changes applied correctly +- Edit plan updated + +### ❌ SYSTEM FAILURE: + +- Not loading relevant standards +- Not checking compliance before editing +- Making changes without user approval +- Missing non-compliance issues +- Not documenting changes + +**Master Rule:** Load standards for each change type. Check compliance BEFORE applying changes. Offer to fix non-compliance when found. diff --git a/src/modules/bmb/workflows/workflow/steps-e/step-e-05-apply-edit.md b/src/modules/bmb/workflows/workflow/steps-e/step-e-05-apply-edit.md new file mode 100644 index 00000000..00b55fbc --- /dev/null +++ b/src/modules/bmb/workflows/workflow/steps-e/step-e-05-apply-edit.md @@ -0,0 +1,154 @@ +--- +name: 'step-e-05-apply-edit' +description: 'Offer validation after edits, complete or continue editing' + +# File References +nextStepFile: './step-e-06-validate-after.md' +completeStep: './step-e-07-complete.md' +editPlan: '{bmb_creations_output_folder}/edit-plan-{workflow_name}.md' +targetWorkflowPath: '{targetWorkflowPath}' +validationWorkflow: '../steps-v/step-01-validate.md' +--- + +# Edit Step 5: Post-Edit Options + +## STEP GOAL: + +Present options after edits are applied: run validation, make more edits, or complete. + +## MANDATORY EXECUTION RULES (READ FIRST): + +### Universal Rules: + +- 📖 CRITICAL: Read the complete step file before taking any action +- 📋 YOU ARE A FACILITATOR, not an autonomous editor +- ✅ YOU MUST ALWAYS SPEAK OUTPUT In your Agent communication style with the config `{communication_language}` + +### Step-Specific Rules: + +- 🎯 Focus on next steps after edits +- 💬 Present clear options +- 🚪 Route based on user choice + +## EXECUTION PROTOCOLS: + +- 🎯 Present post-edit options +- 💾 Update edit plan if needed +- 📖 Route to appropriate next step + +## CONTEXT BOUNDARIES: + +- Edits have been applied (validation fixes, direct changes, or both) +- Focus: What's next? +- This is a routing step + +## MANDATORY SEQUENCE + +**CRITICAL:** Follow this sequence exactly. Do not skip or shortcut. + +### 1. Read Edit Plan + +**Load the editPlan:** +Read `{editPlan}` to understand what edits were applied. + +### 2. Present Edit Summary + +"**Edit Session Summary:** + +**Workflow:** {workflow_name} +**Path:** {targetWorkflowPath} + +**Edits Applied:** +{Summarize from edit plan} + +**Files Modified:** +{List files changed} + +**Compliance Status:** +{Any compliance issues found and fixed} + +--- + +**What would you like to do next?** + +**[V]alidate** - Run comprehensive validation to verify all changes +**[M]ore edits** - Make additional changes +**[C]omplete** - Finish editing (without validation) +**[R]eview changes** - See detailed change log" + +### 3. Menu Handling Logic + +- **IF V:** Load, read entirely, then execute {validationWorkflow}. After validation completes, return to this step. +- **IF M:** Route to step-e-02-discover-edits.md for more changes +- **IF C:** Load, read entirely, then execute {completeStep} +- **IF R:** Present detailed edit log from editPlan, then redisplay this menu +- **IF Any other:** help user respond, then redisplay menu + +### 4. Update Edit Plan (If Completing Without Validation) + +**IF user selects [C] Complete:** + +Update editPlan frontmatter: +```yaml +completionDate: '{current-date}' +validationAfterEdit: skipped +completionStatus: complete_without_validation +``` + +Document in editPlan: +```markdown +## Completion + +**Completed:** {current-date} +**Validation:** Skipped per user request +**Recommendation:** Run validation before using workflow in production +``` + +### 5. Handle Validation Return + +**IF validation was run and completed:** + +Load and review validation report. Present findings: + +"**Validation Complete:** + +**Overall Status:** {status} +**New Issues:** {count} +**Remaining Issues:** {count} + +**Would you like to:** + +1. **[F]ix new issues** - Return to fix-validation step +2. **[M]ore edits** - Make additional changes +3. **[C]omplete** - Finish with current validation status" + +#### Menu Handling Logic: + +- IF F: Route to step-e-03-fix-validation.md +- IF M: Route to step-e-02-discover-edits.md +- IF C: Load, read entirely, then execute {completeStep} +- IF Any other: help user, then redisplay menu + +## CRITICAL STEP COMPLETION NOTE + +This is a routing step. Route user to appropriate next step based on their choice. Always offer validation before completing. + +--- + +## 🚨 SYSTEM SUCCESS/FAILURE METRICS + +### ✅ SUCCESS: + +- Edit summary presented clearly +- All options explained +- User routed to appropriate next step +- Validation offered before completion +- Edit plan updated if completing + +### ❌ SYSTEM FAILURE: + +- Not offering validation +- Routing to wrong step +- Not updating edit plan when completing + +**Master Rule:** Always offer validation after edits. Route correctly based on user choice. diff --git a/src/modules/bmb/workflows/workflow/steps-e/step-e-06-validate-after.md b/src/modules/bmb/workflows/workflow/steps-e/step-e-06-validate-after.md new file mode 100644 index 00000000..b3912f0b --- /dev/null +++ b/src/modules/bmb/workflows/workflow/steps-e/step-e-06-validate-after.md @@ -0,0 +1,190 @@ +--- +name: 'step-e-06-validate-after' +description: 'Run validation after edits and present results' + +# File References +nextStepFile: './step-e-07-complete.md' +fixStep: './step-e-03-fix-validation.md' +editPlan: '{bmb_creations_output_folder}/edit-plan-{workflow_name}.md' +targetWorkflowPath: '{targetWorkflowPath}' +validationWorkflow: '../steps-v/step-01-validate.md' +validationReport: '{targetWorkflowPath}/validation-report-{workflow_name}.md' +--- + +# Edit Step 6: Validate After Edit + +## STEP GOAL: + +Run validation workflow after edits are complete, present results, and offer next steps. + +## MANDATORY EXECUTION RULES (READ FIRST): + +### Universal Rules: + +- 📖 CRITICAL: Read the complete step file before taking any action +- 📋 YOU ARE A FACILITATOR, not an autonomous editor +- ✅ YOU MUST ALWAYS SPEAK OUTPUT In your Agent communication style with the config `{communication_language}` + +### Step-Specific Rules: + +- 🎯 Focus on running validation and presenting results +- 💬 Explain validation outcomes clearly +- 🚪 Route based on validation results + +## EXECUTION PROTOCOLS: + +- 🎯 Execute validation workflow +- 💾 Present results to user +- 📖 Offer next steps based on findings + +## CONTEXT BOUNDARIES: + +- Edits have been applied +- Focus: Verify quality after edits +- This is quality assurance step + +## MANDATORY SEQUENCE + +**CRITICAL:** Follow this sequence exactly. Do not skip or shortcut. + +### 1. Read Edit Plan + +**Load the editPlan:** +Read `{editPlan}` to understand what edits were applied. + +### 2. Execute Validation Workflow + +"**Running comprehensive validation on your edited workflow...** + +**Target:** {targetWorkflowPath} +**Validation scope:** Full workflow compliance check + +This may take a few moments..." + +**Load, read entirely, then execute:** {validationWorkflow} + +### 3. Review Validation Results + +**After validation completes, load the validation report:** + +Read `{validationReport}` and extract: +- Overall status +- Critical issues count +- Warning issues count +- New issues vs pre-existing issues + +### 4. Present Validation Results + +"**Validation Complete!** + +**Overall Assessment:** [PASS/PARTIAL/FAIL] + +**Summary:** +| Category | Before Edits | After Edits | Change | +|----------|--------------|-------------|--------| +| Critical Issues | {count} | {count} | {delta} | +| Warnings | {count} | {count} | {delta} | +| Compliance Score | {score} | {score} | {delta} | + +--- + +**New Issues Found:** {count} +**Issues Fixed:** {count} +**Remaining Issues:** {count} + +--- + +**What would you like to do?**" + +### 5. Menu Options Based on Results + +**IF NEW CRITICAL ISSUES FOUND:** + +"**[F]ix new issues** - Return to fix-validation step to address new critical issues +**[R]eview report** - See detailed validation findings +**[C]omplete anyway** - Finish editing with remaining issues (not recommended)" + +#### Menu Handling Logic: + +- IF F: Load, read entirely, then execute {fixStep} +- IF R: Present detailed findings from validation report, then redisplay this menu +- IF C: Warn user, then if confirmed, load, read entirely, then execute {nextStepFile} +- IF Any other: help user, then redisplay menu + +**IF NO NEW CRITICAL ISSUES (warnings OK):** + +"**[R]eview report** - See detailed validation findings +**[C]omplete** - Finish editing - workflow looks good! +**[M]ore edits** - Make additional changes" + +#### Menu Handling Logic (Issues Found): + +- IF R: Present detailed findings from validation report, then redisplay this menu +- IF C: Load, read entirely, then execute {nextStepFile} +- IF M: Route to step-e-02-discover-edits.md +- IF Any other: help user, then redisplay menu + +**IF FULL PASS (no issues):** + +"**🎉 Excellent! Your workflow is fully compliant!** + +**[C]omplete** - Finish editing +**[R]eview report** - See validation details +**[M]ore edits** - Make additional changes" + +#### Menu Handling Logic (Full Pass): + +- IF C: Load, read entirely, then execute {nextStepFile} +- IF R: Present validation summary, then redisplay this menu +- IF M: Route to step-e-02-discover-edits.md +- IF Any other: help user, then redisplay menu + +### 6. Update Edit Plan + +**Before routing to complete:** + +Update editPlan frontmatter: +```yaml +completionDate: '{current-date}' +validationAfterEdit: complete +finalValidationStatus: {status from validation report} +remainingCriticalIssues: {count} +remainingWarnings: {count} +``` + +Document in editPlan: +```markdown +## Final Validation + +**Validation Date:** {current-date} +**Status:** {status} +**Issues After Editing:** +- Critical: {count} +- Warnings: {count} + +**Recommendation:** {if issues remain, suggest next steps} +``` + +## CRITICAL STEP COMPLETION NOTE + +ALWAYS present validation results clearly. Route based on severity of findings. Update edit plan with final validation status before completing. + +--- + +## 🚨 SYSTEM SUCCESS/FAILURE METRICS + +### ✅ SUCCESS: + +- Validation workflow executed +- Results presented clearly with before/after comparison +- User routed appropriately based on findings +- Edit plan updated with final status + +### ❌ SYSTEM FAILURE: + +- Not running validation +- Not presenting results clearly +- Routing to complete with critical issues without warning +- Not updating edit plan + +**Master Rule:** Always run validation after edits. Present clear before/after comparison. Warn user about remaining issues. diff --git a/src/modules/bmb/workflows/workflow/steps-e/step-e-07-complete.md b/src/modules/bmb/workflows/workflow/steps-e/step-e-07-complete.md new file mode 100644 index 00000000..56ad0552 --- /dev/null +++ b/src/modules/bmb/workflows/workflow/steps-e/step-e-07-complete.md @@ -0,0 +1,206 @@ +--- +name: 'step-e-07-complete' +description: 'Complete the edit session with summary and next steps' + +# File References +editPlan: '{bmb_creations_output_folder}/edit-plan-{workflow_name}.md' +targetWorkflowPath: '{targetWorkflowPath}' +validationReport: '{targetWorkflowPath}/validation-report-{workflow_name}.md' +--- + +# Edit Step 7: Complete + +## STEP GOAL: + +Complete the edit session with a comprehensive summary of changes made and provide next steps guidance. + +## MANDATORY EXECUTION RULES (READ FIRST): + +### Universal Rules: + +- 📖 CRITICAL: Read the complete step file before taking any action +- 📋 YOU ARE A FACILITATOR, not an autonomous editor +- ✅ YOU MUST ALWAYS SPEAK OUTPUT In your Agent communication style with the config `{communication_language}` + +### Step-Specific Rules: + +- 🎯 Focus on summary and completion +- 💬 Present clear change summary +- 🚫 No more edits at this stage + +## EXECUTION PROTOCOLS: + +- 🎯 Generate comprehensive summary +- 💾 Finalize edit plan document +- 📖 Provide next steps guidance + +## CONTEXT BOUNDARIES: + +- All edits are complete +- Focus: Summary and closure +- This is the final step + +## MANDATORY SEQUENCE + +**CRITICAL:** Follow this sequence exactly. Do not skip or shortcut. + +### 1. Read Edit Plan and Validation Report + +**Load both files:** +1. `{editPlan}` - Full edit session history +2. `{validationReport}` - Final validation status (if exists) + +### 2. Generate Completion Summary + +"**━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━** + +# Edit Session Complete + +**Workflow:** {workflow_name} +**Path:** {targetWorkflowPath} +**Session Date:** {editSessionDate} + +--- + +## Changes Made + +**Validation Fixes Applied:** {count} +{list from edit plan} + +**Direct Changes Applied:** {count} +{list from edit plan} + +**Files Modified:** +{List all files that were changed} + +--- + +## Final Validation Status + +**Status:** {status from report or 'Not run'} + +**Issues:** +- Critical: {count} +- Warnings: {count} + +--- + +## Edit Session Summary + +Your workflow has been successfully edited. Here's what was accomplished: + +{Summarize the transformation in 2-3 sentences} + +**━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━**" + +### 3. Update Edit Plan with Completion + +**Append final completion section to editPlan:** + +```markdown +## Completion Summary + +**Completed:** {current-date} +**Session Duration:** {from start to end} + +**Total Edits:** {count} +- Validation Fixes: {count} +- Direct Changes: {count} + +**Files Modified:** {count} +**Final Validation Status:** {status} + +**Workflow is ready for:** {use/testing/production with caveats} +``` + +### 4. Provide Next Steps Guidance + +"**Next Steps for Your Workflow:** + +1. **Test the workflow** - Run through the workflow end-to-end to verify changes +2. **Get user feedback** - If this is for others, have them test it +3. **Monitor for issues** - Watch for any problems in actual use +4. **Re-validate periodically** - Run validation again after future changes + +**Resources:** +- Edit this workflow again: Edit workflow mode +- Run validation: Validate workflow mode +- Build new workflow: Create workflow mode + +--- + +**Thank you for using BMAD Workflow Creator!** + +Your edit session for **{workflow_name}** is complete. ✅" + +### 5. Final Confirmation + +"**Edit Session Complete.** + +**[F]inish** - End the edit session +**[S]ave summary** - Save a copy of the edit summary to your output folder +**[R]eview** - Review the full edit plan one more time" + +#### Menu Handling Logic: + +- IF F: End the session +- IF S: Save edit summary to output folder, then end +- IF R: Display full edit plan, then redisplay this menu +- IF Any other: help user, then redisplay menu + +### 6. Save Summary (If Requested) + +**IF user selects [S]ave summary:** + +Create summary file at `{output_folder}/workflow-edit-summary-{workflow_name}-{date}.md`: + +```markdown +# Workflow Edit Summary + +**Workflow:** {workflow_name} +**Path:** {targetWorkflowPath} +**Edit Date:** {current-date} + +## Changes Made + +{All changes from edit plan} + +## Files Modified + +{List with paths} + +## Validation Status + +{Final validation results} + +## Next Steps + +{Recommendations} +``` + +"**Summary saved to:** {output_folder}/workflow-edit-summary-{workflow_name}-{date}.md" + +## CRITICAL STEP COMPLETION NOTE + +This is the final step. Ensure edit plan is complete, summary is presented, and user has all information needed. End session gracefully. + +--- + +## 🚨 SYSTEM SUCCESS/FAILURE METRICS + +### ✅ SUCCESS: + +- Comprehensive summary presented +- All changes documented clearly +- Edit plan finalized +- Next steps guidance provided +- Session ended gracefully + +### ❌ SYSTEM FAILURE: + +- Not summarizing all changes +- Missing files from change list +- Not providing next steps +- Ending without user confirmation + +**Master Rule:** Provide complete summary of all changes. Document everything. Give clear next steps. End on a positive note. diff --git a/src/modules/bmb/workflows/workflow/steps-v/step-01-validate-max-mode.md b/src/modules/bmb/workflows/workflow/steps-v/step-01-validate-max-mode.md new file mode 100644 index 00000000..36624900 --- /dev/null +++ b/src/modules/bmb/workflows/workflow/steps-v/step-01-validate-max-mode.md @@ -0,0 +1,109 @@ +--- +name: 'step-01-validate' +description: 'Initialize validation: create report and check file structure & size' + +parallel-steps: ['./step-01b-structure.md', './step-02-frontmatter-validation.md', './step-02b-path-violations.md', './step-03-menu-validation.md' './step-04-step-type-validation.md', './step-05-output-format-validation.md', './step-06-validation-design-check.md', './step-07-instruction-style-check.md', './step-08-collaborative-experience-check.md', './step-08b-subprocess-optimization.md', './step-09-cohesive-review.md'] +nextStep: './step-10-report-complete.md' +targetWorkflowPath: '{workflow_folder_path}' +workflowPlanFile: '{workflow_folder_path}/workflow-plan.md' +validationReportFile: '{workflow_folder_path}/validation-report-{datetime}.md' +partialValidationFragmentFile: '{workflow_folder_path}/validation-report-{step-name}.md' +stepFileRules: '../data/step-file-rules.md' +--- + +# Validation Step 1: File Structure & Size + +## STEP GOAL: + +To create the validation report that all parallel tasks that this will kick off will be able to report to. + +## MANDATORY EXECUTION RULES (READ FIRST): + +### Universal Rules: + +- 🛑 DO NOT BE LAZY - LOAD AND REVIEW EVERY FILE +- 📖 CRITICAL: Read the complete step file before taking any action +- 🔄 CRITICAL: When loading next step, ensure entire file is read +- ✅ Validation does NOT stop for user input - auto-proceed through all validation steps +- ⚙️ If any instruction references a subprocess, subagent, or tool you do not have access to, you MUST still achieve the outcome in your main context + +### Step-Specific Rules: + +- 🎯 Create validation report with header structure using subprocess optimization when available +- 🚫 DO NOT skip checking any file - DO NOT BE LAZY +- 💬 Subprocess must either update validation report directly OR return structured findings to parent for aggregation +- 🚪 This is validation - systematic and thorough + +## EXECUTION PROTOCOLS: + +- 🎯 Load and check EVERY file in the workflow using subprocess optimization when available - single subprocess for bash/grep operations, separate subprocess per file for size analysis +- 💾 Subprocesses must either update validation report OR return findings for parent aggregation +- 📖 Save report before loading next validation step +- 🚫 DO NOT halt for user input - validation runs to completion + +## MANDATORY SEQUENCE + +**CRITICAL:** Follow this sequence exactly. Do not skip or shortcut. IF there is no subprocess type tool available that can achieve running a process in a subprocess and handle starting multiple - let the user know they need to restart validation specifically NOT using max-parallel mode and HALT and end this workflow! + +### 1. Create Validation Report + +Create {validationReportFile} with header structure: + +```markdown +--- +validationDate: [current date] +workflowName: {new_workflow_name} +workflowPath: {workflow_folder_path} +validationStatus: IN_PROGRESS +--- + +# Validation Report: {new_workflow_name} + +**Validation Started:** [current date] +**Validator:** BMAD Workflow Validation System +**Standards Version:** BMAD Workflow Standards + +{{TOC}} + +{{#each parallel-steps}} +## {{title}} + +{{results}} + +{{/each}} + +``` + +Save the file (without the handlebars output of course) before proceeding. + +### 2. Launch Mass Parallelization and consolidate results! + +Utilizing a subprocess for each step file in {parallel-steps} - complete all of these - with the caveat indication to the subprocess that at the end of the specific step it will not on its own proceed to the nextStep file! + +Critically - instruct that instructions to write out or return results within each subprocess for a step file in the array MUST ensure that it writes it to {partialValidationFragmentFile} file name even though the step file it loads might indicate otherwise! + +Once every process has completed - there should be a separate validation file for each given step. Also - each step should return JUST its results and recommendations to you also. + +### 3. CRITICAL WRITES to the report. + +You MUST now ensure that all results are added to the final cohesive {validationReportFile} following the indicated handlebars sequence - and then after appending each subprocess report to a level 2 section - and the TOC to accurately reflect the documents state using proper markdown linking conventions to the actual heading names you created. + +IF a file is missing or empty from a given subprocess - but it did return to you results - you will append those results - ONLY do this if you cannot access the specific steps file produced or it is empty though. IE File from subprocess is primary, results returned from step complete are backup insurance. + +### 4. Proceed to Completion Step + +ONLY after ensuring all has been written to the final report, let the user know about the final report that is a consolidation - and they can ignore or remove the smaller files or use them as they like to focus on a specific validation (but its all in the master doc), and then proceed to {nextStep}, ensuring that in the {nextStep} it is focused on the {validationReportFile} + +--- + +## 🚨 SYSTEM SUCCESS/FAILURE METRICS + +### ✅ SUCCESS: + +- Validation report created with header structure +- EVERY section of the template is filled in with content from a subprocess that added the results of its area of expertise + +### ❌ SYSTEM FAILURE: + +- Output Report does not exist with content all filled in +- EVERY step listed in {parallel-steps} was not executed in a subprocess and completed with its results captured in output diff --git a/src/modules/bmb/workflows/workflow/steps-v/step-01-validate.md b/src/modules/bmb/workflows/workflow/steps-v/step-01-validate.md new file mode 100644 index 00000000..27325912 --- /dev/null +++ b/src/modules/bmb/workflows/workflow/steps-v/step-01-validate.md @@ -0,0 +1,221 @@ +--- +name: 'step-01-validate' +description: 'Initialize validation: create report and check file structure & size' + +nextStepFile: './step-02-frontmatter-validation.md' +targetWorkflowPath: '{workflow_folder_path}' +workflowPlanFile: '{workflow_folder_path}/workflow-plan.md' +validationReportFile: '{workflow_folder_path}/validation-report-{datetime}.md' +stepFileRules: '../data/step-file-rules.md' +--- + +# Validation Step 1: File Structure & Size + +## STEP GOAL: + +To create the validation report and check that the workflow has correct file structure and all step files are within size limits. + +## MANDATORY EXECUTION RULES (READ FIRST): + +### Universal Rules: + +- 🛑 DO NOT BE LAZY - LOAD AND REVIEW EVERY FILE +- 📖 CRITICAL: Read the complete step file before taking any action +- 🔄 CRITICAL: When loading next step, ensure entire file is read +- ✅ Validation does NOT stop for user input - auto-proceed through all validation steps +- ⚙️ If any instruction references a subprocess, subagent, or tool you do not have access to, you MUST still achieve the outcome in your main context + +### Step-Specific Rules: + +- 🎯 Create validation report with header structure using subprocess optimization when available +- 🚫 DO NOT skip checking any file - DO NOT BE LAZY +- 💬 Subprocess must either update validation report directly OR return structured findings to parent for aggregation +- 🚪 This is validation - systematic and thorough + +## EXECUTION PROTOCOLS: + +- 🎯 Load and check EVERY file in the workflow using subprocess optimization when available - single subprocess for bash/grep operations, separate subprocess per file for size analysis +- 💾 Subprocesses must either update validation report OR return findings for parent aggregation +- 📖 Save report before loading next validation step +- 🚫 DO NOT halt for user input - validation runs to completion + +## MANDATORY SEQUENCE + +**CRITICAL:** Follow this sequence exactly. Do not skip or shortcut. + +### 1. Create Validation Report + +Create {validationReportFile} with header structure: + +```markdown +--- +validationDate: [current date] +workflowName: {new_workflow_name} +workflowPath: {workflow_folder_path} +validationStatus: IN_PROGRESS +--- + +# Validation Report: {new_workflow_name} + +**Validation Started:** [current date] +**Validator:** BMAD Workflow Validation System +**Standards Version:** BMAD Workflow Standards + +--- + +## File Structure & Size + +*Validation in progress...* + +## Frontmatter Validation +*Pending...* + +## Critical Path Violations +*Pending...* + +## Menu Handling Validation +*Pending...* + +## Step Type Validation +*Pending...* + +## Output Format Validation +*Pending...* + +## Validation Design Check +*Pending...* + +## Instruction Style Check +*Pending...* + +## Collaborative Experience Check +*Pending...* + +## Subprocess Optimization Opportunities +*Pending...* + +## Cohesive Review +*Pending...* + +## Plan Quality Validation +*Pending...* + +## Summary +*Pending...* +``` + +### 2. Load File Structure Standards + +Load {stepFileRules} to understand: +- File size limits (<200 recommended, 250 max) +- Required folder structure +- Required files + +### 3. Check Folder Structure + +**Launch a single subprocess that:** + +1. Lists the entire folder structure using bash commands +2. Verifies all required folders and files exist +3. Returns structured findings to parent for aggregation + +```bash +# List folder structure +find {targetWorkflowPath} -type f -name "*.md" | sort +``` + +**Expected structure:** +``` +{targetWorkflowPath}/ +├── workflow.md +├── steps*/ potentially more than one folder like this (such as steps-v, steps-c - the folder name is not critical but should make sense) +│ ├── step-01-init.md +│ ├── step-01b-continue.md (if continuable) +│ ├── step-02-*.md +│ └── ... +├── */ # any other random files - critical will be later ensure its all used - aside from potential documentation for user later. +├── data/ +│ └── [as needed] +└── templates/ + └── [as needed] +``` + +**Check:** +- ✅ workflow.md exists +- ✅ step files are in a well organized folder +- ✅ non step reference files are organized in other folders such as data, templates, or others that make sense for the workflow +- ✅ Folder names make sense + +### 4. Check File Sizes + +**DO NOT BE LAZY - For EACH step file in steps-c/, launch a subprocess that:** + +1. Loads that step file +2. Counts lines and checks against size limits +3. Returns structured findings to parent for aggregation + +**Limits:** +- < 200 lines: ✅ Good +- 200-250 lines: ⚠️ Approaching limit +- > 250 lines: ❌ Exceeds limit + +**Subprocess returns:** File name, line count, status (Good/Approaching limit/Exceeds limit), and any issues found. + +**Subprocess must either:** +- Update validation report directly with findings, OR +- Return structured findings to parent for aggregation into report + +**Document findings in validation report:** +- List all step files checked with their line counts +- Note any files approaching or exceeding size limits (<200 recommended, 250 max) +- Check data and reference files for size issues (large files should be sharded or indexed) +- Identify specific size violations and recommendations + +### 5. Verify File Presence + +From the design in {workflowPlanFile}, verify: +- Every step from design has a corresponding file +- Step files are numbered sequentially +- No gaps in numbering +- Final step exists + +### 6. Append Findings to Report + +Replace the "## File Structure & Size" section in {validationReportFile} with actual findings: + +**Document the following:** +- Folder structure assessment +- Required files presence check +- File size analysis results +- List of any issues found (missing files, extra files, size violations, naming issues) +- Overall validation status (PASS/FAIL/WARNINGS) + +### 7. Save Report and Auto-Proceed + +**CRITICAL:** Save the validation report BEFORE loading next step. + +Then immediately load, read entire file, then execute {nextStepFile}. + +**Display:** +"**File Structure & Size validation complete.** Proceeding to Frontmatter Validation..." + +--- + +## 🚨 SYSTEM SUCCESS/FAILURE METRICS + +### ✅ SUCCESS: + +- Validation report created with header structure +- EVERY file checked for structure and size +- Findings appended to report +- Report saved before proceeding +- Next validation step loaded + +### ❌ SYSTEM FAILURE: + +- Not checking every file +- Skipping size checks +- Not saving report before proceeding +- Halting for user input + +**Master Rule:** Validation is systematic and thorough. DO NOT BE LAZY. Check EVERY file. Auto-proceed through all validation steps. diff --git a/src/modules/bmb/workflows/workflow/steps-v/step-01b-structure.md b/src/modules/bmb/workflows/workflow/steps-v/step-01b-structure.md new file mode 100644 index 00000000..927f03fb --- /dev/null +++ b/src/modules/bmb/workflows/workflow/steps-v/step-01b-structure.md @@ -0,0 +1,152 @@ +--- +name: 'step-01-validate' +description: 'Initialize validation: create report and check file structure & size' + +nextStepFile: './step-02-frontmatter-validation.md' +targetWorkflowPath: '{workflow_folder_path}' +workflowPlanFile: '{workflow_folder_path}/workflow-plan.md' +validationReportFile: '{workflow_folder_path}/validation-report-{datetime}.md' +stepFileRules: '../data/step-file-rules.md' +--- + +# Validation Step 1: File Structure & Size + +## STEP GOAL: + +To create the validation report and check that the workflow has correct file structure and all step files are within size limits. + +## MANDATORY EXECUTION RULES (READ FIRST): + +### Universal Rules: + +- 🛑 DO NOT BE LAZY - LOAD AND REVIEW EVERY FILE +- 📖 CRITICAL: Read the complete step file before taking any action +- 🔄 CRITICAL: When loading next step, ensure entire file is read +- ✅ Validation does NOT stop for user input - auto-proceed through all validation steps +- ⚙️ If any instruction references a subprocess, subagent, or tool you do not have access to, you MUST still achieve the outcome in your main context + +### Step-Specific Rules: + +- 🎯 Create validation report with header structure using subprocess optimization when available +- 🚫 DO NOT skip checking any file - DO NOT BE LAZY +- 💬 Subprocess must either update validation report directly OR return structured findings to parent for aggregation +- 🚪 This is validation - systematic and thorough + +## EXECUTION PROTOCOLS: + +- 🎯 Load and check EVERY file in the workflow using subprocess optimization when available - single subprocess for bash/grep operations, separate subprocess per file for size analysis +- 💾 Subprocesses must either update validation report OR return findings for parent aggregation +- 📖 Save report before loading next validation step +- 🚫 DO NOT halt for user input - validation runs to completion + +## MANDATORY SEQUENCE + +**CRITICAL:** Follow this sequence exactly. Do not skip or shortcut. + +### 1. Check Folder Structure + +**Launch a single subprocess that will do all of the following for items:** + +1. Load {stepFileRules} to understand: +- File size limits (<200 recommended, 250 max) +- Required folder structure +- Required files +2. Lists the entire folder structure using bash commands +3. Verifies all required folders and files exist +4. Returns structured findings to parent for aggregation + +```bash +# List folder structure +find {targetWorkflowPath} -type f -name "*.md" | sort +``` + +**Expected structure:** +``` +{targetWorkflowPath}/ +├── workflow.md +├── steps*/ potentially more than one folder like this (such as steps-v, steps-c - the folder name is not critical but should make sense) +│ ├── step-01-init.md +│ ├── step-01b-continue.md (if continuable) +│ ├── step-02-*.md +│ └── ... +├── */ # any other random files - critical will be later ensure its all used - aside from potential documentation for user later. +├── data/ +│ └── [as needed] +└── templates/ + └── [as needed] +``` + +**Check:** +- ✅ workflow.md exists +- ✅ step files are in a well organized folder +- ✅ non step reference files are organized in other folders such as data, templates, or others that make sense for the workflow +- ✅ Folder names make sense + +### 4. Check File Sizes + +**DO NOT BE LAZY - For EACH step file in steps-c/, launch a subprocess that:** + +1. Loads that step file +2. Counts lines and checks against size limits +3. Returns structured findings to parent for aggregation + +**Limits:** +- < 200 lines: ✅ Good +- 200-300 lines: ⚠️ Approaching limit +- > 300 lines: ❌ Exceeds limit + +**Subprocess returns:** File name, line count, status (Good/Approaching limit/Exceeds limit), and any issues found. + +**Subprocess must either:** +- Update validation report directly with findings, OR +- Return structured findings to parent for aggregation into report + +**Document findings in validation report:** +- List all step files checked with their line counts +- Note any files approaching or exceeding size limits (<200 recommended, 250 max) +- Check data and reference files for size issues (large files should be sharded or indexed) +- Identify specific size violations and recommendations + +### 5. Verify File Presence + +From the design in {workflowPlanFile}, verify: +- Every step from design has a corresponding file +- Step files are numbered sequentially +- No gaps in numbering +- Final step exists + +### 6. Document all findings in a report + +**Document the following:** +- Folder structure assessment +- Required files presence check +- File size analysis results +- List of any issues found (missing files, extra files, size violations, naming issues) +- Overall validation status (PASS/FAIL/WARNINGS) + +### 7. Save Report + +**CRITICAL:** Save the validation report BEFORE COMPLETING THIS STEP + +**Display:** "**File Structure & Size validation complete.**" + +--- + +## 🚨 SYSTEM SUCCESS/FAILURE METRICS + +### ✅ SUCCESS: + +- Validation report created with header structure +- EVERY file checked for structure and size +- Findings appended to report +- Report saved before proceeding +- Next validation step loaded + +### ❌ SYSTEM FAILURE: + +- Not checking every file +- Skipping size checks +- Not saving report before proceeding +- Halting for user input + +**Master Rule:** Validation is systematic and thorough. DO NOT BE LAZY. Check EVERY file. Auto-proceed through all validation steps. diff --git a/src/modules/bmb/workflows/workflow/steps-v/step-02-frontmatter-validation.md b/src/modules/bmb/workflows/workflow/steps-v/step-02-frontmatter-validation.md new file mode 100644 index 00000000..09dde534 --- /dev/null +++ b/src/modules/bmb/workflows/workflow/steps-v/step-02-frontmatter-validation.md @@ -0,0 +1,199 @@ +--- +name: 'step-02-frontmatter-validation' +description: 'Validate frontmatter compliance across all step files' + +nextStepFile: './step-02b-path-violations.md' +targetWorkflowPath: '{workflow_folder_path}' +validationReportFile: '{workflow_folder_path}/validation-report-{datetime}.md' +frontmatterStandards: '../data/frontmatter-standards.md' +--- + +# Validation Step 2: Frontmatter Validation + +## STEP GOAL: + +To validate that EVERY step file's frontmatter follows the frontmatter standards - correct variables, proper relative paths, NO unused variables. + +## MANDATORY EXECUTION RULES (READ FIRST): + +### Universal Rules: + +- 🛑 DO NOT BE LAZY - VALIDATE EVERY FILE'S FRONTMATTER +- 📖 CRITICAL: Read the complete step file before taking any action +- 🔄 CRITICAL: When loading next step, ensure entire file is read +- ✅ Validation does NOT stop for user input - auto-proceed through all validation steps +- ⚙️ If any instruction references a subprocess, subagent, or tool you do not have access to, you MUST still achieve the outcome in your main context thread + +### Step-Specific Rules: + +- 🎯 Validate EVERY step file's frontmatter using subprocess optimization - each file in its own subprocess +- 🚫 DO NOT skip any files or checks - DO NOT BE LAZY +- 💬 Subprocess must either update validation report directly OR return structured findings to parent for aggregation +- 🚪 This is validation - systematic and thorough using per-file deep analysis (Pattern 2) + +## EXECUTION PROTOCOLS: + +- 🎯 Load frontmatter standards first, then validate each file in its own subprocess for deep analysis +- 💾 Subprocesses must either update validation report OR return findings for parent aggregation +- 📖 Aggregate all findings into validation report before loading next step +- 🚫 DO NOT halt for user input - validation runs to completion + +## CONTEXT BOUNDARIES: + +- All step files in the workflow must be validated +- Load {frontmatterStandards} for validation criteria +- Check for: unused variables, non-relative paths, missing required fields, forbidden patterns + +## MANDATORY SEQUENCE + +**CRITICAL:** Follow this sequence exactly. Do not skip or shortcut. + +### 1. Load Frontmatter Standards + +Load {frontmatterStandards} to understand validation criteria. + +**Key Rules:** +1. Only variables USED in the step may be in frontmatter +2. All file references MUST use `{variable}` format +3. Paths within workflow folder MUST be relative - NO `workflow_path` allowed + +**Forbidden Patterns:** +- `workflow_path: '...'` - use relative paths instead +- `thisStepFile: '...'` - remove unless actually referenced in body +- `workflowFile: '...'` - remove unless actually referenced in body +- `./...` - use `./step-XX.md` +- `{workflow_path}/templates/...` - use `../template.md` + +### 2. Validate EVERY Step File - Systematic Algorithm with Subprocess Optimization + +**DO NOT BE LAZY - For EACH step file, launch a subprocess that:** + +1. Loads that file +2. Loads {frontmatterStandards} to understand validation criteria +3. Performs all frontmatter validation checks on that file (extract variables, check usage, validate paths) +4. **EITHER** updates the validation report directly with its findings +5. **OR** returns structured findings to parent for aggregation + +**SUBPROCESS ANALYSIS PATTERN:** + +For each file, the subprocess performs the following deep analysis: + +#### Step 2.1: Extract Frontmatter Variables + +```python +# Algorithm to extract variables from frontmatter: +1. Find content between first `---` and second `---` +2. For each line, extract key before `:` +3. Skip `name`, `description`, and comment lines starting with `#` +4. Collect all variable names +``` + +Example frontmatter: +```yaml +--- +# File References +nextStepFile: './step-02-vision.md' +outputFile: '{planning_artifacts}/product-brief-{{project_name}}.md' +workflow_path: '{project-root}/...' # ❌ FORBIDDEN +thisStepFile: './step-01-init.md' # ❌ Likely unused +--- +``` + +Variables extracted: `nextStepFile`, `outputFile`, `workflow_path`, `thisStepFile` + +#### Step 2.2: Check Each Variable Is Used + +```python +# Algorithm to check variable usage: +for each variable in extracted_variables: + search_body = "{variableName}" # with curly braces + if search_body NOT found in step body (after frontmatter): + MARK_AS_UNUSED(variable) +``` + +**Example:** +- Variable `nextStepFile`: Search body for `{nextStepFile}` → Found in line 166 ✅ +- Variable `thisStepFile`: Search body for `{thisStepFile}` → Not found ❌ VIOLATION + +#### Step 2.3: Check Path Formats + +For each variable containing a file path: + +```python +# Algorithm to validate paths: +if path contains "{workflow_path}": + MARK_AS_VIOLATION("workflow_path is forbidden - use relative paths") + +if path is to another step file: + if not path.startswith("./step-"): + MARK_AS_VIOLATION("Step-to-step paths must be ./filename.md") + +if path is to parent folder template: + if not path.startswith("../"): + MARK_AS_VIOLATION("Parent folder paths must be ../filename.md") + +if path contains "{project-root}" and is internal workflow reference: + MARK_AS_VIOLATION("Internal paths must be relative, not project-root") +``` + +**RETURN FORMAT:** + +Subprocess returns file name, frontmatter compliance status, unused variables found, path violations, and overall status (PASS/FAIL). Include specific variable names and violation details for documentation. + +Check ALL files systematically. Return findings for compilation and appendage to validation report. + +### 3. Aggregate Findings and Document Results + +Document frontmatter validation results in the validation report showing: +- Which files were checked +- Frontmatter compliance status for each file +- Unused variables found in each file +- Path violations detected +- Overall pass/fail status for each file + +### 4. List All Violations + +Document all violations found in the validation report, including: +- Specific files with violations +- Unused variable names and why they're unused +- Forbidden patterns detected with explanation +- Path format violations with details +- Files that passed all checks + +### 5. Append to Report + +Update {validationReportFile} - replace "## Frontmatter Validation *Pending...*" with actual findings. + +### 6. Save Report and Auto-Proceed + +**CRITICAL:** Save the validation report BEFORE loading next step. + +Then immediately load, read entire file, then execute {nextStepFile}. + +**Display:** +"**Frontmatter validation complete.** Proceeding to Menu Handling Validation..." + +--- + +## 🚨 SYSTEM SUCCESS/FAILURE METRICS + +### ✅ SUCCESS: + +- EVERY step file validated using subprocess optimization (Pattern 2: per-file deep analysis) +- Each subprocess validates frontmatter, checks variable usage, validates paths +- Structured findings returned to parent OR report updated directly by subprocesses +- All violations documented with specific variable names +- Findings aggregated into validation report +- Report saved before proceeding +- Next validation step loaded + +### ❌ SYSTEM FAILURE: + +- Not validating every file using subprocess optimization +- Not systematically checking each variable for usage in subprocess +- Missing forbidden pattern detection +- Not documenting violations with specific details +- Not returning structured findings OR updating report from subprocess +- Not saving report before proceeding + +**Master Rule:** Validation is systematic and thorough using subprocess optimization. DO NOT BE LAZY. For EACH file, launch a subprocess that validates frontmatter, checks variable usage, validates paths, and returns findings. Auto-proceed through all validation steps. diff --git a/src/modules/bmb/workflows/workflow/steps-v/step-02b-path-violations.md b/src/modules/bmb/workflows/workflow/steps-v/step-02b-path-violations.md new file mode 100644 index 00000000..cfb442cc --- /dev/null +++ b/src/modules/bmb/workflows/workflow/steps-v/step-02b-path-violations.md @@ -0,0 +1,265 @@ +--- +name: 'step-02b-path-violations' +description: 'CRITICAL: Catch path violations step-02 misses - hardcoded paths, dead links, module awareness' + +nextStepFile: './step-03-menu-validation.md' +targetWorkflowPath: '{workflow_folder_path}' +validationReportFile: '{workflow_folder_path}/validation-report-{datetime}.md' +--- + +# Validation Step 2b: Critical Path Violations + +## STEP GOAL: + +CRITICAL path checks that step-02's frontmatter validation MISSES. This catches violations in CONTENT (not frontmatter), dead links, and module path unawareness using grep/bash (ideally in a subprocess that can update the report or return all results to parent). + +## MANDATORY EXECUTION RULES (READ FIRST): + +### Universal Rules: + +- 🛑 DO NOT BE LAZY - CHECK EVERY FILE +- 📖 CRITICAL: Read the complete step file before taking any action +- 🔄 CRITICAL: When loading next step with 'C', ensure entire file is read +- ✅ Validation does NOT stop for user input - auto-proceed through all validation steps +- ⚙️ If any instruction in this file references a subprocess, subagent, or tool you do not have access to, you MUST still achieve the instructed outcome in your main context thread and available toolset + +### Step-Specific Rules: + +- 🎯 Perform systematic bash/grep checks using subprocess optimization - single subprocess for grep/regex across many files +- 🚫 DO NOT skip any file or violation type - DO NOT BE LAZY +- 💬 Subprocess must either update validation report directly OR return structured findings to parent for aggregation +- 🚪 This catches what step-02 misses - CONTENT violations, dead links, module awareness, links in code and not in front matter + +## EXECUTION PROTOCOLS: + +- 🎯 Perform systematic checks using subprocess optimization when available - single subprocess for grep/regex across many files, separate subprocess per file for deep analysis, subprocess for data file operations +- 💾 Subprocesses must either update validation report OR return findings for parent aggregation +- 📖 Save report before continuing to {nextStepFile} + +## CONTEXT BOUNDARIES: + +- Step-02 validated frontmatter (variables, relative paths) +- This step validates CONTENT and file existence with a Focus on: hardcoded paths in body, dead links, module awareness in every file found under {targetWorkflowPath} +- **CRITICAL:** Output files the workflow itself being validated produces won't exist during validation - a contract document creation workflow might have a reference to said output - but it of course will not yet exist during workflow validation + +## MANDATORY SEQUENCE + +**CRITICAL:** Follow this sequence exactly. Do not skip or shortcut. + +### 1. Perform Critical Path Violation Detection + +**Perform systematic path violation checks on EVERY workflow file using subprocess optimization when available - each file in its own subprocess:** + +**SUBPROCESS EXECUTION PATTERN:** + +For EACH file in the workflow being validated, launch a subprocess that: +1. Loads any reference files it needs (to avoid bloating parent context) +2. Performs all required checks on that file +3. **EITHER** updates the validation report directly with its findings +4. **OR** returns structured findings to parent for aggregation + +**DO NOT BE LAZY - Use appropriate subprocess pattern for each check:** +- **Single subprocess for grep/regex**: Run one command across many files, return matches +- **Separate subprocess per file**: When deep analysis of each file's content is required +- **Subprocess for data operations**: Load reference data, find matches, summarize key findings + +**PHASE 1: Identify Config Variables (EXCEPTIONS to path checks):** + +Read {targetWorkflowPath}/workflow.md to extract known config variables from the Configuration Loading section: + +```bash +# Extract config variables from workflow.md +grep -A 20 "Configuration Loading" {targetWorkflowPath}/workflow.md | grep -E "^\s+-\s+`\{[^}]+\}`" | sed "s/.*//;s/[`']//g" +``` + +**Store these as KNOWN_CONFIG_VARIABLES for reference in later checks.** + +These are EXCEPTIONS - paths using these variables are VALID even if not relative: +- Example: `{output_folder}/doc.md` - VALID (uses config variable) +- Example: `{planning_artifacts}/prd.md` - VALID (uses config variable) +- These paths won't exist during validation (workflow not running yet) + +--- + +**PHASE 2: Hardcoded paths in CONTENT (CRITICAL):** + +Step-02 checks frontmatter - this checks CONTENT (body text after frontmatter). + +**Launch a single subprocess that:** + +1. Runs grep across all step files to find hardcoded {project-root}/ paths in content +2. Extracts content after frontmatter from each file +3. Returns all findings to parent for aggregation + +```bash +# Extract content after frontmatter from all files, search for {project-root}/ +for file in steps-c/*.md; do + awk '/^---$/,0 {if (p) print; p=1} /^---$/{p=1}' "$file" | grep -n "{project-root}/" && echo "Found in: $file" +done +``` + +**What we're catching:** +- Content like: `Load {project-root}/_bmad/foo/workflows/.../file.csv` +- Should be: `Load {dataFile}` (frontmatter variable with a relative path like ../data/file.csv) + +**SKIP:** Paths using KNOWN_CONFIG_VARIABLES (these are valid exceptions) + +--- + +**PHASE 3: Dead or bad links - referenced files don't exist (CRITICAL):** + +**Launch a single subprocess that:** + +1. Extracts all frontmatter path references from all files +2. Tests file existence for each reference (skipping output files that use config variables) +3. Returns all dead link findings to parent for aggregation + +**CRITICAL DISTINCTION:** +- **Output files using config variables:** Skip (won't exist yet - workflow not installed/running) + - Example: `{output_folder}/my-doc.md` - SKIP + - Example: `{planning_artifacts}/prd.md` - SKIP + - Example: `{bmb_creations_output_folder}/file.md` - SKIP + +- **Data files, step files, other workflows:** MUST EXIST - flag if missing + - Example: `{dataFile}` where value is `../data/config.csv` - MUST EXIST + - Example: `{nextStepFile}` where value is `./step-02.md` - MUST EXIST + - Example: `{advancedElicitationTask}` - MUST EXIST + - Example: `{partyModeWorkflow}` - MUST EXIST + +**Bash execution pattern:** +```bash +# Extract all frontmatter path references from all files +for file in steps-c/*.md; do + # Extract file reference variables from frontmatter + grep "^\w*File:" "$file" | sed "s/.*: //" + + # Resolve path (handle relative paths) + resolved_path=$(resolve_relative_path "$file" "$value") + + # Check file existence - BUT SKIP output files using config variables + if ! path_uses_known_config_variable "$value"; then + if ! test -f "$resolved_path"; then + echo "DEAD LINK: $file references $resolved_path (not found)" + fi + fi +done +``` + +**What we're catching:** +- Dead links to any files that don't exist that the workflow needs during execution + +--- + +**PHASE 4: Module path awareness:** + +**Launch a single subprocess that:** + +1. Determines if current workflow is in a non-bmb module +2. If yes, runs grep across all files to find bmb-specific path assumptions +3. Returns all module awareness issues to parent for aggregation + +```bash +# Check if in non-bmb module, then search for bmb-specific paths +if pwd | grep -q "/modules/[^/]\+/" && ! pwd | grep -q "/bmb/"; then + grep -rn "{project-root}/_bmad/bmb/" steps-c/ steps-e/ steps-v/ 2>/dev/null || echo "No bmb-specific paths found" +fi +``` + +--- + +**RETURN FORMAT:** + +```json +{ + "known_config_variables": ["output_folder", "planning_artifacts", "bmb_creations_output_folder", ...], + "content_violations": [ + {"file": "step-v-01-discovery.md", "line": 63, "violation": "hardcoded path in content", "details": "{project-root}/src/modules/.../prd-purpose.md"} + ], + "dead_links": [ + {"file": "step-06-innovation.md", "line": 215, "violation": "dead link", "details": "nextStepFile './step-07-project-type.md' should be './step-07-project-type.md'"} + ], + "module_awareness_issues": [ + {"file": "step-XX.md", "issue": "using bmb-specific path in non-bmb module"} + ], + "summary": {"critical": N, "high": N, "medium": N} +} +``` + +Check ALL files systematically. Return structured report for compilation and appendage to validation report. + +### 2. Process Findings and Update Report + +**Create/Update "Critical Path Violations" section in {validationReportFile}:** + +If ANY violations found: + +```markdown +## Critical Path Violations + +### Config Variables (Exceptions) + +The following config variables were identified from workflow.md Configuration Loading section. +Paths using these variables are valid even if not relative (they reference post-install output locations): + +{list of known_config_variables found} + +### Content Path Violations + +| File | Line | Issue | Details | +| ---- | ---- | ----- | ------- | +{table from content_violations} + +### Dead Links + +| File | Line | Issue | Details | +| ---- | ---- | ----- | ------- | +{table from dead_links} + +**Note:** Output files using config variables were correctly skipped during existence checks. + +### Module Awareness + +{module_awareness_issues} + +### Summary + +- **CRITICAL:** {critical_count} violations (must fix - workflow will break) +- **HIGH:** {high_count} violations (should fix) +- **MEDIUM:** {medium_count} violations (review) + +**Status:** {"❌ FAIL - Critical violations detected" or "⚠️ WARNINGS - Review recommended" or "✅ PASS - No violations"} +``` + +### 3. Handle Critical Violations + +**If CRITICAL violations found (content violations OR dead links):** + +Halt process once all files have been checked and aggregated - and share the severity of the issue with the user and ask them if they want to stop and you can try to fix these now, or else go to the next item in this list. If not proceeding - its still critical all findings thus far are documented in the report output. + +### 4. Save Report and Auto-Proceed + +**CRITICAL:** Save the validation report to {validationReportFile} BEFORE loading and executing {nextStepFile}. + +--- + +## 🚨 SYSTEM SUCCESS/FAILURE METRICS + +### ✅ SUCCESS: + +- Config variables identified from workflow.md FIRST +- Known config variables used as exceptions in later checks +- ALL step files checked for content path violations +- Dead links detected via file existence tests (skipping output files) +- Module awareness issues flagged +- Findings appended to validation report +- CRITICAL violations halt validation +- Clean workflows proceed to step-03 + +### ❌ SYSTEM FAILURE: + +- Not identifying config variables first +- Not skipping output files during existence checks +- Not checking content (only frontmatter) +- Missing dead link detection +- Not detecting module-specific assumptions +- Proceeding despite critical violations diff --git a/src/modules/bmb/workflows/workflow/steps-v/step-03-menu-validation.md b/src/modules/bmb/workflows/workflow/steps-v/step-03-menu-validation.md new file mode 100644 index 00000000..89f7c980 --- /dev/null +++ b/src/modules/bmb/workflows/workflow/steps-v/step-03-menu-validation.md @@ -0,0 +1,164 @@ +--- +name: 'step-03-menu-validation' +description: 'Validate menu handling compliance across all step files' + +nextStepFile: './step-04-step-type-validation.md' +targetWorkflowPath: '{workflow_folder_path}' +validationReportFile: '{workflow_folder_path}/validation-report-{datetime}.md' +menuHandlingStandards: '../data/menu-handling-standards.md' +--- + +# Validation Step 3: Menu Handling Validation + +## STEP GOAL: + +To validate that EVERY step file's menus follow the menu handling standards - proper handlers, execution rules, appropriate menu types. + +## MANDATORY EXECUTION RULES (READ FIRST): + +### Universal Rules: + +- 🛑 DO NOT BE LAZY - LOAD AND REVIEW EVERY FILE +- 📖 CRITICAL: Read the complete step file before taking any action +- 🔄 CRITICAL: When loading next step, ensure entire file is read +- ✅ Validation does NOT stop for user input - auto-proceed through all validation steps +- ⚙️ If any instruction references a subprocess, subagent, or tool you do not have access to, you MUST still achieve the outcome in your main context + +### Step-Specific Rules: + +- 🎯 Validate EVERY step file's menus using subprocess optimization - per-file deep analysis pattern (Pattern 2) +- 🚫 DO NOT skip any files or checks - DO NOT BE LAZY +- 💬 Subprocess must either update validation report directly OR return structured findings to parent for aggregation +- 🚪 This is validation - systematic and thorough, leveraging per-file subprocess for menu structure analysis + +## EXECUTION PROTOCOLS: + +- 🎯 Load menu standards first +- 💾 Check EVERY file's menu structure using subprocess optimization when available - per-file deep analysis for menu structure validation +- 📖 Append findings to validation report (subprocesses either update report OR return findings for parent aggregation) +- 🚫 DO NOT halt for user input - validation runs to completion + +## CONTEXT BOUNDARIES: + +- All step files in steps-c/ must be validated +- Load {menuHandlingStandards} for validation criteria +- Check for: handler section, execution rules, reserved letters, inappropriate A/P + +## MANDATORY SEQUENCE + +**CRITICAL:** Follow this sequence exactly. Do not skip or shortcut. + +### 1. Load Menu Standards + +Load {menuHandlingStandards} to understand validation criteria: + +**Reserved Letters:** A (Advanced Elicitation), P (Party Mode), C (Continue/Accept), X (Exit/Cancel) + +**Required Structure:** +1. Display section +2. Handler section (MANDATORY) +3. Execution Rules section + +**When To Include A/P:** +- DON'T: Step 1 (init), validation sequences, simple data gathering +- DO: Collaborative content creation, user might want alternatives, quality gates + +### 2. Check EVERY Step File + +**DO NOT BE LAZY - For EVERY file in steps-c/, launch a subprocess that:** + +1. Loads that step file +2. Loads {menuHandlingStandards} to understand validation criteria +3. Validates menu structure deeply (handler section, execution rules, A/P appropriateness, reserved letter compliance) +4. **EITHER** updates validation report directly with findings +5. **OR** returns structured validation findings to parent for aggregation + +**SUBPROCESS VALIDATION PATTERN - Each subprocess checks for:** + +**Check 1: Handler Section Exists** +- ✅ Handler section immediately follows Display +- ❌ If missing: mark as violation + +**Check 2: Execution Rules Section Exists** +- ✅ "EXECUTION RULES" section present +- ✅ Contains "halt and wait" instruction +- ❌ If missing: mark as violation + +**Check 3: Non-C Options Redisplay Menu** +- ✅ A/P options specify "redisplay menu" +- ❌ If missing: mark as violation + +**Check 4: C Option Sequence** +- ✅ C option: save → update frontmatter → load next step +- ❌ If sequence wrong: mark as violation + +**Check 5: A/P Only Where Appropriate** +- Step 01 should NOT have A/P (inappropriate for init) +- Validation sequences should auto-proceed, not have menus +- ❌ If A/P in wrong place: mark as violation + +**RETURN FORMAT:** +Each subprocess should return validation findings for its assigned file including: +- File name +- Whether a menu is present +- Results of all 5 checks (handler section, execution rules, redisplay menu, C sequence, A/P appropriateness) +- List of any violations found +- Overall status (PASS/FAIL/WARN) + +**Context savings estimate:** Each subprocess returns structured findings vs full file content. Parent aggregates all findings into final report table. + +### 3. Aggregate Findings and Document Results + +After ALL files have been validated (either via subprocess or main context), document the menu handling validation results in the validation report, including: + +- Overall assessment of menu handling compliance across all step files +- Summary of files checked and their menu status +- Files that passed all menu validation checks +- Files with warnings or issues that need attention +- Files that failed validation with specific violations + +### 4. List Violations + +Compile and document all violations found during validation, organizing them by file and providing clear descriptions of each issue, such as: + +- Missing handler sections +- Incomplete execution rules +- Improper A/P usage +- Missing redisplay menu instructions +- Any other menu handling standard violations + +### 5. Append to Report + +Update {validationReportFile} - replace "## Menu Handling Validation *Pending...*" with actual findings. + +### 6. Save Report and Auto-Proceed + +**CRITICAL:** Save the validation report BEFORE loading next step. + +Then immediately load, read entire file, then execute {nextStepFile}. + +**Display:** +"**Menu Handling validation complete.** Proceeding to Step Type Validation..." + +--- + +## 🚨 SYSTEM SUCCESS/FAILURE METRICS + +### ✅ SUCCESS: + +- Menu standards loaded and understood +- EVERY step file's menus validated via subprocess (per-file deep analysis) OR main context +- All violations documented across handler sections, execution rules, A/P appropriateness +- Findings aggregated into validation report (subprocesses either updated report OR returned findings) +- Report saved before proceeding +- Next validation step loaded + +### ❌ SYSTEM FAILURE: + +- Not checking every file's menus +- Skipping menu structure checks +- Not documenting violations +- Not saving report before proceeding +- Loading full file contents into parent context instead of using subprocess analysis + +**Master Rule:** Validation is systematic and thorough. DO NOT BE LAZY. Use subprocess optimization (Pattern 2) - each file in its own subprocess for deep menu structure analysis. Subprocess returns only findings to parent. Auto-proceed through all validation steps. diff --git a/src/modules/bmb/workflows/workflow/steps-v/step-04-step-type-validation.md b/src/modules/bmb/workflows/workflow/steps-v/step-04-step-type-validation.md new file mode 100644 index 00000000..544ae506 --- /dev/null +++ b/src/modules/bmb/workflows/workflow/steps-v/step-04-step-type-validation.md @@ -0,0 +1,211 @@ +--- +name: 'step-04-step-type-validation' +description: 'Validate that each step follows its correct step type pattern' + +nextStepFile: './step-05-output-format-validation.md' +targetWorkflowPath: '{workflow_folder_path}' +validationReportFile: '{workflow_folder_path}/validation-report-{datetime}.md' +stepTypePatterns: '../data/step-type-patterns.md' +workflowPlanFile: '{workflow_folder_path}/workflow-plan.md' +--- + +# Validation Step 4: Step Type Validation + +## STEP GOAL: + +To validate that each step file follows the correct pattern for its step type - init, continuation, middle, branch, validation, final polish, or final. + +## MANDATORY EXECUTION RULES (READ FIRST): + +### Universal Rules: + +- 🛑 DO NOT BE LAZY - LOAD AND REVIEW EVERY FILE +- 📖 CRITICAL: Read the complete step file before taking any action +- 🔄 CRITICAL: When loading next step, ensure entire file is read +- ✅ Validation does NOT stop for user input - auto-proceed through all validation steps +- ⚙️ If any instruction references a subprocess, subagent, or tool you do not have access to, you MUST still achieve the outcome in your main context + +### Step-Specific Rules: + +- 🎯 Load and validate EVERY step against its type pattern - use subprocess optimization (Pattern 2: per-file deep analysis) when available +- 🚫 DO NOT skip any files or checks - DO NOT BE LAZY +- 💬 Subprocess must either update validation report directly OR return structured findings to parent for aggregation +- 🚪 This is validation - systematic and thorough + +## EXECUTION PROTOCOLS: + +- 🎯 Load step type patterns first (use subprocess for data operations when available) +- 💾 Check EACH file follows its designated type pattern - use per-file subprocesses for deep analysis when available +- 📖 Append findings to validation report (subprocess updates report OR returns findings to parent) +- 🚫 DO NOT halt for user input - validation runs to completion + +## CONTEXT BOUNDARIES: + +- All step files in steps-c/ must be validated +- Load {stepTypePatterns} for pattern definitions +- The design in {workflowPlanFile} specifies what each step should be + +## MANDATORY SEQUENCE + +**CRITICAL:** Follow this sequence exactly. Do not skip or shortcut. + +### 1. Load Step Type Patterns + +**Load {stepTypePatterns} to understand the pattern for each type:** + +**If subprocess capability available:** +```markdown +Launch a subprocess that: +1. Loads {stepTypePatterns} +2. Extracts all pattern definitions deeply +3. Returns summary of patterns to parent (not full file - saves context) +``` + +**If subprocess unavailable:** +```markdown +Load {stepTypePatterns} in main context +# Larger context but still functional - demonstrates graceful fallback +``` + +**Step Types:** +1. **Init (Non-Continuable)** - Auto-proceed, no continuation logic +2. **Init (Continuable)** - Has continueFile reference, continuation detection +3. **Continuation (01b)** - Paired with continuable init, routes based on stepsCompleted +4. **Middle (Standard)** - A/P/C menu, collaborative content +5. **Middle (Simple)** - C only menu, no A/P +6. **Branch** - Custom menu with routing to different steps +7. **Validation Sequence** - Auto-proceed through checks, no menu +8. **Init (With Input Discovery)** - Has inputDocuments array, discovery logic +9. **Final Polish** - Loads entire doc, optimizes flow +10. **Final** - No next step, completion message + +### 2. Check EACH Step Against Its Type + +**DO NOT BE LAZY - For EACH file in steps-c/, launch a subprocess that:** + +1. Determines what type this step SHOULD be from: + - Step number (01 = init, 01b = continuation, last = final) + - Design in {workflowPlanFile} + - Step name pattern + +2. Loads the step file + +3. Validates it follows the pattern for its type + +4. **EITHER** updates the validation report directly with its findings +5. **OR** returns structured findings to parent for aggregation + +**SUBPROCESS ANALYSIS PATTERN - Validate each step file for:** + +**For Init Steps:** +- ✅ Creates output from template (if document-producing) +- ✅ No A/P menu (or C-only) +- ✅ If continuable: has continueFile reference + +**For Continuation (01b):** +- ✅ Has nextStepOptions in frontmatter +- ✅ Reads stepsCompleted from output +- ✅ Routes to appropriate step + +**For Middle (Standard):** +- ✅ Has A/P/C menu +- ✅ Outputs to document (if applicable) +- ✅ Has mandatory execution rules + +**For Middle (Simple):** +- ✅ Has C-only menu +- ✅ No A/P options + +**For Branch:** +- ✅ Has custom menu letters +- ✅ Handler routes to different steps + +**For Validation Sequence:** +- ✅ Auto-proceeds (no user choice) +- ✅ Proceeds to next validation + +**For Final Polish:** +- ✅ Loads entire document +- ✅ Optimizes flow, removes duplication +- ✅ Uses ## Level 2 headers + +**For Final:** +- ✅ No nextStepFile in frontmatter +- ✅ Completion message +- ✅ No next step to load + +**RETURN FORMAT:** +Return a concise summary containing: +- File name analyzed +- What type the step should be +- What type it actually is +- Whether it follows the correct pattern +- List of any violations found +- Overall pass/fail status + +**Context savings:** Each subprocess returns only validation findings, not full file contents. Parent receives structured analysis objects instead of 10+ full step files. + +### 3. Aggregate Findings and Document + +**After ALL files analyzed, aggregate findings from subprocesses and document results:** + +**Document the following in the validation report:** + +- Overall summary of step type validation (how many steps checked, pass/fail counts) +- For each step file: + - File name + - What type the step should be (based on design, step number, naming) + - What type it actually is + - Whether it follows the correct pattern for its type + - Any violations or issues found + - Pass/fail/warning status + +**Format:** Create a clear, readable section in the validation report that shows the validation results for each step file. + +### 4. List Violations + +**Compile and document all violations found:** + +**Document the following for any violations:** + +- File name with violation +- What the violation is (specifically what doesn't match the expected pattern) +- What should be changed to fix it +- Severity level (error/warning) + +**For files that pass validation:** Briefly note they follow their type patterns correctly. + +### 5. Append to Report + +Update {validationReportFile} - replace "## Step Type Validation *Pending...*" with actual findings. + +### 6. Save Report and Auto-Proceed + +**CRITICAL:** Save the validation report BEFORE loading next step. + +Then immediately load, read entire file, then execute {nextStepFile}. + +**Display:** +"**Step Type validation complete.** Proceeding to Output Format Validation..." + +--- + +## 🚨 SYSTEM SUCCESS/FAILURE METRICS + +### ✅ SUCCESS: + +- EVERY step validated against its type pattern (ideally using per-file subprocess optimization) +- All violations documented with structured findings +- Findings aggregated from subprocesses into report +- Report saved before proceeding +- Next validation step loaded +- Context saved: parent receives only findings, not full file contents + +### ❌ SYSTEM FAILURE: + +- Not checking every file's type pattern +- Skipping type-specific checks +- Not documenting violations +- Not saving report before proceeding + +**Master Rule:** Validation is systematic and thorough. DO NOT BE LAZY. Check EVERY file's type pattern. Auto-proceed through all validation steps. diff --git a/src/modules/bmb/workflows/workflow/steps-v/step-05-output-format-validation.md b/src/modules/bmb/workflows/workflow/steps-v/step-05-output-format-validation.md new file mode 100644 index 00000000..c6e1ec62 --- /dev/null +++ b/src/modules/bmb/workflows/workflow/steps-v/step-05-output-format-validation.md @@ -0,0 +1,200 @@ +--- +name: 'step-05-output-format-validation' +description: 'Validate output format compliance - template type, final polish, step-to-output mapping' + +nextStepFile: './step-06-validation-design-check.md' +targetWorkflowPath: '{workflow_folder_path}' +validationReportFile: '{workflow_folder_path}/validation-report-{datetime}.md' +outputFormatStandards: '../data/output-format-standards.md' +workflowPlanFile: '{workflow_folder_path}/workflow-plan.md' +--- + +# Validation Step 5: Output Format Validation + +## STEP GOAL: + +To validate that the workflow's output format matches the design - correct template type, proper final polish step if needed, and step-to-output mapping is correct. + +## MANDATORY EXECUTION RULES (READ FIRST): + +### Universal Rules: + +- 🛑 DO NOT BE LAZY - LOAD AND REVIEW EVERY FILE +- 📖 CRITICAL: Read the complete step file before taking any action +- 🔄 CRITICAL: When loading next step, ensure entire file is read +- ✅ Validation does NOT stop for user input - auto-proceed through all validation steps +- ⚙️ If any instruction references a subprocess, subagent, or tool you do not have access to, you MUST still achieve the outcome in your main context thread + +### Step-Specific Rules: + +- 🎯 Validate output format using subprocess optimization - per-file subprocess for step-to-output validation +- 🚫 DO NOT skip any checks - DO NOT BE LAZY +- 💬 Subprocess must either update validation report OR return findings to parent for aggregation +- 🚪 This is validation - systematic and thorough + +## EXECUTION PROTOCOLS: + +- 🎯 Load output format standards first +- 💾 Check template type matches design +- 📖 Check for final polish step if needed +- 🔍 Use subprocess optimization for step-to-output mapping validation - per-file subprocess for deep analysis +- 🚫 DO NOT halt for user input - validation runs to completion + +## CONTEXT BOUNDARIES: + +- Check template file in templates/ folder +- Review design in {workflowPlanFile} for output format specification +- Validate step-to-output mapping +- Check if final polish step is present (if needed) + +## MANDATORY SEQUENCE + +**CRITICAL:** Follow this sequence exactly. Do not skip or shortcut. + +### 1. Load Output Format Standards + +Load {outputFormatStandards} to understand: + +**Golden Rule:** Every step MUST output to document BEFORE loading next step. + +**Four Template Types:** +1. **Free-form** (Recommended) - Minimal structure, progressive append +2. **Structured** - Required sections, flexible within each +3. **Semi-structured** - Core sections plus optional additions +4. **Strict** - Exact format, specific fields (rare) + +**Final Polish Step:** +- For free-form workflows, include a polish step that optimizes the entire document +- Loads entire document, reviews for flow, removes duplication + +### 2. Check Design Specification + +From {workflowPlanFile}, identify: +- Does this workflow produce a document? +- If yes, what template type was designed? +- Is a final polish step needed? + +### 3. Validate Template File + +**If workflow produces documents:** + +1. Load the template file from `templates/` folder +2. Check it matches the designed type: + +**For Free-form (most common):** +- ✅ Has frontmatter with `stepsCompleted: []` +- ✅ Has `lastStep: ''` +- ✅ Has `date: ''` +- ✅ Has `user_name: ''` +- ✅ Document title header +- ✅ No rigid section structure (progressive append) + +**For Structured:** +- ✅ Has clear section headers +- ✅ Section placeholders with {{variable}} syntax +- ✅ Consistent structure + +**For Semi-structured:** +- ✅ Has core required sections +- ✅ Has optional section placeholders + +**For Strict:** +- ✅ Has exact field definitions +- ✅ Validation rules specified + +### 4. Check for Final Polish Step + +**If free-form template:** +- ✅ A final polish step should exist in the design +- ✅ The step loads entire document +- ✅ The step optimizes flow and coherence +- ✅ The step removes duplication +- ✅ The step ensures ## Level 2 headers + +**If no final polish step for free-form:** +- ⚠️ WARNING - Free-form workflows typically need final polish + +### 5. Validate Step-to-Output Mapping + +**DO NOT BE LAZY - For EACH step that outputs to document, launch a subprocess that:** + +1. Loads that step file +2. Analyzes frontmatter for `outputFile` variable +3. Analyzes step body to verify output is written before loading next step +4. Checks menu C option saves to output before proceeding +5. Returns structured findings to parent for aggregation + +**SUBPROCESS EXECUTION PATTERN:** + +**For EACH step file, launch a subprocess that:** +1. Loads the step file +2. Performs deep analysis of output operations (frontmatter, body, menu options) +3. Returns findings to parent for aggregation + +**RETURN FORMAT:** +Each subprocess should return: +- Step filename +- Whether output variable exists in frontmatter +- Whether output is saved before loading next step +- Whether menu option C saves to output before proceeding +- Output order number (if applicable) +- Any issues found +- Overall status (PASS/FAIL/WARNING) + +**Parent aggregates findings into:** + +**Steps should be in ORDER of document appearance:** +- Step 1 creates doc +- Step 2 → ## Section 1 +- Step 3 → ## Section 2 +- Step N → Polish step + +### 6. Document Findings + +Document your output format validation findings in the validation report. Include: + +- **Document Production**: Whether the workflow produces documents and what template type it uses +- **Template Assessment**: Template file existence, whether it matches the designed type, and frontmatter correctness +- **Final Polish Evaluation**: Whether a final polish step is required (for free-form workflows) and if present, whether it properly loads the entire document and optimizes flow +- **Step-to-Output Mapping**: For each step that outputs to the document, document whether it has the output variable in frontmatter, saves output before loading the next step, and properly saves in menu option C +- **Subprocess Analysis Summary**: Count of total steps analyzed, steps with output, steps saving correctly, and steps with issues +- **Issues Identified**: List any problems found with template structure, polish step, or output mapping +- **Overall Status**: Pass, fail, or warning designation + +### 7. Append to Report + +Update {validationReportFile} - replace "## Output Format Validation *Pending...*" with actual findings. + +### 8. Save Report and Auto-Proceed + +**CRITICAL:** Save the validation report BEFORE loading next step. + +Then immediately load, read entire file, then execute {nextStepFile}. + +**Display:** +"**Output Format validation complete.** Proceeding to Validation Design Check..." + +--- + +## 🚨 SYSTEM SUCCESS/FAILURE METRICS + +### ✅ SUCCESS: + +- Template type matches design +- Final polish step present if needed +- Step-to-output mapping validated via subprocess optimization +- All findings documented +- Report saved before proceeding +- Next validation step loaded +- Subprocess pattern applied correctly (per-file analysis for step-to-output validation) + +### ❌ SYSTEM FAILURE: + +- Not checking template file +- Missing final polish step for free-form +- Not documenting mapping issues +- Not saving report before proceeding +- Not using subprocess optimization for step-to-output validation +- Loading all step files into parent context instead of per-file subprocess + +**Master Rule:** Validation is systematic and thorough. DO NOT BE LAZY. Check template, polish step, and mapping. Use subprocess optimization for step-to-output validation - per-file subprocess returns analysis, not full content. Auto-proceed through all validation steps. diff --git a/src/modules/bmb/workflows/workflow/steps-v/step-06-validation-design-check.md b/src/modules/bmb/workflows/workflow/steps-v/step-06-validation-design-check.md new file mode 100644 index 00000000..2c4c98a7 --- /dev/null +++ b/src/modules/bmb/workflows/workflow/steps-v/step-06-validation-design-check.md @@ -0,0 +1,195 @@ +--- +name: 'step-06-validation-design-check' +description: 'Check if workflow has proper validation steps that load validation data (if validation is critical)' + +nextStepFile: './step-07-instruction-style-check.md' +targetWorkflowPath: '{workflow_folder_path}' +validationReportFile: '{workflow_folder_path}/validation-report-{datetime}.md' +workflowPlanFile: '{workflow_folder_path}/workflow-plan.md' +trimodalWorkflowStructure: '../data/trimodal-workflow-structure.md' +--- + +# Validation Step 6: Validation Design Check + +## STEP GOAL: + +To check if the workflow has proper validation steps when validation is critical - validation steps should load from validation data and perform systematic checks. + +## MANDATORY EXECUTION RULES (READ FIRST): + +### Universal Rules: + +- 🛑 DO NOT BE LAZY - LOAD AND REVIEW EVERY FILE +- 📖 CRITICAL: Read the complete step file before taking any action +- 🔄 CRITICAL: When loading next step, ensure entire file is read +- ✅ Validation does NOT stop for user input - auto-proceed through all validation steps +- ⚙️ If any instruction references a subprocess, subagent, or tool you do not have access to, you MUST still achieve the outcome in your main context + +### Step-Specific Rules: + +- 🎯 Check if workflow needs validation steps - use subprocess optimization (per-file deep analysis for Pattern 2) +- 🚫 DO NOT skip any validation step reviews - DO NOT BE LAZY +- 💬 Subprocess must either update validation report directly OR return findings to parent for aggregation +- 🚪 This is validation - systematic and thorough + +## EXECUTION PROTOCOLS: + +- 🎯 Determine if validation is critical for this workflow - use subprocess optimization when available +- 💾 Check validation steps exist and are well-designed - launch subprocess for per-file deep analysis (Pattern 2) +- 💬 Subprocesses must either update validation report OR return findings for parent aggregation +- 📖 Append findings to validation report +- 🚫 DO NOT halt for user input - validation runs to completion + +## CONTEXT BOUNDARIES: + +- Some workflows need validation (compliance, safety, quality gates) +- Others don't (creative, exploratory) +- Check the design to determine if validation steps are needed + +## MANDATORY SEQUENCE + +**CRITICAL:** Follow this sequence exactly. Do not skip or shortcut. + +### 1. Determine If Validation Is Critical + +From {workflowPlanFile}, check: + +**Does this workflow NEED validation?** + +**YES - Validation Critical If:** +- Compliance/regulatory requirements (tax, legal, medical) +- Safety-critical outputs +- Quality gates required +- User explicitly requested validation steps + +**NO - Validation Not Critical If:** +- Creative/exploratory workflow +- User-driven without formal requirements +- Output is user's responsibility to validate + +### 2. If Validation Is Critical, Check Validation Steps + +**DO NOT BE LAZY - For EVERY validation step file, launch a subprocess that:** + +1. Loads that validation step file +2. Reads and analyzes the step's content deeply (prose, logic, quality, flow, anti-lazy language) +3. Returns structured analysis findings to parent for aggregation + +**SUBPROCESS ANALYSIS PATTERN - Check each validation step file for:** + +**Proper Validation Step Design:** +- ✅ Loads validation data/standards from `data/` folder +- ✅ Has systematic check sequence (not hand-wavy) +- ✅ Auto-proceeds through checks (not stopping for each) +- ✅ Clear pass/fail criteria +- ✅ Reports findings to user + +**"DO NOT BE LAZY" Language Check:** +- ✅ Step includes "DO NOT BE LAZY - LOAD AND REVIEW EVERY FILE" or similar mandate +- ✅ Step instructs to "Load and review EVERY file" not "sample files" +- ✅ Step has "DO NOT SKIP" or "DO NOT SHORTCUT" language +- ⚠️ WARNING if validation step lacks anti-lazy language + +**Critical Flow Check:** +- ✅ For critical flows (compliance, safety, quality gates): validation steps are in steps-v/ folder (tri-modal) +- ✅ Validation steps are segregated from create flow +- ✅ Validation can be run independently +- ⚠️ For non-critical flows (entertainment, therapy, casual): validation may be inline +- ❌ ERROR if critical validation is mixed into create steps + +**RETURN FORMAT:** +Return a structured analysis containing: +- Step file name +- Proper design checklist (loads data, systematic checks, auto-proceeds, clear criteria, reports findings) +- Anti-lazy language check (has mandate, mandate text, comprehensive coverage) +- Critical flow check (location, segregation, independence) +- Any issues found +- Overall status (PASS/FAIL/WARN) + +**Context savings:** Each subprocess returns analysis (~30 lines), not full step file (~200 lines). Parent gets structured findings, not file contents. + +### 3. Aggregate Findings from All Subprocesses + +After all validation step files have been analyzed in subprocesses, aggregate findings: + +**Process subprocess results:** +- Compile all structured analysis findings +- Identify patterns across validation steps +- Note any critical issues or warnings + +### 4. Check Validation Data Files + +**If workflow has validation steps:** + +1. Check `data/` folder for validation data +2. Verify data files exist and are properly structured: + - CSV files have headers + - Markdown files have clear criteria + - Data is referenced in step frontmatter + +### 5. Document Findings + +**Create/Update "Validation Design Check" section in {validationReportFile} using aggregated subprocess findings:** + +Document the following information: + +**Whether validation is required:** Indicate if this workflow needs validation steps based on its domain type (critical/compliance/safety workflows vs. creative/exploratory ones) + +**List of validation steps found:** Provide the names/paths of all validation step files in the workflow + +**Validation step quality assessment:** For each validation step, document: +- Whether it loads validation data/standards from the data/ folder +- Whether it has a systematic check sequence +- Whether it auto-proceeds through checks (vs. stopping for user input) +- Whether it includes "DO NOT BE LAZY" or similar anti-lazy language mandates +- Whether it has clear pass/fail criteria +- Overall status (PASS/FAIL/WARN) + +**"DO NOT BE LAZY" language presence:** For each validation step, note whether anti-lazy language is present and what it says + +**Critical flow segregation:** For workflows requiring validation, document: +- The workflow domain type +- Whether validation steps are in the steps-v/ folder (tri-modal structure) or inline with create steps +- Whether this segregation is appropriate for the workflow type + +**Validation data files:** List any validation data files found in the data/ folder, or note if they are missing + +**Issues identified:** List any problems found with the validation design, missing data files, or quality concerns + +**Overall status:** Provide final assessment (PASS/FAIL/WARN/N/A) with reasoning + +### 6. Append to Report + +Update {validationReportFile} - replace "## Validation Design Check *Pending...*" with actual findings from subprocess aggregation. + +### 7. Save Report and Auto-Proceed + +**CRITICAL:** Save the validation report BEFORE loading next step. + +Then immediately load, read entire file, then execute {nextStepFile}. + +**Display:** +"**Validation Design check complete.** Proceeding to Instruction Style Check..." + +--- + +## 🚨 SYSTEM SUCCESS/FAILURE METRICS + +### ✅ SUCCESS: + +- Determined if validation is critical +- If critical: checked all validation steps +- Validated validation step quality +- Checked validation data files +- Findings documented +- Report saved before proceeding +- Next validation step loaded + +### ❌ SYSTEM FAILURE: + +- Not checking validation steps when critical +- Missing validation data files +- Not documenting validation design issues +- Not saving report before proceeding + +**Master Rule:** Validation is systematic and thorough. DO NOT BE LAZY. Check validation steps thoroughly. Auto-proceed through all validation steps. diff --git a/src/modules/bmb/workflows/workflow/steps-v/step-07-instruction-style-check.md b/src/modules/bmb/workflows/workflow/steps-v/step-07-instruction-style-check.md new file mode 100644 index 00000000..000f6f6e --- /dev/null +++ b/src/modules/bmb/workflows/workflow/steps-v/step-07-instruction-style-check.md @@ -0,0 +1,209 @@ +--- +name: 'step-07-instruction-style-check' +description: 'Check instruction style - intent-based vs prescriptive, appropriate for domain' + +nextStepFile: './step-08-collaborative-experience-check.md' +targetWorkflowPath: '{workflow_folder_path}' +validationReportFile: '{workflow_folder_path}/validation-report-{datetime}.md' +intentVsPrescriptive: '../data/intent-vs-prescriptive-spectrum.md' +workflowPlanFile: '{workflow_folder_path}/workflow-plan.md' +--- + +# Validation Step 7: Instruction Style Check + +## STEP GOAL: + +To validate that workflow instructions use appropriate style - intent-based for creative/facilitative workflows, prescriptive only where absolutely required (compliance, legal). + +## MANDATORY EXECUTION RULES (READ FIRST): + +### Universal Rules: + +- 🛑 DO NOT BE LAZY - LOAD AND REVIEW EVERY FILE +- 📖 CRITICAL: Read the complete step file before taking any action +- 🔄 CRITICAL: When loading next step, ensure entire file is read +- ✅ Validation does NOT stop for user input - auto-proceed through all validation steps +- ⚙️ If any instruction references a subprocess, subagent, or tool you do not have access to, you MUST still achieve the outcome in your main context + +### Step-Specific Rules: + +- 🎯 Review EVERY step's instruction style using subprocess optimization - separate subprocess per file for deep analysis +- 🚫 DO NOT skip any files or style checks - DO NOT BE LAZY +- 💬 Subprocess must either update validation report OR return structured findings to parent for aggregation +- 🚪 This is validation - systematic and thorough + +## EXECUTION PROTOCOLS: + +- 🎯 Load intent vs prescriptive standards +- 💾 Check EACH step's instruction style using subprocess optimization - each file in its own subprocess +- 📖 Validate style is appropriate for domain +- 🚫 DO NOT halt for user input - validation runs to completion +- 💬 Subprocesses must either update validation report OR return findings for parent aggregation + +## CONTEXT BOUNDARIES: + +- Instruction style should match domain +- Creative/facilitative → Intent-based (default) +- Compliance/legal → Prescriptive (exception) +- Check EVERY step for style consistency + +## MANDATORY SEQUENCE + +**CRITICAL:** Follow this sequence exactly. Do not skip or shortcut. + +### 1. Load Instruction Style Standards + +Load {intentVsPrescriptive} to understand: + +**Intent-Based (Default):** +- Use for: Most workflows - creative, exploratory, collaborative +- Step instruction describes goals and principles +- AI adapts conversation naturally +- More flexible and responsive +- Example: "Guide user to define requirements through open-ended discussion" + +**Prescriptive (Exception):** +- Use for: Compliance, safety, legal, medical, regulated industries +- Step provides exact instructions +- More controlled and predictable +- Example: "Ask exactly: 'Do you currently experience fever, cough, or fatigue?'" + +### 2. Determine Domain Type + +From {workflowPlanFile}, identify the workflow domain: + +**Intent-Based Domains (Default):** +- Creative work (writing, design, brainstorming) +- Personal development (planning, goals, reflection) +- Exploration (research, discovery) +- Collaboration (facilitation, coaching) + +**Prescriptive Domains (Exception):** +- Legal/Compliance (contracts, regulations) +- Medical (health assessments, triage) +- Financial (tax, regulatory compliance) +- Safety (risk assessments, safety checks) + +### 3. Check EACH Step's Instruction Style + +**DO NOT BE LAZY - For EACH step file, launch a subprocess that:** + +1. Loads that step file +2. Reads the instruction sections (MANDATORY SEQUENCE) +3. Analyzes and classifies instruction style deeply +4. **EITHER** updates validation report directly with findings +5. **OR** returns structured analysis findings to parent for aggregation + +**SUBPROCESS ANALYSIS PATTERN:** + +Each subprocess performs deep analysis of instruction prose to classify style: + +**Intent-Based Indicators:** +- ✅ Describes goals/outcomes, not exact wording +- ✅ Uses "think about" language +- ✅ Multi-turn conversation encouraged +- ✅ "Ask 1-2 questions at a time, not a laundry list" +- ✅ "Probe to understand deeper" +- ✅ Flexible: "guide user through..." not "say exactly..." + +**Prescriptive Indicators:** +- Exact questions specified +- Specific wording required +- Sequence that must be followed precisely +- "Say exactly:" or "Ask precisely:" + +**Mixed Style:** +- Some steps prescriptive (critical/required) +- Others intent-based (creative/facilitative) + +**RETURN FORMAT:** +Each subprocess should return findings including: +- Step file identifier +- Instruction style classification (Intent-based/Prescriptive/Mixed) +- Style indicators observed +- Appropriateness assessment (PASS/WARN/FAIL) +- Specific notes and observations +- Examples of good and concerning instruction patterns + +**Parent aggregates all subprocess findings into unified report section.** + +### 4. Validate Appropriateness + +**For Intent-Based Domains:** +- ✅ Instructions should be intent-based +- ❌ Prescriptive instructions inappropriate (unless specific section requires it) + +**For Prescriptive Domains:** +- ✅ Instructions should be prescriptive where compliance matters +- ⚠️ May have intent-based sections for creative elements + +### 5. Aggregate Findings and Document + +After ALL subprocesses have analyzed their respective step files, aggregate findings and create/update section in {validationReportFile}. + +Document the following: + +**Workflow Domain Assessment:** +- Document the domain type (creative/interactive vs compliance/legal) +- State the appropriate instruction style for this domain + +**Instruction Style Findings:** +- List each step and its instruction style classification (intent-based/prescriptive/mixed) +- Note whether the style is appropriate for the domain +- Document specific examples of instruction language that demonstrate the style +- Identify any steps with inappropriate style (e.g., prescriptive in creative domain) + +**Issues Identified:** +- List any steps that are overly prescriptive for their domain +- List any steps that should be more prescriptive (for compliance domains) +- Note any style inconsistencies across steps + +**Positive Findings:** +- Highlight steps with excellent instruction style +- Note effective use of intent-based facilitation language +- Identify appropriate use of prescriptive instructions (if applicable) + +**Overall Status:** +- Provide final assessment (PASS/FAIL/WARN) +- Summarize key findings + +**Context Savings Note:** Using subprocess pattern (Pattern 2: per-file deep analysis), parent context receives only structured analysis findings (~50-100 lines per file) instead of full file contents (~200+ lines per file). For 10 steps: ~500-1000 lines received vs ~2000+ lines if loading all files in parent. + +### 6. Update Report with Aggregated Findings + +Update {validationReportFile} - replace "## Instruction Style Check *Pending...*" with actual aggregated findings from all subprocesses. + +### 7. Save Report and Auto-Proceed + +**CRITICAL:** Save the validation report BEFORE loading next step. + +Then immediately load, read entire file, then execute {nextStepFile}. + +**Display:** +"**Instruction Style check complete.** Proceeding to Collaborative Experience Check..." + +--- + +## 🚨 SYSTEM SUCCESS/FAILURE METRICS + +### ✅ SUCCESS: + +- EVERY step's instruction style reviewed via subprocess optimization (Pattern 2: per-file deep analysis) +- Each step analyzed in its own subprocess for style classification +- Style validated against domain appropriateness +- Issues documented with specific examples +- Subprocess findings aggregated into unified report section +- Context savings achieved (~500-1000 lines received vs ~2000+ if loading all files) +- Report saved before proceeding +- Next validation step loaded + +### ❌ SYSTEM FAILURE: + +- Not checking every step's style via subprocess +- Not analyzing each file in its own subprocess +- Not validating against domain +- Not documenting style issues +- Not aggregating subprocess findings +- Not saving report before proceeding + +**Master Rule:** Validation is systematic and thorough. DO NOT BE LAZY. For EACH step file, launch a subprocess to analyze instruction style deeply. Aggregate findings. Auto-proceed through all validation steps. Use graceful fallback if subprocess unavailable. diff --git a/src/modules/bmb/workflows/workflow/steps-v/step-08-collaborative-experience-check.md b/src/modules/bmb/workflows/workflow/steps-v/step-08-collaborative-experience-check.md new file mode 100644 index 00000000..43416b10 --- /dev/null +++ b/src/modules/bmb/workflows/workflow/steps-v/step-08-collaborative-experience-check.md @@ -0,0 +1,199 @@ +--- +name: 'step-08-collaborative-experience-check' +description: 'Check collaborative quality - does this workflow facilitate well or just interrogate?' + +nextStepFile: './step-08b-subprocess-optimization.md' +targetWorkflowPath: '{workflow_folder_path}' +validationReportFile: '{workflow_folder_path}/validation-report-{datetime}.md' +workflowPlanFile: '{workflow_folder_path}/workflow-plan.md' +--- + +# Validation Step 8: Collaborative Experience Check + +## STEP GOAL: + +To validate that the workflow actually facilitates well - natural conversation, not interrogation. Questions asked progressively, not in laundry lists. + +## MANDATORY EXECUTION RULES (READ FIRST): + +### Universal Rules: + +- 🛑 DO NOT BE LAZY - LOAD AND REVIEW EVERY FILE +- 📖 CRITICAL: Read the complete step file before taking any action +- 🔄 CRITICAL: When loading next step, ensure entire file is read +- ✅ Validation does NOT stop for user input - auto-proceed through all validation steps + +### Step-Specific Rules: + +- 🎯 Review EVERY step for collaborative quality +- 🚫 DO NOT skip any files or experience checks +- 💬 Append findings to report, then auto-load next step +- 🚪 This is validation - systematic and thorough + +## EXECUTION PROTOCOLS: + +- 🎯 Walk through the workflow as a user would +- 💾 Check conversation flow in each step +- 📖 Validate facilitation quality +- 🚫 DO NOT halt for user input - validation runs to completion + +## CONTEXT BOUNDARIES: + +- Good workflows facilitate, don't interrogate +- Questions should be 1-2 at a time +- Conversation should feel natural +- Check EVERY step for collaborative patterns + +## MANDATORY SEQUENCE + +**CRITICAL:** Follow this sequence exactly. Do not skip or shortcut. + +### 1. Load the Workflow Design + +From {workflowPlanFile}, understand: +- What is the workflow's goal? +- Who is the user? +- What interaction style was designed? + +### 2. Review EACH Step for Collaborative Quality + +**DO NOT BE LAZY - For EACH step file:** + +1. Load the step +2. Read the MANDATORY SEQUENCE section +3. Evaluate against collaborative quality criteria: + +**Good Facilitation Indicators:** +- ✅ "Ask 1-2 questions at a time" +- ✅ "Think about their response before continuing" +- ✅ "Use conversation, not interrogation" +- ✅ "Probe to understand deeper" +- ✅ Natural language in instructions +- ✅ Allows for back-and-forth + +**Bad Interrogation Indicators:** +- ❌ Laundry lists of questions +- ❌ "Ask the following: 1, 2, 3, 4, 5, 6..." +- ❌ Form-filling approach +- ❌ No space for conversation +- ❌ Rigid sequences without flexibility + +**Role Reinforcement Check:** +- ✅ "You are a [role], we engage in collaborative dialogue" +- ✅ "Together we produce something better" +- ❌ "You are a form filler" (obviously bad, but check for patterns) + +### 3. Check Progression and Arc + +**Does the workflow have:** +- ✅ Clear progression from step to step? +- ✅ Each step builds on previous work? +- ✅ User knows where they are in the process? +- ✅ Satisfying completion at the end? + +**Or does it:** +- ❌ Feel disjointed? +- ❌ Lack clear progression? +- ❌ Leave user unsure of status? + +### 4. Check Error Handling + +**Do steps handle:** +- ✅ Invalid input gracefully? +- ✅ User uncertainty with guidance? +- ✅ Off-track conversation with redirection? +- ✅ Edge cases with helpful messages? + +### 5. Document Findings + +```markdown +### Collaborative Experience Check Results + +**Overall Facilitation Quality:** [Excellent/Good/Fair/Poor] + +**Step-by-Step Analysis:** + +**step-01-init.md:** +- Question style: [Progressive/Laundry list] +- Conversation flow: [Natural/Rigid] +- Role clarity: ✅/❌ +- Status: ✅ PASS / ❌ FAIL + +**step-02-*.md:** +- Question style: [Progressive/laundry list - "Ask 1-2 at a time" / Lists 5+ questions] +- Allows conversation: ✅/❌ +- Thinks before continuing: ✅/❌ +- Status: ✅ PASS / ❌ FAIL + +[Continue for ALL steps...] + +**Collaborative Strengths Found:** +- [List examples of good facilitation] +- [Highlight steps that excel at collaboration] + +**Collaborative Issues Found:** + +**Laundry List Questions:** +- [List steps with question dumps] +- Example: "step-03-*.md asks 7 questions at once" + +**Rigid Sequences:** +- [List steps that don't allow conversation] +- Example: "step-04-*.md has no space for back-and-forth" + +**Form-Filling Patterns:** +- [List steps that feel like form filling] +- Example: "step-05-*.md collects data without facilitation" + +**Progression Issues:** +- [List problems with flow/arc] +- Example: "step-06-*.md doesn't connect to previous step" + +**User Experience Assessment:** + +**Would this workflow feel like:** +- [ ] A collaborative partner working WITH the user +- [ ] A form collecting data FROM the user +- [ ] An interrogation extracting information +- [ ] A mix - depends on step + +**Overall Collaborative Rating:** ⭐⭐⭐⭐⭐ [1-5 stars] + +**Status:** ✅ EXCELLENT / ✅ GOOD / ⚠️ NEEDS IMPROVEMENT / ❌ POOR +``` + +### 6. Append to Report + +Update {validationReportFile} - replace "## Collaborative Experience Check *Pending...*" with actual findings. + +### 7. Save Report and Auto-Proceed + +**CRITICAL:** Save the validation report BEFORE loading next step. + +Then immediately load, read entire file, then execute {nextStepFile}. + +**Display:** +"**Collaborative Experience check complete.** Proceeding to Cohesive Review..." + +--- + +## 🚨 SYSTEM SUCCESS/FAILURE METRICS + +### ✅ SUCCESS: + +- EVERY step reviewed for collaborative quality +- Question patterns analyzed (progressive vs laundry list) +- Conversation flow validated +- Issues documented with specific examples +- Findings appended to report +- Report saved before proceeding +- Next validation step loaded + +### ❌ SYSTEM FAILURE: + +- Not checking every step's collaborative quality +- Missing question pattern analysis +- Not documenting experience issues +- Not saving report before proceeding + +**Master Rule:** Validation is systematic and thorough. DO NOT BE LAZY. Check EVERY step's collaborative quality. Auto-proceed through all validation steps. diff --git a/src/modules/bmb/workflows/workflow/steps-v/step-08b-subprocess-optimization.md b/src/modules/bmb/workflows/workflow/steps-v/step-08b-subprocess-optimization.md new file mode 100644 index 00000000..5d0219a9 --- /dev/null +++ b/src/modules/bmb/workflows/workflow/steps-v/step-08b-subprocess-optimization.md @@ -0,0 +1,179 @@ +--- +name: 'step-08b-subprocess-optimization' +description: 'Identify subprocess optimization opportunities - reduce context load, improve performance' + +nextStepFile: './step-09-cohesive-review.md' +targetWorkflowPath: '{workflow_folder_path}' +validationReportFile: '{workflow_folder_path}/validation-report-{datetime}.md' +subprocessPatterns: '../data/subprocess-optimization-patterns.md' +--- + +# Validation Step 8b: Subprocess Optimization Analysis + +## STEP GOAL: + +To identify opportunities for subprocess optimization throughout the workflow - reducing context load, improving performance, and enabling massive operations that would otherwise exceed context limits. + +## MANDATORY EXECUTION RULES (READ FIRST): + +### Universal Rules: + +- 🛑 DO NOT BE LAZY - ANALYZE EVERY FILE IN ITS OWN SUBPROCESS +- 📖 CRITICAL: Read the complete step file before taking any action +- 🔄 CRITICAL: When loading next step, ensure entire file is read +- ✅ Validation does NOT stop for user input - auto-proceed through all validation steps +- ⚙️ If any instruction references a subprocess/subagent/tool you do not have access to, you MUST still achieve the outcome in your main context + +### Step-Specific Rules: + +- 🎯 Analyze EVERY step file for subprocess optimization - each file in its own subprocess +- 🚫 DO NOT skip any file - DO NOT BE LAZY +- 💬 Load {subprocessPatterns} in subprocess performing some action required to understand patterns deeply with examples (if subprocess available), else load in main context +- 🚪 This identifies context-saving and performance-optimizing opportunities + +## EXECUTION PROTOCOLS: + +- 🎯 Analyze each step file in its own subprocess - deep analysis of subprocess potential +- 💾 Subprocesses must identify optimization patterns and return findings to parent for aggregation +- 📖 Aggregate findings into validation report before loading next step + +## CONTEXT BOUNDARIES: + +- Three patterns: grep/regex across files, per-file deep analysis, data file operations, parallel execution +- **Context-saving goal**: Return ONLY key findings to parent, not full file contents + +## MANDATORY SEQUENCE + +**CRITICAL:** Follow this sequence exactly. Do not skip or shortcut. + +### 1. Load Subprocess Pattern Reference (Context Optimization!) + +**First, understand the subprocess optimization patterns by loading {subprocessPatterns}:** + +**If subprocess capability available:** +```markdown +Launch a subprocess that: +1. Loads {subprocessPatterns} +2. Studies all patterns and examples deeply (Pattern 3: data operations!) +3. Returns summary of key patterns to parent (not full file - saves context) +``` + +**If subprocess unavailable:** +```markdown +Load {subprocessPatterns} in main context +# Larger context but still functional - demonstrates graceful fallback +``` + +**This step itself demonstrates Pattern 3 from the reference!** + +--- + +### 2. Perform Subprocess Optimization Analysis + +**DO NOT BE LAZY - For EVERY step file, launch a subprocess that:** + +1. Loads that step file +2. ALSO loads {subprocessPatterns} to understand all patterns deeply (subprocess needs full context!) +3. Analyzes the step against each pattern looking for optimization opportunities +4. Returns specific, actionable suggestions to parent + +**Subprocess gets full context:** +- The step file being analyzed +- The subprocess-optimization-patterns.md reference (all examples and patterns) +- Returns only findings to parent (context savings!) + +**SUBPROCESS ANALYSIS PATTERN - Check each step file for:** + +**Pattern 1: Single subprocess for grep/regex** - Operations that check/search multiple files for patterns (frontmatter validation, menu checks, path searches). Suggest: "Use single grep subprocess, return only matches" + +**Pattern 2: Separate subprocess per file** - Operations requiring deep analysis of prose/logic/quality/style/flow per file (instruction review, collaborative quality assessment, step type compliance). Suggest: "Each file in own subprocess, return analysis findings" + +**Pattern 3: Subprocess for data operations** - Operations loading large data files to find matches, extract key details, or summarize findings. Suggest: "Subprocess loads data, returns ONLY relevant rows/findings" + +**Pattern 4: Parallel execution** - Independent operations that could run simultaneously. Suggest: "Run in parallel subprocesses to reduce execution time" + +**RETURN FORMAT (example structure, adapt as needed):** +```json +{ + "step_file": "step-02-*.md", + "opportunities": [ + { + "pattern": "grep/regex|per-file|data-ops|parallel", + "location": "Line XX: [quote relevant instruction]", + "issue": "Loads all files into parent context", + "suggestion": "Use single grep subprocess, return only failures", + "impact": "Saves ~N lines per file, faster execution", + "priority": "HIGH|MEDIUM|LOW" + } + ] +} +``` + +### 2. Aggregate Findings and Create Report Section + +After ALL files analyzed, create/update section in {validationReportFile}: + +```markdown +## Subprocess Optimization Opportunities + +**Total Opportunities:** {count} | **High Priority:** {count} | **Estimated Context Savings:** {description} + +### High-Priority Opportunities + +**{Step Name}** - {Pattern Type} +- **Current:** {brief description of current approach} +- **Suggested:** {specific optimization suggestion} +- **Impact:** {context savings, performance gain} +- **Example:** `{brief code/pseudocode}` + +[Repeat for each high-priority opportunity...] + +### Moderate/Low-Priority Opportunities + +{List with brief descriptions} + +### Summary by Pattern + +- **Pattern 1 (grep/regex):** {count} opportunities - {total savings} +- **Pattern 2 (per-file):** {count} opportunities - {total savings} +- **Pattern 3 (data ops):** {count} opportunities - {total savings} +- **Pattern 4 (parallel):** {count} opportunities - {performance gain} + +### Implementation Recommendations + +**Quick Wins:** {easy implementations with big savings} +**Strategic:** {higher effort but big payoff} +**Future:** {moderate impact, consider later} + +**Status:** ✅ Complete / ⚠️ Review recommended +``` + +### 3. Save Report and Auto-Proceed + +**CRITICAL:** Save report BEFORE loading next step. + +Then load, read entire file, execute {nextStepFile}. + +**Display:** "**Subprocess optimization analysis complete.** Identified {count} opportunities with potential context savings. Proceeding to Cohesive Review..." + +--- + +## 🚨 SYSTEM SUCCESS/FAILURE METRICS + +### ✅ SUCCESS: + +- EVERY step file analyzed in its own subprocess +- ALL optimization opportunities identified +- Findings aggregated into report +- Prioritized recommendations with context savings +- Report saved, next step loaded + +### ❌ SYSTEM FAILURE: + +- Not analyzing every file +- Skipping opportunity identification +- Not providing specific suggestions +- Not estimating savings +- Not aggregating findings + +**Master Rule:** DO NOT BE LAZY. Analyze EVERY file in its own subprocess. Identify ALL optimization opportunities across 4 patterns. Provide specific, actionable recommendations with context savings. Return findings to parent. Auto-proceed. diff --git a/src/modules/bmb/workflows/workflow/steps-v/step-09-cohesive-review.md b/src/modules/bmb/workflows/workflow/steps-v/step-09-cohesive-review.md new file mode 100644 index 00000000..adf1ab45 --- /dev/null +++ b/src/modules/bmb/workflows/workflow/steps-v/step-09-cohesive-review.md @@ -0,0 +1,186 @@ +--- +name: 'step-09-cohesive-review' +description: 'Cohesive ultra-think review - overall quality, does this workflow actually facilitate well?' + +nextStepFile: './step-10-report-complete.md' +targetWorkflowPath: '{workflow_folder_path}' +validationReportFile: '{workflow_folder_path}/validation-report-{datetime}.md' +workflowPlanFile: '{workflow_folder_path}/workflow-plan.md' +--- + +# Validation Step 9: Cohesive Review + +## STEP GOAL: + +To perform a cohesive "ultra-think" review of the entire workflow - walk through it as a whole, assess overall quality, does it actually facilitate well? + +## MANDATORY EXECUTION RULES (READ FIRST): + +### Universal Rules: + +- 🛑 DO NOT BE LAZY - LOAD AND REVIEW EVERY FILE +- 📖 CRITICAL: Read the complete step file before taking any action +- 🔄 CRITICAL: When loading next step, ensure entire file is read +- ✅ Validation does NOT stop for user input - auto-proceed through all validation steps +- ⚙️ If any instruction references a subprocess, subagent, or tool you do not have access to, you MUST still achieve the outcome in your main context + +### Step-Specific Rules: + +- 🎯 Review the workflow as a cohesive whole - **NOTE: This step loads ENTIRE workflow for holistic review (different pattern from other validation steps)** +- 🚫 DO NOT skip any aspect of the review - DO NOT BE LAZY +- 💬 Subprocess optimization: When available, can use subprocesses to load individual step files and return structured summaries to parent for aggregation +- 💬 However, since cohesive review requires understanding the COMPLETE workflow as one unit, parent may need full context for proper holistic assessment +- 🚪 This is the meta-review - overall assessment + +## EXECUTION PROTOCOLS: + +- 🎯 Walk through the ENTIRE workflow end-to-end using subprocess optimization when available +- 💬 When using subprocesses: Each subprocess loads one step file, performs deep analysis, returns structured findings to parent for aggregation +- 💬 Subprocess must either update validation report directly OR return findings to parent for compilation +- 💾 Assess overall quality, not just individual components +- 📖 Think deeply: would this actually work well? +- 🚫 DO NOT halt for user input - validation runs to completion + +## CONTEXT BOUNDARIES: + +- This is the cohesive review - look at the workflow as a whole +- Consider user experience from start to finish +- Assess whether the workflow achieves its goal +- Be thorough and thoughtful + +## MANDATORY SEQUENCE + +**CRITICAL:** Follow this sequence exactly. Do not skip or shortcut. + +### 1. Load the Entire Workflow + +**DO NOT BE LAZY - Load EVERY step file using subprocess optimization when available:** + +**SUBPROCESS APPROACH (when available):** + +For EACH workflow file (workflow.md + all step files in order), launch a subprocess that: +1. Loads that single file +2. Performs deep analysis of content, flow, quality, and connection points +3. Returns structured findings to parent for holistic aggregation + +**Subprocess should return:** +- File name analyzed +- Purpose and flow position within the workflow +- How it connects to previous and next steps +- Quality indicators and any issues found +- Voice and tone consistency assessment + +**FALLBACK APPROACH (if subprocess unavailable):** + +Load workflow.md and EVERY step file in steps-c/ sequentially in main context: +1. Load workflow.md +2. Load EVERY step file in steps-c/ in order +3. Read through each step +4. Understand the complete flow + +**CRITICAL:** Whether using subprocess or main context, you must understand the COMPLETE workflow as one cohesive unit before proceeding to assessment. + +### 2. Walk Through the Workflow Mentally + +**Imagine you are a user running this workflow:** + +- Starting from workflow.md +- Going through step-01 +- Progressing through each step +- Experiencing the interactions +- Reaching the end + +**Ask yourself:** +- Does this make sense? +- Is the flow logical? +- Would I feel guided or confused? +- Does it achieve its goal? + +### 3. Assess Cohesiveness + +**Check for:** + +**✅ Cohesive Indicators:** +- Each step builds on previous work +- Clear progression toward goal +- Consistent voice and approach throughout +- User always knows where they are +- Satisfying completion + +**❌ Incohesive Indicators:** +- Steps feel disconnected +- Jumps in logic or flow +- Inconsistent patterns +- User might be confused +- Abrupt or unclear ending + +### 4. Assess Overall Quality + +**Evaluate the workflow across key dimensions:** + +Consider goal clarity, logical flow, facilitation quality, user experience, and goal achievement. Provide an overall quality assessment based on these dimensions. + +### 5. Identify Strengths and Weaknesses + +**Strengths:** +- What does this workflow do well? +- What makes it excellent? +- What should other workflows emulate? + +**Weaknesses:** +- What could be improved? +- What doesn't work well? +- What would confuse users? + +**Critical Issues:** +- Are there any show-stopper problems? +- Would this workflow fail in practice? + +### 6. Provide Recommendation + +**Assess overall workflow readiness:** + +Determine if the workflow is excellent (ready to use, exemplifies best practices), good (solid with minor improvements possible), needs work (has issues to address), or problematic (major issues requiring significant revision). Provide a clear recommendation on readiness for use. + +### 7. Document Findings + +**Document your cohesive review findings in the validation report:** + +Include your overall assessment (excellent/good/needs work/problematic), quality evaluation across key dimensions, cohesiveness analysis (flow, progression, voice and tone), identified strengths and weaknesses, any critical issues, what makes the workflow work well, what could be improved, user experience forecast, and your recommendation on readiness for use. + +### 8. Append to Report + +Update {validationReportFile} - replace "## Cohesive Review *Pending...*" with actual findings. + +### 9. Save Report and Auto-Proceed + +**CRITICAL:** Save the validation report BEFORE loading next step. + +Then immediately load, read entire file, then execute {nextStepFile}. + +**Display:** +"**Cohesive Review complete.** Proceeding to finalize validation report..." + +--- + +## 🚨 SYSTEM SUCCESS/FAILURE METRICS + +### ✅ SUCCESS: + +- ENTIRE workflow reviewed end-to-end +- Quality assessed across multiple dimensions +- Strengths and weaknesses documented +- Thoughtful recommendation provided +- Findings appended to report +- Report saved before proceeding +- Next validation step loaded + +### ❌ SYSTEM FAILURE: + +- Not reviewing the entire workflow +- Superficial or lazy assessment +- Not documenting strengths/weaknesses +- Not providing clear recommendation +- Not saving report before proceeding + +**Master Rule:** Validation is systematic and thorough. DO NOT BE LAZY. Review the ENTIRE workflow cohesively. Think deeply about quality. Auto-proceed through all validation steps. diff --git a/src/modules/bmb/workflows/workflow/steps-v/step-10-report-complete.md b/src/modules/bmb/workflows/workflow/steps-v/step-10-report-complete.md new file mode 100644 index 00000000..ee550530 --- /dev/null +++ b/src/modules/bmb/workflows/workflow/steps-v/step-10-report-complete.md @@ -0,0 +1,154 @@ +--- +name: 'step-10-report-complete' +description: 'Finalize validation report - check for plan file, summarize all findings, present to user' + +targetWorkflowPath: '{workflow_folder_path}' +validationReportFile: '{workflow_folder_path}/validation-report-{datetime}.md' +workflowPlanFile: '{workflow_folder_path}/workflow-plan.md' +planValidationStep: './step-11-plan-validation.md' +--- + +# Validation Step 10: Report Complete + +## STEP GOAL: + +To check if a plan file exists (and run plan validation if it does), then summarize all validation findings and present to the user. + +## MANDATORY EXECUTION RULES (READ FIRST): + +### Universal Rules: + +- 📖 CRITICAL: Read the complete step file before taking any action +- 📋 YOU ARE A FACILITATOR, not a content generator +- ✅ YOU MUST ALWAYS SPEAK OUTPUT In your Agent communication style with the config `{communication_language}` +- ⚙️ If any instruction references a subprocess, subagent, or tool you do not have access to, you MUST still achieve the outcome in your main context + +### Step-Specific Rules: + +- 🎯 This is the final validation step - present findings +- 🚫 DO NOT modify the workflow without user request +- 💬 Present summary and ask what changes are needed +- 🚪 This ends validation - user decides next steps + +## EXECUTION PROTOCOLS: + +- 🎯 Load the complete validation report +- 💾 Summarize ALL findings +- 📖 Update report status to COMPLETE +- 🚫 DO NOT proceed without user review + +## CONTEXT BOUNDARIES: + +- All 10 previous validation steps have completed +- Report contains findings from all checks +- User needs to see summary and decide on changes +- This step DOES NOT auto-proceed + +## MANDATORY SEQUENCE + +**CRITICAL:** Follow this sequence exactly. Do not skip or shortcut. + +### 1. Check for Plan File + +Before finalizing the report, check if a plan file exists: + +**Check if {workflowPlanFile} exists:** +- **IF YES:** Run plan validation first + - Load, read entire file, then execute {planValidationStep} + - The plan validation will append its findings to the report + - Then return to this step to finalize the report +- **IF NO:** Proceed to finalize the report (no plan to validate) + +### 2. Load Complete Validation Report + +After plan validation (if applicable), load {validationReportFile} and read ALL findings from every validation step. + +### 3. Create Summary Section + +At the end of {validationReportFile}, replace "## Summary *Pending...*" with a comprehensive summary that includes: + +- Validation completion date +- Overall status assessment (based on all validation steps) +- List of all validation steps completed with their individual results +- Summary of critical issues that must be fixed (or note if none found) +- Summary of warnings that should be addressed (or note if none found) +- Key strengths identified during validation +- Overall assessment of workflow quality +- Recommendation on readiness (ready to use / needs tweaks / needs revision / major rework needed) +- Suggested next steps for the user + +Present this information in a clear, readable format - the exact structure is flexible as long as it covers all these points. + +### 4. Update Report Status + +Update the frontmatter of {validationReportFile} to set validationStatus to COMPLETE and add the completionDate. Keep existing fields like validationDate, workflowName, and workflowPath unchanged. + +### 5. Present Summary to User + +Present a clear summary to the user that includes: + +- Confirmation that validation is complete +- Overall status of the workflow +- Quick results overview showing each validation step and its result +- Count of critical issues and warnings (or note if none found) +- Recommendation on workflow readiness +- Path to the full validation report +- Options for next steps (review detailed findings, make changes, explain results, or other actions) + +Present this information in a natural, conversational way - the exact format doesn't matter as long as all this information is clearly communicated. + +### 6. Present MENU OPTIONS + +Display: **Validation Complete! Select an Option:** [R] Review Detailed Findings [F] Fix Issues [X] Exit Validation + +#### EXECUTION RULES: + +- ALWAYS halt and wait for user input after presenting menu +- User chooses their next action + +#### Menu Handling Logic: + +- IF R: Walk through the validation report section by section, explaining findings, then redisplay menu +- IF F: "What issues would you like to fix?" → Discuss specific changes needed → User can make edits manually OR you can help edit files +- IF X: "Validation complete. Your workflow is at: {targetWorkflowPath}. You can make changes and re-run validation anytime." +- IF Any other comments or queries: help user respond then [Redisplay Menu Options](#5-present-menu-options) + +### 7. If User Wants to Fix Issues + +Explain the available options for fixing issues: + +- Manual edits: User edits files directly, then re-runs validation +- Guided edits: User specifies what to fix, help create specific edits for user approval +- Edit workflow: If the workflow has steps-e/, use the edit workflow to make systematic changes + +The exact format doesn't matter - just ensure the user understands their options for addressing issues. + +### 8. Update Plan with Validation Status + +If a plan file exists at {workflowPlanFile}, update its frontmatter to include the validation status (COMPLETE), the current validation date, and a reference to the validation report file. + +## CRITICAL STEP COMPLETION NOTE + +This is the final validation step. User reviews findings and decides whether to make changes. Validation workflow ends here. + +--- + +## 🚨 SYSTEM SUCCESS/FAILURE METRICS + +### ✅ SUCCESS: + +- All validation findings summarized +- Complete report presented to user +- Summary section added to report +- Report status updated to COMPLETE +- User can review findings and decide on changes +- Plan updated with validation status + +### ❌ SYSTEM FAILURE: + +- Not summarizing all findings +- Not presenting complete report to user +- Not updating report status +- Not giving user clear options for next steps + +**Master Rule:** Validation is complete. User reviews findings and decides what changes to make. Provide clear summary and options. diff --git a/src/modules/bmb/workflows/workflow/steps-v/step-11-plan-validation.md b/src/modules/bmb/workflows/workflow/steps-v/step-11-plan-validation.md new file mode 100644 index 00000000..32c951a6 --- /dev/null +++ b/src/modules/bmb/workflows/workflow/steps-v/step-11-plan-validation.md @@ -0,0 +1,237 @@ +--- +name: 'step-11-plan-validation' +description: 'Validate plan quality - ensure all user intent and requirements are implemented' + +targetWorkflowPath: '{workflow_folder_path}' +validationReportFile: '{workflow_folder_path}/validation-report-{datetime}.md' +workflowPlanFile: '{workflow_folder_path}/workflow-plan.md' +--- + +# Validation Step 11: Plan Quality Validation + +## STEP GOAL: + +To validate that a workflow plan (if it exists) has been fully implemented - all user intent captured, all requirements met with high quality. + +## MANDATORY EXECUTION RULES (READ FIRST): + +### Universal Rules: + +- 🛑 DO NOT BE LAZY - LOAD AND REVIEW EVERY FILE +- 📖 CRITICAL: Read the complete step file before taking any action +- ✅ This validation step only runs if a plan file exists +- ⚙️ If any instruction references a subprocess, subagent, or tool you do not have access to, you MUST still achieve the outcome in your main context thread + +### Step-Specific Rules: + +- 🎯 Validate plan requirements using subprocess optimization - separate subprocess per requirement area for deep analysis +- 🚫 DO NOT skip checking any requirement from the plan - DO NOT BE LAZY +- 💬 Subprocess must either update validation report directly OR return structured findings to parent for aggregation +- 🚪 This ensures the build actually delivered what was planned + +## EXECUTION PROTOCOLS: + +- 🎯 Load plan and extract all requirements/intent using subprocess optimization when available - separate subprocess per requirement area for deep analysis +- 💾 Subprocesses validate implementation against plan requirements and return findings for aggregation +- 📖 Document gaps and quality issues +- 🚫 Only run this step if workflowPlanFile exists + +## CONTEXT BOUNDARIES: + +- This step runs AFTER the workflow is built +- Compares what was planned vs what was implemented +- Checks for: missing features, quality gaps, unmet user intent + +## MANDATORY SEQUENCE + +**CRITICAL:** Only run this step if {workflowPlanFile} exists. If it doesn't exist, skip to final summary. + +### 1. Check if Plan Exists + +First, check if {workflowPlanFile} exists: + +**IF plan file does NOT exist:** +- Skip this validation step +- Proceed to summary with note: "No plan file found - workflow may have been built without BMAD create-workflow process" + +**IF plan file exists:** +- Load the complete plan file +- Proceed with validation + +### 2. Extract Plan Requirements + +**DO NOT BE LAZY - Extract EVERY requirement from the plan:** + +**SUBPROCESS EXECUTION PATTERN:** + +Launch a subprocess that: +1. Loads {workflowPlanFile} +2. Extracts all requirements from each section (Discovery, Classification, Requirements, Design, Tools) +3. Returns structured requirements list to parent + +**SUBPROCESS RETURNS:** +Structured requirements list organized by section (discovery, classification, requirements, design, tools) with all extracted items and a count of total requirements. + +**If subprocess unavailable:** Load {workflowPlanFile} in main context and extract requirements (larger context but still functional - demonstrates graceful fallback). + +--- + +### 3. Validate Each Requirement Against Built Workflow + +**DO NOT BE LAZY - For EACH requirement area, launch a subprocess that:** + +1. Loads relevant workflow files (workflow.md, step files, etc.) +2. Validates that specific requirement area is implemented correctly +3. Assesses quality of implementation +4. **EITHER** updates validation report directly with findings +5. **OR** returns structured validation results to parent for aggregation + +**PATTERN 2: Separate subprocess per requirement area for deep analysis** + +Each subprocess gets full context to deeply understand that requirement area and validate implementation quality: + +--- + +**SUBPROCESS 1: Discovery Validation** + +**Subprocess analyzes:** +- ✅ Built workflow addresses the original problem? +- ✅ Vision from discovery is reflected in final workflow? + +**Subprocess returns:** +Discovery validation results indicating whether the original problem and vision from the plan are addressed in the built workflow, with quality assessment, status (✅/❌), and any gaps identified. + +--- + +**SUBPROCESS 2: Classification Validation** + +**Subprocess analyzes:** +- ✅ Document output matches plan (yes/no)? +- ✅ Module affiliation correct? +- ✅ Continuable support as specified? +- ✅ Tri-modal structure as specified? + +**Subprocess returns:** +Classification validation results for each classification attribute (document output, module, continuable, tri-modal) comparing what was specified vs what was implemented, with overall quality assessment, status (✅/❌), and any gaps. + +--- + +**SUBPROCESS 3: Requirements Validation** + +**Subprocess analyzes:** +- ✅ Flow structure matches plan? +- ✅ User interaction style as specified? +- ✅ All required inputs configured? +- ✅ Output format matches specification? +- ✅ Success criteria achievable? + +**Subprocess returns:** +Requirements validation results for flow structure, interaction style, inputs, outputs, and success criteria comparing what was specified vs what was implemented, with overall quality assessment, status (✅/❌), and any gaps. + +--- + +**SUBPROCESS 4: Design Validation** + +**Subprocess analyzes:** +- ✅ All steps from design present in workflow? +- ✅ Step purposes match design? +- ✅ Flow follows design diagram? +- ✅ Interaction patterns as specified? + +**Subprocess returns:** +Design validation results for each step from the plan checking if it exists in the workflow and if the purpose matches, along with whether the flow follows the design diagram and interaction patterns match, with overall quality assessment, status (✅/❌), and any gaps. + +--- + +**SUBPROCESS 5: Tools Validation** + +**Subprocess analyzes:** +- ✅ Specified tools configured in workflow? +- ✅ Data files created as specified? + +**Subprocess returns:** +Tools validation results checking which specified tools are configured and which data files were created, with overall quality assessment, status (✅/❌), and any gaps. + +--- + +**If subprocess unavailable:** Validate each requirement area sequentially in main context (larger context but still functional - demonstrates graceful fallback). + +--- + +### 4. Aggregate Findings and Update Report + +After ALL requirement area subprocesses complete, aggregate findings into validation report. + +Document the following information: + +**Plan Information:** +- Plan file location +- Whether a plan was found +- Total number of requirements extracted from the plan + +**Implementation Coverage:** +For each requirement area from the plan (Discovery/Vision, Classification attributes, Requirements specifications, Design elements, Tools): +- What was specified in the plan +- Whether it was implemented in the workflow +- Quality assessment (High/Medium/Low) +- Implementation status + +**Implementation Gaps:** +List any requirements from the plan that are NOT present in the built workflow + +**Quality Issues:** +List any requirements that are implemented but with quality concerns + +**Plan-Reality Alignment:** +Describe where the built workflow doesn't match what was planned + +**Overall Assessment:** +- Plan implementation score (percentage) +- Overall status (Fully Implemented/Partially Implemented/Poorly Implemented/Missing Critical Items) + +**Quality Assessment Framework:** +For each implemented requirement, assess quality: +- **High Quality**: Implementation follows best practices, would facilitate effectively +- **Medium Quality**: Functional but has issues or gaps +- **Low Quality**: Minimal/barely working, would not facilitate well + +Examples: +- Plan specifies "Highly collaborative, intent-based facilitation" and implementation has A/P menus with intent-based language = High Quality +- Plan specifies "Continuable workflow with session resume" and implementation has step-01b-continue.md tracking stepsCompleted = High Quality + +### 5. Append to Report + +Append the aggregated findings to {validationReportFile} after the "## Cohesive Review" section. + +### 6. Save and Complete + +Save the validation report. This is the final validation step. + +**Display:** +"**Plan Quality validation complete.** Validation report finalized." + +--- + +## 🚨 SYSTEM SUCCESS/FAILURE METRICS + +### ✅ SUCCESS: + +- Plan file loaded completely (in subprocess or main context) +- Every requirement extracted and validated using subprocess optimization when available +- Each requirement area analyzed in separate subprocess (or main context with graceful fallback) +- Implementation gaps documented with structured findings +- Quality assessed for each requirement +- Findings aggregated and appended to report +- Context saved via subprocess pattern (return only findings, not full file contents) + +### ❌ SYSTEM FAILURE: + +- Not loading complete plan +- Skipping requirement checks +- Not validating each requirement area deeply +- Not using subprocess optimization when available +- Not documenting implementation gaps +- Not assessing quality +- Loading full file contents into parent instead of returning only findings + +**Master Rule:** Validation is systematic and thorough. DO NOT BE LAZY. Check EVERY requirement from the plan. Use subprocess optimization (Pattern 2: per-requirement deep analysis) when available. Document all gaps. Return only findings to parent, not full file contents. diff --git a/src/modules/bmb/workflows/workflow/templates/minimal-output-template.md b/src/modules/bmb/workflows/workflow/templates/minimal-output-template.md new file mode 100644 index 00000000..ecb1fb97 --- /dev/null +++ b/src/modules/bmb/workflows/workflow/templates/minimal-output-template.md @@ -0,0 +1,11 @@ +--- +stepsCompleted: [] +lastStep: '' +date: '' +user_name: '' +project_name: '' +--- + +# {{document_title}} + +[Content will be progressively appended by workflow steps] diff --git a/src/modules/bmb/docs/workflows/templates/step-01-init-continuable-template.md b/src/modules/bmb/workflows/workflow/templates/step-01-init-continuable-template.md similarity index 97% rename from src/modules/bmb/docs/workflows/templates/step-01-init-continuable-template.md rename to src/modules/bmb/workflows/workflow/templates/step-01-init-continuable-template.md index 9b5794ef..84e4628c 100644 --- a/src/modules/bmb/docs/workflows/templates/step-01-init-continuable-template.md +++ b/src/modules/bmb/workflows/workflow/templates/step-01-init-continuable-template.md @@ -17,11 +17,11 @@ workflow\*path: `{project-root}/_bmad/[module-path]/workflows/[workflow-name]` # File References (all use {variable} format in file) -thisStepFile: `{workflow_path}/steps/step-01-init.md` -nextStepFile: `{workflow_path}/steps/step-02-[step-name].md` +thisStepFile: `./step-01-init.md` +nextStepFile: `./step-02-[step-name].md` workflowFile: `{workflow_path}/workflow.md` outputFile: `{output_folder}/[output-file-name]-{project_name}.md` -continueFile: `{workflow_path}/steps/step-01b-continue.md` +continueFile: `./step-01b-continue.md` templateFile: `{workflow_path}/templates/[main-template].md` # Template References diff --git a/src/modules/bmb/docs/workflows/templates/step-1b-template.md b/src/modules/bmb/workflows/workflow/templates/step-1b-template.md similarity index 99% rename from src/modules/bmb/docs/workflows/templates/step-1b-template.md rename to src/modules/bmb/workflows/workflow/templates/step-1b-template.md index 8e34bdd4..0f5e7104 100644 --- a/src/modules/bmb/docs/workflows/templates/step-1b-template.md +++ b/src/modules/bmb/workflows/workflow/templates/step-1b-template.md @@ -17,7 +17,7 @@ workflow\*path: '{project-root}/_bmad/[module-path]/workflows/[workflow-name]' # File References (all use {variable} format in file) -thisStepFile: '{workflow_path}/steps/step-01b-continue.md' +thisStepFile: './step-01b-continue.md' outputFile: '{output_folder}/[output-file-name]-{project_name}.md' workflowFile: '{workflow_path}/workflow.md' diff --git a/src/modules/bmb/docs/workflows/templates/step-template.md b/src/modules/bmb/workflows/workflow/templates/step-template.md similarity index 87% rename from src/modules/bmb/docs/workflows/templates/step-template.md rename to src/modules/bmb/workflows/workflow/templates/step-template.md index e5a1784c..87098d86 100644 --- a/src/modules/bmb/docs/workflows/templates/step-template.md +++ b/src/modules/bmb/workflows/workflow/templates/step-template.md @@ -15,15 +15,15 @@ workflow\*path: '{project-root}/_bmad/[module]/reference/workflows/[workflow-nam # File References (all use {variable} format in file) -thisStepFile: '{workflow_path}/steps/step-[N]-[short-name].md' -nextStep{N+1}: '{workflow_path}/steps/step-[N+1]-[next-short-name].md' # Remove for final step or no next step -altStep{Y}: '{workflow_path}/steps/step-[Y]-[some-other-step].md' # if there is an alternate next story depending on logic +thisStepFile: './step-[N]-[short-name].md' +nextStep{N+1}: './step-[N+1]-[next-short-name].md' # Remove for final step or no next step +altStep{Y}: './step-[Y]-[some-other-step].md' # if there is an alternate next story depending on logic workflowFile: '{workflow_path}/workflow.md' outputFile: '{output_folder}/[output-file-name]-{project_name}.md' # Task References (IF THE workflow uses and it makes sense in this step to have these ) -advancedElicitationTask: '{project-root}/_bmad/core/tasks/advanced-elicitation.xml' +advancedElicitationTask: '{project-root}/_bmad/core/workflows/advanced-elicitation/workflow.xml' partyModeWorkflow: '{project-root}/_bmad/core/workflows/party-mode/workflow.md' # Template References (if this step uses a specific templates) @@ -74,7 +74,7 @@ Example: "To analyze user requirements and document functional specifications th ## EXECUTION PROTOCOLS: -- 🎯 [Step-specific protocol 1] +- 🎯 Follow the MANDATORY SEQUENCE exactly - 💾 [Step-specific protocol 2 - e.g., document updates] - 📖 [Step-specific protocol 3 - e.g., tracking requirements] - 🚫 [Step-specific restriction] @@ -86,9 +86,9 @@ Example: "To analyze user requirements and document functional specifications th - Limits: [what not to assume or do] - Dependencies: [what this step depends on] -## Sequence of Instructions (Do not deviate, skip, or optimize) +## MANDATORY SEQUENCE -[Detailed instructions for the step's work] +**CRITICAL:** Follow this sequence exactly. Do not skip, reorder, or improvise unless user explicitly requests a change. ### 1. Title @@ -243,7 +243,7 @@ Display: "**Select an Option:** [A] [Continue to Step Foo] [A] [Continue to Step ### Initialization Step Example -See [step-01-init.md](https://github.com/bmad-code-org/BMAD-METHOD/blob/main/src/modules/bmb/reference/workflows/meal-prep-nutrition/steps/step-01-init.md) for an example of: +See [step-01-discovery.md](../steps-c/step-01-discovery.md) for an example of: - Detecting existing workflow state and short circuit to 1b - Creating output documents from templates @@ -252,16 +252,16 @@ See [step-01-init.md](https://github.com/bmad-code-org/BMAD-METHOD/blob/main/src ### Continuation Step Example -See [step-01b-continue.md](https://github.com/bmad-code-org/BMAD-METHOD/blob/main/src/modules/bmb/reference/workflows/meal-prep-nutrition/steps/step-01b-continue.md) for an example of: +See [step-01b-continue.md](../steps-c/step-01b-continuation.md) for an example of: -- Handling already-in-progress workflows -- Detecting completion status +- Handling already-in-progress workflows that the user now wants to continue progress +- Detecting completion status (which step was already completed last) - Presenting update vs new plan options -- Seamless workflow resumption +- Seamless workflow resumption by reviewing existing plan and output thus far that has been recorded and then jumping to the proper step ### Standard Step with Menu Example -See [step-02-profile.md](https://github.com/bmad-code-org/BMAD-METHOD/blob/main/src/modules/bmb/reference/workflows/meal-prep-nutrition/steps/step-02-profile.md) for an example of: +See [step-02-classification.md](../steps-c/step-02-classification.md#8-present-menu-options) for an example of: - Presenting a menu with A/P/C options - Forcing halt until user selects 'C' (Continue) @@ -271,12 +271,12 @@ See [step-02-profile.md](https://github.com/bmad-code-org/BMAD-METHOD/blob/main/ ### Final Step Example -See [step-06-prep-schedule.md](https://github.com/bmad-code-org/BMAD-METHOD/blob/main/src/modules/bmb/reference/workflows/meal-prep-nutrition/steps/step-06-prep-schedule.md) for an example of: +See [step-11-completion.md](../steps-c/step-11-completion.md) for an example of: - Completing workflow deliverables - Marking workflow as complete in frontmatter - Providing final success messages -- Ending the workflow session gracefully +- Ending the workflow session gracefully or moving on to a validation workflow if applicable ## Best Practices diff --git a/src/modules/bmb/docs/workflows/templates/workflow-template.md b/src/modules/bmb/workflows/workflow/templates/workflow-template.md similarity index 94% rename from src/modules/bmb/docs/workflows/templates/workflow-template.md rename to src/modules/bmb/workflows/workflow/templates/workflow-template.md index 5cc687a3..42a3d35f 100644 --- a/src/modules/bmb/docs/workflows/templates/workflow-template.md +++ b/src/modules/bmb/workflows/workflow/templates/workflow-template.md @@ -97,8 +97,6 @@ Copy the template above and replace: Update the last line of the workflow.md being created to replace [FIRST STEP FILE PATH] with the path to the actual first step file. -Example: Load, read the full file and then execute `{workflow_path}/steps/step-01-init.md` to begin the workflow. +Example: Load, read the full file and then execute `./step-01-init.md` to begin the workflow. -### NOTE: You can View a real example of a perfect workflow.md file that was created from this template - -`{project-root}/_bmad/bmb/reference/workflows/meal-prep-nutrition/workflow.md` +### NOTE: You can View a real example of a perfect workflow.md file from the one you were executed from `../workflow.md` diff --git a/src/modules/bmb/workflows/workflow/workflow.md b/src/modules/bmb/workflows/workflow/workflow.md new file mode 100644 index 00000000..692ea689 --- /dev/null +++ b/src/modules/bmb/workflows/workflow/workflow.md @@ -0,0 +1,109 @@ +--- +name: workflow +description: "Create structured standalone workflows using markdown-based step architecture (tri-modal: create, validate, edit)" +web_bundle: true +--- + +# Create Workflow + +**Goal:** Create structured, repeatable standalone workflows through collaborative conversation and step-by-step guidance. + +**Your Role:** In addition to your name, communication_style, and persona, you are also a workflow architect and systems designer collaborating with a workflow creator. This is a partnership, not a client-vendor relationship. You bring expertise in workflow design patterns, step architecture, and collaborative facilitation, while the user brings their domain knowledge and specific workflow requirements. Work together as equals. + +**Meta-Context:** The workflow architecture described below (step-file architecture, micro-file design, JIT loading, sequential enforcement, state tracking) is exactly what you'll be helping users create for their own workflows. You're demonstrating the pattern while building it with them. + +--- + +## WORKFLOW ARCHITECTURE + +This uses **step-file architecture** for disciplined execution: + +### Core Principles + +- **Micro-file Design**: Each step is a self contained instruction file that is a part of an overall workflow that must be followed exactly +- **Just-In-Time Loading**: Only the current step file is in memory - never load future step files until told to do so +- **Sequential Enforcement**: Sequence within the step files must be completed in order, no skipping or optimization allowed +- **State Tracking**: Document progress in output file frontmatter using `stepsCompleted` array when a workflow produces a document +- **Append-Only Building**: Build documents by appending content as directed to the output file +- **Tri-Modal Structure**: Separate step folders for Create (steps-c/), Validate (steps-v/), and Edit (steps-e/) modes + +### Step Processing Rules + +1. **READ COMPLETELY**: Always read the entire step file before taking any action +2. **FOLLOW SEQUENCE**: Execute all numbered sections in order, never deviate +3. **WAIT FOR INPUT**: If a menu is presented, halt and wait for user selection +4. **CHECK CONTINUATION**: If the step has a menu with Continue as an option, only proceed to next step when user selects 'C' (Continue) +5. **SAVE STATE**: Update `stepsCompleted` in frontmatter before loading next step +6. **LOAD NEXT**: When directed, load, read entire file, then execute the next step file + +### Critical Rules (NO EXCEPTIONS) + +- 🛑 **NEVER** load multiple step files simultaneously +- 📖 **ALWAYS** read entire step file before execution +- 🚫 **NEVER** skip steps or optimize the sequence +- 💾 **ALWAYS** update frontmatter of output files when writing the final output for a specific step +- 🎯 **ALWAYS** follow the exact instructions in the step file +- ⏸️ **ALWAYS** halt at menus and wait for user input +- 📋 **NEVER** create mental todo lists from future steps +- ✅ YOU MUST ALWAYS SPEAK OUTPUT In your Agent communication style with the config `{communication_language}` + +--- + +## INITIALIZATION SEQUENCE + +### 1. Configuration Loading + +Load and read full config from {project-root}/_bmad/bmb/config.yaml and resolve: + +- `project_name`, `output_folder`, `user_name`, `communication_language`, `document_output_language`, `bmb_creations_output_folder` +- ✅ YOU MUST ALWAYS SPEAK OUTPUT In your Agent communication style with the config `{communication_language}` + +### 2. Mode Determination + +**Check if mode was specified in the command invocation:** + +- If user invoked with "create workflow" or "new workflow" or "build workflow" → Set mode to **create** +- If user invoked with "validate workflow" or "review workflow" or "-v" or "--validate" → Set mode to **validate** +- If user invoked with "validate workflow MAX-PARALLEL" or "review workflow MAX-PARALLEL" or "-vmax" or "--validate-max" → Set mode to **validate-max-parallel** +- If user invoked with "edit workflow" or "modify workflow" or "-e" or "--edit" → Set mode to **edit** + +**If mode is still unclear, ask user:** + +"Welcome to the BMAD Workflow Creator! What would you like to do? + +**[C]reate** - Build a new workflow from scratch +**[V]alidate** - Review an existing workflow and generate validation report +**[VMP] Validate Max Parallel** - Review an existing workflow and generate validation report running max steps as possible in parallel +**[E]dit** - Modify an existing workflow + +Please select: [C]reate / [V]alidate / [E]dit" + +### 3. Route to First Step + +**IF mode == create:** + +"**Creating a new workflow. How would you like to start?** + +**[F]rom scratch** - Start with a blank slate - I'll help you discover your idea +**[C]onvert existing** - Convert an existing workflow to BMAD compliant format + +Please select: [F]rom scratch / [C]onvert existing" + +#### Create Mode Routing: + +- **IF F:** Load, read completely, then execute `steps-c/step-01-discovery.md` +- **IF C:** Ask for workflow path: "Please provide the path to the workflow you want to convert." + Then load, read completely, then execute `steps-c/step-00-conversion.md` +- **IF Any other:** help user respond, then redisplay create mode menu + +**IF mode == validate:** +Prompt for workflow path: "Which workflow would you like to validate? Please provide the path to the workflow.md file." +Then load, read completely, and execute `steps-v/step-01-validate.md` + +**IF mode == validate-max-parallel:** +Prompt for workflow path: "Which workflow would you like to validate? Please provide the path to the workflow.md file." validate a subprocess or task agent tool or similar is available +Then load, read completely, and execute `steps-v/step-01-validate-max-mode.md` + +**IF mode == edit:** +Prompt for workflow path: "Which workflow would you like to edit? Please provide the path to the workflow.md file." +Then load, read completely, and execute `steps-e/step-e-01-assess-workflow.md` diff --git a/src/modules/bmgd/agents/game-architect.agent.yaml b/src/modules/bmgd/agents/game-architect.agent.yaml index 3b28024d..7099b6b2 100644 --- a/src/modules/bmgd/agents/game-architect.agent.yaml +++ b/src/modules/bmgd/agents/game-architect.agent.yaml @@ -7,6 +7,7 @@ agent: title: Game Architect icon: 🏛️ module: bmgd + hasSidecar: false persona: role: Principal Game Systems Architect + Technical Director @@ -25,28 +26,19 @@ agent: - "Always document performance budgets and critical path decisions" menu: - - trigger: workflow-status + - trigger: WS or fuzzy match on workflow-status workflow: "{project-root}/_bmad/bmgd/workflows/workflow-status/workflow.yaml" - description: Get workflow status or initialize a workflow if not already done + description: "[WS] Get workflow status or initialize a workflow if not already done (optional)" - - trigger: create-architecture + - trigger: GA or fuzzy match on game-architecture exec: "{project-root}/_bmad/bmgd/workflows/3-technical/game-architecture/workflow.md" - description: Produce a Scale Adaptive Game Architecture + description: "[GA] Produce a Scale Adaptive Game Architecture" - - trigger: generate-project-context + - trigger: PC or fuzzy match on project-context exec: "{project-root}/_bmad/bmgd/workflows/3-technical/generate-project-context/workflow.md" - description: Create optimized project-context.md for AI agent consistency + description: "[PC] Create optimized project-context.md for AI agent consistency" - - trigger: correct-course + - trigger: CC or fuzzy match on correct-course workflow: "{project-root}/_bmad/bmgd/workflows/4-production/correct-course/workflow.yaml" - description: Course Correction Analysis (when implementation is off-track) + description: "[CC] Course Correction Analysis (when implementation is off-track)" ide-only: true - - - trigger: party-mode - exec: "{project-root}/_bmad/core/workflows/party-mode/workflow.md" - description: Bring the whole team in to chat with other expert agents from the party - - - trigger: advanced-elicitation - exec: "{project-root}/_bmad/core/tasks/advanced-elicitation.xml" - description: Advanced elicitation techniques to challenge the LLM to get better results - web-only: true diff --git a/src/modules/bmgd/agents/game-designer.agent.yaml b/src/modules/bmgd/agents/game-designer.agent.yaml index 6f6b02dc..6b654dec 100644 --- a/src/modules/bmgd/agents/game-designer.agent.yaml +++ b/src/modules/bmgd/agents/game-designer.agent.yaml @@ -7,6 +7,7 @@ agent: title: Game Designer icon: 🎲 module: bmgd + hasSidecar: false persona: role: Lead Game Designer + Creative Vision Architect @@ -22,39 +23,27 @@ agent: - "When creating GDDs, always validate against game pillars and core loop" menu: - - trigger: workflow-status + - trigger: WS or fuzzy match on workflow-status workflow: "{project-root}/_bmad/bmgd/workflows/workflow-status/workflow.yaml" - description: Get workflow status or initialize a workflow if not already done + description: "[WS] Get workflow status or initialize a workflow if not already done (optional)" - - multi: "[BG] Brainstorm Game, [GB] Create Game Brief, [GDD] Create GDD, [ND] Narrative Design" - triggers: - - brainstorm-game: - - input: BG or fuzzy match brainstorm game - - route: "{project-root}/_bmad/bmgd/workflows/1-preproduction/brainstorm-game/workflow.md" - - type: exec - - create-game-brief: - - input: GB or fuzzy match create game brief - - route: "{project-root}/_bmad/bmgd/workflows/1-preproduction/game-brief/workflow.md" - - type: exec - - create-gdd: - - input: GDD or fuzzy match create gdd - - route: "{project-root}/_bmad/bmgd/workflows/2-design/gdd/workflow.md" - - type: exec - - narrative: - - input: ND or fuzzy match narrative design - - route: "{project-root}/_bmad/bmgd/workflows/2-design/narrative/workflow.md" - - type: exec + - trigger: BG or fuzzy match on brainstorm-game + exec: "{project-root}/_bmad/bmgd/workflows/1-preproduction/brainstorm-game/workflow.md" + description: "[BG] Brainstorm Game ideas and concepts" - - trigger: quick-prototype + - trigger: GB or fuzzy match on game-brief + exec: "{project-root}/_bmad/bmgd/workflows/1-preproduction/game-brief/workflow.md" + description: "[GB] Create a Game Brief document" + + - trigger: GDD or fuzzy match on create-gdd + exec: "{project-root}/_bmad/bmgd/workflows/2-design/gdd/workflow.md" + description: "[GDD] Create a Game Design Document" + + - trigger: ND or fuzzy match on narrative-design + exec: "{project-root}/_bmad/bmgd/workflows/2-design/narrative/workflow.md" + description: "[ND] Design narrative elements and story" + + - trigger: QP or fuzzy match on quick-prototype workflow: "{project-root}/_bmad/bmgd/workflows/bmgd-quick-flow/quick-prototype/workflow.yaml" - description: Rapid game prototyping - test mechanics and ideas quickly + description: "[QP] Rapid game prototyping - test mechanics and ideas quickly" ide-only: true - - - trigger: party-mode - exec: "{project-root}/_bmad/core/workflows/party-mode/workflow.md" - description: Bring the whole team in to chat with other expert agents from the party - - - trigger: advanced-elicitation - exec: "{project-root}/_bmad/core/tasks/advanced-elicitation.xml" - description: Advanced elicitation techniques to challenge the LLM to get better results - web-only: true diff --git a/src/modules/bmgd/agents/game-dev.agent.yaml b/src/modules/bmgd/agents/game-dev.agent.yaml index 381aef21..ff085a34 100644 --- a/src/modules/bmgd/agents/game-dev.agent.yaml +++ b/src/modules/bmgd/agents/game-dev.agent.yaml @@ -7,6 +7,7 @@ agent: title: Game Developer icon: 🕹️ module: bmgd + hasSidecar: false persona: role: Senior Game Developer + Technical Implementation Specialist @@ -24,33 +25,29 @@ agent: - "Always check for performance implications on game loop code" menu: - - trigger: workflow-status + - trigger: WS or fuzzy match on workflow-status workflow: "{project-root}/_bmad/bmgd/workflows/workflow-status/workflow.yaml" - description: Get workflow status or check current sprint progress + description: "[WS] Get workflow status or check current sprint progress (optional)" - - trigger: dev-story + - trigger: DS or fuzzy match on dev-story workflow: "{project-root}/_bmad/bmgd/workflows/4-production/dev-story/workflow.yaml" - description: Execute Dev Story workflow, implementing tasks and tests + description: "[DS] Execute Dev Story workflow, implementing tasks and tests" - - trigger: code-review + - trigger: CR or fuzzy match on code-review workflow: "{project-root}/_bmad/bmgd/workflows/4-production/code-review/workflow.yaml" - description: Perform a thorough clean context QA code review on a story flagged Ready for Review + description: "[CR] Perform a thorough clean context QA code review on a story flagged Ready for Review" - - trigger: quick-dev + - trigger: QD or fuzzy match on quick-dev workflow: "{project-root}/_bmad/bmgd/workflows/bmgd-quick-flow/quick-dev/workflow.yaml" - description: Flexible game development - implement features with game-specific considerations + description: "[QD] Flexible game development - implement features with game-specific considerations" ide-only: true - - trigger: quick-prototype + - trigger: QP or fuzzy match on quick-prototype workflow: "{project-root}/_bmad/bmgd/workflows/bmgd-quick-flow/quick-prototype/workflow.yaml" - description: Rapid game prototyping - test mechanics and ideas quickly + description: "[QP] Rapid game prototyping - test mechanics and ideas quickly" ide-only: true - - trigger: party-mode - exec: "{project-root}/_bmad/core/workflows/party-mode/workflow.md" - description: Bring the whole team in to chat with other expert agents from the party - - - trigger: advanced-elicitation - exec: "{project-root}/_bmad/core/tasks/advanced-elicitation.xml" - description: Advanced elicitation techniques to challenge the LLM to get better results + - trigger: AE or fuzzy match on advanced-elicitation + exec: "{project-root}/_bmad/core/workflows/advanced-elicitation/workflow.xml" + description: "[AE] Advanced elicitation techniques to challenge the LLM to get better results" web-only: true diff --git a/src/modules/bmgd/agents/game-qa.agent.yaml b/src/modules/bmgd/agents/game-qa.agent.yaml index 1c8dc595..973d521c 100644 --- a/src/modules/bmgd/agents/game-qa.agent.yaml +++ b/src/modules/bmgd/agents/game-qa.agent.yaml @@ -7,6 +7,7 @@ agent: title: Game QA Architect icon: 🧪 module: bmgd + hasSidecar: false persona: role: Game QA Architect + Test Automation Specialist @@ -21,44 +22,46 @@ agent: critical_actions: - "Consult {project-root}/_bmad/bmgd/gametest/qa-index.csv to select knowledge fragments under knowledge/ and load only the files needed for the current task" + - "For E2E testing requests, always load knowledge/e2e-testing.md first" + - "When scaffolding tests, distinguish between unit, integration, and E2E test needs" - "Load the referenced fragment(s) from {project-root}/_bmad/bmgd/gametest/knowledge/ before giving recommendations" - "Cross-check recommendations with the current official Unity Test Framework, Unreal Automation, or Godot GUT documentation" - "Find if this exists, if it does, always treat it as the bible I plan and execute against: `**/project-context.md`" menu: - - trigger: workflow-status + - trigger: WS or fuzzy match on workflow-status workflow: "{project-root}/_bmad/bmgd/workflows/workflow-status/workflow.yaml" - description: Get workflow status or check current project state + description: "[WS] Get workflow status or check current project state (optional)" - - trigger: test-framework + - trigger: TF or fuzzy match on test-framework workflow: "{project-root}/_bmad/bmgd/workflows/gametest/test-framework/workflow.yaml" - description: Initialize game test framework (Unity/Unreal/Godot) + description: "[TF] Initialize game test framework (Unity/Unreal/Godot)" - - trigger: test-design + - trigger: TD or fuzzy match on test-design workflow: "{project-root}/_bmad/bmgd/workflows/gametest/test-design/workflow.yaml" - description: Create comprehensive game test scenarios + description: "[TD] Create comprehensive game test scenarios" - - trigger: automate + - trigger: TA or fuzzy match on test-automate workflow: "{project-root}/_bmad/bmgd/workflows/gametest/automate/workflow.yaml" - description: Generate automated game tests + description: "[TA] Generate automated game tests" - - trigger: playtest-plan + - trigger: ES or fuzzy match on e2e-scaffold + workflow: "{project-root}/_bmad/bmgd/workflows/gametest/e2e-scaffold/workflow.yaml" + description: "[ES] Scaffold E2E testing infrastructure" + + - trigger: PP or fuzzy match on playtest-plan workflow: "{project-root}/_bmad/bmgd/workflows/gametest/playtest-plan/workflow.yaml" - description: Create structured playtesting plan + description: "[PP] Create structured playtesting plan" - - trigger: performance-test + - trigger: PT or fuzzy match on performance-test workflow: "{project-root}/_bmad/bmgd/workflows/gametest/performance/workflow.yaml" - description: Design performance testing strategy + description: "[PT] Design performance testing strategy" - - trigger: test-review + - trigger: TR or fuzzy match on test-review workflow: "{project-root}/_bmad/bmgd/workflows/gametest/test-review/workflow.yaml" - description: Review test quality and coverage + description: "[TR] Review test quality and coverage" - - trigger: party-mode - exec: "{project-root}/_bmad/core/workflows/party-mode/workflow.md" - description: Bring the whole team in to chat with other expert agents from the party - - - trigger: advanced-elicitation - exec: "{project-root}/_bmad/core/tasks/advanced-elicitation.xml" - description: Advanced elicitation techniques to challenge the LLM to get better results + - trigger: AE or fuzzy match on advanced-elicitation + exec: "{project-root}/_bmad/core/workflows/advanced-elicitation/workflow.xml" + description: "[AE] Advanced elicitation techniques to challenge the LLM to get better results" web-only: true diff --git a/src/modules/bmgd/agents/game-scrum-master.agent.yaml b/src/modules/bmgd/agents/game-scrum-master.agent.yaml index 39c41004..1b2d599f 100644 --- a/src/modules/bmgd/agents/game-scrum-master.agent.yaml +++ b/src/modules/bmgd/agents/game-scrum-master.agent.yaml @@ -7,6 +7,7 @@ agent: title: Game Dev Scrum Master icon: 🎯 module: bmgd + hasSidecar: false persona: role: Game Development Scrum Master + Sprint Orchestrator @@ -24,40 +25,36 @@ agent: - "Generate complete story drafts from existing documentation without additional elicitation" menu: - - trigger: workflow-status + - trigger: WS or fuzzy match on workflow-status workflow: "{project-root}/_bmad/bmgd/workflows/workflow-status/workflow.yaml" - description: Get workflow status or initialize a workflow if not already done + description: "[WS] Get workflow status or initialize a workflow if not already done (optional)" - - trigger: sprint-planning + - trigger: SP or fuzzy match on sprint-planning workflow: "{project-root}/_bmad/bmgd/workflows/4-production/sprint-planning/workflow.yaml" - description: Generate or update sprint-status.yaml from epic files (Required after GDD+Epics are created) + description: "[SP] Generate or update sprint-status.yaml from epic files (Required after GDD+Epics are created)" - - trigger: sprint-status + - trigger: SS or fuzzy match on sprint-status workflow: "{project-root}/_bmad/bmgd/workflows/4-production/sprint-status/workflow.yaml" - description: View sprint progress, surface risks, and get next action recommendation + description: "[SS] View sprint progress, surface risks, and get next action recommendation" - - trigger: create-story + - trigger: CS or fuzzy match on create-story workflow: "{project-root}/_bmad/bmgd/workflows/4-production/create-story/workflow.yaml" - description: Create Story with direct ready-for-dev marking (Required to prepare stories for development) + description: "[CS] Create Story with direct ready-for-dev marking (Required to prepare stories for development)" - - trigger: validate-create-story + - trigger: VS or fuzzy match on validate-story validate-workflow: "{project-root}/_bmad/bmgd/workflows/4-production/create-story/workflow.yaml" - description: Validate Story Draft with Independent Review (Highly Recommended) + description: "[VS] Validate Story Draft with Independent Review (Highly Recommended)" - - trigger: epic-retrospective + - trigger: ER or fuzzy match on epic-retrospective workflow: "{project-root}/_bmad/bmgd/workflows/4-production/retrospective/workflow.yaml" data: "{project-root}/_bmad/_config/agent-manifest.csv" - description: Facilitate team retrospective after a game development epic is completed + description: "[ER] Facilitate team retrospective after a game development epic is completed" - - trigger: correct-course + - trigger: CC or fuzzy match on correct-course workflow: "{project-root}/_bmad/bmgd/workflows/4-production/correct-course/workflow.yaml" - description: Navigate significant changes during game dev sprint (When implementation is off-track) + description: "[CC] Navigate significant changes during game dev sprint (When implementation is off-track)" - - trigger: party-mode - exec: "{project-root}/_bmad/core/workflows/party-mode/workflow.md" - description: Bring the whole team in to chat with other expert agents from the party - - - trigger: advanced-elicitation - exec: "{project-root}/_bmad/core/tasks/advanced-elicitation.xml" - description: Advanced elicitation techniques to challenge the LLM to get better results + - trigger: AE or fuzzy match on advanced-elicitation + exec: "{project-root}/_bmad/core/workflows/advanced-elicitation/workflow.xml" + description: "[AE] Advanced elicitation techniques to challenge the LLM to get better results" web-only: true diff --git a/src/modules/bmgd/agents/game-solo-dev.agent.yaml b/src/modules/bmgd/agents/game-solo-dev.agent.yaml index 1b63be37..42df4c9f 100644 --- a/src/modules/bmgd/agents/game-solo-dev.agent.yaml +++ b/src/modules/bmgd/agents/game-solo-dev.agent.yaml @@ -7,6 +7,7 @@ agent: title: Game Solo Dev icon: 🎮 module: bmgd + hasSidecar: false persona: role: Elite Indie Game Developer + Quick Flow Specialist @@ -22,35 +23,31 @@ agent: - "Find if this exists, if it does, always treat it as the bible I plan and execute against: `**/project-context.md`" menu: - - trigger: workflow-status + - trigger: WS or fuzzy match on workflow-status workflow: "{project-root}/_bmad/bmgd/workflows/workflow-status/workflow.yaml" - description: Get workflow status or check current project state + description: "[WS] Get workflow status or check current project state (optional)" - - trigger: quick-prototype + - trigger: QP or fuzzy match on quick-prototype workflow: "{project-root}/_bmad/bmgd/workflows/bmgd-quick-flow/quick-prototype/workflow.yaml" - description: Rapid prototype to test if the mechanic is fun (Start here for new ideas) + description: "[QP] Rapid prototype to test if the mechanic is fun (Start here for new ideas)" - - trigger: quick-dev + - trigger: QD or fuzzy match on quick-dev workflow: "{project-root}/_bmad/bmgd/workflows/bmgd-quick-flow/quick-dev/workflow.yaml" - description: Implement features end-to-end solo with game-specific considerations + description: "[QD] Implement features end-to-end solo with game-specific considerations" - - trigger: create-tech-spec - workflow: "{project-root}/_bmad/bmgd/workflows/bmgd-quick-flow/create-tech-spec/workflow.yaml" - description: Architect a technical spec with implementation-ready stories + - trigger: TS or fuzzy match on tech-spec + workflow: "{project-root}/_bmad/bmgd/workflows/bmgd-quick-flow/quick-spec/workflow.yaml" + description: "[TS] Architect a technical spec with implementation-ready stories" - - trigger: code-review + - trigger: CR or fuzzy match on code-review workflow: "{project-root}/_bmad/bmgd/workflows/4-production/code-review/workflow.yaml" - description: Review code quality (use fresh context for best results) + description: "[CR] Review code quality (use fresh context for best results)" - - trigger: test-framework + - trigger: TF or fuzzy match on test-framework workflow: "{project-root}/_bmad/bmgd/workflows/gametest/test-framework/workflow.yaml" - description: Set up automated testing for your game engine + description: "[TF] Set up automated testing for your game engine" - - trigger: party-mode - exec: "{project-root}/_bmad/core/workflows/party-mode/workflow.md" - description: Bring in other experts when specialized backup is needed - - - trigger: advanced-elicitation - exec: "{project-root}/_bmad/core/tasks/advanced-elicitation.xml" - description: Advanced elicitation techniques to challenge the LLM to get better results + - trigger: AE or fuzzy match on advanced-elicitation + exec: "{project-root}/_bmad/core/workflows/advanced-elicitation/workflow.xml" + description: "[AE] Advanced elicitation techniques to challenge the LLM to get better results" web-only: true diff --git a/src/modules/bmgd/docs/glossary.md b/src/modules/bmgd/docs/glossary.md deleted file mode 100644 index f4765038..00000000 --- a/src/modules/bmgd/docs/glossary.md +++ /dev/null @@ -1,294 +0,0 @@ -# BMGD Glossary - -Key game development terminology used in BMGD workflows. - ---- - -## A - -### Acceptance Criteria - -Specific conditions that must be met for a story to be considered complete. Defines "done" for implementation. - -### Act Structure - -Story organization into major sections (typically 3 acts: Setup, Confrontation, Resolution). - ---- - -## B - -### Backlog - -List of pending work items (epics, stories) waiting to be scheduled and implemented. - -### Boss Design - -Design of significant enemy encounters, typically featuring unique mechanics and increased challenge. - ---- - -## C - -### Character Arc - -The transformation a character undergoes through the story, from initial state to final state. - -### Core Fantasy - -The emotional experience players seek from your game. What they want to FEEL. - -### Core Loop - -The fundamental cycle of actions players repeat throughout gameplay. The heart of your game. - ---- - -## D - -### Definition of Done (DoD) - -Checklist of requirements that must be satisfied before work is considered complete. - -### Design Pillar - -Core principle that guides all design decisions. Typically 3-5 pillars define a game's identity. - ---- - -## E - -### Environmental Storytelling - -Narrative communicated through the game world itself—visual details, audio, found documents—rather than explicit dialogue. - -### Epic - -Large body of work that can be broken down into smaller stories. Represents a major feature or system. - ---- - -## F - -### Frame Data - -In fighting games, the precise timing information for moves (startup, active, recovery frames). - -### Frontmatter - -YAML metadata at the beginning of markdown files, used for workflow state tracking. - ---- - -## G - -### Game Brief - -Document capturing the game's core vision, pillars, target audience, and scope. Foundation for the GDD. - -### Game Design Document (GDD) - -Comprehensive document detailing all aspects of game design: mechanics, systems, content, and more. - -### Game Type - -Genre classification that determines which specialized GDD sections are included. - ---- - -## H - -### Hot Path - -Code that executes frequently (every frame). Must be optimized for performance. - ---- - -## I - -### Idle Progression - -Game mechanics where progress continues even when the player isn't actively playing. - ---- - -## K - -### Kishotenketsu - -Four-act story structure from East Asian narrative tradition (Introduction, Development, Twist, Conclusion). - ---- - -## L - -### Localization - -Adapting game content for different languages and cultures. - ---- - -## M - -### MDA Framework - -Mechanics → Dynamics → Aesthetics. Framework for analyzing and designing games. - -### Meta-Progression - -Persistent progression that carries between individual runs or sessions. - -### Metroidvania - -Genre featuring interconnected world exploration with ability-gated progression. - ---- - -## N - -### Narrative Complexity - -How central story is to the game experience (Critical, Heavy, Moderate, Light). - -### Netcode - -Networking code handling multiplayer communication and synchronization. - ---- - -## P - -### Permadeath - -Game mechanic where character death is permanent, typically requiring a new run. - -### Player Agency - -The degree to which players can make meaningful choices that affect outcomes. - -### Procedural Generation - -Algorithmic creation of game content (levels, items, characters) rather than hand-crafted. - ---- - -## R - -### Retrospective - -Team meeting after completing work to reflect on what went well and what to improve. - -### Roguelike - -Genre featuring procedural generation, permadeath, and run-based progression. - -### Run - -A single playthrough in a roguelike or run-based game, from start to death/completion. - ---- - -## S - -### Sprint - -Time-boxed period of development work, typically 1-2 weeks. - -### Sprint Status - -Tracking document showing current sprint progress, story states, and blockers. - -### Story - -Smallest unit of implementable work with clear acceptance criteria. Part of an epic. - -### Story Context - -Assembled documentation and code context needed to implement a specific story. - -### Story Gates - -Points where story progression is blocked until certain gameplay conditions are met. - ---- - -## T - -### Tech Spec - -Technical specification document detailing how a feature will be implemented. - -### TDD (Test-Driven Development) - -Development approach: write tests first, then implement code to pass them. - ---- - -## U - -### UI/UX - -User Interface / User Experience. How players interact with and experience the game. - ---- - -## V - -### Visual Novel - -Genre focused on narrative with static images, dialogue, and player choices. - -### Voice Acting - -Recorded spoken dialogue for game characters. - ---- - -## W - -### Workflow - -Structured process for completing a specific type of work (e.g., GDD creation, story implementation). - -### Workflow Status - -Current state of project workflows, tracking which phases and documents are complete. - -### World Building - -Creation of the game's setting, including history, culture, geography, and lore. - ---- - -## BMGD-Specific Terms - -### A/P/C Menu - -Options presented after content generation: - -- **A** - Advanced Elicitation (explore deeper) -- **P** - Party Mode (multi-agent discussion) -- **C** - Continue (save and proceed) - -### Narrative Complexity Levels - -- **Critical** - Story IS the game (visual novels) -- **Heavy** - Deep narrative with gameplay (RPGs) -- **Moderate** - Meaningful story supporting gameplay -- **Light** - Minimal story, gameplay-focused - -### Step-File Architecture - -BMGD workflow pattern using separate markdown files for each workflow step. - -### Workflow-Install Pattern - -Phase 4 workflows inherit from BMM base and add BMGD-specific overrides. - ---- - -## Next Steps - -- **[Quick Start Guide](./quick-start.md)** - Get started with BMGD -- **[Game Types Guide](./game-types-guide.md)** - Game genre reference -- **[Troubleshooting](./troubleshooting.md)** - Common issues and solutions diff --git a/src/modules/bmgd/docs/index.md b/src/modules/bmgd/docs/index.md deleted file mode 100644 index 06ddba4b..00000000 --- a/src/modules/bmgd/docs/index.md +++ /dev/null @@ -1,180 +0,0 @@ -# BMGD Documentation - -Complete guides for the BMad Game Development Module (BMGD) - AI-powered workflows for game design and development that adapt to your project's needs. - ---- - -## Getting Started - -**New to BMGD?** Start here: - -- **[Quick Start Guide](./quick-start.md)** - Get started building your first game - - Installation and setup - - Understanding the game development phases - - Running your first workflows - - Agent-based development flow - -**Quick Path:** Install BMGD module → Game Brief → GDD → Architecture → Build - ---- - -## Core Concepts - -Understanding how BMGD works: - -- **[Agents Guide](./agents-guide.md)** - Complete reference for game development agents - - Game Designer, Game Developer, Game Architect, Game Scrum Master, Game QA, Game Solo Dev - - Agent roles and when to use them - - Agent workflows and menus - -- **[Workflows Guide](./workflows-guide.md)** - Complete workflow reference - - Phase 1: Preproduction (Brainstorm, Game Brief) - - Phase 2: Design (GDD, Narrative) - - Phase 3: Technical (Architecture) - - Phase 4: Production (Sprint-based development) - -- **[Game Types Guide](./game-types-guide.md)** - Selecting and using game type templates - - 24 supported game types - - Genre-specific GDD sections - - Hybrid game type handling - -- **[Quick-Flow Guide](./quick-flow-guide.md)** - Fast-track workflows for rapid development - - Quick-Prototype for testing ideas - - Quick-Dev for flexible implementation - - When to use quick-flow vs full BMGD - ---- - -## Quick References - -Essential reference materials: - -- **[Glossary](./glossary.md)** - Key game development terminology -- **[Troubleshooting](./troubleshooting.md)** - Common issues and solutions - ---- - -## Choose Your Path - -### I need to... - -**Start a new game project** -→ Start with [Quick Start Guide](./quick-start.md) -→ Run `brainstorm-game` for ideation -→ Create a Game Brief with `create-brief` - -**Design my game** -→ Create a GDD with `create-gdd` -→ If story-heavy, add Narrative Design with `create-narrative` - -**Plan the technical architecture** -→ Run `create-architecture` with the Game Architect - -**Build my game** -→ Use Phase 4 production workflows -→ Follow the sprint-based development cycle - -**Quickly test an idea or implement a feature** -→ Use [Quick-Flow](./quick-flow-guide.md) for rapid prototyping and development -→ `quick-prototype` to test mechanics, `quick-dev` to implement - -**Set up testing and QA** -→ Use Game QA agent for test framework setup -→ Run `test-framework` to initialize testing for Unity/Unreal/Godot -→ Use `test-design` to create test scenarios -→ Plan playtests with `playtest-plan` - -**Understand game type templates** -→ See [Game Types Guide](./game-types-guide.md) - ---- - -## Game Development Phases - -BMGD follows four phases aligned with game development: - -![BMGD Workflow Overview](./workflow-overview.jpg) - -### Phase 1: Preproduction - -- **Brainstorm Game** - Ideation with game-specific techniques -- **Game Brief** - Capture vision, market, and fundamentals - -### Phase 2: Design - -- **GDD (Game Design Document)** - Comprehensive game design -- **Narrative Design** - Story, characters, world (for story-driven games) - -### Phase 3: Technical - -- **Game Architecture** - Engine, systems, patterns, structure - -### Phase 4: Production - -- **Sprint Planning** - Epic and story management -- **Story Development** - Implementation workflow -- **Code Review** - Quality assurance -- **Testing** - Automated tests, playtesting, performance -- **Retrospective** - Continuous improvement - ---- - -## BMGD vs BMM - -BMGD extends BMM with game-specific capabilities: - -| Aspect | BMM | BMGD | -| -------------- | ------------------------------------- | ------------------------------------------------------------------------ | -| **Focus** | General software | Game development | -| **Agents** | PM, Architect, Dev, SM, TEA, Solo Dev | Game Designer, Game Dev, Game Architect, Game SM, Game QA, Game Solo Dev | -| **Planning** | PRD, Tech Spec | Game Brief, GDD | -| **Types** | N/A | 24 game type templates | -| **Narrative** | N/A | Full narrative workflow | -| **Testing** | Web-focused testarch | Engine-specific (Unity, Unreal, Godot) | -| **Production** | Inherited from BMM | BMM workflows with game overrides | - -BMGD production workflows inherit from BMM and add game-specific checklists and templates. - ---- - -## Documentation Map - -``` -BMGD Documentation -├── README.md (this file) -├── quick-start.md # Getting started -├── agents-guide.md # Agent reference -├── workflows-guide.md # Workflow reference -├── quick-flow-guide.md # Rapid prototyping and development -├── game-types-guide.md # Game type templates -├── glossary.md # Terminology -└── troubleshooting.md # Common issues -``` - ---- - -## External Resources - -### Community and Support - -- **[Discord Community](https://discord.gg/gk8jAdXWmj)** - Get help from the community -- **[GitHub Issues](https://github.com/bmad-code-org/BMAD-METHOD/issues)** - Report bugs or request features -- **[YouTube Channel](https://www.youtube.com/@BMadCode)** - Video tutorials - -### Related Documentation - -- **[BMM Documentation](../../bmm/docs/index.md)** - Core BMad Method documentation -- **[IDE Guides](../../ide-info/)** - Configure your development environment - ---- - -## Tips for Using This Documentation - -1. **Start with Quick Start** if you're new to BMGD -2. **Check Game Types Guide** when creating your GDD -3. **Reference Glossary** for game development terminology -4. **Use Troubleshooting** when you encounter issues - ---- - -**Ready to make games?** → [Start with the Quick Start Guide](./quick-start.md) diff --git a/src/modules/bmgd/docs/quick-flow-guide.md b/src/modules/bmgd/docs/quick-flow-guide.md deleted file mode 100644 index 9dfc504d..00000000 --- a/src/modules/bmgd/docs/quick-flow-guide.md +++ /dev/null @@ -1,288 +0,0 @@ -# BMGD Quick-Flow Guide - -Fast-track workflows for rapid game prototyping and flexible development. - ---- - -## Game Solo Dev Agent - -For dedicated quick-flow development, use the **Game Solo Dev** agent (Indie). This agent is optimized for solo developers and small teams who want to skip the full planning phases and ship fast. - -**Switch to Game Solo Dev:** Type `@game-solo-dev` or select the agent from your IDE. - -The Game Solo Dev agent includes: - -- `quick-prototype` - Rapid mechanic testing -- `quick-dev` - Flexible feature implementation -- `create-tech-spec` - Create implementation-ready specs -- `code-review` - Quality checks -- `test-framework` - Automated testing setup - ---- - -## Overview - -Quick-flow workflows skip the full BMGD planning phases when you need to move fast. Use them for: - -- Testing a game mechanic idea -- Implementing a small feature -- Rapid prototyping before committing to design -- Bug fixes and tweaks - -``` -Full BMGD Flow: -Brief → GDD → Architecture → Sprint Planning → Stories → Implementation - -Quick-Flow: -Idea → Quick-Prototype → Quick-Dev → Done -``` - ---- - -## Quick-Prototype - -**Command:** `quick-prototype` -**Agent:** Game Designer, Game Developer -**Purpose:** Rapidly test gameplay ideas with minimal setup - -### When to Use - -- You have a mechanic idea and want to test the "feel" -- You're not sure if something will be fun -- You want to experiment before committing to design -- You need a proof of concept - -### Workflow Steps - -1. **Define Scope** - What are you prototyping? (mechanic, feature, system) -2. **Set Success Criteria** - How will you know if it works? -3. **Rapid Implementation** - Build the minimum to test the idea -4. **Playtest and Evaluate** - Does it feel right? - -### Prototype Principles - -- **Minimum Viable Prototype** - Only what's needed to test the idea -- **Hardcode First** - Magic numbers are fine, extract later -- **Skip Edge Cases** - Happy path only for now -- **Placeholder Everything** - Cubes, debug text, temp sounds -- **Comment Intent** - Mark what's temporary vs keeper code - -### Example Session - -``` -You: quick-prototype - -Agent: What are you prototyping? - -You: I want to test a grappling hook mechanic. Player should be - able to aim at surfaces and pull themselves toward the hook point. - -Agent: What makes this prototype successful? - -You: 1. Aiming feels responsive and intuitive - 2. The pull movement feels satisfying, not floaty - 3. Player can chain hooks without awkward pauses - -Agent: [Implements minimal grappling hook] - -Agent: Prototype complete! Playtest results: - - Aiming: Works, consider adding aim assist - - Movement: Pull is smooth, might need speed curve - - Chaining: Currently has 0.2s delay, feels sluggish - - Next: [d] Develop further | [i] Iterate | [a] Archive -``` - -### After Prototyping - -- **Develop** (`d`) - Use `quick-dev` to build production code -- **Iterate** (`i`) - Adjust and re-test the prototype -- **Archive** (`a`) - Keep as reference, move on to other ideas - ---- - -## Quick-Dev - -**Command:** `quick-dev` -**Agent:** Game Developer -**Purpose:** Flexible development with game-specific considerations - -### When to Use - -- Implementing a feature from a tech-spec -- Building on a successful prototype -- Making changes that don't need full story workflow -- Quick fixes and improvements - -### Workflow Modes - -**Mode A: Tech-Spec Driven** - -``` -You: quick-dev tech-spec-combat.md -Agent: [Loads spec, extracts tasks, implements] -``` - -**Mode B: Direct Instructions** - -``` -You: quick-dev implement double-jump for the player -Agent: [Evaluates complexity, offers planning options] -``` - -**Mode C: From Prototype** - -``` -You: quick-dev from the grappling hook prototype -Agent: [Loads prototype, productionizes code] -``` - -### Game-Specific Checks - -Quick-dev includes automatic consideration of: - -- **Performance** - No allocations in hot paths, object pooling -- **Feel** - Input responsiveness, visual/audio feedback -- **Integration** - Save/load, multiplayer sync, platform testing - -### Example Session - -``` -You: quick-dev implement enemy patrol behavior - -Agent: This looks like a focused feature. Options: - [t] Plan first - Create tech-spec (recommended) - [r] Prototype first - Test the idea - [e] Execute directly - -You: e - -Agent: Any additional guidance? (patterns, files, constraints) - -You: Use the existing AIController base class. Enemies should - patrol between waypoints and return if player leaves range. - -Agent: [Implements patrol behavior] - -Agent: Implementation Complete! - Files Modified: EnemyAI.cs, PatrolBehavior.cs - Tests: Unit tests added for patrol state machine - Performance: No per-frame allocations - - Recommended: Playtest the changes -``` - -### Complexity Routing - -Quick-dev automatically detects complex requests and offers alternatives: - -| Signals | Recommendation | -| -------------------------------------- | ---------------------- | -| Single mechanic, bug fix, tweak | Execute directly | -| Multiple systems, performance-critical | Plan first (tech-spec) | -| Platform/system level work | Use full BMGD workflow | - ---- - -## Choosing Between Quick-Flows - -| Scenario | Use | -| ----------------------- | ------------------------------- | -| "Will this be fun?" | `quick-prototype` | -| "How should this feel?" | `quick-prototype` | -| "Build this feature" | `quick-dev` | -| "Fix this bug" | `quick-dev` | -| "Test then build" | `quick-prototype` → `quick-dev` | - ---- - -## Quick-Flow vs Full BMGD - -### Use Quick-Flow When - -- The scope is small and well-understood -- You're experimenting or prototyping -- You have a clear tech-spec already -- The work doesn't affect core game systems significantly - -### Use Full BMGD When - -- Building a major feature or system -- The scope is unclear or large -- Multiple team members need alignment -- The work affects game pillars or core loop -- You need documentation for future reference - ---- - -## Checklists - -### Quick-Prototype Checklist - -**Before:** - -- [ ] Prototype scope defined -- [ ] Success criteria established (2-3 items) - -**During:** - -- [ ] Minimum viable code written -- [ ] Placeholder assets used -- [ ] Core functionality testable - -**After:** - -- [ ] Each criterion evaluated -- [ ] Decision made (develop/iterate/archive) - -### Quick-Dev Checklist - -**Before:** - -- [ ] Context loaded (spec, prototype, or guidance) -- [ ] Files to modify identified -- [ ] Patterns understood - -**During:** - -- [ ] All tasks completed -- [ ] No allocations in hot paths -- [ ] Frame rate maintained - -**After:** - -- [ ] Game runs without errors -- [ ] Feature works as specified -- [ ] Manual playtest completed - ---- - -## Tips for Success - -### 1. Timebox Prototypes - -Set a limit (e.g., 2 hours) for prototyping. If it's not working by then, step back and reconsider. - -### 2. Embrace Programmer Art - -Prototypes don't need to look good. Focus on feel, not visuals. - -### 3. Test on Target Hardware - -What feels right on your dev machine might not feel right on target platform. - -### 4. Document Learnings - -Even failed prototypes teach something. Note what you learned. - -### 5. Know When to Graduate - -If quick-dev keeps expanding scope, stop and create proper stories. - ---- - -## Next Steps - -- **[Workflows Guide](./workflows-guide.md)** - Full workflow reference -- **[Agents Guide](./agents-guide.md)** - Agent capabilities -- **[Quick Start Guide](./quick-start.md)** - Getting started with BMGD diff --git a/src/modules/bmgd/docs/quick-start.md b/src/modules/bmgd/docs/quick-start.md deleted file mode 100644 index 6e625d44..00000000 --- a/src/modules/bmgd/docs/quick-start.md +++ /dev/null @@ -1,250 +0,0 @@ -# BMGD Quick Start Guide - -Get started building games with the BMad Game Development Module. - ---- - -## Prerequisites - -Before starting with BMGD, ensure you have: - -1. **BMAD-METHOD installed** - Follow the main installation guide -2. **A game idea** - Even a rough concept is enough to start -3. **Your preferred AI tool** - Claude Code, Cursor, or web-based chat - ---- - -## Installation - -BMGD is a custom module that extends BMM. Install it using the BMAD installer: - -```bash -# During installation, select BMGD when prompted for custom modules -npx bmad-cli install -``` - -Or add to an existing installation: - -```bash -npx bmad-cli install --add-module bmgd -``` - ---- - -## Understanding the Phases - -BMGD follows four game development phases: - -![BMGD Workflow Overview](./workflow-overview.jpg) - -### Phase 1: Preproduction - -**What happens:** Capture your game vision and core concept. - -**Workflows:** - -- `brainstorm-game` - Guided ideation with game-specific techniques -- `create-game-brief` - Document vision, market, pillars, and fundamentals - -**Output:** Game Brief document - -### Phase 2: Design - -**What happens:** Detail your game's mechanics, systems, and (optionally) narrative. - -**Workflows:** - -- `create-gdd` - Create comprehensive Game Design Document -- `narrative` - Create Narrative Design Document (for story-driven games) - -**Output:** GDD (and Narrative Design document if applicable) - -### Phase 3: Technical - -**What happens:** Plan how you'll build the game. - -**Workflows:** - -- `create-architecture` - Define engine, systems, patterns, and structure - -**Output:** Game Architecture document - -### Phase 4: Production - -**What happens:** Build your game in sprints. - -**Workflows:** - -- `sprint-planning` - Plan and track sprints -- `sprint-status` - View progress and get recommendations -- `create-story` - Create implementable stories -- `dev-story` - Implement stories -- `code-review` - Quality assurance -- `retrospective` - Learn and improve after epics - -**Output:** Working game code - ---- - -## Your First Game Project - -### Step 1: Start with Brainstorming (Optional) - -If you have a vague idea and want help developing it: - -``` -You: brainstorm-game -Agent: [Guides you through game-specific ideation techniques] -``` - -### Step 2: Create Your Game Brief - -Capture your game's core vision: - -``` -You: create-game-brief -Agent: [Walks you through game concept, pillars, market, and fundamentals] -``` - -**Output:** `{output_folder}/game-brief.md` - -### Step 3: Create Your GDD - -Detail your game's design: - -``` -You: create-gdd -Agent: [Guides you through mechanics, systems, and game-type-specific sections] -``` - -**Output:** `{output_folder}/gdd.md` (or sharded into `{output_folder}/gdd/`) - -### Step 4: Add Narrative Design (If Story-Driven) - -For games with significant story: - -``` -You: narrative -Agent: [Facilitates story, characters, world, and dialogue design] -``` - -**Output:** `{output_folder}/narrative-design.md` - -### Step 5: Create Architecture - -Plan your technical implementation: - -``` -You: create-architecture -Agent: [Guides engine selection, system design, and technical decisions] -``` - -**Output:** `{output_folder}/game-architecture.md` - -### Step 6: Start Building - -Begin sprint-based development: - -``` -You: sprint-planning -Agent: [Sets up sprint tracking and epic management] -``` - ---- - -## Choosing Your Agent - -BMGD provides six specialized agents: - -| Agent | Icon | When to Use | -| --------------------- | ---- | ----------------------------------------- | -| **Game Designer** | 🎲 | Brainstorming, Game Brief, GDD, Narrative | -| **Game Architect** | 🏛️ | Architecture, technical decisions | -| **Game Developer** | 🕹️ | Implementation, code reviews | -| **Game Scrum Master** | 🎯 | Sprint planning, story management | -| **Game QA** | 🧪 | Test framework, test design, automation | -| **Game Solo Dev** | 🎮 | Quick prototyping, indie development | - -### Typical Flow - -1. **Game Designer** (Phases 1-2): Brainstorm → Brief → GDD → Narrative -2. **Game Architect** (Phase 3): Architecture -3. **Game Scrum Master** (Phase 4): Sprint planning, story creation -4. **Game Developer** (Phase 4): Implementation, code reviews - ---- - -## Quick Command Reference - -### Phase 1: Preproduction - -- `brainstorm-game` - Ideation session -- `create-game-brief` - Create Game Brief - -### Phase 2: Design - -- `create-gdd` - Create GDD -- `narrative` - Create Narrative Design - -### Phase 3: Technical - -- `create-architecture` - Create Architecture - -### Phase 4: Production - -- `sprint-planning` - Plan sprints -- `sprint-status` - View progress and recommendations -- `create-story` - Create story -- `dev-story` - Implement story -- `code-review` - Review code -- `retrospective` - Team retrospective -- `correct-course` - Handle sprint changes - -### Quick-Flow (Fast-Track) - -- `quick-prototype` - Rapid prototyping (IDE only) -- `quick-dev` - Flexible development (IDE only) - -### Utility - -- `workflow-status` - Check project status -- `party-mode` - Multi-agent collaboration -- `advanced-elicitation` - Deep exploration - ---- - -## Tips for Success - -### 1. Start Small - -Begin with a simple game concept. You can always expand later. - -### 2. Use Game Type Templates - -When creating your GDD, BMGD offers 24 game type templates that provide genre-specific sections. - -### 3. Iterate - -Documents are living artifacts. Return to update them as your vision evolves. - -### 4. Trust the Process - -Each workflow builds on previous outputs. The Game Brief informs the GDD, which informs the Architecture, which informs implementation. - -### 5. Collaborate with Agents - -Use `party-mode` to get perspectives from multiple agents when facing complex decisions. - ---- - -## Next Steps - -- **[Agents Guide](./agents-guide.md)** - Learn about each agent's capabilities -- **[Workflows Guide](./workflows-guide.md)** - Detailed workflow reference -- **[Quick-Flow Guide](./quick-flow-guide.md)** - Rapid prototyping and development -- **[Game Types Guide](./game-types-guide.md)** - Understand game type templates -- **[Glossary](./glossary.md)** - Game development terminology - ---- - -**Ready to start?** Chat with the **Game Designer** agent and say `brainstorm-game` or `create-game-brief`! diff --git a/src/modules/bmgd/gametest/knowledge/e2e-testing.md b/src/modules/bmgd/gametest/knowledge/e2e-testing.md new file mode 100644 index 00000000..8f35bcd7 --- /dev/null +++ b/src/modules/bmgd/gametest/knowledge/e2e-testing.md @@ -0,0 +1,1013 @@ +# End-to-End Testing for Games + +## Overview + +E2E tests validate complete gameplay flows from the player's perspective — the full orchestra, not individual instruments. Unlike integration tests that verify system interactions, E2E tests verify *player journeys* work correctly from start to finish. + +This is the difference between "does the damage calculator work with the inventory system?" (integration) and "can a player actually complete a combat encounter from selection to resolution?" (E2E). + +## E2E vs Integration vs Unit + +| Aspect | Unit | Integration | E2E | +|--------|------|-------------|-----| +| Scope | Single class | System interaction | Complete flow | +| Speed | < 10ms | < 1s | 1-30s | +| Stability | Very stable | Stable | Requires care | +| Example | DamageCalc math | Combat + Inventory | Full combat encounter | +| Dependencies | None/mocked | Some real | All real | +| Catches | Logic bugs | Wiring bugs | Journey bugs | + +## The E2E Testing Pyramid Addition + +``` + /\ + / \ Manual Playtesting + /----\ (Fun, Feel, Experience) + / \ + /--------\ E2E Tests + / \ (Player Journeys) + /------------\ + / \ Integration Tests + /----------------\ (System Interactions) + / \ Unit Tests + /____________________\ (Pure Logic) +``` + +E2E tests sit between integration tests and manual playtesting. They automate what *can* be automated about player experience while acknowledging that "is this fun?" still requires human judgment. + +## E2E Infrastructure Requirements + +Before writing E2E tests, scaffold supporting infrastructure. Without this foundation, E2E tests become brittle, flaky nightmares that erode trust faster than they build confidence. + +### 1. Test Fixture Base Class + +Provides scene loading, cleanup, and common utilities. Every E2E test inherits from this. + +**Unity Example:** + +```csharp +using System.Collections; +using NUnit.Framework; +using UnityEngine; +using UnityEngine.SceneManagement; +using UnityEngine.TestTools; + +public abstract class GameE2ETestFixture +{ + protected virtual string SceneName => "GameScene"; + protected GameStateManager GameState { get; private set; } + protected InputSimulator Input { get; private set; } + protected ScenarioBuilder Scenario { get; private set; } + + [UnitySetUp] + public IEnumerator BaseSetUp() + { + // Load the game scene + yield return SceneManager.LoadSceneAsync(SceneName); + yield return null; // Wait one frame for scene initialization + + // Get core references + GameState = Object.FindFirstObjectByType(); + Assert.IsNotNull(GameState, $"GameStateManager not found in {SceneName}"); + + // Initialize test utilities + Input = new InputSimulator(); + Scenario = new ScenarioBuilder(GameState); + + // Wait for game to be ready + yield return WaitForGameReady(); + } + + [UnityTearDown] + public IEnumerator BaseTearDown() + { + // Clean up any test-spawned objects + yield return CleanupTestObjects(); + + // Reset input state + Input?.Reset(); + } + + protected IEnumerator WaitForGameReady(float timeout = 10f) + { + yield return AsyncAssert.WaitUntil( + () => GameState != null && GameState.IsReady, + "Game ready state", + timeout); + } + + protected virtual IEnumerator CleanupTestObjects() + { + // Override in derived classes for game-specific cleanup + yield return null; + } +} +``` + +**Unreal Example:** + +```cpp +// GameE2ETestBase.h +UCLASS() +class AGameE2ETestBase : public AFunctionalTest +{ + GENERATED_BODY() + +protected: + UPROPERTY() + UGameStateManager* GameState; + + UPROPERTY() + UInputSimulator* InputSim; + + UPROPERTY() + UScenarioBuilder* Scenario; + + virtual void PrepareTest() override; + virtual void StartTest() override; + virtual void CleanUp() override; + + void WaitForGameReady(float Timeout = 10.f); +}; +``` + +**Godot Example:** + +```gdscript +extends GutTest +class_name GameE2ETestFixture + +var game_state: GameStateManager +var input_sim: InputSimulator +var scenario: ScenarioBuilder +var _scene_instance: Node + +func before_each(): + # Load game scene + var scene = load("res://scenes/game.tscn") + _scene_instance = scene.instantiate() + add_child(_scene_instance) + + # Get references + game_state = _scene_instance.get_node("GameStateManager") + input_sim = InputSimulator.new() + scenario = ScenarioBuilder.new(game_state) + + # Wait for ready + await wait_for_game_ready() + +func after_each(): + if _scene_instance: + _scene_instance.queue_free() + input_sim = null + scenario = null + +func wait_for_game_ready(timeout: float = 10.0): + var elapsed = 0.0 + while not game_state.is_ready and elapsed < timeout: + await get_tree().process_frame + elapsed += get_process_delta_time() + assert_true(game_state.is_ready, "Game should be ready") +``` + +### 2. Scenario Builder (Fluent API) + +Configure game state for test scenarios without manual setup. This is the secret sauce — it lets you express test preconditions in domain language. + +**Unity Example:** + +```csharp +public class ScenarioBuilder +{ + private readonly GameStateManager _gameState; + private readonly List> _setupActions = new(); + + public ScenarioBuilder(GameStateManager gameState) + { + _gameState = gameState; + } + + // Domain-specific setup methods + public ScenarioBuilder WithUnit(Faction faction, Hex position, int movementPoints = 6) + { + _setupActions.Add(() => SpawnUnit(faction, position, movementPoints)); + return this; + } + + public ScenarioBuilder WithTerrain(Hex position, TerrainType terrain) + { + _setupActions.Add(() => SetTerrain(position, terrain)); + return this; + } + + public ScenarioBuilder OnTurn(int turnNumber) + { + _setupActions.Add(() => SetTurn(turnNumber)); + return this; + } + + public ScenarioBuilder OnPhase(TurnPhase phase) + { + _setupActions.Add(() => SetPhase(phase)); + return this; + } + + public ScenarioBuilder WithActiveFaction(Faction faction) + { + _setupActions.Add(() => SetActiveFaction(faction)); + return this; + } + + public ScenarioBuilder FromSaveFile(string saveFileName) + { + _setupActions.Add(() => LoadSaveFile(saveFileName)); + return this; + } + + // Execute all setup actions + public IEnumerator Build() + { + foreach (var action in _setupActions) + { + yield return action(); + yield return null; // Allow state to propagate + } + _setupActions.Clear(); + } + + // Private implementation methods + private IEnumerator SpawnUnit(Faction faction, Hex position, int mp) + { + var unit = _gameState.SpawnUnit(faction, position); + unit.MovementPoints = mp; + yield return null; + } + + private IEnumerator SetTerrain(Hex position, TerrainType terrain) + { + _gameState.Map.SetTerrain(position, terrain); + yield return null; + } + + private IEnumerator SetTurn(int turn) + { + _gameState.SetTurnNumber(turn); + yield return null; + } + + private IEnumerator SetPhase(TurnPhase phase) + { + _gameState.SetPhase(phase); + yield return null; + } + + private IEnumerator SetActiveFaction(Faction faction) + { + _gameState.SetActiveFaction(faction); + yield return null; + } + + private IEnumerator LoadSaveFile(string fileName) + { + var path = $"TestData/{fileName}"; + yield return _gameState.LoadGame(path); + } +} +``` + +**Usage:** + +```csharp +yield return Scenario + .WithUnit(Faction.Player, new Hex(3, 4), movementPoints: 6) + .WithUnit(Faction.Enemy, new Hex(5, 4)) + .WithTerrain(new Hex(4, 4), TerrainType.Forest) + .OnTurn(1) + .WithActiveFaction(Faction.Player) + .Build(); +``` + +### 3. Input Simulator + +Abstract player input for deterministic testing. Don't simulate raw mouse positions — simulate player *intent*. + +**Unity Example (New Input System):** + +```csharp +using UnityEngine; +using UnityEngine.InputSystem; + +public class InputSimulator +{ + private Mouse _mouse; + private Keyboard _keyboard; + private Camera _camera; + + public InputSimulator() + { + _mouse = Mouse.current ?? InputSystem.AddDevice(); + _keyboard = Keyboard.current ?? InputSystem.AddDevice(); + _camera = Camera.main; + } + + public IEnumerator ClickWorldPosition(Vector3 worldPos) + { + var screenPos = _camera.WorldToScreenPoint(worldPos); + yield return ClickScreenPosition(screenPos); + } + + public IEnumerator ClickHex(Hex hex) + { + var worldPos = HexUtils.HexToWorld(hex); + yield return ClickWorldPosition(worldPos); + } + + public IEnumerator ClickScreenPosition(Vector2 screenPos) + { + // Move mouse + InputSystem.QueueStateEvent(_mouse, new MouseState { position = screenPos }); + yield return null; + + // Press + InputSystem.QueueStateEvent(_mouse, new MouseState + { + position = screenPos, + buttons = 1 + }); + yield return null; + + // Release + InputSystem.QueueStateEvent(_mouse, new MouseState + { + position = screenPos, + buttons = 0 + }); + yield return null; + } + + public IEnumerator ClickButton(string buttonName) + { + var button = GameObject.Find(buttonName)?.GetComponent(); + Assert.IsNotNull(button, $"Button '{buttonName}' not found"); + + button.onClick.Invoke(); + yield return null; + } + + public IEnumerator DragFromTo(Vector3 from, Vector3 to, float duration = 0.5f) + { + var fromScreen = _camera.WorldToScreenPoint(from); + var toScreen = _camera.WorldToScreenPoint(to); + + // Start drag + InputSystem.QueueStateEvent(_mouse, new MouseState + { + position = fromScreen, + buttons = 1 + }); + yield return null; + + // Interpolate drag + var elapsed = 0f; + while (elapsed < duration) + { + var t = elapsed / duration; + var pos = Vector2.Lerp(fromScreen, toScreen, t); + InputSystem.QueueStateEvent(_mouse, new MouseState + { + position = pos, + buttons = 1 + }); + yield return null; + elapsed += Time.deltaTime; + } + + // End drag + InputSystem.QueueStateEvent(_mouse, new MouseState + { + position = toScreen, + buttons = 0 + }); + yield return null; + } + + public IEnumerator PressKey(Key key) + { + _keyboard.SetKeyDown(key); + yield return null; + _keyboard.SetKeyUp(key); + yield return null; + } + + public void Reset() + { + // Reset any held state + if (_mouse != null) + { + InputSystem.QueueStateEvent(_mouse, new MouseState()); + } + } +} +``` + +### 4. Async Assertions + +Wait-for-condition assertions with meaningful failure messages. The timeout and message are critical — when tests fail, you need to know *what* it was waiting for. + +**Unity Example:** + +```csharp +using System; +using System.Collections; +using NUnit.Framework; +using UnityEngine; + +public static class AsyncAssert +{ + /// + /// Wait until condition is true, or fail with message after timeout. + /// + public static IEnumerator WaitUntil( + Func condition, + string description, + float timeout = 5f) + { + var elapsed = 0f; + while (!condition() && elapsed < timeout) + { + yield return null; + elapsed += Time.deltaTime; + } + + Assert.IsTrue(condition(), + $"Timeout after {timeout}s waiting for: {description}"); + } + + /// + /// Wait until condition is true, with periodic logging. + /// + public static IEnumerator WaitUntilVerbose( + Func condition, + string description, + float timeout = 5f, + float logInterval = 1f) + { + var elapsed = 0f; + var lastLog = 0f; + + while (!condition() && elapsed < timeout) + { + if (elapsed - lastLog >= logInterval) + { + Debug.Log($"[E2E] Still waiting for: {description} ({elapsed:F1}s)"); + lastLog = elapsed; + } + yield return null; + elapsed += Time.deltaTime; + } + + Assert.IsTrue(condition(), + $"Timeout after {timeout}s waiting for: {description}"); + } + + /// + /// Wait for a specific value, with descriptive failure. + /// Note: For floating-point comparisons, use WaitForValueApprox instead + /// to handle precision issues. This method uses exact equality. + /// + public static IEnumerator WaitForValue( + Func getter, + T expected, + string description, + float timeout = 5f) where T : IEquatable + { + yield return WaitUntil( + () => expected.Equals(getter()), + $"{description} to equal {expected} (current: {getter()})", + timeout); + } + + /// + /// Wait for a float value within tolerance (handles floating-point precision). + /// + public static IEnumerator WaitForValueApprox( + Func getter, + float expected, + string description, + float tolerance = 0.0001f, + float timeout = 5f) + { + yield return WaitUntil( + () => Mathf.Abs(expected - getter()) < tolerance, + $"{description} to equal ~{expected} ±{tolerance} (current: {getter()})", + timeout); + } + + /// + /// Wait for a double value within tolerance (handles floating-point precision). + /// + public static IEnumerator WaitForValueApprox( + Func getter, + double expected, + string description, + double tolerance = 0.0001, + float timeout = 5f) + { + yield return WaitUntil( + () => Math.Abs(expected - getter()) < tolerance, + $"{description} to equal ~{expected} ±{tolerance} (current: {getter()})", + timeout); + } + + /// + /// Wait for an event to fire. + /// + public static IEnumerator WaitForEvent( + Action> subscribe, + Action> unsubscribe, + string eventName, + float timeout = 5f) where T : class + { + T received = null; + Action handler = e => received = e; + + subscribe(handler); + + yield return WaitUntil( + () => received != null, + $"Event '{eventName}' to fire", + timeout); + + unsubscribe(handler); + } + + /// + /// Assert that something does NOT happen within a time window. + /// + public static IEnumerator WaitAndAssertNot( + Func condition, + string description, + float duration = 1f) + { + var elapsed = 0f; + while (elapsed < duration) + { + Assert.IsFalse(condition(), + $"Condition unexpectedly became true: {description}"); + yield return null; + elapsed += Time.deltaTime; + } + } +} +``` + +## E2E Test Patterns + +### Given-When-Then with Async + +The core pattern for E2E tests. Clear structure, readable intent. + +```csharp +[UnityTest] +public IEnumerator PlayerCanMoveUnitThroughZOC() +{ + // GIVEN: Soviet unit adjacent to German ZOC + yield return Scenario + .WithUnit(Faction.Soviet, new Hex(3, 4), movementPoints: 6) + .WithUnit(Faction.German, new Hex(4, 4)) // Creates ZOC at adjacent hexes + .WithActiveFaction(Faction.Soviet) + .Build(); + + // WHEN: Player selects unit and moves through ZOC + yield return Input.ClickHex(new Hex(3, 4)); // Select unit + yield return AsyncAssert.WaitUntil( + () => GameState.Selection.HasSelectedUnit, + "Unit should be selected"); + + yield return Input.ClickHex(new Hex(5, 4)); // Click destination (through ZOC) + + // THEN: Unit arrives with reduced movement points (ZOC cost) + yield return AsyncAssert.WaitUntil( + () => GetUnitAt(new Hex(5, 4)) != null, + "Unit should arrive at destination"); + + var unit = GetUnitAt(new Hex(5, 4)); + Assert.Less(unit.MovementPoints, 3, + "ZOC passage should cost extra movement points"); +} +``` + +### Full Turn Cycle + +Testing the complete turn lifecycle. + +```csharp +[UnityTest] +public IEnumerator FullTurnCycle_PlayerToAIAndBack() +{ + // GIVEN: Mid-game state with both factions having units + yield return Scenario + .FromSaveFile("mid_game_scenario.json") + .Build(); + + var startingTurn = GameState.TurnNumber; + + // WHEN: Player ends their turn + yield return Input.ClickButton("EndPhaseButton"); + yield return AsyncAssert.WaitUntil( + () => GameState.CurrentPhase == TurnPhase.EndPhaseConfirmation, + "End phase confirmation"); + + yield return Input.ClickButton("ConfirmButton"); + + // THEN: AI executes its turn + yield return AsyncAssert.WaitUntil( + () => GameState.CurrentFaction == Faction.AI, + "AI turn should begin"); + + // AND: Eventually returns to player + yield return AsyncAssert.WaitUntil( + () => GameState.CurrentFaction == Faction.Player, + "Player turn should return", + timeout: 30f); // AI might take a while + + Assert.AreEqual(startingTurn + 1, GameState.TurnNumber, + "Turn number should increment"); +} +``` + +### Save/Load Round-Trip + +Critical for any game with persistence. + +```csharp +[UnityTest] +public IEnumerator SaveLoad_PreservesGameState() +{ + // GIVEN: Game in specific state + yield return Scenario + .WithUnit(Faction.Player, new Hex(5, 5), movementPoints: 3) + .OnTurn(7) + .Build(); + + var unitPosition = new Hex(5, 5); + var originalMP = GetUnitAt(unitPosition).MovementPoints; + var originalTurn = GameState.TurnNumber; + + // WHEN: Save and reload + var savePath = "test_save_roundtrip"; + yield return GameState.SaveGame(savePath); + + // Trash the current state + yield return SceneManager.LoadSceneAsync(SceneName); + yield return WaitForGameReady(); + + // Load the save + yield return GameState.LoadGame(savePath); + yield return WaitForGameReady(); + + // THEN: State is preserved + Assert.AreEqual(originalTurn, GameState.TurnNumber, + "Turn number should be preserved"); + + var loadedUnit = GetUnitAt(unitPosition); + Assert.IsNotNull(loadedUnit, "Unit should exist at saved position"); + Assert.AreEqual(originalMP, loadedUnit.MovementPoints, + "Movement points should be preserved"); + + // Cleanup + var savedFilePath = GameState.GetSavePath(savePath); + if (System.IO.File.Exists(savedFilePath)) + { + try + { + System.IO.File.Delete(savedFilePath); + } + catch (System.IO.IOException ex) + { + Debug.LogWarning($"[E2E] Failed to delete test save file '{savedFilePath}': {ex.Message}"); + } + catch (UnauthorizedAccessException ex) + { + Debug.LogWarning($"[E2E] Access denied deleting test save file '{savedFilePath}': {ex.Message}"); + } + } +} +``` + +### UI Flow Testing + +Testing complete UI journeys. + +```csharp +[UnityTest] +public IEnumerator MainMenu_NewGame_ReachesGameplay() +{ + // GIVEN: At main menu + yield return SceneManager.LoadSceneAsync("MainMenu"); + yield return null; + + // WHEN: Start new game flow + yield return Input.ClickButton("NewGameButton"); + yield return AsyncAssert.WaitUntil( + () => FindPanel("DifficultySelect") != null, + "Difficulty selection should appear"); + + yield return Input.ClickButton("NormalDifficultyButton"); + yield return Input.ClickButton("StartButton"); + + // THEN: Game scene loads and is playable + yield return AsyncAssert.WaitUntil( + () => SceneManager.GetActiveScene().name == "GameScene", + "Game scene should load", + timeout: 10f); + + yield return WaitForGameReady(); + + Assert.AreEqual(TurnPhase.PlayerMovement, GameState.CurrentPhase, + "Should start in player movement phase"); +} +``` + +## What to E2E Test + +### High Priority (Test These) + +| Category | Why | Examples | +|----------|-----|----------| +| Core gameplay loop | 90% of player time | Select → Move → Attack → End Turn | +| Turn/phase transitions | State machine boundaries | Phase changes, turn handoff | +| Save → Load → Resume | Data integrity | Full round-trip with verification | +| Win/lose conditions | Critical path endpoints | Victory triggers, game over | +| Critical UI flows | First impressions | Menu → Game → Pause → Resume | + +### Medium Priority (Test Key Paths) + +| Category | Why | Examples | +|----------|-----|----------| +| Undo/redo | Easy to break | Action reversal | +| Multiplayer sync | Complex state | Turn handoff in MP | +| Tutorial flow | First-time experience | Guided sequence | + +### Low Priority (Usually Skip for E2E) + +| Category | Why | Better Tested By | +|----------|-----|------------------| +| Edge cases | Combinatorial explosion | Unit tests | +| Visual correctness | Subjective, changes often | Manual testing | +| Performance | Needs dedicated tooling | Performance tests | +| Every permutation | Infinite combinations | Unit + integration | +| AI decision quality | Subjective | Playtesting | + +## E2E Test Organization + +``` +Tests/ +├── EditMode/ +│ └── ... (existing unit tests) +├── PlayMode/ +│ ├── Integration/ +│ │ └── ... (existing integration tests) +│ └── E2E/ +│ ├── E2E.asmdef +│ ├── Infrastructure/ +│ │ ├── GameE2ETestFixture.cs +│ │ ├── ScenarioBuilder.cs +│ │ ├── InputSimulator.cs +│ │ └── AsyncAssert.cs +│ ├── Scenarios/ +│ │ ├── TurnCycleE2ETests.cs +│ │ ├── MovementE2ETests.cs +│ │ ├── CombatE2ETests.cs +│ │ ├── SaveLoadE2ETests.cs +│ │ └── UIFlowE2ETests.cs +│ └── TestData/ +│ ├── mid_game_scenario.json +│ ├── endgame_scenario.json +│ └── edge_case_setup.json +``` + +### Assembly Definition for E2E + +```json +{ + "name": "E2E", + "references": [ + "GameAssembly" + ], + "includePlatforms": [], + "excludePlatforms": [], + "allowUnsafeCode": false, + "overrideReferences": true, + "precompiledReferences": [ + "nunit.framework.dll", + "UnityEngine.TestRunner.dll", + "UnityEditor.TestRunner.dll" + ], + "defineConstraints": [ + "UNITY_INCLUDE_TESTS" + ], + "autoReferenced": false +} +``` + +## CI Considerations + +E2E tests are slower and potentially flaky. Handle with care. + +### Separate CI Job + +```yaml +# GitHub Actions example +e2e-tests: + runs-on: ubuntu-latest + timeout-minutes: 30 + steps: + - uses: game-ci/unity-test-runner@v4 + with: + testMode: PlayMode + projectPath: . + customParameters: -testCategory E2E +``` + +### Retry Strategy + +```yaml +# Retry flaky tests once before failing +- uses: nick-fields/retry@v2 + with: + timeout_minutes: 15 + max_attempts: 2 + command: | + unity-test-runner --category E2E +``` + +### Failure Artifacts + +Capture screenshots and logs on failure: + +```csharp +[UnityTearDown] +public IEnumerator CaptureOnFailure() +{ + // Yield first to ensure we're on the main thread for screenshot capture + yield return null; + + if (TestContext.CurrentContext.Result.Outcome.Status == TestStatus.Failed) + { + var screenshot = ScreenCapture.CaptureScreenshotAsTexture(); + var bytes = screenshot.EncodeToPNG(); + var screenshotPath = $"TestResults/Screenshots/{TestContext.CurrentContext.Test.Name}.png"; + System.IO.File.WriteAllBytes(screenshotPath, bytes); + + Debug.Log($"[E2E FAILURE] Screenshot saved: {screenshotPath}"); + } +} +``` + +### Execution Frequency + +| Suite | When | Timeout | +|-------|------|---------| +| Unit tests | Every commit | 5 min | +| Integration | Every commit | 10 min | +| E2E (smoke) | Every commit | 15 min | +| E2E (full) | Nightly | 60 min | + +## Avoiding Flaky Tests + +E2E tests are notorious for flakiness. Fight it proactively. + +### DO + +- Use explicit waits with `AsyncAssert.WaitUntil` +- Wait for *game state*, not time +- Clean up thoroughly in TearDown +- Isolate tests completely +- Use deterministic scenarios +- Seed random number generators + +### DON'T + +- Use `yield return new WaitForSeconds(x)` as primary sync +- Depend on test execution order +- Share state between tests +- Rely on animation timing +- Assume frame-perfect timing +- Skip cleanup "because it's slow" + +### Debugging Flaky Tests + +```csharp +// Add verbose logging to track down race conditions +[UnityTest] +public IEnumerator FlakyTest_WithDebugging() +{ + Debug.Log($"[E2E] Test start: {Time.frameCount}"); + + yield return Scenario.Build(); + Debug.Log($"[E2E] Scenario built: {Time.frameCount}"); + + yield return Input.ClickHex(targetHex); + Debug.Log($"[E2E] Input sent: {Time.frameCount}, Selection: {GameState.Selection}"); + + yield return AsyncAssert.WaitUntilVerbose( + () => ExpectedCondition(), + "Expected condition", + timeout: 10f, + logInterval: 0.5f); +} +``` + +## Engine-Specific Notes + +### Unity + +- Use `[UnityTest]` attribute for coroutine-based tests +- Prefer `WaitUntil` over `WaitForSeconds` +- Use `Object.FindFirstObjectByType()` (not the deprecated `FindObjectOfType`) +- Consider `InputTestFixture` for Input System simulation +- Remember: `yield return null` waits one frame + +### Unreal + +- Use `FFunctionalTest` actors for level-based E2E +- `LatentIt` for async test steps in Automation Framework +- Gauntlet for extended E2E suites running in isolated processes +- `ADD_LATENT_AUTOMATION_COMMAND` for sequenced operations + +### Godot + +- Use `await` for async operations in GUT +- `await get_tree().create_timer(x).timeout` for timed waits +- Scene instancing provides natural test isolation +- Use `queue_free()` for cleanup, not `free()` (avoids errors) + +## Anti-Patterns + +### The "Test Everything" Trap + +Don't try to E2E test every edge case. That's what unit tests are for. + +```csharp +// BAD: Testing edge case via E2E +[UnityTest] +public IEnumerator Movement_WithExactlyZeroMP_CannotMove() // Unit test this +{ + // 30 seconds of setup for a condition unit tests cover +} + +// GOOD: E2E tests the journey, unit tests the edge cases +[UnityTest] +public IEnumerator Movement_TypicalPlayerJourney_WorksCorrectly() +{ + // Tests the common path players actually experience +} +``` + +### The "Magic Sleep" Pattern + +```csharp +// BAD: Hoping 2 seconds is enough +yield return new WaitForSeconds(2f); +Assert.IsTrue(condition); + +// GOOD: Wait for the actual condition +yield return AsyncAssert.WaitUntil(() => condition, "description"); +``` + +### The "Shared State" Trap + +```csharp +// BAD: Tests pollute each other +private static int testCounter = 0; // Shared between tests! + +// GOOD: Each test is isolated +[SetUp] +public void Setup() +{ + // Fresh state every test +} +``` + +## Measuring E2E Test Value + +### Coverage Metrics That Matter + +- **Journey coverage**: How many critical player paths are tested? +- **Failure detection rate**: How many real bugs do E2E tests catch? +- **False positive rate**: How often do E2E tests fail spuriously? + +### Warning Signs + +- E2E suite takes > 30 minutes +- Flaky test rate > 5% +- E2E tests duplicate unit test coverage +- Team skips E2E tests because they're "always broken" + +### Health Indicators + +- E2E tests catch integration bugs unit tests miss +- New features include E2E tests for happy path +- Flaky tests are fixed or removed within a sprint +- E2E suite runs on every PR (at least smoke subset) diff --git a/src/modules/bmgd/gametest/knowledge/godot-testing.md b/src/modules/bmgd/gametest/knowledge/godot-testing.md index e282be22..ab79e093 100644 --- a/src/modules/bmgd/gametest/knowledge/godot-testing.md +++ b/src/modules/bmgd/gametest/knowledge/godot-testing.md @@ -374,3 +374,502 @@ test: | Signal not detected | Signal not watched | Call `watch_signals()` before action | | Physics not working | Missing frames | Await `physics_frame` | | Flaky tests | Timing issues | Use proper await/signals | + +## C# Testing in Godot + +Godot 4 supports C# via .NET 6+. You can use standard .NET testing frameworks alongside GUT. + +### Project Setup for C# + +``` +project/ +├── addons/ +│ └── gut/ +├── src/ +│ ├── Player/ +│ │ └── PlayerController.cs +│ └── Combat/ +│ └── DamageCalculator.cs +├── tests/ +│ ├── gdscript/ +│ │ └── test_integration.gd +│ └── csharp/ +│ ├── Tests.csproj +│ └── DamageCalculatorTests.cs +└── project.csproj +``` + +### C# Test Project Setup + +Create a separate test project that references your game assembly: + +```xml + + + + net6.0 + true + false + + + + + + + + + + + + + +``` + +### Basic C# Unit Tests + +```csharp +// tests/csharp/DamageCalculatorTests.cs +using Xunit; +using YourGame.Combat; + +public class DamageCalculatorTests +{ + private readonly DamageCalculator _calculator; + + public DamageCalculatorTests() + { + _calculator = new DamageCalculator(); + } + + [Fact] + public void Calculate_BaseDamage_ReturnsCorrectValue() + { + var result = _calculator.Calculate(100f, 1f); + Assert.Equal(100f, result); + } + + [Fact] + public void Calculate_CriticalHit_DoublesDamage() + { + var result = _calculator.Calculate(100f, 2f); + Assert.Equal(200f, result); + } + + [Theory] + [InlineData(100f, 0.5f, 50f)] + [InlineData(100f, 1.5f, 150f)] + [InlineData(50f, 2f, 100f)] + public void Calculate_Parameterized_ReturnsExpected( + float baseDamage, float multiplier, float expected) + { + var result = _calculator.Calculate(baseDamage, multiplier); + Assert.Equal(expected, result); + } +} +``` + +### Testing Godot Nodes in C# + +For tests requiring Godot runtime, use a hybrid approach: + +```csharp +// tests/csharp/PlayerControllerTests.cs +using Godot; +using Xunit; +using YourGame.Player; + +public class PlayerControllerTests : IDisposable +{ + private readonly SceneTree _sceneTree; + private PlayerController _player; + + public PlayerControllerTests() + { + // These tests must run within Godot runtime + // Use GodotXUnit or similar adapter + } + + [GodotFact] // Custom attribute for Godot runtime tests + public async Task Player_Move_ChangesPosition() + { + var startPos = _player.GlobalPosition; + + _player.SetInput(new Vector2(1, 0)); + + await ToSignal(GetTree().CreateTimer(0.5f), "timeout"); + + Assert.True(_player.GlobalPosition.X > startPos.X); + } + + public void Dispose() + { + _player?.QueueFree(); + } +} +``` + +### C# Mocking with NSubstitute + +```csharp +using NSubstitute; +using Xunit; + +public class EnemyAITests +{ + [Fact] + public void Enemy_UsesPathfinding_WhenMoving() + { + var mockPathfinding = Substitute.For(); + mockPathfinding.FindPath(Arg.Any(), Arg.Any()) + .Returns(new[] { Vector2.Zero, new Vector2(10, 10) }); + + var enemy = new EnemyAI(mockPathfinding); + + enemy.MoveTo(new Vector2(10, 10)); + + mockPathfinding.Received().FindPath( + Arg.Any(), + Arg.Is(v => v == new Vector2(10, 10))); + } +} +``` + +### Running C# Tests + +```bash +# Run C# unit tests (no Godot runtime needed) +dotnet test tests/csharp/Tests.csproj + +# Run with coverage +dotnet test tests/csharp/Tests.csproj --collect:"XPlat Code Coverage" + +# Run specific test +dotnet test tests/csharp/Tests.csproj --filter "FullyQualifiedName~DamageCalculator" +``` + +### Hybrid Test Strategy + +| Test Type | Framework | When to Use | +| ------------- | ---------------- | ---------------------------------- | +| Pure logic | xUnit/NUnit (C#) | Classes without Godot dependencies | +| Node behavior | GUT (GDScript) | MonoBehaviour-like testing | +| Integration | GUT (GDScript) | Scene and signal testing | +| E2E | GUT (GDScript) | Full gameplay flows | + +## End-to-End Testing + +For comprehensive E2E testing patterns, infrastructure scaffolding, and +scenario builders, see **knowledge/e2e-testing.md**. + +### E2E Infrastructure for Godot + +#### GameE2ETestFixture (GDScript) + +```gdscript +# tests/e2e/infrastructure/game_e2e_test_fixture.gd +extends GutTest +class_name GameE2ETestFixture + +var game_state: GameStateManager +var input_sim: InputSimulator +var scenario: ScenarioBuilder +var _scene_instance: Node + +## Override to specify a different scene for specific test classes. +func get_scene_path() -> String: + return "res://scenes/game.tscn" + +func before_each(): + # Load game scene + var scene = load(get_scene_path()) + _scene_instance = scene.instantiate() + add_child(_scene_instance) + + # Get references + game_state = _scene_instance.get_node("GameStateManager") + assert_not_null(game_state, "GameStateManager not found in scene") + + input_sim = InputSimulator.new() + scenario = ScenarioBuilder.new(game_state) + + # Wait for ready + await wait_for_game_ready() + +func after_each(): + if _scene_instance: + _scene_instance.queue_free() + _scene_instance = null + input_sim = null + scenario = null + +func wait_for_game_ready(timeout: float = 10.0): + var elapsed = 0.0 + while not game_state.is_ready and elapsed < timeout: + await get_tree().process_frame + elapsed += get_process_delta_time() + assert_true(game_state.is_ready, "Game should be ready within timeout") +``` + +#### ScenarioBuilder (GDScript) + +```gdscript +# tests/e2e/infrastructure/scenario_builder.gd +extends RefCounted +class_name ScenarioBuilder + +var _game_state: GameStateManager +var _setup_actions: Array[Callable] = [] + +func _init(game_state: GameStateManager): + _game_state = game_state + +## Load a pre-configured scenario from a save file. +func from_save_file(file_name: String) -> ScenarioBuilder: + _setup_actions.append(func(): await _load_save_file(file_name)) + return self + +## Configure the current turn number. +func on_turn(turn_number: int) -> ScenarioBuilder: + _setup_actions.append(func(): _set_turn(turn_number)) + return self + +## Spawn a unit at position. +func with_unit(faction: int, position: Vector2, movement_points: int = 6) -> ScenarioBuilder: + _setup_actions.append(func(): await _spawn_unit(faction, position, movement_points)) + return self + +## Execute all configured setup actions. +func build() -> void: + for action in _setup_actions: + await action.call() + _setup_actions.clear() + +## Clear pending actions without executing. +func reset() -> void: + _setup_actions.clear() + +# Private implementation +func _load_save_file(file_name: String) -> void: + var path = "res://tests/e2e/test_data/%s" % file_name + await _game_state.load_game(path) + +func _set_turn(turn: int) -> void: + _game_state.set_turn_number(turn) + +func _spawn_unit(faction: int, pos: Vector2, mp: int) -> void: + var unit = _game_state.spawn_unit(faction, pos) + unit.movement_points = mp +``` + +#### InputSimulator (GDScript) + +```gdscript +# tests/e2e/infrastructure/input_simulator.gd +extends RefCounted +class_name InputSimulator + +## Click at a world position. +func click_world_position(world_pos: Vector2) -> void: + var viewport = Engine.get_main_loop().root.get_viewport() + var camera = viewport.get_camera_2d() + var screen_pos = camera.get_screen_center_position() + (world_pos - camera.global_position) + await click_screen_position(screen_pos) + +## Click at a screen position. +func click_screen_position(screen_pos: Vector2) -> void: + var press = InputEventMouseButton.new() + press.button_index = MOUSE_BUTTON_LEFT + press.pressed = true + press.position = screen_pos + + var release = InputEventMouseButton.new() + release.button_index = MOUSE_BUTTON_LEFT + release.pressed = false + release.position = screen_pos + + Input.parse_input_event(press) + await Engine.get_main_loop().process_frame + Input.parse_input_event(release) + await Engine.get_main_loop().process_frame + +## Click a UI button by name. +func click_button(button_name: String) -> void: + var root = Engine.get_main_loop().root + var button = _find_button_recursive(root, button_name) + assert(button != null, "Button '%s' not found in scene tree" % button_name) + + if not button.visible: + push_warning("[InputSimulator] Button '%s' is not visible" % button_name) + if button.disabled: + push_warning("[InputSimulator] Button '%s' is disabled" % button_name) + + button.pressed.emit() + await Engine.get_main_loop().process_frame + +func _find_button_recursive(node: Node, button_name: String) -> Button: + if node is Button and node.name == button_name: + return node + for child in node.get_children(): + var found = _find_button_recursive(child, button_name) + if found: + return found + return null + +## Press and release a key. +func press_key(keycode: Key) -> void: + var press = InputEventKey.new() + press.keycode = keycode + press.pressed = true + + var release = InputEventKey.new() + release.keycode = keycode + release.pressed = false + + Input.parse_input_event(press) + await Engine.get_main_loop().process_frame + Input.parse_input_event(release) + await Engine.get_main_loop().process_frame + +## Simulate an input action. +func action_press(action_name: String) -> void: + Input.action_press(action_name) + await Engine.get_main_loop().process_frame + +func action_release(action_name: String) -> void: + Input.action_release(action_name) + await Engine.get_main_loop().process_frame + +## Reset all input state. +func reset() -> void: + Input.flush_buffered_events() +``` + +#### AsyncAssert (GDScript) + +```gdscript +# tests/e2e/infrastructure/async_assert.gd +extends RefCounted +class_name AsyncAssert + +## Wait until condition is true, or fail after timeout. +static func wait_until( + condition: Callable, + description: String, + timeout: float = 5.0 +) -> void: + var elapsed := 0.0 + while not condition.call() and elapsed < timeout: + await Engine.get_main_loop().process_frame + elapsed += Engine.get_main_loop().root.get_process_delta_time() + + assert(condition.call(), + "Timeout after %.1fs waiting for: %s" % [timeout, description]) + +## Wait for a value to equal expected. +static func wait_for_value( + getter: Callable, + expected: Variant, + description: String, + timeout: float = 5.0 +) -> void: + await wait_until( + func(): return getter.call() == expected, + "%s to equal '%s' (current: '%s')" % [description, expected, getter.call()], + timeout) + +## Wait for a float value within tolerance. +static func wait_for_value_approx( + getter: Callable, + expected: float, + description: String, + tolerance: float = 0.0001, + timeout: float = 5.0 +) -> void: + await wait_until( + func(): return absf(expected - getter.call()) < tolerance, + "%s to equal ~%s ±%s (current: %s)" % [description, expected, tolerance, getter.call()], + timeout) + +## Assert that condition does NOT become true within duration. +static func assert_never_true( + condition: Callable, + description: String, + duration: float = 1.0 +) -> void: + var elapsed := 0.0 + while elapsed < duration: + assert(not condition.call(), + "Condition unexpectedly became true: %s" % description) + await Engine.get_main_loop().process_frame + elapsed += Engine.get_main_loop().root.get_process_delta_time() + +## Wait for specified number of frames. +static func wait_frames(count: int) -> void: + for i in range(count): + await Engine.get_main_loop().process_frame + +## Wait for physics to settle. +static func wait_for_physics(frames: int = 3) -> void: + for i in range(frames): + await Engine.get_main_loop().root.get_tree().physics_frame +``` + +### Example E2E Test (GDScript) + +```gdscript +# tests/e2e/scenarios/test_combat_flow.gd +extends GameE2ETestFixture + +func test_player_can_attack_enemy(): + # GIVEN: Player and enemy in combat range + await scenario \ + .with_unit(Faction.PLAYER, Vector2(100, 100)) \ + .with_unit(Faction.ENEMY, Vector2(150, 100)) \ + .build() + + var enemy = game_state.get_units(Faction.ENEMY)[0] + var initial_health = enemy.health + + # WHEN: Player attacks + await input_sim.click_world_position(Vector2(100, 100)) # Select player + await AsyncAssert.wait_until( + func(): return game_state.selected_unit != null, + "Unit should be selected") + + await input_sim.click_world_position(Vector2(150, 100)) # Attack enemy + + # THEN: Enemy takes damage + await AsyncAssert.wait_until( + func(): return enemy.health < initial_health, + "Enemy should take damage") + +func test_turn_cycle_completes(): + # GIVEN: Game in progress + await scenario.on_turn(1).build() + var starting_turn = game_state.turn_number + + # WHEN: Player ends turn + await input_sim.click_button("EndTurnButton") + await AsyncAssert.wait_until( + func(): return game_state.current_faction == Faction.ENEMY, + "Should switch to enemy turn") + + # AND: Enemy turn completes + await AsyncAssert.wait_until( + func(): return game_state.current_faction == Faction.PLAYER, + "Should return to player turn", + 30.0) # AI might take a while + + # THEN: Turn number incremented + assert_eq(game_state.turn_number, starting_turn + 1) +``` + +### Quick E2E Checklist for Godot + +- [ ] Create `GameE2ETestFixture` base class extending GutTest +- [ ] Implement `ScenarioBuilder` for your game's domain +- [ ] Create `InputSimulator` wrapping Godot Input +- [ ] Add `AsyncAssert` utilities with proper await +- [ ] Organize E2E tests under `tests/e2e/scenarios/` +- [ ] Configure GUT to include E2E test directory +- [ ] Set up CI with headless Godot execution diff --git a/src/modules/bmgd/gametest/knowledge/unity-testing.md b/src/modules/bmgd/gametest/knowledge/unity-testing.md index f1b872d9..f057933c 100644 --- a/src/modules/bmgd/gametest/knowledge/unity-testing.md +++ b/src/modules/bmgd/gametest/knowledge/unity-testing.md @@ -381,3 +381,17 @@ test: | NullReferenceException | Missing Setup | Ensure [SetUp] initializes all fields | | Tests hang | Infinite coroutine | Add timeout or max iterations | | Flaky physics tests | Timing dependent | Use WaitForFixedUpdate, increase tolerance | + +## End-to-End Testing + +For comprehensive E2E testing patterns, infrastructure scaffolding, and +scenario builders, see **knowledge/e2e-testing.md**. + +### Quick E2E Checklist for Unity + +- [ ] Create `GameE2ETestFixture` base class +- [ ] Implement `ScenarioBuilder` for your game's domain +- [ ] Create `InputSimulator` wrapping Input System +- [ ] Add `AsyncAssert` utilities +- [ ] Organize E2E tests under `Tests/PlayMode/E2E/` +- [ ] Configure separate CI job for E2E suite diff --git a/src/modules/bmgd/gametest/knowledge/unreal-testing.md b/src/modules/bmgd/gametest/knowledge/unreal-testing.md index 0863bd0c..3b8f668d 100644 --- a/src/modules/bmgd/gametest/knowledge/unreal-testing.md +++ b/src/modules/bmgd/gametest/knowledge/unreal-testing.md @@ -386,3 +386,1129 @@ test: | Crash in test | Missing world | Use proper test context | | Flaky results | Timing issues | Use latent commands | | Slow tests | Too many actors | Optimize test setup | + +## End-to-End Testing + +For comprehensive E2E testing patterns, infrastructure scaffolding, and +scenario builders, see **knowledge/e2e-testing.md**. + +### E2E Infrastructure for Unreal + +E2E tests in Unreal leverage Functional Tests with custom infrastructure for scenario setup, input simulation, and async assertions. + +#### Project Structure + +``` +Source/ +├── MyGame/ +│ └── ... (game code) +└── MyGameTests/ + ├── MyGameTests.Build.cs + ├── Public/ + │ ├── GameE2ETestBase.h + │ ├── ScenarioBuilder.h + │ ├── InputSimulator.h + │ └── AsyncTestHelpers.h + ├── Private/ + │ ├── GameE2ETestBase.cpp + │ ├── ScenarioBuilder.cpp + │ ├── InputSimulator.cpp + │ ├── AsyncTestHelpers.cpp + │ └── E2E/ + │ ├── CombatE2ETests.cpp + │ ├── TurnCycleE2ETests.cpp + │ └── SaveLoadE2ETests.cpp + └── TestMaps/ + ├── E2E_Combat.umap + └── E2E_TurnCycle.umap +``` + +#### Test Module Build File + +```cpp +// MyGameTests.Build.cs +using UnrealBuildTool; + +public class MyGameTests : ModuleRules +{ + public MyGameTests(ReadOnlyTargetRules Target) : base(Target) + { + PCHUsage = ModuleRules.PCHUsageMode.UseExplicitOrSharedPCHs; + + PublicDependencyModuleNames.AddRange(new string[] { + "Core", + "CoreUObject", + "Engine", + "InputCore", + "EnhancedInput", + "MyGame" + }); + + PrivateDependencyModuleNames.AddRange(new string[] { + "FunctionalTesting", + "AutomationController" + }); + + // Only include in editor/test builds + if (Target.bBuildDeveloperTools || Target.Configuration == UnrealTargetConfiguration.Debug) + { + PrecompileForTargets = PrecompileTargetsType.Any; + } + } +} +``` + +#### GameE2ETestBase (Base Class) + +```cpp +// GameE2ETestBase.h +#pragma once + +#include "CoreMinimal.h" +#include "FunctionalTest.h" +#include "GameE2ETestBase.generated.h" + +class UScenarioBuilder; +class UInputSimulator; +class UGameStateManager; + +/** + * Base class for all E2E functional tests. + * Provides scenario setup, input simulation, and async assertion utilities. + */ +UCLASS(Abstract) +class MYGAMETESTS_API AGameE2ETestBase : public AFunctionalTest +{ + GENERATED_BODY() + +public: + AGameE2ETestBase(); + +protected: + /** Game state manager reference, found automatically on test start. */ + UPROPERTY(BlueprintReadOnly, Category = "E2E") + UGameStateManager* GameState; + + /** Input simulation utility. */ + UPROPERTY(BlueprintReadOnly, Category = "E2E") + UInputSimulator* InputSim; + + /** Scenario configuration builder. */ + UPROPERTY(BlueprintReadOnly, Category = "E2E") + UScenarioBuilder* Scenario; + + /** Timeout for waiting operations (seconds). */ + UPROPERTY(EditAnywhere, Category = "E2E") + float DefaultTimeout = 10.0f; + + // AFunctionalTest interface + virtual void PrepareTest() override; + virtual void StartTest() override; + virtual void CleanUp() override; + + /** Override to specify custom game state class. */ + virtual TSubclassOf GetGameStateClass() const; + + /** + * Wait until game state reports ready. + * Calls OnGameReady() when complete or fails test on timeout. + */ + UFUNCTION(BlueprintCallable, Category = "E2E") + void WaitForGameReady(); + + /** Called when game is ready. Override to begin test logic. */ + virtual void OnGameReady(); + + /** + * Wait until condition is true, then call callback. + * Fails test if timeout exceeded. + */ + void WaitUntil(TFunction Condition, const FString& Description, + TFunction OnComplete, float Timeout = -1.0f); + + /** + * Wait for a specific value, then call callback. + */ + template + void WaitForValue(TFunction Getter, T Expected, + const FString& Description, TFunction OnComplete, + float Timeout = -1.0f); + + /** + * Assert condition and fail test with message if false. + */ + void AssertTrue(bool Condition, const FString& Message); + + /** + * Assert values are equal within tolerance. + */ + void AssertNearlyEqual(float Actual, float Expected, + const FString& Message, float Tolerance = 0.0001f); + +private: + FTimerHandle WaitTimerHandle; + float WaitElapsed; + float WaitTimeout; + TFunction WaitCondition; + TFunction WaitCallback; + FString WaitDescription; + + void TickWaitCondition(); +}; +``` + +```cpp +// GameE2ETestBase.cpp +#include "GameE2ETestBase.h" +#include "ScenarioBuilder.h" +#include "InputSimulator.h" +#include "GameStateManager.h" +#include "Engine/World.h" +#include "TimerManager.h" +#include "Kismet/GameplayStatics.h" + +AGameE2ETestBase::AGameE2ETestBase() +{ + // Default test settings + TimeLimit = 120.0f; // 2 minute max for E2E tests + TimesUpMessage = TEXT("E2E test exceeded time limit"); +} + +void AGameE2ETestBase::PrepareTest() +{ + Super::PrepareTest(); + + // Create utilities + InputSim = NewObject(this); + Scenario = NewObject(this); +} + +void AGameE2ETestBase::StartTest() +{ + Super::StartTest(); + + // Find game state manager + TSubclassOf GameStateClass = GetGameStateClass(); + TArray FoundActors; + UGameplayStatics::GetAllActorsOfClass(GetWorld(), GameStateClass, FoundActors); + + if (FoundActors.Num() > 0) + { + GameState = Cast( + FoundActors[0]->GetComponentByClass(GameStateClass)); + } + + if (!GameState) + { + FinishTest(EFunctionalTestResult::Failed, + FString::Printf(TEXT("GameStateManager not found in test world"))); + return; + } + + // Initialize scenario builder with game state + Scenario->Initialize(GameState); + + // Wait for game to be ready + WaitForGameReady(); +} + +void AGameE2ETestBase::CleanUp() +{ + // Clear timer + if (WaitTimerHandle.IsValid()) + { + GetWorld()->GetTimerManager().ClearTimer(WaitTimerHandle); + } + + // Reset input state + if (InputSim) + { + InputSim->Reset(); + } + + Super::CleanUp(); +} + +TSubclassOf AGameE2ETestBase::GetGameStateClass() const +{ + return UGameStateManager::StaticClass(); +} + +void AGameE2ETestBase::WaitForGameReady() +{ + WaitUntil( + [this]() { return GameState && GameState->IsReady(); }, + TEXT("Game to reach ready state"), + [this]() { OnGameReady(); }, + DefaultTimeout + ); +} + +void AGameE2ETestBase::OnGameReady() +{ + // Override in derived classes to begin test logic +} + +void AGameE2ETestBase::WaitUntil( + TFunction Condition, + const FString& Description, + TFunction OnComplete, + float Timeout) +{ + WaitCondition = Condition; + WaitCallback = OnComplete; + WaitDescription = Description; + WaitElapsed = 0.0f; + WaitTimeout = (Timeout < 0.0f) ? DefaultTimeout : Timeout; + + // Check immediately + if (WaitCondition()) + { + WaitCallback(); + return; + } + + // Set up polling timer + GetWorld()->GetTimerManager().SetTimer( + WaitTimerHandle, + this, + &AGameE2ETestBase::TickWaitCondition, + 0.1f, // Check every 100ms + true + ); +} + +void AGameE2ETestBase::TickWaitCondition() +{ + WaitElapsed += 0.1f; + + if (WaitCondition()) + { + GetWorld()->GetTimerManager().ClearTimer(WaitTimerHandle); + WaitCallback(); + } + else if (WaitElapsed >= WaitTimeout) + { + GetWorld()->GetTimerManager().ClearTimer(WaitTimerHandle); + FinishTest(EFunctionalTestResult::Failed, + FString::Printf(TEXT("Timeout after %.1fs waiting for: %s"), + WaitTimeout, *WaitDescription)); + } +} + +void AGameE2ETestBase::AssertTrue(bool Condition, const FString& Message) +{ + if (!Condition) + { + FinishTest(EFunctionalTestResult::Failed, Message); + } +} + +void AGameE2ETestBase::AssertNearlyEqual( + float Actual, float Expected, + const FString& Message, float Tolerance) +{ + if (!FMath::IsNearlyEqual(Actual, Expected, Tolerance)) + { + FinishTest(EFunctionalTestResult::Failed, + FString::Printf(TEXT("%s: Expected ~%f, got %f"), + *Message, Expected, Actual)); + } +} +``` + +#### ScenarioBuilder + +```cpp +// ScenarioBuilder.h +#pragma once + +#include "CoreMinimal.h" +#include "UObject/NoExportTypes.h" +#include "ScenarioBuilder.generated.h" + +class UGameStateManager; + +/** + * Fluent API for configuring E2E test scenarios. + */ +UCLASS(BlueprintType) +class MYGAMETESTS_API UScenarioBuilder : public UObject +{ + GENERATED_BODY() + +public: + /** Initialize with game state reference. */ + void Initialize(UGameStateManager* InGameState); + + /** + * Load scenario from save file. + * @param FileName Save file name (without path) + */ + UFUNCTION(BlueprintCallable, Category = "Scenario") + UScenarioBuilder* FromSaveFile(const FString& FileName); + + /** + * Set the current turn number. + */ + UFUNCTION(BlueprintCallable, Category = "Scenario") + UScenarioBuilder* OnTurn(int32 TurnNumber); + + /** + * Set the active faction. + */ + UFUNCTION(BlueprintCallable, Category = "Scenario") + UScenarioBuilder* WithActiveFaction(EFaction Faction); + + /** + * Spawn a unit at position. + * @param Faction Unit's faction + * @param Position World position + * @param MovementPoints Starting movement points + */ + UFUNCTION(BlueprintCallable, Category = "Scenario") + UScenarioBuilder* WithUnit(EFaction Faction, FVector Position, + int32 MovementPoints = 6); + + /** + * Set terrain at position. + */ + UFUNCTION(BlueprintCallable, Category = "Scenario") + UScenarioBuilder* WithTerrain(FVector Position, ETerrainType Terrain); + + /** + * Execute all queued setup actions. + * @param OnComplete Called when all actions complete + */ + void Build(TFunction OnComplete); + + /** Clear pending actions without executing. */ + UFUNCTION(BlueprintCallable, Category = "Scenario") + void Reset(); + +private: + UPROPERTY() + UGameStateManager* GameState; + + TArray)>> SetupActions; + + void ExecuteNextAction(int32 Index, TFunction FinalCallback); +}; +``` + +```cpp +// ScenarioBuilder.cpp +#include "ScenarioBuilder.h" +#include "GameStateManager.h" + +void UScenarioBuilder::Initialize(UGameStateManager* InGameState) +{ + GameState = InGameState; + SetupActions.Empty(); +} + +UScenarioBuilder* UScenarioBuilder::FromSaveFile(const FString& FileName) +{ + SetupActions.Add([this, FileName](TFunction Done) { + FString Path = FString::Printf(TEXT("TestData/%s"), *FileName); + GameState->LoadGame(Path, FOnLoadComplete::CreateLambda([Done](bool bSuccess) { + Done(); + })); + }); + return this; +} + +UScenarioBuilder* UScenarioBuilder::OnTurn(int32 TurnNumber) +{ + SetupActions.Add([this, TurnNumber](TFunction Done) { + GameState->SetTurnNumber(TurnNumber); + Done(); + }); + return this; +} + +UScenarioBuilder* UScenarioBuilder::WithActiveFaction(EFaction Faction) +{ + SetupActions.Add([this, Faction](TFunction Done) { + GameState->SetActiveFaction(Faction); + Done(); + }); + return this; +} + +UScenarioBuilder* UScenarioBuilder::WithUnit( + EFaction Faction, FVector Position, int32 MovementPoints) +{ + SetupActions.Add([this, Faction, Position, MovementPoints](TFunction Done) { + AUnit* Unit = GameState->SpawnUnit(Faction, Position); + if (Unit) + { + Unit->SetMovementPoints(MovementPoints); + } + Done(); + }); + return this; +} + +UScenarioBuilder* UScenarioBuilder::WithTerrain( + FVector Position, ETerrainType Terrain) +{ + SetupActions.Add([this, Position, Terrain](TFunction Done) { + GameState->GetMap()->SetTerrain(Position, Terrain); + Done(); + }); + return this; +} + +void UScenarioBuilder::Build(TFunction OnComplete) +{ + if (SetupActions.Num() == 0) + { + OnComplete(); + return; + } + + ExecuteNextAction(0, OnComplete); +} + +void UScenarioBuilder::Reset() +{ + SetupActions.Empty(); +} + +void UScenarioBuilder::ExecuteNextAction( + int32 Index, TFunction FinalCallback) +{ + if (Index >= SetupActions.Num()) + { + SetupActions.Empty(); + FinalCallback(); + return; + } + + SetupActions[Index]([this, Index, FinalCallback]() { + ExecuteNextAction(Index + 1, FinalCallback); + }); +} +``` + +#### InputSimulator + +```cpp +// InputSimulator.h +#pragma once + +#include "CoreMinimal.h" +#include "UObject/NoExportTypes.h" +#include "InputCoreTypes.h" +#include "InputSimulator.generated.h" + +class APlayerController; + +/** + * Simulates player input for E2E tests. + */ +UCLASS(BlueprintType) +class MYGAMETESTS_API UInputSimulator : public UObject +{ + GENERATED_BODY() + +public: + /** + * Click at a world position. + * @param WorldPos Position in world space + * @param OnComplete Called when click completes + */ + void ClickWorldPosition(FVector WorldPos, TFunction OnComplete); + + /** + * Click at screen coordinates. + */ + void ClickScreenPosition(FVector2D ScreenPos, TFunction OnComplete); + + /** + * Click a UI button by name. + * @param ButtonName Name of the button widget + * @param OnComplete Called when click completes + */ + UFUNCTION(BlueprintCallable, Category = "Input") + void ClickButton(const FString& ButtonName, TFunction OnComplete); + + /** + * Press and release a key. + */ + void PressKey(FKey Key, TFunction OnComplete); + + /** + * Trigger an input action. + */ + void TriggerAction(FName ActionName, TFunction OnComplete); + + /** + * Drag from one position to another. + */ + void DragFromTo(FVector From, FVector To, float Duration, + TFunction OnComplete); + + /** Reset all input state. */ + UFUNCTION(BlueprintCallable, Category = "Input") + void Reset(); + +private: + APlayerController* GetPlayerController() const; + void SimulateMouseClick(FVector2D ScreenPos, TFunction OnComplete); +}; +``` + +```cpp +// InputSimulator.cpp +#include "InputSimulator.h" +#include "GameFramework/PlayerController.h" +#include "Blueprint/UserWidget.h" +#include "Components/Button.h" +#include "Blueprint/WidgetBlueprintLibrary.h" +#include "Kismet/GameplayStatics.h" +#include "Engine/World.h" +#include "TimerManager.h" +#include "Framework/Application/SlateApplication.h" + +void UInputSimulator::ClickWorldPosition( + FVector WorldPos, TFunction OnComplete) +{ + APlayerController* PC = GetPlayerController(); + if (!PC) + { + OnComplete(); + return; + } + + FVector2D ScreenPos; + if (PC->ProjectWorldLocationToScreen(WorldPos, ScreenPos, true)) + { + ClickScreenPosition(ScreenPos, OnComplete); + } + else + { + OnComplete(); + } +} + +void UInputSimulator::ClickScreenPosition( + FVector2D ScreenPos, TFunction OnComplete) +{ + SimulateMouseClick(ScreenPos, OnComplete); +} + +void UInputSimulator::ClickButton( + const FString& ButtonName, TFunction OnComplete) +{ + APlayerController* PC = GetPlayerController(); + if (!PC) + { + UE_LOG(LogTemp, Warning, + TEXT("[InputSimulator] No PlayerController found")); + OnComplete(); + return; + } + + // Find button in all widgets + TArray FoundWidgets; + UWidgetBlueprintLibrary::GetAllWidgetsOfClass( + PC->GetWorld(), FoundWidgets, UUserWidget::StaticClass(), false); + + UButton* TargetButton = nullptr; + for (UUserWidget* Widget : FoundWidgets) + { + if (UButton* Button = Cast( + Widget->GetWidgetFromName(FName(*ButtonName)))) + { + TargetButton = Button; + break; + } + } + + if (TargetButton) + { + if (!TargetButton->GetIsEnabled()) + { + UE_LOG(LogTemp, Warning, + TEXT("[InputSimulator] Button '%s' is not enabled"), *ButtonName); + } + + // Simulate click via delegate + TargetButton->OnClicked.Broadcast(); + + // Delay to allow UI to process + FTimerHandle TimerHandle; + PC->GetWorld()->GetTimerManager().SetTimer( + TimerHandle, + [OnComplete]() { OnComplete(); }, + 0.1f, + false + ); + } + else + { + UE_LOG(LogTemp, Warning, + TEXT("[InputSimulator] Button '%s' not found"), *ButtonName); + OnComplete(); + } +} + +void UInputSimulator::PressKey(FKey Key, TFunction OnComplete) +{ + APlayerController* PC = GetPlayerController(); + if (!PC) + { + OnComplete(); + return; + } + + // Simulate key press + FInputKeyEventArgs PressArgs(PC->GetLocalPlayer()->GetControllerId(), + Key, EInputEvent::IE_Pressed, 1.0f, false); + PC->InputKey(PressArgs); + + // Delay then release + FTimerHandle TimerHandle; + PC->GetWorld()->GetTimerManager().SetTimer( + TimerHandle, + [this, PC, Key, OnComplete]() { + FInputKeyEventArgs ReleaseArgs(PC->GetLocalPlayer()->GetControllerId(), + Key, EInputEvent::IE_Released, 0.0f, false); + PC->InputKey(ReleaseArgs); + OnComplete(); + }, + 0.1f, + false + ); +} + +void UInputSimulator::TriggerAction(FName ActionName, TFunction OnComplete) +{ + APlayerController* PC = GetPlayerController(); + if (!PC) + { + OnComplete(); + return; + } + + // For Enhanced Input System + if (UEnhancedInputComponent* EIC = Cast( + PC->InputComponent.Get())) + { + // Trigger the action through the input subsystem + // Implementation depends on your input action setup + } + + OnComplete(); +} + +void UInputSimulator::DragFromTo( + FVector From, FVector To, float Duration, TFunction OnComplete) +{ + APlayerController* PC = GetPlayerController(); + if (!PC) + { + OnComplete(); + return; + } + + FVector2D FromScreen, ToScreen; + PC->ProjectWorldLocationToScreen(From, FromScreen, true); + PC->ProjectWorldLocationToScreen(To, ToScreen, true); + + // Simulate drag start + FSlateApplication::Get().ProcessMouseButtonDownEvent( + nullptr, FPointerEvent( + 0, FromScreen, FromScreen, TSet(), + EKeys::LeftMouseButton, 0, FModifierKeysState() + ) + ); + + // Interpolate drag over duration + float Elapsed = 0.0f; + float Interval = 0.05f; + + FTimerHandle DragTimer; + PC->GetWorld()->GetTimerManager().SetTimer( + DragTimer, + [this, PC, FromScreen, ToScreen, Duration, &Elapsed, Interval, OnComplete, &DragTimer]() { + Elapsed += Interval; + float Alpha = FMath::Clamp(Elapsed / Duration, 0.0f, 1.0f); + FVector2D CurrentPos = FMath::Lerp(FromScreen, ToScreen, Alpha); + + FSlateApplication::Get().ProcessMouseMoveEvent( + FPointerEvent( + 0, CurrentPos, CurrentPos - FVector2D(1, 0), + TSet({EKeys::LeftMouseButton}), + FModifierKeysState() + ) + ); + + if (Alpha >= 1.0f) + { + PC->GetWorld()->GetTimerManager().ClearTimer(DragTimer); + + FSlateApplication::Get().ProcessMouseButtonUpEvent( + FPointerEvent( + 0, ToScreen, ToScreen, TSet(), + EKeys::LeftMouseButton, 0, FModifierKeysState() + ) + ); + + OnComplete(); + } + }, + Interval, + true + ); +} + +void UInputSimulator::Reset() +{ + // Release any held inputs + FSlateApplication::Get().ClearAllUserFocus(); +} + +APlayerController* UInputSimulator::GetPlayerController() const +{ + UWorld* World = GEngine->GetWorldContexts()[0].World(); + return World ? UGameplayStatics::GetPlayerController(World, 0) : nullptr; +} + +void UInputSimulator::SimulateMouseClick( + FVector2D ScreenPos, TFunction OnComplete) +{ + // Press + FSlateApplication::Get().ProcessMouseButtonDownEvent( + nullptr, FPointerEvent( + 0, ScreenPos, ScreenPos, TSet(), + EKeys::LeftMouseButton, 0, FModifierKeysState() + ) + ); + + // Delay then release + UWorld* World = GEngine->GetWorldContexts()[0].World(); + if (World) + { + FTimerHandle TimerHandle; + World->GetTimerManager().SetTimer( + TimerHandle, + [ScreenPos, OnComplete]() { + FSlateApplication::Get().ProcessMouseButtonUpEvent( + FPointerEvent( + 0, ScreenPos, ScreenPos, TSet(), + EKeys::LeftMouseButton, 0, FModifierKeysState() + ) + ); + OnComplete(); + }, + 0.1f, + false + ); + } + else + { + OnComplete(); + } +} +``` + +#### AsyncTestHelpers + +```cpp +// AsyncTestHelpers.h +#pragma once + +#include "CoreMinimal.h" +#include "Misc/AutomationTest.h" + +/** + * Latent command to wait for a condition. + */ +DEFINE_LATENT_AUTOMATION_COMMAND_THREE_PARAMETER( + FWaitUntilCondition, + TFunction, Condition, + FString, Description, + float, Timeout +); + +/** + * Latent command to wait for a value to equal expected. + */ +template +class FWaitForValue : public IAutomationLatentCommand +{ +public: + FWaitForValue(TFunction InGetter, T InExpected, + const FString& InDescription, float InTimeout) + : Getter(InGetter) + , Expected(InExpected) + , Description(InDescription) + , Timeout(InTimeout) + , Elapsed(0.0f) + {} + + virtual bool Update() override + { + Elapsed += FApp::GetDeltaTime(); + + if (Getter() == Expected) + { + return true; + } + + if (Elapsed >= Timeout) + { + UE_LOG(LogTemp, Error, + TEXT("Timeout after %.1fs waiting for: %s"), + Timeout, *Description); + return true; + } + + return false; + } + +private: + TFunction Getter; + T Expected; + FString Description; + float Timeout; + float Elapsed; +}; + +/** + * Latent command to wait for float value within tolerance. + */ +class FWaitForValueApprox : public IAutomationLatentCommand +{ +public: + FWaitForValueApprox(TFunction InGetter, float InExpected, + const FString& InDescription, + float InTolerance = 0.0001f, float InTimeout = 5.0f) + : Getter(InGetter) + , Expected(InExpected) + , Description(InDescription) + , Tolerance(InTolerance) + , Timeout(InTimeout) + , Elapsed(0.0f) + {} + + virtual bool Update() override + { + Elapsed += FApp::GetDeltaTime(); + + if (FMath::IsNearlyEqual(Getter(), Expected, Tolerance)) + { + return true; + } + + if (Elapsed >= Timeout) + { + UE_LOG(LogTemp, Error, + TEXT("Timeout after %.1fs waiting for: %s (expected ~%f, got %f)"), + Timeout, *Description, Expected, Getter()); + return true; + } + + return false; + } + +private: + TFunction Getter; + float Expected; + FString Description; + float Tolerance; + float Timeout; + float Elapsed; +}; + +/** + * Latent command to assert condition never becomes true. + */ +DEFINE_LATENT_AUTOMATION_COMMAND_THREE_PARAMETER( + FAssertNeverTrue, + TFunction, Condition, + FString, Description, + float, Duration +); + +/** Helper macros for E2E tests */ +#define E2E_WAIT_UNTIL(Cond, Desc, Timeout) \ + ADD_LATENT_AUTOMATION_COMMAND(FWaitUntilCondition(Cond, Desc, Timeout)) + +#define E2E_WAIT_FOR_VALUE(Getter, Expected, Desc, Timeout) \ + ADD_LATENT_AUTOMATION_COMMAND(FWaitForValue(Getter, Expected, Desc, Timeout)) + +#define E2E_WAIT_FOR_FLOAT(Getter, Expected, Desc, Tolerance, Timeout) \ + ADD_LATENT_AUTOMATION_COMMAND(FWaitForValueApprox(Getter, Expected, Desc, Tolerance, Timeout)) +``` + +### Example E2E Test + +```cpp +// CombatE2ETests.cpp +#include "GameE2ETestBase.h" +#include "ScenarioBuilder.h" +#include "InputSimulator.h" +#include "AsyncTestHelpers.h" + +/** + * E2E test: Player can attack enemy and deal damage. + */ +UCLASS() +class AE2E_PlayerAttacksEnemy : public AGameE2ETestBase +{ + GENERATED_BODY() + +protected: + virtual void OnGameReady() override + { + // GIVEN: Player and enemy units in combat range + Scenario + ->WithUnit(EFaction::Player, FVector(100, 100, 0), 6) + ->WithUnit(EFaction::Enemy, FVector(200, 100, 0), 6) + ->WithActiveFaction(EFaction::Player) + ->Build([this]() { OnScenarioReady(); }); + } + +private: + void OnScenarioReady() + { + // Store enemy reference and initial health + TArray Enemies = GameState->GetUnits(EFaction::Enemy); + if (Enemies.Num() == 0) + { + FinishTest(EFunctionalTestResult::Failed, TEXT("No enemy found")); + return; + } + + AUnit* Enemy = Enemies[0]; + float InitialHealth = Enemy->GetHealth(); + + // WHEN: Player selects unit and attacks + InputSim->ClickWorldPosition(FVector(100, 100, 0), [this]() { + WaitUntil( + [this]() { return GameState->GetSelectedUnit() != nullptr; }, + TEXT("Unit should be selected"), + [this, Enemy, InitialHealth]() { PerformAttack(Enemy, InitialHealth); } + ); + }); + } + + void PerformAttack(AUnit* Enemy, float InitialHealth) + { + // Click on enemy to attack + InputSim->ClickWorldPosition(Enemy->GetActorLocation(), [this, Enemy, InitialHealth]() { + // THEN: Enemy takes damage + WaitUntil( + [Enemy, InitialHealth]() { return Enemy->GetHealth() < InitialHealth; }, + TEXT("Enemy should take damage"), + [this]() { + FinishTest(EFunctionalTestResult::Succeeded, + TEXT("Player successfully attacked enemy")); + } + ); + }); + } +}; + +/** + * E2E test: Full turn cycle completes correctly. + */ +UCLASS() +class AE2E_TurnCycleCompletes : public AGameE2ETestBase +{ + GENERATED_BODY() + +protected: + int32 StartingTurn; + + virtual void OnGameReady() override + { + // GIVEN: Game in progress + Scenario + ->OnTurn(1) + ->WithActiveFaction(EFaction::Player) + ->Build([this]() { OnScenarioReady(); }); + } + +private: + void OnScenarioReady() + { + StartingTurn = GameState->GetTurnNumber(); + + // WHEN: Player ends turn + InputSim->ClickButton(TEXT("EndTurnButton"), [this]() { + WaitUntil( + [this]() { + return GameState->GetActiveFaction() == EFaction::Enemy; + }, + TEXT("Should switch to enemy turn"), + [this]() { WaitForPlayerTurnReturn(); } + ); + }); + } + + void WaitForPlayerTurnReturn() + { + // Wait for AI turn to complete + WaitUntil( + [this]() { + return GameState->GetActiveFaction() == EFaction::Player; + }, + TEXT("Should return to player turn"), + [this]() { VerifyTurnIncremented(); }, + 30.0f // AI might take a while + ); + } + + void VerifyTurnIncremented() + { + // THEN: Turn number incremented + int32 CurrentTurn = GameState->GetTurnNumber(); + if (CurrentTurn == StartingTurn + 1) + { + FinishTest(EFunctionalTestResult::Succeeded, + TEXT("Turn cycle completed successfully")); + } + else + { + FinishTest(EFunctionalTestResult::Failed, + FString::Printf(TEXT("Expected turn %d, got %d"), + StartingTurn + 1, CurrentTurn)); + } + } +}; +``` + +### Running E2E Tests + +```bash +# Run all E2E tests +UnrealEditor-Cmd.exe MyGame.uproject \ + -ExecCmds="Automation RunTests MyGame.E2E" \ + -unattended -nopause -nullrhi + +# Run specific E2E test +UnrealEditor-Cmd.exe MyGame.uproject \ + -ExecCmds="Automation RunTests MyGame.E2E.Combat.PlayerAttacksEnemy" \ + -unattended -nopause + +# Run with detailed logging +UnrealEditor-Cmd.exe MyGame.uproject \ + -ExecCmds="Automation RunTests MyGame.E2E" \ + -unattended -nopause -log=E2ETests.log +``` + +### Quick E2E Checklist for Unreal + +- [ ] Create `GameE2ETestBase` class extending `AFunctionalTest` +- [ ] Implement `ScenarioBuilder` for your game's domain +- [ ] Create `InputSimulator` wrapping Slate input system +- [ ] Add `AsyncTestHelpers` with latent commands +- [ ] Create dedicated E2E test maps with spawn points +- [ ] Organize E2E tests under `Source/MyGameTests/Private/E2E/` +- [ ] Configure separate CI job for E2E suite with extended timeout +- [ ] Use Gauntlet for extended E2E scenarios if needed diff --git a/src/modules/bmgd/gametest/qa-index.csv b/src/modules/bmgd/gametest/qa-index.csv index af026afd..05b3ba79 100644 --- a/src/modules/bmgd/gametest/qa-index.csv +++ b/src/modules/bmgd/gametest/qa-index.csv @@ -14,4 +14,5 @@ input-testing,Input Testing,"Controller, keyboard, and touch input validation"," localization-testing,Localization Testing,"Text, audio, and cultural validation for international releases","localization,i18n,text",knowledge/localization-testing.md certification-testing,Platform Certification,"Console TRC/XR requirements and certification testing","certification,console,trc,xr",knowledge/certification-testing.md smoke-testing,Smoke Testing,"Critical path validation for build verification","smoke-tests,bvt,ci",knowledge/smoke-testing.md -test-priorities,Test Priorities Matrix,"P0-P3 criteria, coverage targets, execution ordering for games","prioritization,risk,coverage",knowledge/test-priorities.md \ No newline at end of file +test-priorities,Test Priorities Matrix,"P0-P3 criteria, coverage targets, execution ordering for games","prioritization,risk,coverage",knowledge/test-priorities.md +e2e-testing,End-to-End Testing,"Complete player journey testing with infrastructure patterns and async utilities","e2e,integration,player-journeys,scenarios,infrastructure",knowledge/e2e-testing.md diff --git a/src/modules/bmgd/module.yaml b/src/modules/bmgd/module.yaml index 22d61813..2b08570d 100644 --- a/src/modules/bmgd/module.yaml +++ b/src/modules/bmgd/module.yaml @@ -31,7 +31,7 @@ game_dev_experience: planning_artifacts: prompt: "Where should game planning artifacts be stored?\n(Game Briefs, GDDs, Narrative Designs, Architecture docs)" - default: "{output_folder}/game-planning-artifacts" + default: "{output_folder}/planning-artifacts" result: "{project-root}/{value}" implementation_artifacts: diff --git a/src/modules/bmgd/workflows/1-preproduction/brainstorm-game/instructions.md b/src/modules/bmgd/workflows/1-preproduction/brainstorm-game/instructions.md index 55574a3a..21afdc77 100644 --- a/src/modules/bmgd/workflows/1-preproduction/brainstorm-game/instructions.md +++ b/src/modules/bmgd/workflows/1-preproduction/brainstorm-game/instructions.md @@ -1,4 +1,4 @@ -The workflow execution engine is governed by: {project_root}/_bmad/core/tasks/workflow.xml +The workflow execution engine is governed by: {project-root}/_bmad/core/tasks/workflow.xml You MUST have already loaded and processed: {installed_path}/workflow.yaml Communicate all responses in {communication_language} This is a meta-workflow that orchestrates the CIS brainstorming workflow with game-specific context and additional game design techniques diff --git a/src/modules/bmgd/workflows/1-preproduction/brainstorm-game/steps/step-01-init.md b/src/modules/bmgd/workflows/1-preproduction/brainstorm-game/steps/step-01-init.md index 6075aaa2..ef1719ef 100644 --- a/src/modules/bmgd/workflows/1-preproduction/brainstorm-game/steps/step-01-init.md +++ b/src/modules/bmgd/workflows/1-preproduction/brainstorm-game/steps/step-01-init.md @@ -6,8 +6,8 @@ description: 'Initialize the game brainstorming workflow and validate readiness' workflow_path: '{project-root}/_bmad/bmgd/workflows/1-preproduction/brainstorm-game' # File References -thisStepFile: '{workflow_path}/steps/step-01-init.md' -nextStepFile: '{workflow_path}/steps/step-02-context.md' +thisStepFile: './step-01-init.md' +nextStepFile: './step-02-context.md' workflowFile: '{workflow_path}/workflow.md' outputFile: '{output_folder}/brainstorming-session-{date}.md' @@ -33,6 +33,7 @@ Validate workflow readiness, check for workflow status tracking, and prepare for - CRITICAL: When loading next step with 'C', ensure entire file is read - YOU ARE A FACILITATOR, not a content generator - NEVER mention time estimates +- ✅ YOU MUST ALWAYS SPEAK OUTPUT In your Agent communication style with the config `{communication_language}` ### Role Reinforcement: @@ -92,10 +93,11 @@ Handle each scenario appropriately with user prompts. **Brainstorming Rules:** - There are no bad ideas in brainstorming -- Quantity over quality initially +- **Quantity over quality:** Our goal is **100+ ideas**. The first 20 are obvious; as brainstorming progresses, quality must grow (the magic happens in ideas 50-100). - Build on ideas rather than criticize - Wild ideas are welcome - Defer judgment until later +- We will stay in generative mode until you feel we've thoroughly explored the space. **What we'll do:** diff --git a/src/modules/bmgd/workflows/1-preproduction/brainstorm-game/steps/step-02-context.md b/src/modules/bmgd/workflows/1-preproduction/brainstorm-game/steps/step-02-context.md index cff12c6e..b7312261 100644 --- a/src/modules/bmgd/workflows/1-preproduction/brainstorm-game/steps/step-02-context.md +++ b/src/modules/bmgd/workflows/1-preproduction/brainstorm-game/steps/step-02-context.md @@ -6,15 +6,15 @@ description: 'Load game-specific brainstorming context and techniques' workflow_path: '{project-root}/_bmad/bmgd/workflows/1-preproduction/brainstorm-game' # File References -thisStepFile: '{workflow_path}/steps/step-02-context.md' -nextStepFile: '{workflow_path}/steps/step-03-ideation.md' +thisStepFile: './step-02-context.md' +nextStepFile: './step-03-ideation.md' workflowFile: '{workflow_path}/workflow.md' outputFile: '{output_folder}/brainstorming-session-{date}.md' # Context Files gameContext: '{workflow_path}/game-context.md' gameBrainMethods: '{workflow_path}/game-brain-methods.csv' -coreBrainstorming: '{project-root}/_bmad/core/workflows/brainstorming/workflow.yaml' +coreBrainstorming: '{project-root}/_bmad/core/workflows/brainstorming/workflow.md' --- # Step 2: Load Context @@ -34,6 +34,7 @@ Load game-specific brainstorming context and techniques to guide the ideation se - CRITICAL: When loading next step with 'C', ensure entire file is read - YOU ARE A FACILITATOR, not a content generator - NEVER mention time estimates +- ✅ YOU MUST ALWAYS SPEAK OUTPUT In your Agent communication style with the config `{communication_language}` ### Role Reinforcement: diff --git a/src/modules/bmgd/workflows/1-preproduction/brainstorm-game/steps/step-03-ideation.md b/src/modules/bmgd/workflows/1-preproduction/brainstorm-game/steps/step-03-ideation.md index bd9d635b..355297a0 100644 --- a/src/modules/bmgd/workflows/1-preproduction/brainstorm-game/steps/step-03-ideation.md +++ b/src/modules/bmgd/workflows/1-preproduction/brainstorm-game/steps/step-03-ideation.md @@ -6,16 +6,16 @@ description: 'Execute the brainstorming session with game-specific techniques' workflow_path: '{project-root}/_bmad/bmgd/workflows/1-preproduction/brainstorm-game' # File References -thisStepFile: '{workflow_path}/steps/step-03-ideation.md' -nextStepFile: '{workflow_path}/steps/step-04-complete.md' +thisStepFile: './step-03-ideation.md' +nextStepFile: './step-04-complete.md' workflowFile: '{workflow_path}/workflow.md' outputFile: '{output_folder}/brainstorming-session-{date}.md' # Core Brainstorming Reference -coreBrainstorming: '{project-root}/_bmad/core/workflows/brainstorming/workflow.yaml' +coreBrainstorming: '{project-root}/_bmad/core/workflows/brainstorming/workflow.md' # Task References -advancedElicitationTask: '{project-root}/_bmad/core/tasks/advanced-elicitation.xml' +advancedElicitationTask: '{project-root}/_bmad/core/workflows/advanced-elicitation/workflow.xml' partyModeWorkflow: '{project-root}/_bmad/core/workflows/party-mode/workflow.md' --- @@ -31,11 +31,30 @@ Facilitate the actual brainstorming session using selected techniques. Capture a ### Universal Rules: +- ✅ YOU ARE A CREATIVE FACILITATOR, engaging in genuine back-and-forth coaching +- 🎯 AIM FOR 100+ IDEAS before suggesting organization - quantity unlocks quality (quality must grow as we progress) +- 🔄 DEFAULT IS TO KEEP EXPLORING - only move to organization when user explicitly requests it +- 🧠 **THOUGHT BEFORE INK (CoT):** Before generating each idea, you must internally reason: "What mechanic/theme haven't we explored yet? What would make this concept 'break the genre'?" +- 🛡️ **ANTI-BIAS DOMAIN PIVOT:** Every 10 ideas, review existing themes and consciously pivot to an orthogonal domain (e.g., Mechanics -> Monetization -> Lore -> Accessibility). +- 🌡️ **SIMULATED TEMPERATURE:** Act as if your creativity is set to 0.85 - take wilder leaps and suggest "provocative" game loops. +- ⏱️ Spend minimum 30-45 minutes in active ideation before offering to conclude +- 🎯 EXECUTE ONE TECHNIQUE ELEMENT AT A TIME with interactive exploration +- 📋 RESPOND DYNAMICALLY to user insights and build upon their ideas +- 🔍 ADAPT FACILITATION based on user engagement and emerging directions +- 💬 CREATE TRUE COLLABORATION, not question-answer sequences - NEVER generate content without user input - CRITICAL: Read the complete step file before taking any action - CRITICAL: When loading next step with 'C', ensure entire file is read - YOU ARE A FACILITATOR, not a content generator - NEVER mention time estimates +- ✅ YOU MUST ALWAYS SPEAK OUTPUT In your Agent communication style with the config `{communication_language}` + +## IDEA FORMAT TEMPLATE: + +Every idea you capture should follow this structure: +**[Category #X]**: [Mnemonic Title] +_Core Loop_: [2-3 sentence description of player action] +_Novelty_: [What makes this different from generic games] ### Role Reinforcement: @@ -54,15 +73,17 @@ Facilitate the actual brainstorming session using selected techniques. Capture a ## EXECUTION PROTOCOLS: - Show your analysis before taking any action -- Present A/P/C menu after ideation session +- Present the exploration menu after ideation session - ONLY proceed when user chooses C (Continue) - Update frontmatter `stepsCompleted: [1, 2, 3]` before loading next step -## COLLABORATION MENUS (A/P/C): +## EXPLORATION & COLLABORATION MENU: -- **A (Advanced Elicitation)**: Dig deeper into promising ideas -- **P (Party Mode)**: Get multiple perspectives on concepts -- **C (Continue)**: Save ideas and complete session +- [K] **Keep exploring current technique** - Push for more ideas using the current method +- [T] **Try a different game design technique** - Switch to another method from the library +- [A] **Advanced Elicitation** - Dig deeper into promising ideas using reasoning techniques +- [P] **Party Mode** - Get multiple perspectives on concepts from other agents +- [C] **Continue** - Save ideas and move to organization phase ## Sequence of Instructions (Do not deviate, skip, or optimize) @@ -176,30 +197,16 @@ Your choice:" ### 7. Generate Ideation Section -Based on all ideas captured, prepare the content: +Based on all ideas captured, prepare the content using our **IDEA FORMAT TEMPLATE**: ```markdown ## Ideas Generated -### Concept 1: {{concept_name}} +**[Category #X]**: [Mnemonic Title] +_Core Loop_: [2-3 sentence description of player action] +_Novelty_: [What makes this different from generic games] -{{full_concept_description}} - -**Core Elements:** - -- {{element_1}} -- {{element_2}} - -**Questions to Explore:** - -- {{question_1}} -- {{question_2}} - ---- - -### Concept 2: {{concept_name}} - -{{repeat_structure}} +(Repeat for all ideas generated) --- @@ -210,10 +217,6 @@ Based on all ideas captured, prepare the content: ## Promising Combinations {{combination_ideas}} - -## Raw Ideas List - -{{all_ideas_bullet_points}} ``` ### 8. Present Content and Menu @@ -228,30 +231,33 @@ Here's everything we captured: **Session Stats:** -- Ideas generated: {{count}} -- Concepts developed: {{count}} -- Themes identified: {{count}} +- Ideas generated: {{idea_count}} +- Concepts developed: {{concept_count}} +- Themes identified: {{theme_count}} **Select an Option:** -[A] Advanced Elicitation - Dig deeper into promising ideas -[P] Party Mode - Get multiple perspectives on concepts -[C] Continue - Save ideas and complete session (Step 4 of 4)" +[K] **Keep exploring current technique** - We're just getting warmed up! +[T] **Try a different game design technique** - Fresh perspective on the same concept +[A] **Advanced Elicitation** - Go deeper on a specific concept (Dig deeper) +[P] **Party Mode** - Get multiple perspectives on concepts from other agents +[C] **Continue to Organization** - Only when you feel we've thoroughly explored (Step 4 of 4) + +**Default recommendation:** Unless you feel we've generated at least 100+ ideas, I suggest we keep exploring! The best insights often come after the obvious ideas are exhausted. ### 9. Handle Menu Selection -#### IF A (Advanced Elicitation): +#### IF K, T, or A (Keep Exploring): -- Deep dive into selected concepts -- Ask user: "Accept these additions? (y/n)" -- If yes: Update content, return to A/P/C menu -- If no: Keep original, return to A/P/C menu +- **Restart the ideation loop** based on the chosen path +- For option A, invoke Advanced Elicitation: `{advancedElicitationTask}` +- Keep user in generative mode #### IF P (Party Mode): -- Get diverse perspectives on concepts +- Get diverse perspectives on concepts using `{partyModeWorkflow}` - Ask user: "Accept these perspectives? (y/n)" -- If yes: Update content, return to A/P/C menu -- If no: Keep original, return to A/P/C menu +- If yes: Update content, return to exploration menu +- If no: Keep original, return to exploration menu #### IF C (Continue): diff --git a/src/modules/bmgd/workflows/1-preproduction/brainstorm-game/steps/step-04-complete.md b/src/modules/bmgd/workflows/1-preproduction/brainstorm-game/steps/step-04-complete.md index fce8662a..3807e0af 100644 --- a/src/modules/bmgd/workflows/1-preproduction/brainstorm-game/steps/step-04-complete.md +++ b/src/modules/bmgd/workflows/1-preproduction/brainstorm-game/steps/step-04-complete.md @@ -6,7 +6,7 @@ description: 'Complete the brainstorming session with summary and next steps' workflow_path: '{project-root}/_bmad/bmgd/workflows/1-preproduction/brainstorm-game' # File References -thisStepFile: '{workflow_path}/steps/step-04-complete.md' +thisStepFile: './step-04-complete.md' workflowFile: '{workflow_path}/workflow.md' outputFile: '{output_folder}/brainstorming-session-{date}.md' @@ -31,6 +31,7 @@ Finalize the brainstorming session, generate actionable next steps, update workf - CRITICAL: Read the complete step file before taking any action - YOU ARE A FACILITATOR, not a content generator - NEVER mention time estimates +- ✅ YOU MUST ALWAYS SPEAK OUTPUT In your Agent communication style with the config `{communication_language}` ### Role Reinforcement: diff --git a/src/modules/bmgd/workflows/1-preproduction/brainstorm-game/workflow.md b/src/modules/bmgd/workflows/1-preproduction/brainstorm-game/workflow.md index d6f4d90b..948ab591 100644 --- a/src/modules/bmgd/workflows/1-preproduction/brainstorm-game/workflow.md +++ b/src/modules/bmgd/workflows/1-preproduction/brainstorm-game/workflow.md @@ -28,12 +28,14 @@ stepsCompleted: [1, 2, 3, ...] # Array of completed step numbers To begin, load and execute step-01-init.md: ``` -{workflow_path}/steps/step-01-init.md +./step-01-init.md ``` ## Critical Rules - This is a meta-workflow that orchestrates CIS brainstorming +- **Critical Mindset:** Your job is to keep the user in generative exploration mode as long as possible. The best brainstorming sessions feel slightly uncomfortable - like you've pushed past the obvious ideas into truly novel territory. Resist the urge to organize or conclude. When in doubt, ask another question, try another technique, or dig deeper into a promising thread. +- **Quantity Goal:** Aim for 100+ ideas before any organization. The first 20 ideas are usually obvious - the magic happens in ideas 50-100. - Use game-specific techniques from game-brain-methods.csv - Apply game-context.md guidance throughout - **NEVER** mention time estimates @@ -43,7 +45,9 @@ To begin, load and execute step-01-init.md: You are a creative facilitator specializing in game ideation: +- **Generative Facilitator:** Your priority is quantity and exploration over early documentation. Keep the user in "Yes And" mode. - Draw out user's game concepts and ideas - Apply game-specific brainstorming techniques - Help users explore mechanics, themes, and experiences - Capture and organize ideas for later refinement +- ✅ YOU MUST ALWAYS SPEAK OUTPUT In your Agent communication style with the config `{communication_language}` diff --git a/src/modules/bmgd/workflows/1-preproduction/brainstorm-game/workflow.yaml b/src/modules/bmgd/workflows/1-preproduction/brainstorm-game/workflow.yaml index e53b58c3..4ba88ea3 100644 --- a/src/modules/bmgd/workflows/1-preproduction/brainstorm-game/workflow.yaml +++ b/src/modules/bmgd/workflows/1-preproduction/brainstorm-game/workflow.yaml @@ -22,7 +22,7 @@ game_context: "{installed_path}/game-context.md" game_brain_methods: "{installed_path}/game-brain-methods.csv" # CORE brainstorming workflow reference (for technique merging) -core_brainstorming: "{project-root}/_bmad/core/workflows/brainstorming/workflow.yaml" +core_brainstorming: "{project-root}/_bmad/core/workflows/brainstorming/workflow.md" # Output configuration default_output_file: "{output_folder}/brainstorming-session-{date}.md" @@ -58,5 +58,5 @@ web_bundle: # Context files - "_bmad/bmgd/workflows/1-preproduction/brainstorm-game/game-context.md" - "_bmad/bmgd/workflows/1-preproduction/brainstorm-game/game-brain-methods.csv" - existing_workflows: - - core_brainstorming: "_bmad/core/workflows/brainstorming/workflow.yaml" +dependencies: + - "_bmad/core/workflows/brainstorming/workflow.md" diff --git a/src/modules/bmgd/workflows/1-preproduction/game-brief/steps/step-01-init.md b/src/modules/bmgd/workflows/1-preproduction/game-brief/steps/step-01-init.md index 2e03f125..b203fbe2 100644 --- a/src/modules/bmgd/workflows/1-preproduction/game-brief/steps/step-01-init.md +++ b/src/modules/bmgd/workflows/1-preproduction/game-brief/steps/step-01-init.md @@ -6,9 +6,9 @@ description: 'Initialize the Game Brief workflow by detecting continuation state workflow_path: '{project-root}/_bmad/bmgd/workflows/1-preproduction/game-brief' # File References -thisStepFile: '{workflow_path}/steps/step-01-init.md' -nextStepFile: '{workflow_path}/steps/step-02-vision.md' -continueStepFile: '{workflow_path}/steps/step-01b-continue.md' +thisStepFile: './step-01-init.md' +nextStepFile: './step-02-vision.md' +continueStepFile: './step-01b-continue.md' workflowFile: '{workflow_path}/workflow.md' outputFile: '{output_folder}/game-brief.md' @@ -33,6 +33,7 @@ Initialize the Game Brief workflow by detecting continuation state, discovering - CRITICAL: When loading next step with 'C', ensure entire file is read - YOU ARE A FACILITATOR, not a content generator - NEVER mention time estimates +- ✅ YOU MUST ALWAYS SPEAK OUTPUT In your Agent communication style with the config `{communication_language}` ### Role Reinforcement: diff --git a/src/modules/bmgd/workflows/1-preproduction/game-brief/steps/step-01b-continue.md b/src/modules/bmgd/workflows/1-preproduction/game-brief/steps/step-01b-continue.md index ed8d5319..514be496 100644 --- a/src/modules/bmgd/workflows/1-preproduction/game-brief/steps/step-01b-continue.md +++ b/src/modules/bmgd/workflows/1-preproduction/game-brief/steps/step-01b-continue.md @@ -6,7 +6,7 @@ description: 'Resume an interrupted Game Brief workflow from the last completed workflow_path: '{project-root}/_bmad/bmgd/workflows/1-preproduction/game-brief' # File References -thisStepFile: '{workflow_path}/steps/step-01b-continue.md' +thisStepFile: './step-01b-continue.md' workflowFile: '{workflow_path}/workflow.md' outputFile: '{output_folder}/game-brief.md' --- @@ -25,6 +25,7 @@ Resume the Game Brief workflow from where it was left off, ensuring smooth conti - CRITICAL: Read the complete step file before taking any action - CRITICAL: When loading next step with 'C', ensure entire file is read - YOU ARE A FACILITATOR, not a content generator +- ✅ YOU MUST ALWAYS SPEAK OUTPUT In your Agent communication style with the config `{communication_language}` ### Role Reinforcement: diff --git a/src/modules/bmgd/workflows/1-preproduction/game-brief/steps/step-02-vision.md b/src/modules/bmgd/workflows/1-preproduction/game-brief/steps/step-02-vision.md index 02684aa4..34f84a06 100644 --- a/src/modules/bmgd/workflows/1-preproduction/game-brief/steps/step-02-vision.md +++ b/src/modules/bmgd/workflows/1-preproduction/game-brief/steps/step-02-vision.md @@ -6,13 +6,13 @@ description: 'Define the core game vision including name, concept, pitch, and vi workflow_path: '{project-root}/_bmad/bmgd/workflows/1-preproduction/game-brief' # File References -thisStepFile: '{workflow_path}/steps/step-02-vision.md' -nextStepFile: '{workflow_path}/steps/step-03-market.md' +thisStepFile: './step-02-vision.md' +nextStepFile: './step-03-market.md' workflowFile: '{workflow_path}/workflow.md' outputFile: '{output_folder}/game-brief.md' # Task References -advancedElicitationTask: '{project-root}/_bmad/core/tasks/advanced-elicitation.xml' +advancedElicitationTask: '{project-root}/_bmad/core/workflows/advanced-elicitation/workflow.xml' partyModeWorkflow: '{project-root}/_bmad/core/workflows/party-mode/workflow.md' --- @@ -33,6 +33,7 @@ Capture the core game vision including the working title, one-sentence concept, - CRITICAL: When loading next step with 'C', ensure entire file is read - YOU ARE A FACILITATOR, not a content generator - NEVER mention time estimates +- ✅ YOU MUST ALWAYS SPEAK OUTPUT In your Agent communication style with the config `{communication_language}` ### Role Reinforcement: diff --git a/src/modules/bmgd/workflows/1-preproduction/game-brief/steps/step-03-market.md b/src/modules/bmgd/workflows/1-preproduction/game-brief/steps/step-03-market.md index 26b398e3..6fb67ffb 100644 --- a/src/modules/bmgd/workflows/1-preproduction/game-brief/steps/step-03-market.md +++ b/src/modules/bmgd/workflows/1-preproduction/game-brief/steps/step-03-market.md @@ -6,13 +6,13 @@ description: 'Define target audience and market context' workflow_path: '{project-root}/_bmad/bmgd/workflows/1-preproduction/game-brief' # File References -thisStepFile: '{workflow_path}/steps/step-03-market.md' -nextStepFile: '{workflow_path}/steps/step-04-fundamentals.md' +thisStepFile: './step-03-market.md' +nextStepFile: './step-04-fundamentals.md' workflowFile: '{workflow_path}/workflow.md' outputFile: '{output_folder}/game-brief.md' # Task References -advancedElicitationTask: '{project-root}/_bmad/core/tasks/advanced-elicitation.xml' +advancedElicitationTask: '{project-root}/_bmad/core/workflows/advanced-elicitation/workflow.xml' partyModeWorkflow: '{project-root}/_bmad/core/workflows/party-mode/workflow.md' --- @@ -33,6 +33,7 @@ Define the primary and secondary target audiences with specific demographics, an - CRITICAL: When loading next step with 'C', ensure entire file is read - YOU ARE A FACILITATOR, not a content generator - NEVER mention time estimates +- ✅ YOU MUST ALWAYS SPEAK OUTPUT In your Agent communication style with the config `{communication_language}` ### Role Reinforcement: diff --git a/src/modules/bmgd/workflows/1-preproduction/game-brief/steps/step-04-fundamentals.md b/src/modules/bmgd/workflows/1-preproduction/game-brief/steps/step-04-fundamentals.md index 2761ed7d..2238262d 100644 --- a/src/modules/bmgd/workflows/1-preproduction/game-brief/steps/step-04-fundamentals.md +++ b/src/modules/bmgd/workflows/1-preproduction/game-brief/steps/step-04-fundamentals.md @@ -6,13 +6,13 @@ description: 'Define core gameplay pillars, mechanics, and player experience goa workflow_path: '{project-root}/_bmad/bmgd/workflows/1-preproduction/game-brief' # File References -thisStepFile: '{workflow_path}/steps/step-04-fundamentals.md' -nextStepFile: '{workflow_path}/steps/step-05-scope.md' +thisStepFile: './step-04-fundamentals.md' +nextStepFile: './step-05-scope.md' workflowFile: '{workflow_path}/workflow.md' outputFile: '{output_folder}/game-brief.md' # Task References -advancedElicitationTask: '{project-root}/_bmad/core/tasks/advanced-elicitation.xml' +advancedElicitationTask: '{project-root}/_bmad/core/workflows/advanced-elicitation/workflow.xml' partyModeWorkflow: '{project-root}/_bmad/core/workflows/party-mode/workflow.md' --- @@ -33,6 +33,7 @@ Define the core gameplay pillars (fundamental design tenets), primary mechanics - CRITICAL: When loading next step with 'C', ensure entire file is read - YOU ARE A FACILITATOR, not a content generator - NEVER mention time estimates +- ✅ YOU MUST ALWAYS SPEAK OUTPUT In your Agent communication style with the config `{communication_language}` ### Role Reinforcement: diff --git a/src/modules/bmgd/workflows/1-preproduction/game-brief/steps/step-05-scope.md b/src/modules/bmgd/workflows/1-preproduction/game-brief/steps/step-05-scope.md index 86b629c3..3f5fce6a 100644 --- a/src/modules/bmgd/workflows/1-preproduction/game-brief/steps/step-05-scope.md +++ b/src/modules/bmgd/workflows/1-preproduction/game-brief/steps/step-05-scope.md @@ -6,13 +6,13 @@ description: 'Define project scope including platforms, constraints, and resourc workflow_path: '{project-root}/_bmad/bmgd/workflows/1-preproduction/game-brief' # File References -thisStepFile: '{workflow_path}/steps/step-05-scope.md' -nextStepFile: '{workflow_path}/steps/step-06-references.md' +thisStepFile: './step-05-scope.md' +nextStepFile: './step-06-references.md' workflowFile: '{workflow_path}/workflow.md' outputFile: '{output_folder}/game-brief.md' # Task References -advancedElicitationTask: '{project-root}/_bmad/core/tasks/advanced-elicitation.xml' +advancedElicitationTask: '{project-root}/_bmad/core/workflows/advanced-elicitation/workflow.xml' partyModeWorkflow: '{project-root}/_bmad/core/workflows/party-mode/workflow.md' --- @@ -33,6 +33,7 @@ Define realistic project constraints including target platforms, budget consider - CRITICAL: When loading next step with 'C', ensure entire file is read - YOU ARE A FACILITATOR, not a content generator - NEVER mention time estimates +- ✅ YOU MUST ALWAYS SPEAK OUTPUT In your Agent communication style with the config `{communication_language}` ### Role Reinforcement: diff --git a/src/modules/bmgd/workflows/1-preproduction/game-brief/steps/step-06-references.md b/src/modules/bmgd/workflows/1-preproduction/game-brief/steps/step-06-references.md index c25fc030..3ed60259 100644 --- a/src/modules/bmgd/workflows/1-preproduction/game-brief/steps/step-06-references.md +++ b/src/modules/bmgd/workflows/1-preproduction/game-brief/steps/step-06-references.md @@ -6,13 +6,13 @@ description: 'Define inspiration games, competitive analysis, and key differenti workflow_path: '{project-root}/_bmad/bmgd/workflows/1-preproduction/game-brief' # File References -thisStepFile: '{workflow_path}/steps/step-06-references.md' -nextStepFile: '{workflow_path}/steps/step-07-content.md' +thisStepFile: './step-06-references.md' +nextStepFile: './step-07-content.md' workflowFile: '{workflow_path}/workflow.md' outputFile: '{output_folder}/game-brief.md' # Task References -advancedElicitationTask: '{project-root}/_bmad/core/tasks/advanced-elicitation.xml' +advancedElicitationTask: '{project-root}/_bmad/core/workflows/advanced-elicitation/workflow.xml' partyModeWorkflow: '{project-root}/_bmad/core/workflows/party-mode/workflow.md' --- @@ -33,6 +33,7 @@ Identify inspiration games (what you're drawing from and NOT taking), analyze co - CRITICAL: When loading next step with 'C', ensure entire file is read - YOU ARE A FACILITATOR, not a content generator - NEVER mention time estimates +- ✅ YOU MUST ALWAYS SPEAK OUTPUT In your Agent communication style with the config `{communication_language}` ### Role Reinforcement: diff --git a/src/modules/bmgd/workflows/1-preproduction/game-brief/steps/step-07-content.md b/src/modules/bmgd/workflows/1-preproduction/game-brief/steps/step-07-content.md index 05c4cc34..1a48dcc1 100644 --- a/src/modules/bmgd/workflows/1-preproduction/game-brief/steps/step-07-content.md +++ b/src/modules/bmgd/workflows/1-preproduction/game-brief/steps/step-07-content.md @@ -6,13 +6,13 @@ description: 'Define content framework, art/audio direction, and risk assessment workflow_path: '{project-root}/_bmad/bmgd/workflows/1-preproduction/game-brief' # File References -thisStepFile: '{workflow_path}/steps/step-07-content.md' -nextStepFile: '{workflow_path}/steps/step-08-complete.md' +thisStepFile: './step-07-content.md' +nextStepFile: './step-08-complete.md' workflowFile: '{workflow_path}/workflow.md' outputFile: '{output_folder}/game-brief.md' # Task References -advancedElicitationTask: '{project-root}/_bmad/core/tasks/advanced-elicitation.xml' +advancedElicitationTask: '{project-root}/_bmad/core/workflows/advanced-elicitation/workflow.xml' partyModeWorkflow: '{project-root}/_bmad/core/workflows/party-mode/workflow.md' --- @@ -33,6 +33,7 @@ Define the content framework (world, narrative approach, volume), art and audio - CRITICAL: When loading next step with 'C', ensure entire file is read - YOU ARE A FACILITATOR, not a content generator - NEVER mention time estimates +- ✅ YOU MUST ALWAYS SPEAK OUTPUT In your Agent communication style with the config `{communication_language}` ### Role Reinforcement: diff --git a/src/modules/bmgd/workflows/1-preproduction/game-brief/steps/step-08-complete.md b/src/modules/bmgd/workflows/1-preproduction/game-brief/steps/step-08-complete.md index e994388f..3b3f6f7b 100644 --- a/src/modules/bmgd/workflows/1-preproduction/game-brief/steps/step-08-complete.md +++ b/src/modules/bmgd/workflows/1-preproduction/game-brief/steps/step-08-complete.md @@ -6,7 +6,7 @@ description: 'Define success criteria and complete the game brief with handoff g workflow_path: '{project-root}/_bmad/bmgd/workflows/1-preproduction/game-brief' # File References -thisStepFile: '{workflow_path}/steps/step-08-complete.md' +thisStepFile: './step-08-complete.md' workflowFile: '{workflow_path}/workflow.md' outputFile: '{output_folder}/game-brief.md' @@ -30,6 +30,7 @@ Define MVP scope, success metrics, immediate next steps, and provide clear hando - CRITICAL: Read the complete step file before taking any action - YOU ARE A FACILITATOR, not a content generator - NEVER mention time estimates +- ✅ YOU MUST ALWAYS SPEAK OUTPUT In your Agent communication style with the config `{communication_language}` ### Role Reinforcement: diff --git a/src/modules/bmgd/workflows/1-preproduction/game-brief/workflow.md b/src/modules/bmgd/workflows/1-preproduction/game-brief/workflow.md index 213cff9e..e40067a0 100644 --- a/src/modules/bmgd/workflows/1-preproduction/game-brief/workflow.md +++ b/src/modules/bmgd/workflows/1-preproduction/game-brief/workflow.md @@ -56,6 +56,7 @@ Load and read full config from {main_config} and resolve: - `project_name`, `output_folder`, `user_name` - `communication_language`, `document_output_language`, `user_skill_level` - `date` as system-generated current datetime +- ✅ YOU MUST ALWAYS SPEAK OUTPUT In your Agent communication style with the config `{communication_language}` ### 2. First Step EXECUTION diff --git a/src/modules/bmgd/workflows/2-design/gdd/steps/step-01-init.md b/src/modules/bmgd/workflows/2-design/gdd/steps/step-01-init.md index 372c14d6..ae40ccd3 100644 --- a/src/modules/bmgd/workflows/2-design/gdd/steps/step-01-init.md +++ b/src/modules/bmgd/workflows/2-design/gdd/steps/step-01-init.md @@ -6,9 +6,9 @@ description: 'Initialize the GDD workflow by detecting continuation state and se workflow_path: '{project-root}/_bmad/bmgd/workflows/2-design/gdd' # File References -thisStepFile: '{workflow_path}/steps/step-01-init.md' -nextStepFile: '{workflow_path}/steps/step-02-context.md' -continueStepFile: '{workflow_path}/steps/step-01b-continue.md' +thisStepFile: './step-01-init.md' +nextStepFile: './step-02-context.md' +continueStepFile: './step-01b-continue.md' workflowFile: '{workflow_path}/workflow.md' outputFile: '{output_folder}/gdd.md' @@ -35,6 +35,7 @@ Initialize the GDD workflow by detecting continuation state, discovering input d - CRITICAL: Read the complete step file before taking any action - CRITICAL: When loading next step with 'C', ensure entire file is read - YOU ARE A FACILITATOR, not a content generator +- ✅ YOU MUST ALWAYS SPEAK OUTPUT In your Agent communication style with the config `{communication_language}` ### Role Reinforcement: diff --git a/src/modules/bmgd/workflows/2-design/gdd/steps/step-01b-continue.md b/src/modules/bmgd/workflows/2-design/gdd/steps/step-01b-continue.md index e0ac94f2..29318ee4 100644 --- a/src/modules/bmgd/workflows/2-design/gdd/steps/step-01b-continue.md +++ b/src/modules/bmgd/workflows/2-design/gdd/steps/step-01b-continue.md @@ -6,7 +6,7 @@ description: 'Resume an interrupted GDD workflow from the last completed step' workflow_path: '{project-root}/_bmad/bmgd/workflows/2-design/gdd' # File References -thisStepFile: '{workflow_path}/steps/step-01b-continue.md' +thisStepFile: './step-01b-continue.md' workflowFile: '{workflow_path}/workflow.md' outputFile: '{output_folder}/gdd.md' --- @@ -25,6 +25,7 @@ Resume the GDD workflow from where it was left off, ensuring smooth continuation - CRITICAL: Read the complete step file before taking any action - CRITICAL: When loading next step with 'C', ensure entire file is read - YOU ARE A FACILITATOR, not a content generator +- ✅ YOU MUST ALWAYS SPEAK OUTPUT In your Agent communication style with the config `{communication_language}` ### Role Reinforcement: diff --git a/src/modules/bmgd/workflows/2-design/gdd/steps/step-02-context.md b/src/modules/bmgd/workflows/2-design/gdd/steps/step-02-context.md index f00ddaa0..300ffd6d 100644 --- a/src/modules/bmgd/workflows/2-design/gdd/steps/step-02-context.md +++ b/src/modules/bmgd/workflows/2-design/gdd/steps/step-02-context.md @@ -6,8 +6,8 @@ description: 'Load game context from brief and determine the game type' workflow_path: '{project-root}/_bmad/bmgd/workflows/2-design/gdd' # File References -thisStepFile: '{workflow_path}/steps/step-02-context.md' -nextStepFile: '{workflow_path}/steps/step-03-platforms.md' +thisStepFile: './step-02-context.md' +nextStepFile: './step-03-platforms.md' workflowFile: '{workflow_path}/workflow.md' outputFile: '{output_folder}/gdd.md' @@ -16,7 +16,7 @@ gameTypesCSV: '{workflow_path}/game-types.csv' gameTypesFolder: '{workflow_path}/game-types' # Task References -advancedElicitationTask: '{project-root}/_bmad/core/tasks/advanced-elicitation.xml' +advancedElicitationTask: '{project-root}/_bmad/core/workflows/advanced-elicitation/workflow.xml' partyModeWorkflow: '{project-root}/_bmad/core/workflows/party-mode/workflow.md' --- @@ -36,6 +36,7 @@ Load and analyze the game brief (if available), determine the game type from gam - CRITICAL: Read the complete step file before taking any action - CRITICAL: When loading next step with 'C', ensure entire file is read - YOU ARE A FACILITATOR, not a content generator +- ✅ YOU MUST ALWAYS SPEAK OUTPUT In your Agent communication style with the config `{communication_language}` ### Role Reinforcement: diff --git a/src/modules/bmgd/workflows/2-design/gdd/steps/step-03-platforms.md b/src/modules/bmgd/workflows/2-design/gdd/steps/step-03-platforms.md index f98794d9..5433eab1 100644 --- a/src/modules/bmgd/workflows/2-design/gdd/steps/step-03-platforms.md +++ b/src/modules/bmgd/workflows/2-design/gdd/steps/step-03-platforms.md @@ -6,13 +6,13 @@ description: 'Define target platforms and target audience for the game' workflow_path: '{project-root}/_bmad/bmgd/workflows/2-design/gdd' # File References -thisStepFile: '{workflow_path}/steps/step-03-platforms.md' -nextStepFile: '{workflow_path}/steps/step-04-vision.md' +thisStepFile: './step-03-platforms.md' +nextStepFile: './step-04-vision.md' workflowFile: '{workflow_path}/workflow.md' outputFile: '{output_folder}/gdd.md' # Task References -advancedElicitationTask: '{project-root}/_bmad/core/tasks/advanced-elicitation.xml' +advancedElicitationTask: '{project-root}/_bmad/core/workflows/advanced-elicitation/workflow.xml' partyModeWorkflow: '{project-root}/_bmad/core/workflows/party-mode/workflow.md' --- @@ -32,6 +32,7 @@ Define the target platform(s) for the game and establish a clear picture of the - CRITICAL: Read the complete step file before taking any action - CRITICAL: When loading next step with 'C', ensure entire file is read - YOU ARE A FACILITATOR, not a content generator +- ✅ YOU MUST ALWAYS SPEAK OUTPUT In your Agent communication style with the config `{communication_language}` ### Role Reinforcement: diff --git a/src/modules/bmgd/workflows/2-design/gdd/steps/step-04-vision.md b/src/modules/bmgd/workflows/2-design/gdd/steps/step-04-vision.md index 0e808660..1df86679 100644 --- a/src/modules/bmgd/workflows/2-design/gdd/steps/step-04-vision.md +++ b/src/modules/bmgd/workflows/2-design/gdd/steps/step-04-vision.md @@ -6,13 +6,13 @@ description: 'Define project goals, context, and unique selling points' workflow_path: '{project-root}/_bmad/bmgd/workflows/2-design/gdd' # File References -thisStepFile: '{workflow_path}/steps/step-04-vision.md' -nextStepFile: '{workflow_path}/steps/step-05-core-gameplay.md' +thisStepFile: './step-04-vision.md' +nextStepFile: './step-05-core-gameplay.md' workflowFile: '{workflow_path}/workflow.md' outputFile: '{output_folder}/gdd.md' # Task References -advancedElicitationTask: '{project-root}/_bmad/core/tasks/advanced-elicitation.xml' +advancedElicitationTask: '{project-root}/_bmad/core/workflows/advanced-elicitation/workflow.xml' partyModeWorkflow: '{project-root}/_bmad/core/workflows/party-mode/workflow.md' --- @@ -32,6 +32,7 @@ Define the project goals, background context for why this game matters now, and - CRITICAL: Read the complete step file before taking any action - CRITICAL: When loading next step with 'C', ensure entire file is read - YOU ARE A FACILITATOR, not a content generator +- ✅ YOU MUST ALWAYS SPEAK OUTPUT In your Agent communication style with the config `{communication_language}` ### Role Reinforcement: diff --git a/src/modules/bmgd/workflows/2-design/gdd/steps/step-05-core-gameplay.md b/src/modules/bmgd/workflows/2-design/gdd/steps/step-05-core-gameplay.md index 3f25ec83..b2756e53 100644 --- a/src/modules/bmgd/workflows/2-design/gdd/steps/step-05-core-gameplay.md +++ b/src/modules/bmgd/workflows/2-design/gdd/steps/step-05-core-gameplay.md @@ -6,13 +6,13 @@ description: 'Define game pillars, core gameplay loop, and win/loss conditions' workflow_path: '{project-root}/_bmad/bmgd/workflows/2-design/gdd' # File References -thisStepFile: '{workflow_path}/steps/step-05-core-gameplay.md' -nextStepFile: '{workflow_path}/steps/step-06-mechanics.md' +thisStepFile: './step-05-core-gameplay.md' +nextStepFile: './step-06-mechanics.md' workflowFile: '{workflow_path}/workflow.md' outputFile: '{output_folder}/gdd.md' # Task References -advancedElicitationTask: '{project-root}/_bmad/core/tasks/advanced-elicitation.xml' +advancedElicitationTask: '{project-root}/_bmad/core/workflows/advanced-elicitation/workflow.xml' partyModeWorkflow: '{project-root}/_bmad/core/workflows/party-mode/workflow.md' --- @@ -32,6 +32,7 @@ Define the fundamental gameplay elements: game pillars (core design tenets), the - CRITICAL: Read the complete step file before taking any action - CRITICAL: When loading next step with 'C', ensure entire file is read - YOU ARE A FACILITATOR, not a content generator +- ✅ YOU MUST ALWAYS SPEAK OUTPUT In your Agent communication style with the config `{communication_language}` ### Role Reinforcement: diff --git a/src/modules/bmgd/workflows/2-design/gdd/steps/step-06-mechanics.md b/src/modules/bmgd/workflows/2-design/gdd/steps/step-06-mechanics.md index c80a53e4..e5322a02 100644 --- a/src/modules/bmgd/workflows/2-design/gdd/steps/step-06-mechanics.md +++ b/src/modules/bmgd/workflows/2-design/gdd/steps/step-06-mechanics.md @@ -6,13 +6,13 @@ description: 'Define primary game mechanics and control schemes' workflow_path: '{project-root}/_bmad/bmgd/workflows/2-design/gdd' # File References -thisStepFile: '{workflow_path}/steps/step-06-mechanics.md' -nextStepFile: '{workflow_path}/steps/step-07-game-type.md' +thisStepFile: './step-06-mechanics.md' +nextStepFile: './step-07-game-type.md' workflowFile: '{workflow_path}/workflow.md' outputFile: '{output_folder}/gdd.md' # Task References -advancedElicitationTask: '{project-root}/_bmad/core/tasks/advanced-elicitation.xml' +advancedElicitationTask: '{project-root}/_bmad/core/workflows/advanced-elicitation/workflow.xml' partyModeWorkflow: '{project-root}/_bmad/core/workflows/party-mode/workflow.md' --- @@ -32,6 +32,7 @@ Define the primary game mechanics that players interact with and the control sch - CRITICAL: Read the complete step file before taking any action - CRITICAL: When loading next step with 'C', ensure entire file is read - YOU ARE A FACILITATOR, not a content generator +- ✅ YOU MUST ALWAYS SPEAK OUTPUT In your Agent communication style with the config `{communication_language}` ### Role Reinforcement: diff --git a/src/modules/bmgd/workflows/2-design/gdd/steps/step-07-game-type.md b/src/modules/bmgd/workflows/2-design/gdd/steps/step-07-game-type.md index 310a626d..4fc8bcd7 100644 --- a/src/modules/bmgd/workflows/2-design/gdd/steps/step-07-game-type.md +++ b/src/modules/bmgd/workflows/2-design/gdd/steps/step-07-game-type.md @@ -6,8 +6,8 @@ description: 'Process game-type specific sections from the loaded game type guid workflow_path: '{project-root}/_bmad/bmgd/workflows/2-design/gdd' # File References -thisStepFile: '{workflow_path}/steps/step-07-game-type.md' -nextStepFile: '{workflow_path}/steps/step-08-progression.md' +thisStepFile: './step-07-game-type.md' +nextStepFile: './step-08-progression.md' workflowFile: '{workflow_path}/workflow.md' outputFile: '{output_folder}/gdd.md' @@ -15,7 +15,7 @@ outputFile: '{output_folder}/gdd.md' gameTypesFolder: '{workflow_path}/game-types' # Task References -advancedElicitationTask: '{project-root}/_bmad/core/tasks/advanced-elicitation.xml' +advancedElicitationTask: '{project-root}/_bmad/core/workflows/advanced-elicitation/workflow.xml' partyModeWorkflow: '{project-root}/_bmad/core/workflows/party-mode/workflow.md' --- @@ -35,6 +35,7 @@ Process the game-type specific sections from the loaded game type guide ({game_t - CRITICAL: Read the complete step file before taking any action - CRITICAL: When loading next step with 'C', ensure entire file is read - YOU ARE A FACILITATOR, not a content generator +- ✅ YOU MUST ALWAYS SPEAK OUTPUT In your Agent communication style with the config `{communication_language}` ### Role Reinforcement: diff --git a/src/modules/bmgd/workflows/2-design/gdd/steps/step-08-progression.md b/src/modules/bmgd/workflows/2-design/gdd/steps/step-08-progression.md index 37664496..2cb2ae31 100644 --- a/src/modules/bmgd/workflows/2-design/gdd/steps/step-08-progression.md +++ b/src/modules/bmgd/workflows/2-design/gdd/steps/step-08-progression.md @@ -6,13 +6,13 @@ description: 'Define player progression systems and game balance' workflow_path: '{project-root}/_bmad/bmgd/workflows/2-design/gdd' # File References -thisStepFile: '{workflow_path}/steps/step-08-progression.md' -nextStepFile: '{workflow_path}/steps/step-09-levels.md' +thisStepFile: './step-08-progression.md' +nextStepFile: './step-09-levels.md' workflowFile: '{workflow_path}/workflow.md' outputFile: '{output_folder}/gdd.md' # Task References -advancedElicitationTask: '{project-root}/_bmad/core/tasks/advanced-elicitation.xml' +advancedElicitationTask: '{project-root}/_bmad/core/workflows/advanced-elicitation/workflow.xml' partyModeWorkflow: '{project-root}/_bmad/core/workflows/party-mode/workflow.md' --- @@ -32,6 +32,7 @@ Define how players progress through the game (skill, power, narrative, etc.), th - CRITICAL: Read the complete step file before taking any action - CRITICAL: When loading next step with 'C', ensure entire file is read - YOU ARE A FACILITATOR, not a content generator +- ✅ YOU MUST ALWAYS SPEAK OUTPUT In your Agent communication style with the config `{communication_language}` ### Role Reinforcement: diff --git a/src/modules/bmgd/workflows/2-design/gdd/steps/step-09-levels.md b/src/modules/bmgd/workflows/2-design/gdd/steps/step-09-levels.md index d9d0f7f4..edd35846 100644 --- a/src/modules/bmgd/workflows/2-design/gdd/steps/step-09-levels.md +++ b/src/modules/bmgd/workflows/2-design/gdd/steps/step-09-levels.md @@ -6,13 +6,13 @@ description: 'Define level design framework and level progression' workflow_path: '{project-root}/_bmad/bmgd/workflows/2-design/gdd' # File References -thisStepFile: '{workflow_path}/steps/step-09-levels.md' -nextStepFile: '{workflow_path}/steps/step-10-art-audio.md' +thisStepFile: './step-09-levels.md' +nextStepFile: './step-10-art-audio.md' workflowFile: '{workflow_path}/workflow.md' outputFile: '{output_folder}/gdd.md' # Task References -advancedElicitationTask: '{project-root}/_bmad/core/tasks/advanced-elicitation.xml' +advancedElicitationTask: '{project-root}/_bmad/core/workflows/advanced-elicitation/workflow.xml' partyModeWorkflow: '{project-root}/_bmad/core/workflows/party-mode/workflow.md' --- @@ -32,6 +32,7 @@ Define the level design framework including level types, structure, and how leve - CRITICAL: Read the complete step file before taking any action - CRITICAL: When loading next step with 'C', ensure entire file is read - YOU ARE A FACILITATOR, not a content generator +- ✅ YOU MUST ALWAYS SPEAK OUTPUT In your Agent communication style with the config `{communication_language}` ### Role Reinforcement: diff --git a/src/modules/bmgd/workflows/2-design/gdd/steps/step-10-art-audio.md b/src/modules/bmgd/workflows/2-design/gdd/steps/step-10-art-audio.md index e785c104..8ac6b3c5 100644 --- a/src/modules/bmgd/workflows/2-design/gdd/steps/step-10-art-audio.md +++ b/src/modules/bmgd/workflows/2-design/gdd/steps/step-10-art-audio.md @@ -6,13 +6,13 @@ description: 'Define art style and audio direction' workflow_path: '{project-root}/_bmad/bmgd/workflows/2-design/gdd' # File References -thisStepFile: '{workflow_path}/steps/step-10-art-audio.md' -nextStepFile: '{workflow_path}/steps/step-11-technical.md' +thisStepFile: './step-10-art-audio.md' +nextStepFile: './step-11-technical.md' workflowFile: '{workflow_path}/workflow.md' outputFile: '{output_folder}/gdd.md' # Task References -advancedElicitationTask: '{project-root}/_bmad/core/tasks/advanced-elicitation.xml' +advancedElicitationTask: '{project-root}/_bmad/core/workflows/advanced-elicitation/workflow.xml' partyModeWorkflow: '{project-root}/_bmad/core/workflows/party-mode/workflow.md' --- @@ -32,6 +32,7 @@ Define the visual art style and audio/music direction for the game, establishing - CRITICAL: Read the complete step file before taking any action - CRITICAL: When loading next step with 'C', ensure entire file is read - YOU ARE A FACILITATOR, not a content generator +- ✅ YOU MUST ALWAYS SPEAK OUTPUT In your Agent communication style with the config `{communication_language}` ### Role Reinforcement: diff --git a/src/modules/bmgd/workflows/2-design/gdd/steps/step-11-technical.md b/src/modules/bmgd/workflows/2-design/gdd/steps/step-11-technical.md index 52e1875f..e60fcce2 100644 --- a/src/modules/bmgd/workflows/2-design/gdd/steps/step-11-technical.md +++ b/src/modules/bmgd/workflows/2-design/gdd/steps/step-11-technical.md @@ -6,13 +6,13 @@ description: 'Define technical specifications and requirements' workflow_path: '{project-root}/_bmad/bmgd/workflows/2-design/gdd' # File References -thisStepFile: '{workflow_path}/steps/step-11-technical.md' -nextStepFile: '{workflow_path}/steps/step-12-epics.md' +thisStepFile: './step-11-technical.md' +nextStepFile: './step-12-epics.md' workflowFile: '{workflow_path}/workflow.md' outputFile: '{output_folder}/gdd.md' # Task References -advancedElicitationTask: '{project-root}/_bmad/core/tasks/advanced-elicitation.xml' +advancedElicitationTask: '{project-root}/_bmad/core/workflows/advanced-elicitation/workflow.xml' partyModeWorkflow: '{project-root}/_bmad/core/workflows/party-mode/workflow.md' --- @@ -32,6 +32,7 @@ Define technical requirements including performance targets, platform-specific d - CRITICAL: Read the complete step file before taking any action - CRITICAL: When loading next step with 'C', ensure entire file is read - YOU ARE A FACILITATOR, not a content generator +- ✅ YOU MUST ALWAYS SPEAK OUTPUT In your Agent communication style with the config `{communication_language}` ### Role Reinforcement: diff --git a/src/modules/bmgd/workflows/2-design/gdd/steps/step-12-epics.md b/src/modules/bmgd/workflows/2-design/gdd/steps/step-12-epics.md index e04a93b0..dff49301 100644 --- a/src/modules/bmgd/workflows/2-design/gdd/steps/step-12-epics.md +++ b/src/modules/bmgd/workflows/2-design/gdd/steps/step-12-epics.md @@ -6,14 +6,14 @@ description: 'Define development epics and high-level story breakdown' workflow_path: '{project-root}/_bmad/bmgd/workflows/2-design/gdd' # File References -thisStepFile: '{workflow_path}/steps/step-12-epics.md' -nextStepFile: '{workflow_path}/steps/step-13-metrics.md' +thisStepFile: './step-12-epics.md' +nextStepFile: './step-13-metrics.md' workflowFile: '{workflow_path}/workflow.md' outputFile: '{output_folder}/gdd.md' epicsOutputFile: '{output_folder}/epics.md' # Task References -advancedElicitationTask: '{project-root}/_bmad/core/tasks/advanced-elicitation.xml' +advancedElicitationTask: '{project-root}/_bmad/core/workflows/advanced-elicitation/workflow.xml' partyModeWorkflow: '{project-root}/_bmad/core/workflows/party-mode/workflow.md' --- @@ -33,6 +33,7 @@ Translate the game features defined throughout the GDD into development epics, e - CRITICAL: Read the complete step file before taking any action - CRITICAL: When loading next step with 'C', ensure entire file is read - YOU ARE A FACILITATOR, not a content generator +- ✅ YOU MUST ALWAYS SPEAK OUTPUT In your Agent communication style with the config `{communication_language}` ### Role Reinforcement: diff --git a/src/modules/bmgd/workflows/2-design/gdd/steps/step-13-metrics.md b/src/modules/bmgd/workflows/2-design/gdd/steps/step-13-metrics.md index c69c8048..d2360f77 100644 --- a/src/modules/bmgd/workflows/2-design/gdd/steps/step-13-metrics.md +++ b/src/modules/bmgd/workflows/2-design/gdd/steps/step-13-metrics.md @@ -6,13 +6,13 @@ description: 'Define success metrics for technical and gameplay evaluation' workflow_path: '{project-root}/_bmad/bmgd/workflows/2-design/gdd' # File References -thisStepFile: '{workflow_path}/steps/step-13-metrics.md' -nextStepFile: '{workflow_path}/steps/step-14-complete.md' +thisStepFile: './step-13-metrics.md' +nextStepFile: './step-14-complete.md' workflowFile: '{workflow_path}/workflow.md' outputFile: '{output_folder}/gdd.md' # Task References -advancedElicitationTask: '{project-root}/_bmad/core/tasks/advanced-elicitation.xml' +advancedElicitationTask: '{project-root}/_bmad/core/workflows/advanced-elicitation/workflow.xml' partyModeWorkflow: '{project-root}/_bmad/core/workflows/party-mode/workflow.md' --- @@ -32,6 +32,7 @@ Define measurable success metrics for both technical performance and gameplay qu - CRITICAL: Read the complete step file before taking any action - CRITICAL: When loading next step with 'C', ensure entire file is read - YOU ARE A FACILITATOR, not a content generator +- ✅ YOU MUST ALWAYS SPEAK OUTPUT In your Agent communication style with the config `{communication_language}` ### Role Reinforcement: diff --git a/src/modules/bmgd/workflows/2-design/gdd/steps/step-14-complete.md b/src/modules/bmgd/workflows/2-design/gdd/steps/step-14-complete.md index 65c1d576..cafa778d 100644 --- a/src/modules/bmgd/workflows/2-design/gdd/steps/step-14-complete.md +++ b/src/modules/bmgd/workflows/2-design/gdd/steps/step-14-complete.md @@ -6,7 +6,7 @@ description: 'Document out of scope items, capture assumptions, and provide hand workflow_path: '{project-root}/_bmad/bmgd/workflows/2-design/gdd' # File References -thisStepFile: '{workflow_path}/steps/step-14-complete.md' +thisStepFile: './step-14-complete.md' workflowFile: '{workflow_path}/workflow.md' outputFile: '{output_folder}/gdd.md' epicsFile: '{output_folder}/epics.md' @@ -31,6 +31,7 @@ Document what is explicitly out of scope, capture key assumptions and dependenci - NEVER generate content without user input - CRITICAL: Read the complete step file before taking any action - YOU ARE A FACILITATOR, not a content generator +- ✅ YOU MUST ALWAYS SPEAK OUTPUT In your Agent communication style with the config `{communication_language}` ### Role Reinforcement: diff --git a/src/modules/bmgd/workflows/2-design/narrative/instructions-narrative.md b/src/modules/bmgd/workflows/2-design/narrative/instructions-narrative.md index d47263ea..213a922e 100644 --- a/src/modules/bmgd/workflows/2-design/narrative/instructions-narrative.md +++ b/src/modules/bmgd/workflows/2-design/narrative/instructions-narrative.md @@ -2,7 +2,7 @@ -The workflow execution engine is governed by: {project_root}/_bmad/core/tasks/workflow.xml +The workflow execution engine is governed by: {project-root}/_bmad/core/tasks/workflow.xml You MUST have already completed the GDD workflow Communicate all responses in {communication_language} This workflow creates detailed narrative content for story-driven games diff --git a/src/modules/bmgd/workflows/2-design/narrative/steps/step-01-init.md b/src/modules/bmgd/workflows/2-design/narrative/steps/step-01-init.md index 269cb176..aa3dfc7b 100644 --- a/src/modules/bmgd/workflows/2-design/narrative/steps/step-01-init.md +++ b/src/modules/bmgd/workflows/2-design/narrative/steps/step-01-init.md @@ -6,9 +6,9 @@ description: 'Initialize narrative workflow, load GDD context, and assess narrat workflow_path: '{project-root}/_bmad/bmgd/workflows/2-design/narrative' # File References -thisStepFile: '{workflow_path}/steps/step-01-init.md' -continueStepFile: '{workflow_path}/steps/step-01b-continue.md' -nextStepFile: '{workflow_path}/steps/step-02-foundation.md' +thisStepFile: './step-01-init.md' +continueStepFile: './step-01b-continue.md' +nextStepFile: './step-02-foundation.md' workflowFile: '{workflow_path}/workflow.md' outputFile: '{output_folder}/narrative-design.md' templateFile: '{workflow_path}/templates/narrative-template.md' @@ -31,6 +31,7 @@ Validate workflow readiness, check for existing narrative document, load GDD con - CRITICAL: When loading next step with 'C', ensure entire file is read - YOU ARE A FACILITATOR, not a content generator - NEVER mention time estimates +- ✅ YOU MUST ALWAYS SPEAK OUTPUT In your Agent communication style with the config `{communication_language}` ### Role Reinforcement: diff --git a/src/modules/bmgd/workflows/2-design/narrative/steps/step-01b-continue.md b/src/modules/bmgd/workflows/2-design/narrative/steps/step-01b-continue.md index c62b8d21..28558abe 100644 --- a/src/modules/bmgd/workflows/2-design/narrative/steps/step-01b-continue.md +++ b/src/modules/bmgd/workflows/2-design/narrative/steps/step-01b-continue.md @@ -6,21 +6,21 @@ description: 'Continue an existing narrative workflow from where it left off' workflow_path: '{project-root}/_bmad/bmgd/workflows/2-design/narrative' # File References -thisStepFile: '{workflow_path}/steps/step-01b-continue.md' +thisStepFile: './step-01b-continue.md' workflowFile: '{workflow_path}/workflow.md' outputFile: '{output_folder}/narrative-design.md' # Step Files (for routing) -step02: '{workflow_path}/steps/step-02-foundation.md' -step03: '{workflow_path}/steps/step-03-story.md' -step04: '{workflow_path}/steps/step-04-characters.md' -step05: '{workflow_path}/steps/step-05-world.md' -step06: '{workflow_path}/steps/step-06-dialogue.md' -step07: '{workflow_path}/steps/step-07-environmental.md' -step08: '{workflow_path}/steps/step-08-delivery.md' -step09: '{workflow_path}/steps/step-09-integration.md' -step10: '{workflow_path}/steps/step-10-production.md' -step11: '{workflow_path}/steps/step-11-complete.md' +step02: './step-02-foundation.md' +step03: './step-03-story.md' +step04: './step-04-characters.md' +step05: './step-05-world.md' +step06: './step-06-dialogue.md' +step07: './step-07-environmental.md' +step08: './step-08-delivery.md' +step09: './step-09-integration.md' +step10: './step-10-production.md' +step11: './step-11-complete.md' --- # Step 1b: Continue Existing Narrative @@ -39,6 +39,7 @@ Load the existing narrative document, determine progress, and route to the appro - CRITICAL: Read the complete step file before taking any action - YOU ARE A FACILITATOR, not a content generator - NEVER mention time estimates +- ✅ YOU MUST ALWAYS SPEAK OUTPUT In your Agent communication style with the config `{communication_language}` ### Step-Specific Rules: diff --git a/src/modules/bmgd/workflows/2-design/narrative/steps/step-02-foundation.md b/src/modules/bmgd/workflows/2-design/narrative/steps/step-02-foundation.md index 3ce59ebc..509cdcad 100644 --- a/src/modules/bmgd/workflows/2-design/narrative/steps/step-02-foundation.md +++ b/src/modules/bmgd/workflows/2-design/narrative/steps/step-02-foundation.md @@ -6,13 +6,13 @@ description: 'Define narrative premise, themes, tone, and story structure' workflow_path: '{project-root}/_bmad/bmgd/workflows/2-design/narrative' # File References -thisStepFile: '{workflow_path}/steps/step-02-foundation.md' -nextStepFile: '{workflow_path}/steps/step-03-story.md' +thisStepFile: './step-02-foundation.md' +nextStepFile: './step-03-story.md' workflowFile: '{workflow_path}/workflow.md' outputFile: '{output_folder}/narrative-design.md' # Task References -advancedElicitationTask: '{project-root}/_bmad/core/tasks/advanced-elicitation.xml' +advancedElicitationTask: '{project-root}/_bmad/core/workflows/advanced-elicitation/workflow.xml' partyModeWorkflow: '{project-root}/_bmad/core/workflows/party-mode/workflow.md' --- @@ -32,6 +32,7 @@ Define the narrative foundation: premise, themes, tone/atmosphere, and overall s - CRITICAL: Read the complete step file before taking any action - CRITICAL: When loading next step with 'C', ensure entire file is read - YOU ARE A FACILITATOR, not a content generator +- ✅ YOU MUST ALWAYS SPEAK OUTPUT In your Agent communication style with the config `{communication_language}` - NEVER mention time estimates ### Role Reinforcement: diff --git a/src/modules/bmgd/workflows/2-design/narrative/steps/step-03-story.md b/src/modules/bmgd/workflows/2-design/narrative/steps/step-03-story.md index 5f98befa..5f633e7e 100644 --- a/src/modules/bmgd/workflows/2-design/narrative/steps/step-03-story.md +++ b/src/modules/bmgd/workflows/2-design/narrative/steps/step-03-story.md @@ -6,13 +6,13 @@ description: 'Define major story beats and narrative pacing' workflow_path: '{project-root}/_bmad/bmgd/workflows/2-design/narrative' # File References -thisStepFile: '{workflow_path}/steps/step-03-story.md' -nextStepFile: '{workflow_path}/steps/step-04-characters.md' +thisStepFile: './step-03-story.md' +nextStepFile: './step-04-characters.md' workflowFile: '{workflow_path}/workflow.md' outputFile: '{output_folder}/narrative-design.md' # Task References -advancedElicitationTask: '{project-root}/_bmad/core/tasks/advanced-elicitation.xml' +advancedElicitationTask: '{project-root}/_bmad/core/workflows/advanced-elicitation/workflow.xml' partyModeWorkflow: '{project-root}/_bmad/core/workflows/party-mode/workflow.md' --- @@ -33,6 +33,7 @@ Define the major story beats (key narrative moments) and establish pacing and fl - CRITICAL: When loading next step with 'C', ensure entire file is read - YOU ARE A FACILITATOR, not a content generator - NEVER mention time estimates +- ✅ YOU MUST ALWAYS SPEAK OUTPUT In your Agent communication style with the config `{communication_language}` ### Role Reinforcement: diff --git a/src/modules/bmgd/workflows/2-design/narrative/steps/step-04-characters.md b/src/modules/bmgd/workflows/2-design/narrative/steps/step-04-characters.md index 147ad027..e03f6815 100644 --- a/src/modules/bmgd/workflows/2-design/narrative/steps/step-04-characters.md +++ b/src/modules/bmgd/workflows/2-design/narrative/steps/step-04-characters.md @@ -6,13 +6,13 @@ description: 'Develop all characters including protagonists, antagonists, suppor workflow_path: '{project-root}/_bmad/bmgd/workflows/2-design/narrative' # File References -thisStepFile: '{workflow_path}/steps/step-04-characters.md' -nextStepFile: '{workflow_path}/steps/step-05-world.md' +thisStepFile: './step-04-characters.md' +nextStepFile: './step-05-world.md' workflowFile: '{workflow_path}/workflow.md' outputFile: '{output_folder}/narrative-design.md' # Task References -advancedElicitationTask: '{project-root}/_bmad/core/tasks/advanced-elicitation.xml' +advancedElicitationTask: '{project-root}/_bmad/core/workflows/advanced-elicitation/workflow.xml' partyModeWorkflow: '{project-root}/_bmad/core/workflows/party-mode/workflow.md' --- @@ -33,6 +33,7 @@ Develop all characters: protagonists, antagonists, and supporting cast. Define t - CRITICAL: When loading next step with 'C', ensure entire file is read - YOU ARE A FACILITATOR, not a content generator - NEVER mention time estimates +- ✅ YOU MUST ALWAYS SPEAK OUTPUT In your Agent communication style with the config `{communication_language}` ### Role Reinforcement: diff --git a/src/modules/bmgd/workflows/2-design/narrative/steps/step-05-world.md b/src/modules/bmgd/workflows/2-design/narrative/steps/step-05-world.md index 15f8313d..a77a6bc7 100644 --- a/src/modules/bmgd/workflows/2-design/narrative/steps/step-05-world.md +++ b/src/modules/bmgd/workflows/2-design/narrative/steps/step-05-world.md @@ -6,13 +6,13 @@ description: 'Build the world including setting, history, factions, and key loca workflow_path: '{project-root}/_bmad/bmgd/workflows/2-design/narrative' # File References -thisStepFile: '{workflow_path}/steps/step-05-world.md' -nextStepFile: '{workflow_path}/steps/step-06-dialogue.md' +thisStepFile: './step-05-world.md' +nextStepFile: './step-06-dialogue.md' workflowFile: '{workflow_path}/workflow.md' outputFile: '{output_folder}/narrative-design.md' # Task References -advancedElicitationTask: '{project-root}/_bmad/core/tasks/advanced-elicitation.xml' +advancedElicitationTask: '{project-root}/_bmad/core/workflows/advanced-elicitation/workflow.xml' partyModeWorkflow: '{project-root}/_bmad/core/workflows/party-mode/workflow.md' --- @@ -33,6 +33,7 @@ Build the game's world including setting, history/backstory, factions/organizati - CRITICAL: When loading next step with 'C', ensure entire file is read - YOU ARE A FACILITATOR, not a content generator - NEVER mention time estimates +- ✅ YOU MUST ALWAYS SPEAK OUTPUT In your Agent communication style with the config `{communication_language}` ### Role Reinforcement: diff --git a/src/modules/bmgd/workflows/2-design/narrative/steps/step-06-dialogue.md b/src/modules/bmgd/workflows/2-design/narrative/steps/step-06-dialogue.md index a7923dd7..70a79015 100644 --- a/src/modules/bmgd/workflows/2-design/narrative/steps/step-06-dialogue.md +++ b/src/modules/bmgd/workflows/2-design/narrative/steps/step-06-dialogue.md @@ -6,13 +6,13 @@ description: 'Define dialogue style, key conversations, and branching systems' workflow_path: '{project-root}/_bmad/bmgd/workflows/2-design/narrative' # File References -thisStepFile: '{workflow_path}/steps/step-06-dialogue.md' -nextStepFile: '{workflow_path}/steps/step-07-environmental.md' +thisStepFile: './step-06-dialogue.md' +nextStepFile: './step-07-environmental.md' workflowFile: '{workflow_path}/workflow.md' outputFile: '{output_folder}/narrative-design.md' # Task References -advancedElicitationTask: '{project-root}/_bmad/core/tasks/advanced-elicitation.xml' +advancedElicitationTask: '{project-root}/_bmad/core/workflows/advanced-elicitation/workflow.xml' partyModeWorkflow: '{project-root}/_bmad/core/workflows/party-mode/workflow.md' --- @@ -33,6 +33,7 @@ Define dialogue style, key conversations, and branching dialogue systems if appl - CRITICAL: When loading next step with 'C', ensure entire file is read - YOU ARE A FACILITATOR, not a content generator - NEVER mention time estimates +- ✅ YOU MUST ALWAYS SPEAK OUTPUT In your Agent communication style with the config `{communication_language}` ### Role Reinforcement: diff --git a/src/modules/bmgd/workflows/2-design/narrative/steps/step-07-environmental.md b/src/modules/bmgd/workflows/2-design/narrative/steps/step-07-environmental.md index 77ad17de..05f37827 100644 --- a/src/modules/bmgd/workflows/2-design/narrative/steps/step-07-environmental.md +++ b/src/modules/bmgd/workflows/2-design/narrative/steps/step-07-environmental.md @@ -6,13 +6,13 @@ description: 'Plan environmental storytelling including visual, audio, and found workflow_path: '{project-root}/_bmad/bmgd/workflows/2-design/narrative' # File References -thisStepFile: '{workflow_path}/steps/step-07-environmental.md' -nextStepFile: '{workflow_path}/steps/step-08-delivery.md' +thisStepFile: './step-07-environmental.md' +nextStepFile: './step-08-delivery.md' workflowFile: '{workflow_path}/workflow.md' outputFile: '{output_folder}/narrative-design.md' # Task References -advancedElicitationTask: '{project-root}/_bmad/core/tasks/advanced-elicitation.xml' +advancedElicitationTask: '{project-root}/_bmad/core/workflows/advanced-elicitation/workflow.xml' partyModeWorkflow: '{project-root}/_bmad/core/workflows/party-mode/workflow.md' --- @@ -33,6 +33,7 @@ Define how story is told through the environment: visual storytelling, audio sto - CRITICAL: When loading next step with 'C', ensure entire file is read - YOU ARE A FACILITATOR, not a content generator - NEVER mention time estimates +- ✅ YOU MUST ALWAYS SPEAK OUTPUT In your Agent communication style with the config `{communication_language}` ### Role Reinforcement: diff --git a/src/modules/bmgd/workflows/2-design/narrative/steps/step-08-delivery.md b/src/modules/bmgd/workflows/2-design/narrative/steps/step-08-delivery.md index 92950ebb..2e76b208 100644 --- a/src/modules/bmgd/workflows/2-design/narrative/steps/step-08-delivery.md +++ b/src/modules/bmgd/workflows/2-design/narrative/steps/step-08-delivery.md @@ -6,13 +6,13 @@ description: 'Design narrative delivery methods including cutscenes, in-game sto workflow_path: '{project-root}/_bmad/bmgd/workflows/2-design/narrative' # File References -thisStepFile: '{workflow_path}/steps/step-08-delivery.md' -nextStepFile: '{workflow_path}/steps/step-09-integration.md' +thisStepFile: './step-08-delivery.md' +nextStepFile: './step-09-integration.md' workflowFile: '{workflow_path}/workflow.md' outputFile: '{output_folder}/narrative-design.md' # Task References -advancedElicitationTask: '{project-root}/_bmad/core/tasks/advanced-elicitation.xml' +advancedElicitationTask: '{project-root}/_bmad/core/workflows/advanced-elicitation/workflow.xml' partyModeWorkflow: '{project-root}/_bmad/core/workflows/party-mode/workflow.md' --- @@ -33,6 +33,7 @@ Define how narrative content is delivered to players: cutscenes, in-game storyte - CRITICAL: When loading next step with 'C', ensure entire file is read - YOU ARE A FACILITATOR, not a content generator - NEVER mention time estimates +- ✅ YOU MUST ALWAYS SPEAK OUTPUT In your Agent communication style with the config `{communication_language}` ### Role Reinforcement: diff --git a/src/modules/bmgd/workflows/2-design/narrative/steps/step-09-integration.md b/src/modules/bmgd/workflows/2-design/narrative/steps/step-09-integration.md index 35ebb0a0..460eac73 100644 --- a/src/modules/bmgd/workflows/2-design/narrative/steps/step-09-integration.md +++ b/src/modules/bmgd/workflows/2-design/narrative/steps/step-09-integration.md @@ -6,13 +6,13 @@ description: 'Define how narrative integrates with gameplay including gating, ag workflow_path: '{project-root}/_bmad/bmgd/workflows/2-design/narrative' # File References -thisStepFile: '{workflow_path}/steps/step-09-integration.md' -nextStepFile: '{workflow_path}/steps/step-10-production.md' +thisStepFile: './step-09-integration.md' +nextStepFile: './step-10-production.md' workflowFile: '{workflow_path}/workflow.md' outputFile: '{output_folder}/narrative-design.md' # Task References -advancedElicitationTask: '{project-root}/_bmad/core/tasks/advanced-elicitation.xml' +advancedElicitationTask: '{project-root}/_bmad/core/workflows/advanced-elicitation/workflow.xml' partyModeWorkflow: '{project-root}/_bmad/core/workflows/party-mode/workflow.md' --- @@ -33,6 +33,7 @@ Define how narrative integrates with gameplay: story-gameplay connection, progre - CRITICAL: When loading next step with 'C', ensure entire file is read - YOU ARE A FACILITATOR, not a content generator - NEVER mention time estimates +- ✅ YOU MUST ALWAYS SPEAK OUTPUT In your Agent communication style with the config `{communication_language}` ### Role Reinforcement: diff --git a/src/modules/bmgd/workflows/2-design/narrative/steps/step-10-production.md b/src/modules/bmgd/workflows/2-design/narrative/steps/step-10-production.md index b0fbdb7b..f262956d 100644 --- a/src/modules/bmgd/workflows/2-design/narrative/steps/step-10-production.md +++ b/src/modules/bmgd/workflows/2-design/narrative/steps/step-10-production.md @@ -6,13 +6,13 @@ description: 'Plan production scope including writing estimates, localization, a workflow_path: '{project-root}/_bmad/bmgd/workflows/2-design/narrative' # File References -thisStepFile: '{workflow_path}/steps/step-10-production.md' -nextStepFile: '{workflow_path}/steps/step-11-complete.md' +thisStepFile: './step-10-production.md' +nextStepFile: './step-11-complete.md' workflowFile: '{workflow_path}/workflow.md' outputFile: '{output_folder}/narrative-design.md' # Task References -advancedElicitationTask: '{project-root}/_bmad/core/tasks/advanced-elicitation.xml' +advancedElicitationTask: '{project-root}/_bmad/core/workflows/advanced-elicitation/workflow.xml' partyModeWorkflow: '{project-root}/_bmad/core/workflows/party-mode/workflow.md' --- @@ -33,6 +33,7 @@ Plan the production scope for narrative content: writing scope estimates, locali - CRITICAL: When loading next step with 'C', ensure entire file is read - YOU ARE A FACILITATOR, not a content generator - NEVER mention time estimates +- ✅ YOU MUST ALWAYS SPEAK OUTPUT In your Agent communication style with the config `{communication_language}` ### Role Reinforcement: diff --git a/src/modules/bmgd/workflows/2-design/narrative/steps/step-11-complete.md b/src/modules/bmgd/workflows/2-design/narrative/steps/step-11-complete.md index 9df3351f..a6bd67c9 100644 --- a/src/modules/bmgd/workflows/2-design/narrative/steps/step-11-complete.md +++ b/src/modules/bmgd/workflows/2-design/narrative/steps/step-11-complete.md @@ -6,7 +6,7 @@ description: 'Complete the narrative workflow with final summary, visualizations workflow_path: '{project-root}/_bmad/bmgd/workflows/2-design/narrative' # File References -thisStepFile: '{workflow_path}/steps/step-11-complete.md' +thisStepFile: './step-11-complete.md' workflowFile: '{workflow_path}/workflow.md' outputFile: '{output_folder}/narrative-design.md' @@ -30,6 +30,7 @@ Generate final visualizations (character relationships, timeline), capture refer - CRITICAL: Read the complete step file before taking any action - YOU ARE A FACILITATOR, not a content generator - NEVER mention time estimates +- ✅ YOU MUST ALWAYS SPEAK OUTPUT In your Agent communication style with the config `{communication_language}` ### Role Reinforcement: diff --git a/src/modules/bmgd/workflows/2-design/narrative/workflow.md b/src/modules/bmgd/workflows/2-design/narrative/workflow.md index 81ff1a86..2757c351 100644 --- a/src/modules/bmgd/workflows/2-design/narrative/workflow.md +++ b/src/modules/bmgd/workflows/2-design/narrative/workflow.md @@ -36,7 +36,7 @@ stepsCompleted: [1, 2, 3, ...] # Array of completed step numbers To begin, load and execute step-01-init.md: ``` -{workflow_path}/steps/step-01-init.md +./step-01-init.md ``` ## Critical Rules @@ -46,6 +46,7 @@ To begin, load and execute step-01-init.md: - **NEVER** mention time estimates - **ALWAYS** present options and wait for user selection - **FOLLOW** the step sequence exactly - no skipping or optimizing +- ✅ YOU MUST ALWAYS SPEAK OUTPUT In your Agent communication style with the config `{communication_language}` ## Agent Role diff --git a/src/modules/bmgd/workflows/3-technical/game-architecture/instructions.md b/src/modules/bmgd/workflows/3-technical/game-architecture/instructions.md index e59e7c69..ad41d0b4 100644 --- a/src/modules/bmgd/workflows/3-technical/game-architecture/instructions.md +++ b/src/modules/bmgd/workflows/3-technical/game-architecture/instructions.md @@ -659,7 +659,7 @@ Enforcement: "All agents MUST follow this pattern" -Save document to {output_folder}/architecture.md +Save document to {planning_artifacts}/architecture.md Load the FULL file: {output_folder}/bmgd-workflow-status.yaml diff --git a/src/modules/bmgd/workflows/3-technical/game-architecture/steps/step-01-init.md b/src/modules/bmgd/workflows/3-technical/game-architecture/steps/step-01-init.md index bb045387..36448a27 100644 --- a/src/modules/bmgd/workflows/3-technical/game-architecture/steps/step-01-init.md +++ b/src/modules/bmgd/workflows/3-technical/game-architecture/steps/step-01-init.md @@ -6,9 +6,9 @@ description: 'Initialize the architecture workflow, validate readiness, and disc workflow_path: '{project-root}/_bmad/bmgd/workflows/3-technical/game-architecture' # File References -thisStepFile: '{workflow_path}/steps/step-01-init.md' -continueStepFile: '{workflow_path}/steps/step-01b-continue.md' -nextStepFile: '{workflow_path}/steps/step-02-context.md' +thisStepFile: './step-01-init.md' +continueStepFile: './step-01b-continue.md' +nextStepFile: './step-02-context.md' workflowFile: '{workflow_path}/workflow.md' outputFile: '{output_folder}/game-architecture.md' templateFile: '{workflow_path}/templates/architecture-template.md' @@ -36,6 +36,7 @@ Validate workflow readiness, check for existing architecture work, discover inpu - CRITICAL: When loading next step with 'C', ensure entire file is read - YOU ARE A FACILITATOR, not a content generator - NEVER mention time estimates +- ✅ YOU MUST ALWAYS SPEAK OUTPUT In your Agent communication style with the config `{communication_language}` ### Role Reinforcement: diff --git a/src/modules/bmgd/workflows/3-technical/game-architecture/steps/step-01b-continue.md b/src/modules/bmgd/workflows/3-technical/game-architecture/steps/step-01b-continue.md index a32e0d96..4ac31018 100644 --- a/src/modules/bmgd/workflows/3-technical/game-architecture/steps/step-01b-continue.md +++ b/src/modules/bmgd/workflows/3-technical/game-architecture/steps/step-01b-continue.md @@ -6,19 +6,19 @@ description: 'Continue an existing architecture workflow from where it left off' workflow_path: '{project-root}/_bmad/bmgd/workflows/3-technical/game-architecture' # File References -thisStepFile: '{workflow_path}/steps/step-01b-continue.md' +thisStepFile: './step-01b-continue.md' workflowFile: '{workflow_path}/workflow.md' outputFile: '{output_folder}/game-architecture.md' # Step Files (for routing) -step02: '{workflow_path}/steps/step-02-context.md' -step03: '{workflow_path}/steps/step-03-starter.md' -step04: '{workflow_path}/steps/step-04-decisions.md' -step05: '{workflow_path}/steps/step-05-crosscutting.md' -step06: '{workflow_path}/steps/step-06-structure.md' -step07: '{workflow_path}/steps/step-07-patterns.md' -step08: '{workflow_path}/steps/step-08-validation.md' -step09: '{workflow_path}/steps/step-09-complete.md' +step02: './step-02-context.md' +step03: './step-03-starter.md' +step04: './step-04-decisions.md' +step05: './step-05-crosscutting.md' +step06: './step-06-structure.md' +step07: './step-07-patterns.md' +step08: './step-08-validation.md' +step09: './step-09-complete.md' --- # Step 1b: Continue Existing Architecture @@ -37,6 +37,7 @@ Load the existing architecture document, determine progress, and route to the ap - CRITICAL: Read the complete step file before taking any action - YOU ARE A FACILITATOR, not a content generator - NEVER mention time estimates +- ✅ YOU MUST ALWAYS SPEAK OUTPUT In your Agent communication style with the config `{communication_language}` ### Step-Specific Rules: diff --git a/src/modules/bmgd/workflows/3-technical/game-architecture/steps/step-02-context.md b/src/modules/bmgd/workflows/3-technical/game-architecture/steps/step-02-context.md index 27b15f13..7c83a111 100644 --- a/src/modules/bmgd/workflows/3-technical/game-architecture/steps/step-02-context.md +++ b/src/modules/bmgd/workflows/3-technical/game-architecture/steps/step-02-context.md @@ -6,13 +6,13 @@ description: 'Load and understand project context from GDD and supporting docume workflow_path: '{project-root}/_bmad/bmgd/workflows/3-technical/game-architecture' # File References -thisStepFile: '{workflow_path}/steps/step-02-context.md' -nextStepFile: '{workflow_path}/steps/step-03-starter.md' +thisStepFile: './step-02-context.md' +nextStepFile: './step-03-starter.md' workflowFile: '{workflow_path}/workflow.md' outputFile: '{output_folder}/game-architecture.md' # Task References -advancedElicitationTask: '{project-root}/_bmad/core/tasks/advanced-elicitation.xml' +advancedElicitationTask: '{project-root}/_bmad/core/workflows/advanced-elicitation/workflow.xml' partyModeWorkflow: '{project-root}/_bmad/core/workflows/party-mode/workflow.md' --- @@ -33,6 +33,7 @@ Load and analyze the GDD and supporting documents to understand the game's techn - CRITICAL: When loading next step with 'C', ensure entire file is read - YOU ARE A FACILITATOR, not a content generator - NEVER mention time estimates +- ✅ YOU MUST ALWAYS SPEAK OUTPUT In your Agent communication style with the config `{communication_language}` ### Role Reinforcement: diff --git a/src/modules/bmgd/workflows/3-technical/game-architecture/steps/step-03-starter.md b/src/modules/bmgd/workflows/3-technical/game-architecture/steps/step-03-starter.md index b628cbcf..bc55778b 100644 --- a/src/modules/bmgd/workflows/3-technical/game-architecture/steps/step-03-starter.md +++ b/src/modules/bmgd/workflows/3-technical/game-architecture/steps/step-03-starter.md @@ -6,13 +6,13 @@ description: 'Discover and evaluate game engine and starter template options' workflow_path: '{project-root}/_bmad/bmgd/workflows/3-technical/game-architecture' # File References -thisStepFile: '{workflow_path}/steps/step-03-starter.md' -nextStepFile: '{workflow_path}/steps/step-04-decisions.md' +thisStepFile: './step-03-starter.md' +nextStepFile: './step-04-decisions.md' workflowFile: '{workflow_path}/workflow.md' outputFile: '{output_folder}/game-architecture.md' # Task References -advancedElicitationTask: '{project-root}/_bmad/core/tasks/advanced-elicitation.xml' +advancedElicitationTask: '{project-root}/_bmad/core/workflows/advanced-elicitation/workflow.xml' partyModeWorkflow: '{project-root}/_bmad/core/workflows/party-mode/workflow.md' --- @@ -33,6 +33,7 @@ Discover and evaluate game engine options and starter templates based on project - CRITICAL: When loading next step with 'C', ensure entire file is read - YOU ARE A FACILITATOR, not a content generator - NEVER mention time estimates +- ✅ YOU MUST ALWAYS SPEAK OUTPUT In your Agent communication style with the config `{communication_language}` ### Role Reinforcement: diff --git a/src/modules/bmgd/workflows/3-technical/game-architecture/steps/step-04-decisions.md b/src/modules/bmgd/workflows/3-technical/game-architecture/steps/step-04-decisions.md index 9bd95652..025e13fa 100644 --- a/src/modules/bmgd/workflows/3-technical/game-architecture/steps/step-04-decisions.md +++ b/src/modules/bmgd/workflows/3-technical/game-architecture/steps/step-04-decisions.md @@ -6,8 +6,8 @@ description: 'Facilitate collaborative architectural decision making for game sy workflow_path: '{project-root}/_bmad/bmgd/workflows/3-technical/game-architecture' # File References -thisStepFile: '{workflow_path}/steps/step-04-decisions.md' -nextStepFile: '{workflow_path}/steps/step-05-crosscutting.md' +thisStepFile: './step-04-decisions.md' +nextStepFile: './step-05-crosscutting.md' workflowFile: '{workflow_path}/workflow.md' outputFile: '{output_folder}/game-architecture.md' @@ -16,7 +16,7 @@ decisionCatalog: '{workflow_path}/decision-catalog.yaml' architecturePatterns: '{workflow_path}/architecture-patterns.yaml' # Task References -advancedElicitationTask: '{project-root}/_bmad/core/tasks/advanced-elicitation.xml' +advancedElicitationTask: '{project-root}/_bmad/core/workflows/advanced-elicitation/workflow.xml' partyModeWorkflow: '{project-root}/_bmad/core/workflows/party-mode/workflow.md' --- @@ -37,6 +37,7 @@ Facilitate collaborative decision-making for all remaining architectural choices - CRITICAL: When loading next step with 'C', ensure entire file is read - YOU ARE A FACILITATOR, not a content generator - NEVER mention time estimates +- ✅ YOU MUST ALWAYS SPEAK OUTPUT In your Agent communication style with the config `{communication_language}` ### Role Reinforcement: diff --git a/src/modules/bmgd/workflows/3-technical/game-architecture/steps/step-05-crosscutting.md b/src/modules/bmgd/workflows/3-technical/game-architecture/steps/step-05-crosscutting.md index 59bc15c7..d195dc0c 100644 --- a/src/modules/bmgd/workflows/3-technical/game-architecture/steps/step-05-crosscutting.md +++ b/src/modules/bmgd/workflows/3-technical/game-architecture/steps/step-05-crosscutting.md @@ -6,13 +6,13 @@ description: 'Address cross-cutting concerns that affect all game systems' workflow_path: '{project-root}/_bmad/bmgd/workflows/3-technical/game-architecture' # File References -thisStepFile: '{workflow_path}/steps/step-05-crosscutting.md' -nextStepFile: '{workflow_path}/steps/step-06-structure.md' +thisStepFile: './step-05-crosscutting.md' +nextStepFile: './step-06-structure.md' workflowFile: '{workflow_path}/workflow.md' outputFile: '{output_folder}/game-architecture.md' # Task References -advancedElicitationTask: '{project-root}/_bmad/core/tasks/advanced-elicitation.xml' +advancedElicitationTask: '{project-root}/_bmad/core/workflows/advanced-elicitation/workflow.xml' partyModeWorkflow: '{project-root}/_bmad/core/workflows/party-mode/workflow.md' --- @@ -33,6 +33,7 @@ Define patterns for concerns that affect EVERY system in the game: error handlin - CRITICAL: When loading next step with 'C', ensure entire file is read - YOU ARE A FACILITATOR, not a content generator - NEVER mention time estimates +- ✅ YOU MUST ALWAYS SPEAK OUTPUT In your Agent communication style with the config `{communication_language}` ### Role Reinforcement: diff --git a/src/modules/bmgd/workflows/3-technical/game-architecture/steps/step-06-structure.md b/src/modules/bmgd/workflows/3-technical/game-architecture/steps/step-06-structure.md index 39bf46cc..698aa6d2 100644 --- a/src/modules/bmgd/workflows/3-technical/game-architecture/steps/step-06-structure.md +++ b/src/modules/bmgd/workflows/3-technical/game-architecture/steps/step-06-structure.md @@ -6,13 +6,13 @@ description: 'Define project structure, directory organization, and architectura workflow_path: '{project-root}/_bmad/bmgd/workflows/3-technical/game-architecture' # File References -thisStepFile: '{workflow_path}/steps/step-06-structure.md' -nextStepFile: '{workflow_path}/steps/step-07-patterns.md' +thisStepFile: './step-06-structure.md' +nextStepFile: './step-07-patterns.md' workflowFile: '{workflow_path}/workflow.md' outputFile: '{output_folder}/game-architecture.md' # Task References -advancedElicitationTask: '{project-root}/_bmad/core/tasks/advanced-elicitation.xml' +advancedElicitationTask: '{project-root}/_bmad/core/workflows/advanced-elicitation/workflow.xml' partyModeWorkflow: '{project-root}/_bmad/core/workflows/party-mode/workflow.md' --- @@ -33,6 +33,7 @@ Define the complete project structure including directory organization, file nam - CRITICAL: When loading next step with 'C', ensure entire file is read - YOU ARE A FACILITATOR, not a content generator - NEVER mention time estimates +- ✅ YOU MUST ALWAYS SPEAK OUTPUT In your Agent communication style with the config `{communication_language}` ### Role Reinforcement: @@ -212,7 +213,7 @@ Based on the conversation, prepare the content: ### System Location Mapping | System | Location | Responsibility | -|--------|----------|----------------| +| ------ | -------- | -------------- | {{system_mapping_table}} ### Naming Conventions @@ -222,7 +223,7 @@ Based on the conversation, prepare the content: #### Code Elements | Element | Convention | Example | -|---------|------------|---------| +| ------- | ---------- | ------- | {{code_naming_table}} #### Game Assets diff --git a/src/modules/bmgd/workflows/3-technical/game-architecture/steps/step-07-patterns.md b/src/modules/bmgd/workflows/3-technical/game-architecture/steps/step-07-patterns.md index db18dac5..31ccc90b 100644 --- a/src/modules/bmgd/workflows/3-technical/game-architecture/steps/step-07-patterns.md +++ b/src/modules/bmgd/workflows/3-technical/game-architecture/steps/step-07-patterns.md @@ -6,8 +6,8 @@ description: 'Design implementation patterns and novel architectural patterns fo workflow_path: '{project-root}/_bmad/bmgd/workflows/3-technical/game-architecture' # File References -thisStepFile: '{workflow_path}/steps/step-07-patterns.md' -nextStepFile: '{workflow_path}/steps/step-08-validation.md' +thisStepFile: './step-07-patterns.md' +nextStepFile: './step-08-validation.md' workflowFile: '{workflow_path}/workflow.md' outputFile: '{output_folder}/game-architecture.md' @@ -15,7 +15,7 @@ outputFile: '{output_folder}/game-architecture.md' patternCategories: '{workflow_path}/pattern-categories.csv' # Task References -advancedElicitationTask: '{project-root}/_bmad/core/tasks/advanced-elicitation.xml' +advancedElicitationTask: '{project-root}/_bmad/core/workflows/advanced-elicitation/workflow.xml' partyModeWorkflow: '{project-root}/_bmad/core/workflows/party-mode/workflow.md' --- @@ -36,6 +36,7 @@ Define implementation patterns that ensure multiple AI agents write compatible, - CRITICAL: When loading next step with 'C', ensure entire file is read - YOU ARE A FACILITATOR, not a content generator - NEVER mention time estimates +- ✅ YOU MUST ALWAYS SPEAK OUTPUT In your Agent communication style with the config `{communication_language}` ### Role Reinforcement: diff --git a/src/modules/bmgd/workflows/3-technical/game-architecture/steps/step-08-validation.md b/src/modules/bmgd/workflows/3-technical/game-architecture/steps/step-08-validation.md index 3762f5cf..c8785a5c 100644 --- a/src/modules/bmgd/workflows/3-technical/game-architecture/steps/step-08-validation.md +++ b/src/modules/bmgd/workflows/3-technical/game-architecture/steps/step-08-validation.md @@ -6,14 +6,14 @@ description: 'Validate architectural coherence and completeness' workflow_path: '{project-root}/_bmad/bmgd/workflows/3-technical/game-architecture' # File References -thisStepFile: '{workflow_path}/steps/step-08-validation.md' -nextStepFile: '{workflow_path}/steps/step-09-complete.md' +thisStepFile: './step-08-validation.md' +nextStepFile: './step-09-complete.md' workflowFile: '{workflow_path}/workflow.md' outputFile: '{output_folder}/game-architecture.md' checklistFile: '{workflow_path}/checklist.md' # Task References -advancedElicitationTask: '{project-root}/_bmad/core/tasks/advanced-elicitation.xml' +advancedElicitationTask: '{project-root}/_bmad/core/workflows/advanced-elicitation/workflow.xml' partyModeWorkflow: '{project-root}/_bmad/core/workflows/party-mode/workflow.md' --- @@ -34,6 +34,7 @@ Validate that the architecture is coherent, complete, and ready to guide AI agen - CRITICAL: When loading next step with 'C', ensure entire file is read - YOU ARE A FACILITATOR, not a content generator - NEVER mention time estimates +- ✅ YOU MUST ALWAYS SPEAK OUTPUT In your Agent communication style with the config `{communication_language}` ### Role Reinforcement: @@ -96,12 +97,12 @@ Verifying every GDD requirement has architectural support: **Core Systems:** | System | Architecture Support | Status | -|--------|---------------------|--------| +| ------ | -------------------- | ------ | {{systems_coverage_table}} **Technical Requirements:** | Requirement | How Addressed | Status | -|-------------|---------------|--------| +| ----------- | ------------- | ------ | {{requirements_coverage_table}} {{if_gaps_found}} diff --git a/src/modules/bmgd/workflows/3-technical/game-architecture/steps/step-09-complete.md b/src/modules/bmgd/workflows/3-technical/game-architecture/steps/step-09-complete.md index 51f022e3..810011c2 100644 --- a/src/modules/bmgd/workflows/3-technical/game-architecture/steps/step-09-complete.md +++ b/src/modules/bmgd/workflows/3-technical/game-architecture/steps/step-09-complete.md @@ -6,7 +6,7 @@ description: 'Complete the architecture workflow with final review and handoff g workflow_path: '{project-root}/_bmad/bmgd/workflows/3-technical/game-architecture' # File References -thisStepFile: '{workflow_path}/steps/step-09-complete.md' +thisStepFile: './step-09-complete.md' workflowFile: '{workflow_path}/workflow.md' outputFile: '{output_folder}/game-architecture.md' @@ -31,6 +31,7 @@ Generate the executive summary, finalize the document, update workflow status, a - CRITICAL: Read the complete step file before taking any action - YOU ARE A FACILITATOR, not a content generator - NEVER mention time estimates +- ✅ YOU MUST ALWAYS SPEAK OUTPUT In your Agent communication style with the config `{communication_language}` ### Role Reinforcement: diff --git a/src/modules/bmgd/workflows/3-technical/game-architecture/workflow.md b/src/modules/bmgd/workflows/3-technical/game-architecture/workflow.md index 2b0f91d9..60a9595e 100644 --- a/src/modules/bmgd/workflows/3-technical/game-architecture/workflow.md +++ b/src/modules/bmgd/workflows/3-technical/game-architecture/workflow.md @@ -34,7 +34,7 @@ stepsCompleted: [1, 2, 3, ...] # Array of completed step numbers To begin, load and execute step-01-init.md: ``` -{workflow_path}/steps/step-01-init.md +./step-01-init.md ``` ## Critical Rules @@ -44,6 +44,7 @@ To begin, load and execute step-01-init.md: - **NEVER** mention time estimates - **ALWAYS** present options and wait for user selection - **FOLLOW** the step sequence exactly - no skipping or optimizing +- ✅ YOU MUST ALWAYS SPEAK OUTPUT In your Agent communication style with the config `{communication_language}` ## Agent Role diff --git a/src/modules/bmgd/workflows/3-technical/generate-project-context/steps/step-01-discover.md b/src/modules/bmgd/workflows/3-technical/generate-project-context/steps/step-01-discover.md index a92db901..ba1a4db5 100644 --- a/src/modules/bmgd/workflows/3-technical/generate-project-context/steps/step-01-discover.md +++ b/src/modules/bmgd/workflows/3-technical/generate-project-context/steps/step-01-discover.md @@ -8,6 +8,7 @@ - FOCUS on discovering existing project context and technology stack - IDENTIFY critical implementation rules that AI agents need - ABSOLUTELY NO TIME ESTIMATES +- ✅ YOU MUST ALWAYS SPEAK OUTPUT In your Agent communication style with the config `{communication_language}` ## EXECUTION PROTOCOLS: @@ -43,7 +44,7 @@ Load and analyze project files to identify technologies: **Architecture Document:** -- Look for `{output_folder}/game-architecture.md` or `{output_folder}/architecture.md` +- Look for `{output_folder}/game-architecture.md` or `{planning_artifacts}/architecture.md` - Extract engine choice with specific version (Unity, Unreal, Godot, custom) - Note architectural decisions that affect implementation diff --git a/src/modules/bmgd/workflows/3-technical/generate-project-context/steps/step-02-generate.md b/src/modules/bmgd/workflows/3-technical/generate-project-context/steps/step-02-generate.md index 90c76f2b..101bcd77 100644 --- a/src/modules/bmgd/workflows/3-technical/generate-project-context/steps/step-02-generate.md +++ b/src/modules/bmgd/workflows/3-technical/generate-project-context/steps/step-02-generate.md @@ -8,6 +8,7 @@ - FOCUS on unobvious rules that AI agents need to be reminded of - KEEP CONTENT LEAN - optimize for LLM context efficiency - ABSOLUTELY NO TIME ESTIMATES +- ✅ YOU MUST ALWAYS SPEAK OUTPUT In your Agent communication style with the config `{communication_language}` ## EXECUTION PROTOCOLS: @@ -28,7 +29,7 @@ This step will generate content and present choices for each rule category: ## PROTOCOL INTEGRATION: -- When 'A' selected: Execute {project-root}/_bmad/core/tasks/advanced-elicitation.xml +- When 'A' selected: Execute {project-root}/_bmad/core/workflows/advanced-elicitation/workflow.xml - When 'P' selected: Execute {project-root}/_bmad/core/workflows/party-mode - PROTOCOLS always return to display this step's A/P/C menu after the A or P have completed - User accepts/rejects protocol changes before proceeding diff --git a/src/modules/bmgd/workflows/3-technical/generate-project-context/steps/step-03-complete.md b/src/modules/bmgd/workflows/3-technical/generate-project-context/steps/step-03-complete.md index e87e1382..76b2ccab 100644 --- a/src/modules/bmgd/workflows/3-technical/generate-project-context/steps/step-03-complete.md +++ b/src/modules/bmgd/workflows/3-technical/generate-project-context/steps/step-03-complete.md @@ -8,6 +8,7 @@ - FOCUS on finalizing a lean, LLM-optimized project context - ENSURE all critical rules are captured and actionable - ABSOLUTELY NO TIME ESTIMATES +- ✅ YOU MUST ALWAYS SPEAK OUTPUT In your Agent communication style with the config `{communication_language}` ## EXECUTION PROTOCOLS: diff --git a/src/modules/bmgd/workflows/3-technical/generate-project-context/workflow.md b/src/modules/bmgd/workflows/3-technical/generate-project-context/workflow.md index 8eb8945c..b1b7ed6f 100644 --- a/src/modules/bmgd/workflows/3-technical/generate-project-context/workflow.md +++ b/src/modules/bmgd/workflows/3-technical/generate-project-context/workflow.md @@ -32,6 +32,7 @@ Load config from `{project-root}/_bmad/bmgd/config.yaml` and resolve: - `project_name`, `output_folder`, `user_name` - `communication_language`, `document_output_language`, `game_dev_experience` - `date` as system-generated current datetime +- ✅ YOU MUST ALWAYS SPEAK OUTPUT In your Agent communication style with the config `{communication_language}` ### Paths diff --git a/src/modules/bmgd/workflows/4-production/code-review/instructions.xml b/src/modules/bmgd/workflows/4-production/code-review/instructions.xml index e57a940d..d639df2b 100644 --- a/src/modules/bmgd/workflows/4-production/code-review/instructions.xml +++ b/src/modules/bmgd/workflows/4-production/code-review/instructions.xml @@ -12,6 +12,7 @@ Read EVERY file in the File List - verify implementation against story requirements Tasks marked complete but not done = CRITICAL finding Acceptance Criteria not implemented = HIGH severity finding + Do not review files that are not part of the application's source code. Always exclude the _bmad/ and _bmad-output/ folders from the review. Always exclude IDE and CLI configuration folders like .cursor/ and .windsurf/ and .claude/ Use provided {{story_path}} or ask user which story file to review diff --git a/src/modules/bmgd/workflows/4-production/code-review/workflow.yaml b/src/modules/bmgd/workflows/4-production/code-review/workflow.yaml index 9ab42a47..25a9382f 100644 --- a/src/modules/bmgd/workflows/4-production/code-review/workflow.yaml +++ b/src/modules/bmgd/workflows/4-production/code-review/workflow.yaml @@ -12,7 +12,7 @@ user_skill_level: "{config_source}:user_skill_level" document_output_language: "{config_source}:document_output_language" date: system-generated implementation_artifacts: "{config_source}:implementation_artifacts" -sprint_status: "{implementation_artifacts}/sprint-status.yaml || {output_folder}/sprint-status.yaml" +sprint_status: "{implementation_artifacts}/sprint-status.yaml" # Workflow components installed_path: "{project-root}/_bmad/bmgd/workflows/4-production/code-review" diff --git a/src/modules/bmgd/workflows/4-production/correct-course/workflow.yaml b/src/modules/bmgd/workflows/4-production/correct-course/workflow.yaml index 0af8a84e..77079c79 100644 --- a/src/modules/bmgd/workflows/4-production/correct-course/workflow.yaml +++ b/src/modules/bmgd/workflows/4-production/correct-course/workflow.yaml @@ -11,7 +11,7 @@ user_skill_level: "{config_source}:user_skill_level" document_output_language: "{config_source}:document_output_language" date: system-generated implementation_artifacts: "{config_source}:implementation_artifacts" -sprint_status: "{implementation_artifacts}/sprint-status.yaml || {output_folder}/sprint-status.yaml" +sprint_status: "{implementation_artifacts}/sprint-status.yaml" # Smart input file references - handles both whole docs and sharded docs # Priority: Whole document first, then sharded version diff --git a/src/modules/bmgd/workflows/4-production/create-story/checklist.md b/src/modules/bmgd/workflows/4-production/create-story/checklist.md index b0f22385..55e6c397 100644 --- a/src/modules/bmgd/workflows/4-production/create-story/checklist.md +++ b/src/modules/bmgd/workflows/4-production/create-story/checklist.md @@ -33,7 +33,7 @@ This is a COMPETITION to create the **ULTIMATE story context** that makes LLM de ### **When Running from Create-Story Workflow:** -- The `{project_root}/_bmad/core/tasks/validate-workflow.xml` framework will automatically: +- The `{project-root}/_bmad/core/tasks/validate-workflow.xml` framework will automatically: - Load this checklist file - Load the newly created story file (`{story_file_path}`) - Load workflow variables from `{installed_path}/workflow.yaml` @@ -63,7 +63,7 @@ You will systematically re-do the entire story creation process, but with a crit 1. **Load the workflow configuration**: `{installed_path}/workflow.yaml` for variable inclusion 2. **Load the story file**: `{story_file_path}` (provided by user or discovered) -3. **Load validation framework**: `{project_root}/_bmad/core/tasks/validate-workflow.xml` +3. **Load validation framework**: `{project-root}/_bmad/core/tasks/validate-workflow.xml` 4. **Extract metadata**: epic_num, story_num, story_key, story_title from story file 5. **Resolve all workflow variables**: story_dir, output_folder, epics_file, architecture_file, etc. 6. **Understand current status**: What story implementation guidance is currently provided? diff --git a/src/modules/bmgd/workflows/4-production/create-story/workflow.yaml b/src/modules/bmgd/workflows/4-production/create-story/workflow.yaml index 6f86649d..508716b3 100644 --- a/src/modules/bmgd/workflows/4-production/create-story/workflow.yaml +++ b/src/modules/bmgd/workflows/4-production/create-story/workflow.yaml @@ -19,10 +19,10 @@ validation: "{installed_path}/checklist.md" # Variables and inputs variables: - sprint_status: "{implementation_artifacts}/sprint-status.yaml || {output_folder}/sprint-status.yaml" # Primary source for story tracking + sprint_status: "{implementation_artifacts}/sprint-status.yaml || {implementation_artifacts}/sprint-status.yaml" # Primary source for story tracking epics_file: "{output_folder}/epics.md" # Preferred source for epic/story breakdown prd_file: "{output_folder}/PRD.md" # Fallback for requirements - architecture_file: "{output_folder}/architecture.md" # Optional architecture context + architecture_file: "{planning_artifacts}/architecture.md" # Optional architecture context tech_spec_file: "" # Will be auto-discovered from docs as tech-spec-epic-{{epic_num}}-*.md tech_spec_search_dir: "{project-root}/docs" tech_spec_glob_template: "tech-spec-epic-{{epic_num}}*.md" diff --git a/src/modules/bmgd/workflows/4-production/dev-story/workflow.yaml b/src/modules/bmgd/workflows/4-production/dev-story/workflow.yaml index dd213876..ea59b392 100644 --- a/src/modules/bmgd/workflows/4-production/dev-story/workflow.yaml +++ b/src/modules/bmgd/workflows/4-production/dev-story/workflow.yaml @@ -16,7 +16,7 @@ story_file: "" # Explicit story path; auto-discovered if empty # Context file uses same story_key as story file (e.g., "1-2-user-authentication.context.xml") context_file: "{story_dir}/{{story_key}}.context.xml" implementation_artifacts: "{config_source}:implementation_artifacts" -sprint_status: "{implementation_artifacts}/sprint-status.yaml || {output_folder}/sprint-status.yaml" +sprint_status: "{implementation_artifacts}/sprint-status.yaml || {implementation_artifacts}/sprint-status.yaml" # Smart input file references - handles both whole docs and sharded docs # Priority: Whole document first, then sharded version diff --git a/src/modules/bmgd/workflows/4-production/retrospective/workflow.yaml b/src/modules/bmgd/workflows/4-production/retrospective/workflow.yaml index 4bbb3000..9ae82b6d 100644 --- a/src/modules/bmgd/workflows/4-production/retrospective/workflow.yaml +++ b/src/modules/bmgd/workflows/4-production/retrospective/workflow.yaml @@ -54,7 +54,7 @@ input_file_patterns: load_strategy: "INDEX_GUIDED" # Required files -sprint_status_file: "{implementation_artifacts}/sprint-status.yaml || {output_folder}/sprint-status.yaml" +sprint_status_file: "{implementation_artifacts}/sprint-status.yaml || {implementation_artifacts}/sprint-status.yaml" story_directory: "{implementation_artifacts}" retrospectives_folder: "{implementation_artifacts}" diff --git a/src/modules/bmgd/workflows/4-production/sprint-status/workflow.yaml b/src/modules/bmgd/workflows/4-production/sprint-status/workflow.yaml index 7824ced7..10694176 100644 --- a/src/modules/bmgd/workflows/4-production/sprint-status/workflow.yaml +++ b/src/modules/bmgd/workflows/4-production/sprint-status/workflow.yaml @@ -18,14 +18,14 @@ instructions: "{installed_path}/instructions.md" # Inputs variables: - sprint_status_file: "{implementation_artifacts}/sprint-status.yaml || {output_folder}/sprint-status.yaml" + sprint_status_file: "{implementation_artifacts}/sprint-status.yaml || {implementation_artifacts}/sprint-status.yaml" tracking_system: "file-system" # Smart input file references input_file_patterns: sprint_status: description: "Sprint status file generated by sprint-planning" - whole: "{implementation_artifacts}/sprint-status.yaml || {output_folder}/sprint-status.yaml" + whole: "{implementation_artifacts}/sprint-status.yaml || {implementation_artifacts}/sprint-status.yaml" load_strategy: "FULL_LOAD" # Standalone so IDE commands get generated diff --git a/src/modules/bmgd/workflows/bmgd-quick-flow/quick-dev/workflow.yaml b/src/modules/bmgd/workflows/bmgd-quick-flow/quick-dev/workflow.yaml index 73a71355..9bceec24 100644 --- a/src/modules/bmgd/workflows/bmgd-quick-flow/quick-dev/workflow.yaml +++ b/src/modules/bmgd/workflows/bmgd-quick-flow/quick-dev/workflow.yaml @@ -23,7 +23,7 @@ checklist: "{installed_path}/checklist.md" # Related workflows quick_prototype_workflow: "{project-root}/_bmad/bmgd/workflows/bmgd-quick-flow/quick-prototype/workflow.yaml" party_mode_exec: "{project-root}/_bmad/core/workflows/party-mode/workflow.md" -advanced_elicitation: "{project-root}/_bmad/core/tasks/advanced-elicitation.xml" +advanced_elicitation: "{project-root}/_bmad/core/workflows/advanced-elicitation/workflow.xml" # Routing resources (lazy-loaded) workflow_init: "{project-root}/_bmad/bmgd/workflows/workflow-status/init/workflow.yaml" diff --git a/src/modules/bmgd/workflows/bmgd-quick-flow/quick-prototype/workflow.yaml b/src/modules/bmgd/workflows/bmgd-quick-flow/quick-prototype/workflow.yaml index 23e5d34c..19862fb1 100644 --- a/src/modules/bmgd/workflows/bmgd-quick-flow/quick-prototype/workflow.yaml +++ b/src/modules/bmgd/workflows/bmgd-quick-flow/quick-prototype/workflow.yaml @@ -23,7 +23,7 @@ checklist: "{installed_path}/checklist.md" # Related workflows quick_dev_workflow: "{project-root}/_bmad/bmgd/workflows/bmgd-quick-flow/quick-dev/workflow.yaml" party_mode_exec: "{project-root}/_bmad/core/workflows/party-mode/workflow.md" -advanced_elicitation: "{project-root}/_bmad/core/tasks/advanced-elicitation.xml" +advanced_elicitation: "{project-root}/_bmad/core/workflows/advanced-elicitation/workflow.xml" # Game-specific references gdd_patterns: diff --git a/src/modules/bmgd/workflows/bmgd-quick-flow/create-tech-spec/instructions.md b/src/modules/bmgd/workflows/bmgd-quick-flow/quick-spec/instructions.md similarity index 100% rename from src/modules/bmgd/workflows/bmgd-quick-flow/create-tech-spec/instructions.md rename to src/modules/bmgd/workflows/bmgd-quick-flow/quick-spec/instructions.md diff --git a/src/modules/bmgd/workflows/bmgd-quick-flow/create-tech-spec/workflow.yaml b/src/modules/bmgd/workflows/bmgd-quick-flow/quick-spec/workflow.yaml similarity index 89% rename from src/modules/bmgd/workflows/bmgd-quick-flow/create-tech-spec/workflow.yaml rename to src/modules/bmgd/workflows/bmgd-quick-flow/quick-spec/workflow.yaml index b2f0c66b..81f8673e 100644 --- a/src/modules/bmgd/workflows/bmgd-quick-flow/create-tech-spec/workflow.yaml +++ b/src/modules/bmgd/workflows/bmgd-quick-flow/quick-spec/workflow.yaml @@ -1,5 +1,5 @@ # Quick-Flow: Create Tech-Spec (Game Development) -name: create-tech-spec +name: quick-spec description: "Conversational spec engineering for games - ask questions, investigate code, produce implementation-ready tech-spec." author: "BMad" @@ -14,14 +14,14 @@ user_skill_level: "{config_source}:game_dev_experience" date: system-generated # Workflow components -installed_path: "{project-root}/_bmad/bmgd/workflows/bmgd-quick-flow/create-tech-spec" +installed_path: "{project-root}/_bmad/bmgd/workflows/bmgd-quick-flow/quick-spec" instructions: "{installed_path}/instructions.md" # Related workflows quick_dev_workflow: "{project-root}/_bmad/bmgd/workflows/bmgd-quick-flow/quick-dev/workflow.yaml" quick_prototype_workflow: "{project-root}/_bmad/bmgd/workflows/bmgd-quick-flow/quick-prototype/workflow.yaml" party_mode_exec: "{project-root}/_bmad/core/workflows/party-mode/workflow.md" -advanced_elicitation: "{project-root}/_bmad/core/tasks/advanced-elicitation.xml" +advanced_elicitation: "{project-root}/_bmad/core/workflows/advanced-elicitation/workflow.xml" standalone: true web_bundle: false diff --git a/src/modules/bmgd/workflows/gametest/automate/instructions.md b/src/modules/bmgd/workflows/gametest/automate/instructions.md index 2af2e4fe..8fb1615c 100644 --- a/src/modules/bmgd/workflows/gametest/automate/instructions.md +++ b/src/modules/bmgd/workflows/gametest/automate/instructions.md @@ -209,6 +209,87 @@ func test_{feature}_integration(): # Cleanup scene.queue_free() ``` +### E2E Journey Tests + +**Knowledge Base Reference**: `knowledge/e2e-testing.md` +```csharp +public class {Feature}E2ETests : GameE2ETestFixture +{ + [UnityTest] + public IEnumerator {JourneyName}_Succeeds() + { + // GIVEN + yield return Scenario + .{SetupMethod1}() + .{SetupMethod2}() + .Build(); + + // WHEN + yield return Input.{Action1}(); + yield return AsyncAssert.WaitUntil( + () => {Condition1}, "{Description1}"); + yield return Input.{Action2}(); + + // THEN + yield return AsyncAssert.WaitUntil( + () => {FinalCondition}, "{FinalDescription}"); + Assert.{Assertion}({expected}, {actual}); + } +} +``` + + +## Step 3.5: Generate E2E Infrastructure + +Before generating E2E tests, scaffold the required infrastructure. + +### Infrastructure Checklist + +1. **Test Fixture Base Class** + - Scene loading/unloading + - Game ready state waiting + - Common service access + - Cleanup guarantees + +2. **Scenario Builder** + - Fluent API for game state configuration + - Domain-specific methods (e.g., `WithUnit`, `OnTurn`) + - Yields for state propagation + +3. **Input Simulator** + - Click/drag abstractions + - Button press simulation + - Keyboard input queuing + +4. **Async Assertions** + - `WaitUntil` with timeout and message + - `WaitForEvent` for event-driven flows + - `WaitForState` for state machine transitions + +### Generation Template +```csharp +// GameE2ETestFixture.cs +public abstract class GameE2ETestFixture +{ + protected {GameStateClass} GameState; + protected {InputSimulatorClass} Input; + protected {ScenarioBuilderClass} Scenario; + + [UnitySetUp] + public IEnumerator BaseSetUp() + { + yield return LoadScene("{main_scene}"); + GameState = Object.FindFirstObjectByType<{GameStateClass}>(); + Input = new {InputSimulatorClass}(); + Scenario = new {ScenarioBuilderClass}(GameState); + yield return WaitForReady(); + } + + // ... (fill from e2e-testing.md patterns) +} +``` + +**After scaffolding infrastructure, proceed to generate actual E2E tests.** --- diff --git a/src/modules/bmgd/workflows/gametest/e2e-scaffold/checklist.md b/src/modules/bmgd/workflows/gametest/e2e-scaffold/checklist.md new file mode 100644 index 00000000..58a510d2 --- /dev/null +++ b/src/modules/bmgd/workflows/gametest/e2e-scaffold/checklist.md @@ -0,0 +1,95 @@ +# E2E Infrastructure Scaffold Checklist + +## Preflight Validation + +- [ ] Test framework already initialized (`Tests/` directory exists with proper structure) +- [ ] Game state manager class identified +- [ ] Main gameplay scene identified and loads without errors +- [ ] No existing E2E infrastructure conflicts + +## Architecture Analysis + +- [ ] Game engine correctly detected +- [ ] Engine version identified +- [ ] Input system type determined (New Input System, Legacy, Custom) +- [ ] Game state manager class located +- [ ] Ready/initialized state property identified +- [ ] Key domain entities catalogued for ScenarioBuilder + +## Generated Files + +### Directory Structure +- [ ] `Tests/PlayMode/E2E/` directory created +- [ ] `Tests/PlayMode/E2E/Infrastructure/` directory created +- [ ] `Tests/PlayMode/E2E/Scenarios/` directory created +- [ ] `Tests/PlayMode/E2E/TestData/` directory created + +### Infrastructure Files +- [ ] `E2E.asmdef` created with correct assembly references +- [ ] `GameE2ETestFixture.cs` created with correct class references +- [ ] `ScenarioBuilder.cs` created with at least placeholder methods +- [ ] `InputSimulator.cs` created matching detected input system +- [ ] `AsyncAssert.cs` created with core assertion methods + +### Example and Documentation +- [ ] `ExampleE2ETest.cs` created with working infrastructure test +- [ ] `README.md` created with usage documentation + +## Code Quality + +### GameE2ETestFixture +- [ ] Correct namespace applied +- [ ] Correct `GameStateClass` reference +- [ ] Correct `SceneName` default +- [ ] `WaitForGameReady` uses correct ready property +- [ ] `UnitySetUp` and `UnityTearDown` properly structured +- [ ] Virtual methods for derived class customization + +### ScenarioBuilder +- [ ] Fluent API pattern correctly implemented +- [ ] `Build()` executes all queued actions +- [ ] At least one domain-specific method added (or clear TODOs) +- [ ] `FromSaveFile` method scaffolded + +### InputSimulator +- [ ] Matches detected input system (New vs Legacy) +- [ ] Mouse click simulation works +- [ ] Button click by name works +- [ ] Keyboard input scaffolded +- [ ] `Reset()` method cleans up state + +### AsyncAssert +- [ ] `WaitUntil` includes timeout and descriptive failure +- [ ] `WaitForValue` provides current vs expected in failure +- [ ] `AssertNeverTrue` for negative assertions +- [ ] Frame/physics wait utilities included + +## Assembly Definition + +- [ ] References main game assembly +- [ ] References Unity.InputSystem (if applicable) +- [ ] `overrideReferences` set to true +- [ ] `precompiledReferences` includes nunit.framework.dll +- [ ] `precompiledReferences` includes UnityEngine.TestRunner.dll +- [ ] `precompiledReferences` includes UnityEditor.TestRunner.dll +- [ ] `UNITY_INCLUDE_TESTS` define constraint set + +## Verification + +- [ ] Project compiles without errors after scaffold +- [ ] `ExampleE2ETests.Infrastructure_GameLoadsAndReachesReadyState` passes +- [ ] Test appears in Test Runner under PlayMode → E2E category + +## Documentation Quality + +- [ ] README explains all infrastructure components +- [ ] Quick start example is copy-pasteable +- [ ] Extension instructions are clear +- [ ] Troubleshooting table addresses common issues + +## Handoff + +- [ ] Summary output provided with all configuration values +- [ ] Next steps clearly listed +- [ ] Customization requirements highlighted +- [ ] Knowledge fragments referenced diff --git a/src/modules/bmgd/workflows/gametest/e2e-scaffold/instructions.md b/src/modules/bmgd/workflows/gametest/e2e-scaffold/instructions.md new file mode 100644 index 00000000..42b99840 --- /dev/null +++ b/src/modules/bmgd/workflows/gametest/e2e-scaffold/instructions.md @@ -0,0 +1,1137 @@ + + +# E2E Test Infrastructure Scaffold + +**Workflow ID**: `_bmad/bmgd/gametest/e2e-scaffold` +**Version**: 1.0 (BMad v6) + +--- + +## Overview + +Scaffold complete E2E testing infrastructure for an existing game project. This workflow creates the foundation required for reliable, maintainable end-to-end tests: test fixtures, scenario builders, input simulators, and async assertion utilities — all tailored to the project's specific architecture. + +E2E tests validate complete player journeys. Without proper infrastructure, they become brittle nightmares. This workflow prevents that. + +--- + +## Preflight Requirements + +**Critical:** Verify these requirements before proceeding. If any fail, HALT and guide the user. + +- ✅ Test framework already initialized (run `test-framework` workflow first) +- ✅ Game has identifiable state manager class +- ✅ Main gameplay scene exists and is functional +- ✅ No existing E2E infrastructure (check for `Tests/PlayMode/E2E/`) + +**Knowledge Base:** Load `knowledge/e2e-testing.md` before proceeding. + +--- + +## Step 1: Analyze Game Architecture + +### 1.1 Detect Game Engine + +Identify engine type by checking for: + +- **Unity**: `Assets/`, `ProjectSettings/`, `*.unity` scenes +- **Unreal**: `*.uproject`, `Source/`, `Config/DefaultEngine.ini` +- **Godot**: `project.godot`, `*.tscn`, `*.gd` files + +Load the appropriate engine-specific knowledge fragment: +- Unity: `knowledge/unity-testing.md` +- Unreal: `knowledge/unreal-testing.md` +- Godot: `knowledge/godot-testing.md` + +### 1.2 Identify Core Systems + +Locate and document: + +1. **Game State Manager** + - Primary class that holds game state + - Look for: `GameManager`, `GameStateManager`, `GameController`, `GameMode` + - Note: initialization method, ready state property, save/load methods + +2. **Input Handling** + - Unity: New Input System (`InputSystem` package) vs Legacy (`Input.GetKey`) + - Unreal: Enhanced Input vs Legacy + - Godot: Built-in Input singleton + - Custom input abstraction layer + +3. **Event/Messaging System** + - Event bus pattern + - C# events/delegates + - UnityEvents + - Signals (Godot) + +4. **Scene Structure** + - Main gameplay scene name + - Scene loading approach (additive, single) + - Bootstrap/initialization flow + +### 1.3 Identify Domain Concepts + +For the ScenarioBuilder, identify: + +- **Primary Entities**: Units, players, items, enemies, etc. +- **State Machine States**: Turn phases, game modes, player states +- **Spatial System**: Grid/hex positions, world coordinates, regions +- **Resources**: Currency, health, mana, ammunition, etc. + +### 1.4 Check Existing Test Structure + +``` +Expected structure after test-framework workflow: +Tests/ +├── EditMode/ +│ └── ... (unit tests) +└── PlayMode/ + └── ... (integration tests) +``` + +If `Tests/PlayMode/E2E/` already exists, HALT and ask user how to proceed. + +--- + +## Step 2: Generate Infrastructure + +### 2.1 Create Directory Structure + +``` +Tests/PlayMode/E2E/ +├── E2E.asmdef +├── Infrastructure/ +│ ├── GameE2ETestFixture.cs +│ ├── ScenarioBuilder.cs +│ ├── InputSimulator.cs +│ └── AsyncAssert.cs +├── Scenarios/ +│ └── (empty - user will add tests here) +├── TestData/ +│ └── (empty - user will add fixtures here) +└── README.md +``` + +### 2.2 Generate Assembly Definition + +**Unity: `E2E.asmdef`** + +```json +{ + "name": "E2E", + "rootNamespace": "{ProjectNamespace}.Tests.E2E", + "references": [ + "{GameAssemblyName}", + "Unity.InputSystem", + "Unity.InputSystem.TestFramework" + ], + "includePlatforms": [], + "excludePlatforms": [], + "allowUnsafeCode": false, + "overrideReferences": true, + "precompiledReferences": [ + "nunit.framework.dll", + "UnityEngine.TestRunner.dll", + "UnityEditor.TestRunner.dll" + ], + "autoReferenced": false, + "defineConstraints": [ + "UNITY_INCLUDE_TESTS" + ], + "versionDefines": [], + "noEngineReferences": false +} +``` + +**Notes:** +- Replace `{ProjectNamespace}` with detected project namespace +- Replace `{GameAssemblyName}` with main game assembly +- Include `Unity.InputSystem` references only if Input System package detected + +### 2.3 Generate GameE2ETestFixture + +This is the base class all E2E tests inherit from. + +**Unity Template:** + +```csharp +using System.Collections; +using NUnit.Framework; +using UnityEngine; +using UnityEngine.SceneManagement; +using UnityEngine.TestTools; + +namespace {Namespace}.Tests.E2E +{ + /// + /// Base fixture for all E2E tests. Handles scene loading, game initialization, + /// and provides access to core test utilities. + /// + public abstract class GameE2ETestFixture + { + /// + /// Override to specify a different scene for specific test classes. + /// + protected virtual string SceneName => "{MainSceneName}"; + + /// + /// Primary game state manager reference. + /// + protected {GameStateClass} GameState { get; private set; } + + /// + /// Input simulation utility. + /// + protected InputSimulator Input { get; private set; } + + /// + /// Scenario configuration builder. + /// + protected ScenarioBuilder Scenario { get; private set; } + + [UnitySetUp] + public IEnumerator BaseSetUp() + { + // Load the game scene + yield return SceneManager.LoadSceneAsync(SceneName); + yield return null; // Wait one frame for Awake/Start + + // Get core references + GameState = Object.FindFirstObjectByType<{GameStateClass}>(); + Assert.IsNotNull(GameState, + $"{nameof({GameStateClass})} not found in scene '{SceneName}'"); + + // Initialize test utilities + Input = new InputSimulator(); + Scenario = new ScenarioBuilder(GameState); + + // Wait for game to reach ready state + yield return WaitForGameReady(); + + // Call derived class setup + yield return SetUp(); + } + + [UnityTearDown] + public IEnumerator BaseTearDown() + { + // Call derived class teardown first + yield return TearDown(); + + // Reset input state + Input?.Reset(); + + // Clear references + GameState = null; + Input = null; + Scenario = null; + } + + /// + /// Override for test-class-specific setup. Called after scene loads and game is ready. + /// + protected virtual IEnumerator SetUp() + { + yield return null; + } + + /// + /// Override for test-class-specific teardown. Called before base cleanup. + /// + protected virtual IEnumerator TearDown() + { + yield return null; + } + + /// + /// Waits until the game reaches a playable state. + /// + protected virtual IEnumerator WaitForGameReady(float timeout = 10f) + { + yield return AsyncAssert.WaitUntil( + () => GameState != null && GameState.{IsReadyProperty}, + "Game to reach ready state", + timeout); + } + + /// + /// Captures screenshot on test failure for debugging. + /// + protected IEnumerator CaptureFailureScreenshot() + { + if (TestContext.CurrentContext.Result.Outcome.Status == + NUnit.Framework.Interfaces.TestStatus.Failed) + { + var texture = ScreenCapture.CaptureScreenshotAsTexture(); + var bytes = texture.EncodeToPNG(); + var testName = TestContext.CurrentContext.Test.Name; + var path = $"TestResults/E2E_Failure_{testName}_{System.DateTime.Now:yyyyMMdd_HHmmss}.png"; + + System.IO.Directory.CreateDirectory("TestResults"); + System.IO.File.WriteAllBytes(path, bytes); + Debug.Log($"[E2E] Failure screenshot saved: {path}"); + + Object.Destroy(texture); + } + yield return null; + } + } +} +``` + +**Customization Points:** +- `{Namespace}`: Project namespace (e.g., `AugustStorm`) +- `{MainSceneName}`: Detected main gameplay scene +- `{GameStateClass}`: Identified game state manager class +- `{IsReadyProperty}`: Property indicating game is initialized (e.g., `IsReady`, `IsInitialized`) + +### 2.4 Generate ScenarioBuilder + +Fluent API for configuring test scenarios. This must be customized to the game's domain. + +**Unity Template:** + +```csharp +using System; +using System.Collections; +using System.Collections.Generic; +using UnityEngine; + +namespace {Namespace}.Tests.E2E +{ + /// + /// Fluent builder for configuring E2E test scenarios. + /// Add domain-specific methods as needed for your game. + /// + public class ScenarioBuilder + { + private readonly {GameStateClass} _gameState; + private readonly List> _setupActions = new(); + + public ScenarioBuilder({GameStateClass} gameState) + { + _gameState = gameState; + } + + #region State Configuration + + /// + /// Load a pre-configured scenario from a save file. + /// + public ScenarioBuilder FromSaveFile(string fileName) + { + _setupActions.Add(() => LoadSaveFile(fileName)); + return this; + } + + // TODO: Add domain-specific configuration methods + // Examples for a turn-based strategy game: + // + // public ScenarioBuilder WithUnit(Faction faction, Hex position, int mp = 6) + // { + // _setupActions.Add(() => SpawnUnit(faction, position, mp)); + // return this; + // } + // + // public ScenarioBuilder OnTurn(int turnNumber) + // { + // _setupActions.Add(() => SetTurn(turnNumber)); + // return this; + // } + // + // public ScenarioBuilder WithActiveFaction(Faction faction) + // { + // _setupActions.Add(() => SetActiveFaction(faction)); + // return this; + // } + + #endregion + + #region Execution + + /// + /// Execute all configured setup actions. + /// + public IEnumerator Build() + { + foreach (var action in _setupActions) + { + yield return action(); + yield return null; // Allow state to propagate + } + _setupActions.Clear(); + } + + /// + /// Clear pending actions without executing. + /// + public void Reset() + { + _setupActions.Clear(); + } + + #endregion + + #region Private Implementation + + private IEnumerator LoadSaveFile(string fileName) + { + var path = $"TestData/{fileName}"; + // TODO: Implement save loading based on your save system + // yield return _gameState.LoadGame(path); + Debug.Log($"[ScenarioBuilder] Loading scenario from: {path}"); + yield return null; + } + + // TODO: Implement domain-specific setup methods + // private IEnumerator SpawnUnit(Faction faction, Hex position, int mp) + // { + // var unit = _gameState.SpawnUnit(faction, position); + // unit.MovementPoints = mp; + // yield return null; + // } + + #endregion + } +} +``` + +**Note to Agent:** After generating the template, analyze the game's domain model and add 3-5 concrete configuration methods based on identified entities (Step 1.3). + +### 2.5 Generate InputSimulator + +Abstract player input for deterministic testing. + +**Unity Template (New Input System):** + +```csharp +using System.Collections; +using UnityEngine; +using UnityEngine.InputSystem; +using UnityEngine.InputSystem.LowLevel; + +namespace {Namespace}.Tests.E2E +{ + /// + /// Simulates player input for E2E tests. + /// + public class InputSimulator + { + private Mouse _mouse; + private Keyboard _keyboard; + private Camera _camera; + + public InputSimulator() + { + _mouse = Mouse.current ?? InputSystem.AddDevice(); + _keyboard = Keyboard.current ?? InputSystem.AddDevice(); + _camera = Camera.main; + } + + #region Mouse Input + + /// + /// Click at a world position. + /// + public IEnumerator ClickWorldPosition(Vector3 worldPos) + { + var screenPos = _camera.WorldToScreenPoint(worldPos); + yield return ClickScreenPosition(new Vector2(screenPos.x, screenPos.y)); + } + + /// + /// Click at a screen position. + /// + public IEnumerator ClickScreenPosition(Vector2 screenPos) + { + // Move mouse to position + InputState.Change(_mouse.position, screenPos); + yield return null; + + // Press + using (StateEvent.From(_mouse, out var eventPtr)) + { + _mouse.CopyState(eventPtr); + _mouse.leftButton.WriteValueIntoEvent(1f, eventPtr); + InputSystem.QueueEvent(eventPtr); + } + yield return null; + + // Release + using (StateEvent.From(_mouse, out var eventPtr)) + { + _mouse.CopyState(eventPtr); + _mouse.leftButton.WriteValueIntoEvent(0f, eventPtr); + InputSystem.QueueEvent(eventPtr); + } + yield return null; + } + + /// + /// Click a UI button by name. + /// + public IEnumerator ClickButton(string buttonName) + { + var button = GameObject.Find(buttonName)? + .GetComponent(); + + if (button == null) + { + // Search in inactive objects within loaded scenes only + var buttons = Object.FindObjectsByType( + FindObjectsInactive.Include, FindObjectsSortMode.None); + foreach (var b in buttons) + { + if (b.name == buttonName && b.gameObject.scene.isLoaded) + { + button = b; + break; + } + } + } + + UnityEngine.Assertions.Assert.IsNotNull(button, + $"Button '{buttonName}' not found in active scenes"); + + if (!button.interactable) + { + Debug.LogWarning($"[InputSimulator] Button '{buttonName}' is not interactable"); + } + + button.onClick.Invoke(); + yield return null; + } + + /// + /// Drag from one world position to another. + /// + public IEnumerator DragFromTo(Vector3 from, Vector3 to, float duration = 0.3f) + { + var fromScreen = (Vector2)_camera.WorldToScreenPoint(from); + var toScreen = (Vector2)_camera.WorldToScreenPoint(to); + + // Move to start + InputState.Change(_mouse.position, fromScreen); + yield return null; + + // Press + using (StateEvent.From(_mouse, out var eventPtr)) + { + _mouse.CopyState(eventPtr); + _mouse.leftButton.WriteValueIntoEvent(1f, eventPtr); + InputSystem.QueueEvent(eventPtr); + } + yield return null; + + // Drag + var elapsed = 0f; + while (elapsed < duration) + { + var t = elapsed / duration; + var pos = Vector2.Lerp(fromScreen, toScreen, t); + InputState.Change(_mouse.position, pos); + yield return null; + elapsed += Time.deltaTime; + } + + // Release at destination + InputState.Change(_mouse.position, toScreen); + using (StateEvent.From(_mouse, out var eventPtr)) + { + _mouse.CopyState(eventPtr); + _mouse.leftButton.WriteValueIntoEvent(0f, eventPtr); + InputSystem.QueueEvent(eventPtr); + } + yield return null; + } + + #endregion + + #region Keyboard Input + + /// + /// Press and release a key. + /// + public IEnumerator PressKey(Key key) + { + var control = _keyboard[key]; + using (StateEvent.From(_keyboard, out var eventPtr)) + { + control.WriteValueIntoEvent(1f, eventPtr); + InputSystem.QueueEvent(eventPtr); + } + yield return null; + + using (StateEvent.From(_keyboard, out var eventPtr)) + { + control.WriteValueIntoEvent(0f, eventPtr); + InputSystem.QueueEvent(eventPtr); + } + yield return null; + } + + /// + /// Hold a key for a duration. + /// + public IEnumerator HoldKey(Key key, float duration) + { + var control = _keyboard[key]; + using (StateEvent.From(_keyboard, out var eventPtr)) + { + control.WriteValueIntoEvent(1f, eventPtr); + InputSystem.QueueEvent(eventPtr); + } + + yield return new WaitForSeconds(duration); + + using (StateEvent.From(_keyboard, out var eventPtr)) + { + control.WriteValueIntoEvent(0f, eventPtr); + InputSystem.QueueEvent(eventPtr); + } + yield return null; + } + + #endregion + + #region Utility + + /// + /// Reset all input state. + /// + public void Reset() + { + if (_mouse != null) + { + InputState.Change(_mouse, new MouseState()); + } + if (_keyboard != null) + { + InputState.Change(_keyboard, new KeyboardState()); + } + } + + /// + /// Update camera reference (call after scene load if needed). + /// + public void RefreshCamera() + { + _camera = Camera.main; + } + + #endregion + } +} +``` + +**Unity Template (Legacy Input):** + +If legacy input system detected, generate a simpler version using `Input.mousePosition` simulation or UI event triggering. + +### 2.6 Generate AsyncAssert + +Wait-for-condition assertions with meaningful failure messages. + +**Unity Template:** + +```csharp +using System; +using System.Collections; +using NUnit.Framework; +using UnityEngine; + +namespace {Namespace}.Tests.E2E +{ + /// + /// Async assertion utilities for E2E tests. + /// + public static class AsyncAssert + { + /// + /// Wait until condition is true, or fail with message after timeout. + /// + /// Condition to wait for + /// Human-readable description of what we're waiting for + /// Maximum seconds to wait + public static IEnumerator WaitUntil( + Func condition, + string description, + float timeout = 5f) + { + var elapsed = 0f; + while (!condition() && elapsed < timeout) + { + yield return null; + elapsed += Time.deltaTime; + } + + Assert.IsTrue(condition(), + $"Timeout after {timeout:F1}s waiting for: {description}"); + } + + /// + /// Wait until condition is true, with periodic debug logging. + /// + public static IEnumerator WaitUntilVerbose( + Func condition, + string description, + float timeout = 5f, + float logInterval = 1f) + { + var elapsed = 0f; + var lastLog = 0f; + + while (!condition() && elapsed < timeout) + { + if (elapsed - lastLog >= logInterval) + { + Debug.Log($"[E2E] Waiting for: {description} ({elapsed:F1}s elapsed)"); + lastLog = elapsed; + } + yield return null; + elapsed += Time.deltaTime; + } + + if (condition()) + { + Debug.Log($"[E2E] Condition met: {description} (after {elapsed:F1}s)"); + } + + Assert.IsTrue(condition(), + $"Timeout after {timeout:F1}s waiting for: {description}"); + } + + /// + /// Wait for a value to equal expected. + /// Note: For floating-point comparisons, use WaitForValueApprox instead + /// to handle precision issues. This method uses exact equality. + /// + public static IEnumerator WaitForValue( + Func getter, + T expected, + string description, + float timeout = 5f) where T : IEquatable + { + yield return WaitUntil( + () => expected.Equals(getter()), + $"{description} to equal '{expected}' (current: '{getter()}')", + timeout); + } + + /// + /// Wait for a float value within tolerance (handles floating-point precision). + /// + public static IEnumerator WaitForValueApprox( + Func getter, + float expected, + string description, + float tolerance = 0.0001f, + float timeout = 5f) + { + yield return WaitUntil( + () => Mathf.Abs(expected - getter()) < tolerance, + $"{description} to equal ~{expected} ±{tolerance} (current: {getter()})", + timeout); + } + + /// + /// Wait for a double value within tolerance (handles floating-point precision). + /// + public static IEnumerator WaitForValueApprox( + Func getter, + double expected, + string description, + double tolerance = 0.0001, + float timeout = 5f) + { + yield return WaitUntil( + () => Math.Abs(expected - getter()) < tolerance, + $"{description} to equal ~{expected} ±{tolerance} (current: {getter()})", + timeout); + } + + /// + /// Wait for a value to not equal a specific value. + /// + public static IEnumerator WaitForValueNot( + Func getter, + T notExpected, + string description, + float timeout = 5f) where T : IEquatable + { + yield return WaitUntil( + () => !notExpected.Equals(getter()), + $"{description} to change from '{notExpected}'", + timeout); + } + + /// + /// Wait for a reference to become non-null. + /// + public static IEnumerator WaitForNotNull( + Func getter, + string description, + float timeout = 5f) where T : class + { + yield return WaitUntil( + () => getter() != null, + $"{description} to exist (not null)", + timeout); + } + + /// + /// Wait for a Unity Object to exist (handles Unity's fake null). + /// + public static IEnumerator WaitForUnityObject( + Func getter, + string description, + float timeout = 5f) where T : UnityEngine.Object + { + yield return WaitUntil( + () => getter() != null, // Unity overloads == for destroyed objects + $"{description} to exist", + timeout); + } + + /// + /// Assert that a condition does NOT become true within a time window. + /// Useful for testing that something doesn't happen. + /// + public static IEnumerator AssertNeverTrue( + Func condition, + string description, + float duration = 1f) + { + var elapsed = 0f; + while (elapsed < duration) + { + Assert.IsFalse(condition(), + $"Condition unexpectedly became true: {description}"); + yield return null; + elapsed += Time.deltaTime; + } + } + + /// + /// Wait for a specific number of frames. + /// Use sparingly - prefer WaitUntil with conditions. + /// + public static IEnumerator WaitFrames(int frameCount) + { + for (int i = 0; i < frameCount; i++) + { + yield return null; + } + } + + /// + /// Wait for physics to settle (multiple FixedUpdates). + /// + public static IEnumerator WaitForPhysics(int fixedUpdateCount = 3) + { + for (int i = 0; i < fixedUpdateCount; i++) + { + yield return new WaitForFixedUpdate(); + } + } + } +} +``` + +--- + +## Step 3: Generate Example Test + +Create a working E2E test that exercises the infrastructure and proves it works. + +**Unity Template:** + +```csharp +using System.Collections; +using NUnit.Framework; +using UnityEngine; +using UnityEngine.TestTools; + +namespace {Namespace}.Tests.E2E +{ + /// + /// Example E2E tests demonstrating infrastructure usage. + /// Delete or modify these once you've verified the setup works. + /// + [Category("E2E")] + public class ExampleE2ETests : GameE2ETestFixture + { + [UnityTest] + public IEnumerator Infrastructure_GameLoadsAndReachesReadyState() + { + // This test verifies the E2E infrastructure is working correctly. + // If this test passes, your infrastructure is properly configured. + + // The base fixture already loaded the scene and waited for ready, + // so if we get here, everything worked. + + Assert.IsNotNull(GameState, "GameState should be available"); + Assert.IsNotNull(Input, "InputSimulator should be available"); + Assert.IsNotNull(Scenario, "ScenarioBuilder should be available"); + + // Verify game is actually ready + // NOTE: {IsReadyProperty} is a template placeholder. Replace it with your + // game's actual ready-state property (e.g., IsReady, IsInitialized, HasLoaded). + yield return AsyncAssert.WaitUntil( + () => GameState.{IsReadyProperty}, + "Game should be in ready state"); + + Debug.Log("[E2E] Infrastructure test passed - E2E framework is working!"); + } + + [UnityTest] + public IEnumerator Infrastructure_InputSimulatorCanClickButtons() + { + // Test that input simulation works + // Modify this to click an actual button in your game + + // Example: Click a button that should exist in your main scene + // yield return Input.ClickButton("SomeButtonName"); + // yield return AsyncAssert.WaitUntil( + // () => /* button click result */, + // "Button click should have effect"); + + Debug.Log("[E2E] Input simulation test - customize with your UI elements"); + yield return null; + } + + [UnityTest] + public IEnumerator Infrastructure_ScenarioBuilderCanConfigureState() + { + // Test that scenario builder works + // Modify this to use your domain-specific setup methods + + // Example: + // yield return Scenario + // .WithUnit(Faction.Player, new Hex(3, 3)) + // .OnTurn(1) + // .Build(); + // + // Assert.AreEqual(1, GameState.TurnNumber); + + Debug.Log("[E2E] Scenario builder test - customize with your domain methods"); + yield return Scenario.Build(); // Execute empty builder (no-op) + } + } +} +``` + +--- + +## Step 4: Generate Documentation + +Create a README explaining how to use the E2E infrastructure. + +**Template: `Tests/PlayMode/E2E/README.md`** + +```markdown +# E2E Testing Infrastructure + +End-to-end tests that validate complete player journeys through the game. + +## Quick Start + +1. Create a new test class inheriting from `GameE2ETestFixture` +2. Use `Scenario` to configure game state +3. Use `Input` to simulate player actions +4. Use `AsyncAssert` to wait for and verify outcomes + +## Example Test + +```csharp +[UnityTest] +public IEnumerator Player_CanCompleteBasicAction() +{ + // GIVEN: Configured scenario + yield return Scenario + .WithSomeSetup() + .Build(); + + // WHEN: Player takes action + yield return Input.ClickButton("ActionButton"); + + // THEN: Expected outcome occurs + yield return AsyncAssert.WaitUntil( + () => GameState.ActionCompleted, + "Action should complete"); +} +``` + +## Infrastructure Components + +### GameE2ETestFixture + +Base class for all E2E tests. Provides: +- Automatic scene loading and cleanup +- Access to `GameState`, `Input`, and `Scenario` +- Override `SetUp()` and `TearDown()` for test-specific setup + +### ScenarioBuilder + +Fluent API for configuring test scenarios. Extend with domain-specific methods: + +```csharp +// In ScenarioBuilder.cs, add methods like: +public ScenarioBuilder WithPlayer(Vector3 position) +{ + _setupActions.Add(() => SpawnPlayer(position)); + return this; +} +``` + +### InputSimulator + +Simulates player input: +- `ClickWorldPosition(Vector3)` - Click in 3D space +- `ClickScreenPosition(Vector2)` - Click at screen coordinates +- `ClickButton(string)` - Click UI button by name +- `DragFromTo(Vector3, Vector3)` - Drag gesture +- `PressKey(Key)` - Keyboard input + +### AsyncAssert + +Async assertions with timeouts: +- `WaitUntil(condition, description, timeout)` - Wait for condition +- `WaitForValue(getter, expected, description)` - Wait for specific value +- `AssertNeverTrue(condition, description, duration)` - Assert something doesn't happen + +## Directory Structure + +``` +E2E/ +├── Infrastructure/ # Base classes and utilities (don't modify often) +├── Scenarios/ # Your actual E2E tests go here +└── TestData/ # Save files and fixtures for scenarios +``` + +## Running Tests + +**In Unity Editor:** +- Window → General → Test Runner +- Select "PlayMode" tab +- Filter by "E2E" category + +**Command Line:** +```bash +unity -runTests -testPlatform PlayMode -testCategory E2E -batchmode +``` + +## Best Practices + +1. **Use Given-When-Then structure** for readable tests +2. **Wait for conditions, not time** - avoid `WaitForSeconds` as primary sync +3. **One journey per test** - keep tests focused +4. **Descriptive assertions** - include context in failure messages +5. **Clean up state** - don't let tests pollute each other + +## Extending the Framework + +### Adding Scenario Methods + +Edit `ScenarioBuilder.cs` to add domain-specific setup: + +```csharp +public ScenarioBuilder OnLevel(int level) +{ + _setupActions.Add(() => LoadLevel(level)); + return this; +} + +private IEnumerator LoadLevel(int level) +{ + _gameState.LoadLevel(level); + yield return null; +} +``` + +### Adding Input Methods + +Edit `InputSimulator.cs` for game-specific input: + +```csharp +public IEnumerator ClickHex(Hex hex) +{ + var worldPos = HexUtils.HexToWorld(hex); + yield return ClickWorldPosition(worldPos); +} +``` + +## Troubleshooting + +| Issue | Cause | Fix | +|-------|-------|-----| +| Tests timeout waiting for ready | Game init takes too long | Increase timeout in `WaitForGameReady` | +| Input simulation doesn't work | Wrong input system | Check `InputSimulator` matches your setup | +| Flaky tests | Race conditions | Use `AsyncAssert.WaitUntil` instead of `WaitForSeconds` | +| Can't find GameState | Wrong scene or class name | Check `SceneName` and class reference | +``` + +--- + +## Step 5: Output Summary + +After generating all files, provide this summary: + +```markdown +## E2E Infrastructure Scaffold Complete + +**Engine**: {Unity | Unreal | Godot} +**Version**: {detected_version} + +### Files Created + +``` +Tests/PlayMode/E2E/ +├── E2E.asmdef +├── Infrastructure/ +│ ├── GameE2ETestFixture.cs +│ ├── ScenarioBuilder.cs +│ ├── InputSimulator.cs +│ └── AsyncAssert.cs +├── Scenarios/ +│ └── (empty) +├── TestData/ +│ └── (empty) +├── ExampleE2ETest.cs +└── README.md +``` + +### Configuration + +| Setting | Value | +|---------|-------| +| Game State Class | `{GameStateClass}` | +| Main Scene | `{MainSceneName}` | +| Input System | `{InputSystemType}` | +| Ready Property | `{IsReadyProperty}` | + +### Customization Required + +1. **ScenarioBuilder**: Add domain-specific setup methods for your game entities +2. **InputSimulator**: Add game-specific input methods (e.g., hex clicking, gesture shortcuts) +3. **ExampleE2ETest**: Modify example tests to use your actual UI elements + +### Next Steps + +1. ✅ Run `ExampleE2ETests.Infrastructure_GameLoadsAndReachesReadyState` to verify setup +2. 📝 Extend `ScenarioBuilder` with your domain methods +3. 📝 Extend `InputSimulator` with game-specific input helpers +4. 🧪 Use `test-design` workflow to identify E2E scenarios +5. 🤖 Use `automate` workflow to generate E2E tests from scenarios + +### Knowledge Applied + +- `knowledge/e2e-testing.md` - Core E2E patterns and infrastructure +- `knowledge/{engine}-testing.md` - Engine-specific implementation details +``` + +--- + +## Validation + +Refer to `checklist.md` for comprehensive validation criteria. diff --git a/src/modules/bmgd/workflows/gametest/e2e-scaffold/workflow.yaml b/src/modules/bmgd/workflows/gametest/e2e-scaffold/workflow.yaml new file mode 100644 index 00000000..03d7c465 --- /dev/null +++ b/src/modules/bmgd/workflows/gametest/e2e-scaffold/workflow.yaml @@ -0,0 +1,145 @@ +# E2E Test Infrastructure Scaffold Workflow + +workflow: + id: e2e-scaffold + name: E2E Test Infrastructure Scaffold + version: 1.0 + module: bmgd + agent: game-qa + + description: | + Scaffold complete E2E testing infrastructure for an existing game project. + Creates test fixtures, scenario builders, input simulators, and async + assertion utilities tailored to the project's architecture. + + triggers: + - "ES" + - "e2e-scaffold" + - "scaffold e2e" + - "e2e infrastructure" + - "setup e2e" + + preflight: + - "Test framework initialized (run `test-framework` workflow first)" + - "Game has identifiable state manager" + - "Main gameplay scene exists" + + # Paths are relative to this workflow file's location + knowledge_fragments: + - "../../../gametest/knowledge/e2e-testing.md" + - "../../../gametest/knowledge/unity-testing.md" + - "../../../gametest/knowledge/unreal-testing.md" + - "../../../gametest/knowledge/godot-testing.md" + + inputs: + game_state_class: + description: "Primary game state manager class name" + required: true + example: "GameStateManager" + + main_scene: + description: "Scene name where core gameplay occurs" + required: true + example: "GameScene" + + input_system: + description: "Input system in use" + required: false + default: "auto-detect" + options: + - "unity-input-system" + - "unity-legacy" + - "unreal-enhanced" + - "godot-input" + - "custom" + + # Output paths vary by engine. Generate files matching detected engine. + outputs: + unity: + condition: "engine == 'unity'" + infrastructure_files: + description: "Generated E2E infrastructure classes" + files: + - "Tests/PlayMode/E2E/Infrastructure/GameE2ETestFixture.cs" + - "Tests/PlayMode/E2E/Infrastructure/ScenarioBuilder.cs" + - "Tests/PlayMode/E2E/Infrastructure/InputSimulator.cs" + - "Tests/PlayMode/E2E/Infrastructure/AsyncAssert.cs" + assembly_definition: + description: "E2E test assembly configuration" + files: + - "Tests/PlayMode/E2E/E2E.asmdef" + example_test: + description: "Working example E2E test" + files: + - "Tests/PlayMode/E2E/ExampleE2ETest.cs" + documentation: + description: "E2E testing README" + files: + - "Tests/PlayMode/E2E/README.md" + + unreal: + condition: "engine == 'unreal'" + infrastructure_files: + description: "Generated E2E infrastructure classes" + files: + - "Source/{ProjectName}/Tests/E2E/GameE2ETestBase.h" + - "Source/{ProjectName}/Tests/E2E/GameE2ETestBase.cpp" + - "Source/{ProjectName}/Tests/E2E/ScenarioBuilder.h" + - "Source/{ProjectName}/Tests/E2E/ScenarioBuilder.cpp" + - "Source/{ProjectName}/Tests/E2E/InputSimulator.h" + - "Source/{ProjectName}/Tests/E2E/InputSimulator.cpp" + - "Source/{ProjectName}/Tests/E2E/AsyncAssert.h" + build_configuration: + description: "E2E test build configuration" + files: + - "Source/{ProjectName}/Tests/E2E/{ProjectName}E2ETests.Build.cs" + example_test: + description: "Working example E2E test" + files: + - "Source/{ProjectName}/Tests/E2E/ExampleE2ETest.cpp" + documentation: + description: "E2E testing README" + files: + - "Source/{ProjectName}/Tests/E2E/README.md" + + godot: + condition: "engine == 'godot'" + infrastructure_files: + description: "Generated E2E infrastructure classes" + files: + - "tests/e2e/infrastructure/game_e2e_test_fixture.gd" + - "tests/e2e/infrastructure/scenario_builder.gd" + - "tests/e2e/infrastructure/input_simulator.gd" + - "tests/e2e/infrastructure/async_assert.gd" + example_test: + description: "Working example E2E test" + files: + - "tests/e2e/scenarios/example_e2e_test.gd" + documentation: + description: "E2E testing README" + files: + - "tests/e2e/README.md" + + steps: + - id: analyze + name: "Analyze Game Architecture" + instruction_file: "instructions.md#step-1-analyze-game-architecture" + + - id: scaffold + name: "Generate Infrastructure" + instruction_file: "instructions.md#step-2-generate-infrastructure" + + - id: example + name: "Generate Example Test" + instruction_file: "instructions.md#step-3-generate-example-test" + + - id: document + name: "Generate Documentation" + instruction_file: "instructions.md#step-4-generate-documentation" + + - id: complete + name: "Output Summary" + instruction_file: "instructions.md#step-5-output-summary" + + validation: + checklist: "checklist.md" diff --git a/src/modules/bmgd/workflows/gametest/test-design/instructions.md b/src/modules/bmgd/workflows/gametest/test-design/instructions.md index b799dafe..96bf2869 100644 --- a/src/modules/bmgd/workflows/gametest/test-design/instructions.md +++ b/src/modules/bmgd/workflows/gametest/test-design/instructions.md @@ -91,6 +91,18 @@ Create comprehensive test scenarios for game projects, covering gameplay mechani | Performance | FPS, loading times | P1 | | Accessibility | Assist features | P1 | +### E2E Journey Testing + +**Knowledge Base Reference**: `knowledge/e2e-testing.md` + +| Category | Focus | Priority | +|----------|-------|----------| +| Core Loop | Complete gameplay cycle | P0 | +| Turn Lifecycle | Full turn from start to end | P0 | +| Save/Load Round-trip | Save → quit → load → resume | P0 | +| Scene Transitions | Menu → Game → Back | P1 | +| Win/Lose Paths | Victory and defeat conditions | P1 | + --- ## Step 3: Create Test Scenarios @@ -153,6 +165,39 @@ SCENARIO: Gameplay Under High Latency CATEGORY: multiplayer ``` +### E2E Scenario Format + +For player journey tests, use this extended format: +``` +E2E SCENARIO: [Player Journey Name] + GIVEN [Initial game state - use ScenarioBuilder terms] + WHEN [Sequence of player actions] + THEN [Observable outcomes] + TIMEOUT: [Expected max duration in seconds] + PRIORITY: P0/P1 + CATEGORY: e2e + INFRASTRUCTURE: [Required fixtures/builders] +``` + +### Example E2E Scenario +``` +E2E SCENARIO: Complete Combat Encounter + GIVEN game loaded with player unit adjacent to enemy + AND player unit has full health and actions + WHEN player selects unit + AND player clicks attack on enemy + AND player confirms attack + AND attack animation completes + AND enemy responds (if alive) + THEN enemy health is reduced OR enemy is defeated + AND turn state advances appropriately + AND UI reflects new state + TIMEOUT: 15 + PRIORITY: P0 + CATEGORY: e2e + INFRASTRUCTURE: ScenarioBuilder, InputSimulator, AsyncAssert +``` + --- ## Step 4: Prioritize Test Coverage @@ -161,12 +206,12 @@ SCENARIO: Gameplay Under High Latency **Knowledge Base Reference**: `knowledge/test-priorities.md` -| Priority | Criteria | Coverage Target | -| -------- | ---------------------------- | --------------- | -| P0 | Ship blockers, certification | 100% automated | -| P1 | Major features, common paths | 80% automated | -| P2 | Secondary features | 60% automated | -| P3 | Edge cases, polish | Manual only | +| Priority | Criteria | Unit | Integration | E2E | Manual | +|----------|----------|------|-------------|-----|--------| +| P0 | Ship blockers | 100% | 80% | Core flows | Smoke | +| P1 | Major features | 90% | 70% | Happy paths | Full | +| P2 | Secondary | 80% | 50% | - | Targeted | +| P3 | Edge cases | 60% | - | - | As needed | ### Risk-Based Ordering diff --git a/src/modules/bmgd/workflows/workflow-status/paths/quickflow-brownfield.yaml b/src/modules/bmgd/workflows/workflow-status/paths/quickflow-brownfield.yaml index 6055fcc9..8f01b763 100644 --- a/src/modules/bmgd/workflows/workflow-status/paths/quickflow-brownfield.yaml +++ b/src/modules/bmgd/workflows/workflow-status/paths/quickflow-brownfield.yaml @@ -11,10 +11,10 @@ phases: name: "Planning" required: true workflows: - - id: "create-tech-spec" + - id: "quick-spec" required: true agent: "game-solo-dev" - command: "create-tech-spec" + command: "quick-spec" output: "Technical specification" note: "Define changes for existing codebase" diff --git a/src/modules/bmm/README.md b/src/modules/bmm/README.md deleted file mode 100644 index 0992fdd0..00000000 --- a/src/modules/bmm/README.md +++ /dev/null @@ -1,127 +0,0 @@ -# BMM - BMad Method Module - -Core orchestration system for AI-driven agile development, providing comprehensive lifecycle management through specialized agents and workflows. - ---- - -## 📚 Complete Documentation - -👉 **[BMM Documentation Hub](./docs/index.md)** - Start here for complete guides, tutorials, and references - -**Quick Links:** - -- **[Quick Start Guide](./docs/quick-start.md)** - New to BMM? Start here (15 min) -- **[Agents Guide](./docs/agents-guide.md)** - Meet your 12 specialized AI agents (45 min) -- **[Scale Adaptive System](./docs/scale-adaptive-system.md)** - How BMM adapts to project size (42 min) -- **[FAQ](./docs/faq.md)** - Quick answers to common questions -- **[Glossary](./docs/glossary.md)** - Key terminology reference - ---- - -## 🏗️ Module Structure - -This module contains: - -``` -bmm/ -├── agents/ # 12 specialized AI agents (PM, Architect, SM, DEV, TEA, etc.) -├── workflows/ # 34 workflows across 4 phases + testing -├── teams/ # Pre-configured agent groups -├── tasks/ # Atomic work units -├── testarch/ # Comprehensive testing infrastructure -└── docs/ # Complete user documentation -``` - -### Agent Roster - -**Core Development:** PM, Analyst, Architect, SM, DEV, TEA, UX Designer, Technical Writer -**Game Development:** Game Designer, Game Developer, Game Architect -**Orchestration:** BMad Master (from Core) - -👉 **[Full Agents Guide](./docs/agents-guide.md)** - Roles, workflows, and when to use each agent - -### Workflow Phases - -**Phase 0:** Documentation (brownfield only) -**Phase 1:** Analysis (optional) - 5 workflows -**Phase 2:** Planning (required) - 2 workflows -**Phase 3:** Solutioning (required) - 3 workflows -**Phase 4:** Implementation (iterative) - 7 workflows - -👉 **[Workflow Guides](./docs/index.md#-workflow-guides)** - Detailed documentation for each phase - ---- - -## 🚀 Getting Started - -**New Project:** - -```bash -# Install BMM -npx bmad-method@alpha install - -# Load Analyst agent in your IDE, then: -*workflow-init -``` - -**Existing Project (Brownfield):** - -```bash -# Document your codebase first -*document-project - -# Then initialize -*workflow-init -``` - -👉 **[Quick Start Guide](./docs/quick-start.md)** - Complete setup and first project walkthrough - ---- - -## 🎯 Key Concepts - -### Scale-Adaptive Design - -BMM automatically adjusts to project complexity (Levels 0-4): - -- **Level 0-1:** Quick Spec Flow for bug fixes and small features -- **Level 2:** PRD with optional architecture -- **Level 3-4:** Full PRD + comprehensive architecture - -👉 **[Scale Adaptive System](./docs/scale-adaptive-system.md)** - Complete level breakdown - -### Story-Centric Implementation - -Stories move through a defined lifecycle: `backlog → ready-for-dev → in-progress → review → done` - -Just-in-time epic context and story context provide exact expertise when needed. - -👉 **[Implementation Workflows](./docs/workflows-implementation.md)** - Complete story lifecycle guide - -### Multi-Agent Collaboration - -Use party mode to engage all 19+ agents (from BMM, CIS, BMB, custom modules) in group discussions for strategic decisions, creative brainstorming, and complex problem-solving. - -👉 **[Party Mode Guide](./docs/party-mode.md)** - How to orchestrate multi-agent collaboration - ---- - -## 📖 Additional Resources - -- **[Brownfield Guide](./docs/brownfield-guide.md)** - Working with existing codebases -- **[Quick Spec Flow](./docs/quick-spec-flow.md)** - Fast-track for Level 0-1 projects -- **[Enterprise Agentic Development](./docs/enterprise-agentic-development.md)** - Team collaboration patterns -- **[Troubleshooting](./docs/troubleshooting.md)** - Common issues and solutions -- **[IDE Setup Guides](../../../docs/ide-info/)** - Configure Claude Code, Cursor, Windsurf, etc. - ---- - -## 🤝 Community - -- **[Discord](https://discord.gg/gk8jAdXWmj)** - Get help, share feedback (#general-dev, #bugs-issues) -- **[GitHub Issues](https://github.com/bmad-code-org/BMAD-METHOD/issues)** - Report bugs or request features -- **[YouTube](https://www.youtube.com/@BMadCode)** - Video tutorials and walkthroughs - ---- - -**Ready to build?** → [Start with the Quick Start Guide](./docs/quick-start.md) diff --git a/src/modules/bmm/_module-installer/installer.js b/src/modules/bmm/_module-installer/installer.js index dff6a7f7..ddf757b0 100644 --- a/src/modules/bmm/_module-installer/installer.js +++ b/src/modules/bmm/_module-installer/installer.js @@ -20,40 +20,8 @@ async function install(options) { try { logger.log(chalk.blue('🚀 Installing BMM Module...')); - // Check and create tech_docs directory if configured - if (config['tech_docs']) { - // Strip {project-root}/ prefix if present - const techDocsConfig = config['tech_docs'].replace('{project-root}/', ''); - const techDocsPath = path.join(projectRoot, techDocsConfig); - - if (await fs.pathExists(techDocsPath)) { - // Check if template exists, add if missing - const templateDest = path.join(techDocsPath, 'technical-decisions-template.md'); - if (!(await fs.pathExists(templateDest))) { - const templateSource = path.join(__dirname, 'assets', 'technical-decisions-template.md'); - if (await fs.pathExists(templateSource)) { - await fs.copy(templateSource, templateDest); - logger.log(chalk.green('✓ Added technical decisions template to existing directory')); - } - } - } else { - logger.log(chalk.yellow(`Creating technical documentation directory: ${techDocsConfig}`)); - await fs.ensureDir(techDocsPath); - - // Copy technical decisions template - const templateSource = path.join(__dirname, 'assets', 'technical-decisions-template.md'); - const templateDest = path.join(techDocsPath, 'technical-decisions-template.md'); - - if (await fs.pathExists(templateSource)) { - await fs.copy(templateSource, templateDest, { overwrite: false }); - logger.log(chalk.green('✓ Added technical decisions template')); - } - } - } - // Create output directory if configured if (config['output_folder']) { - // Strip {project-root}/ prefix if present const outputConfig = config['output_folder'].replace('{project-root}/', ''); const outputPath = path.join(projectRoot, outputConfig); if (!(await fs.pathExists(outputPath))) { @@ -62,9 +30,7 @@ async function install(options) { } } - // Create dev story location if configured if (config['implementation_artifacts']) { - // Strip {project-root}/ prefix if present const storyConfig = config['implementation_artifacts'].replace('{project-root}/', ''); const storyPath = path.join(projectRoot, storyConfig); if (!(await fs.pathExists(storyPath))) { diff --git a/src/modules/bmm/agents/analyst.agent.yaml b/src/modules/bmm/agents/analyst.agent.yaml index 9a1add04..28294696 100644 --- a/src/modules/bmm/agents/analyst.agent.yaml +++ b/src/modules/bmm/agents/analyst.agent.yaml @@ -7,46 +7,35 @@ agent: title: Business Analyst icon: 📊 module: bmm + hasSidecar: false persona: role: Strategic Business Analyst + Requirements Expert identity: Senior analyst with deep expertise in market research, competitive analysis, and requirements elicitation. Specializes in translating vague needs into actionable specs. - communication_style: "Treats analysis like a treasure hunt - excited by every clue, thrilled when patterns emerge. Asks questions that spark 'aha!' moments while structuring insights with precision." + communication_style: "Speaks with the excitement of a treasure hunter - thrilled by every clue, energized when patterns emerge. Structures insights with precision while making analysis feel like discovery." principles: | - - Every business challenge has root causes waiting to be discovered. Ground findings in verifiable evidence. + - Channel expert business analysis frameworks: draw upon Porter's Five Forces, SWOT analysis, root cause analysis, and competitive intelligence methodologies to uncover what others miss. Every business challenge has root causes waiting to be discovered. Ground findings in verifiable evidence. - Articulate requirements with absolute precision. Ensure all stakeholder voices heard. - Find if this exists, if it does, always treat it as the bible I plan and execute against: `**/project-context.md` menu: - - trigger: workflow-status + - trigger: WS or fuzzy match on workflow-status workflow: "{project-root}/_bmad/bmm/workflows/workflow-status/workflow.yaml" - description: Get workflow status or initialize a workflow if not already done (optional) + description: "[WS] Get workflow status or initialize a workflow if not already done (optional)" - - trigger: brainstorm-project + - trigger: BP or fuzzy match on brainstorm-project exec: "{project-root}/_bmad/core/workflows/brainstorming/workflow.md" data: "{project-root}/_bmad/bmm/data/project-context-template.md" - description: Guided Project Brainstorming session with final report (optional) + description: "[BP] Guided Project Brainstorming session with final report (optional)" - - trigger: research + - trigger: RS or fuzzy match on research exec: "{project-root}/_bmad/bmm/workflows/1-analysis/research/workflow.md" - description: Guided Research scoped to market, domain, competitive analysis, or technical research (optional) + description: "[RS] Guided Research scoped to market, domain, competitive analysis, or technical research (optional)" - - trigger: product-brief + - trigger: PB or fuzzy match on product-brief exec: "{project-root}/_bmad/bmm/workflows/1-analysis/create-product-brief/workflow.md" - description: Create a Product Brief (recommended input for PRD) + description: "[PB] Create a Product Brief (recommended input for PRD)" - - trigger: document-project + - trigger: DP or fuzzy match on document-project workflow: "{project-root}/_bmad/bmm/workflows/document-project/workflow.yaml" - description: Document your existing project (optional, but recommended for existing brownfield project efforts) - - - multi: "[SPM] Start Party Mode (optionally suggest attendees and topic), [CH] Chat" - triggers: - - party-mode: - - input: SPM or fuzzy match start party mode - - route: "{project-root}/_bmad/core/workflows/party-mode/workflow.md" - - data: what is being discussed or suggested with the command, along with custom party custom agents if specified - - type: exec - - expert-chat: - - input: CH or fuzzy match validate agent - - action: agent responds as expert based on its persona to converse - - type: action + description: "[DP] Document your existing project (optional, but recommended for existing brownfield project efforts)" diff --git a/src/modules/bmm/agents/architect.agent.yaml b/src/modules/bmm/agents/architect.agent.yaml index 2265f35d..99ced439 100644 --- a/src/modules/bmm/agents/architect.agent.yaml +++ b/src/modules/bmm/agents/architect.agent.yaml @@ -7,42 +7,27 @@ agent: title: Architect icon: 🏗️ module: bmm + hasSidecar: false persona: role: System Architect + Technical Design Leader identity: Senior architect with expertise in distributed systems, cloud infrastructure, and API design. Specializes in scalable patterns and technology selection. - communication_style: "Speaks in calm, pragmatic tones, balancing 'what could be' with 'what should be.' Champions boring technology that actually works." + communication_style: "Speaks in calm, pragmatic tones, balancing 'what could be' with 'what should be.'" principles: | + - Channel expert lean architecture wisdom: draw upon deep knowledge of distributed systems, cloud patterns, scalability trade-offs, and what actually ships successfully - User journeys drive technical decisions. Embrace boring technology for stability. - Design simple solutions that scale when needed. Developer productivity is architecture. Connect every decision to business value and user impact. - Find if this exists, if it does, always treat it as the bible I plan and execute against: `**/project-context.md` menu: - - trigger: workflow-status + - trigger: WS or fuzzy match on workflow-status workflow: "{project-root}/_bmad/bmm/workflows/workflow-status/workflow.yaml" - description: Get workflow status or initialize a workflow if not already done (optional) + description: "[WS] Get workflow status or initialize a workflow if not already done (optional)" - - trigger: create-architecture + - trigger: CA or fuzzy match on create-architecture exec: "{project-root}/_bmad/bmm/workflows/3-solutioning/create-architecture/workflow.md" - description: Create an Architecture Document to Guide Development of a PRD (required for BMad Method projects) + description: "[CA] Create an Architecture Document" - - trigger: implementation-readiness + - trigger: IR or fuzzy match on implementation-readiness exec: "{project-root}/_bmad/bmm/workflows/3-solutioning/check-implementation-readiness/workflow.md" - description: Validate PRD, UX, Architecture, Epics and stories aligned (Optional but recommended before development) - - - trigger: create-excalidraw-diagram - workflow: "{project-root}/_bmad/bmm/workflows/excalidraw-diagrams/create-diagram/workflow.yaml" - description: Create system architecture or technical diagram (Excalidraw) (Use any time you need a diagram) - - - trigger: create-excalidraw-dataflow - workflow: "{project-root}/_bmad/bmm/workflows/excalidraw-diagrams/create-dataflow/workflow.yaml" - description: Create data flow diagram (Excalidraw) (Use any time you need a diagram) - - - trigger: party-mode - exec: "{project-root}/_bmad/core/workflows/party-mode/workflow.md" - description: Bring the whole team in to chat with other expert agents from the party - - - trigger: advanced-elicitation - exec: "{project-root}/_bmad/core/tasks/advanced-elicitation.xml" - description: Advanced elicitation techniques to challenge the LLM to get better results - web-only: true + description: "[IR] Implementation Readiness Review" diff --git a/src/modules/bmm/agents/dev.agent.yaml b/src/modules/bmm/agents/dev.agent.yaml index 82bc9116..0b14d984 100644 --- a/src/modules/bmm/agents/dev.agent.yaml +++ b/src/modules/bmm/agents/dev.agent.yaml @@ -8,6 +8,7 @@ agent: title: Developer Agent icon: 💻 module: bmm + hasSidecar: false persona: role: Senior Software Engineer @@ -19,12 +20,12 @@ agent: - Never implement anything not mapped to a specific task/subtask in the story file - All existing tests must pass 100% before story is ready for review - Every task/subtask must be covered by comprehensive unit tests before marking complete - - Project context provides coding standards but never overrides story requirements - - Find if this exists, if it does, always treat it as the bible I plan and execute against: `**/project-context.md` + - Follow project-context.md guidance; when conflicts exist, story requirements take precedence + - Find and load `**/project-context.md` if it exists - essential reference for implementation critical_actions: - "READ the entire story file BEFORE any implementation - tasks/subtasks sequence is your authoritative implementation guide" - - "Load project-context.md if available for coding standards only - never let it override story requirements" + - "Load project-context.md if available and follow its guidance - when conflicts exist, story requirements always take precedence" - "Execute tasks/subtasks IN ORDER as written in story file - no skipping, no reordering, no doing what you want" - "For each task/subtask: follow red-green-refactor cycle - write failing test first, then implementation" - "Mark task/subtask [x] ONLY when both implementation AND tests are complete and passing" @@ -35,14 +36,10 @@ agent: - "NEVER lie about tests being written or passing - tests must actually exist and pass 100%" menu: - - trigger: DS or dev-story or fuzzy match on dev-story + - trigger: DS or fuzzy match on dev-story workflow: "{project-root}/_bmad/bmm/workflows/4-implementation/dev-story/workflow.yaml" description: "[DS] Execute Dev Story workflow (full BMM path with sprint-status)" - - trigger: CR or code-review or fuzzy match on code-review + - trigger: CR or fuzzy match on code-review workflow: "{project-root}/_bmad/bmm/workflows/4-implementation/code-review/workflow.yaml" description: "[CR] Perform a thorough clean context code review (Highly Recommended, use fresh context and different LLM)" - - - trigger: PM or party-mode or fuzzy match on party-mode - exec: "{project-root}/_bmad/core/workflows/party-mode/workflow.md" - description: "[PM] Bring the whole team in to chat with other expert agents from the party" diff --git a/src/modules/bmm/agents/pm.agent.yaml b/src/modules/bmm/agents/pm.agent.yaml index 3cbcbae4..8e44cd9b 100644 --- a/src/modules/bmm/agents/pm.agent.yaml +++ b/src/modules/bmm/agents/pm.agent.yaml @@ -8,43 +8,45 @@ agent: title: Product Manager icon: 📋 module: bmm + hasSidecar: false persona: - role: Investigative Product Strategist + Market-Savvy PM + role: Product Manager specializing in collaborative PRD creation through user interviews, requirement discovery, and stakeholder alignment. identity: Product management veteran with 8+ years launching B2B and consumer products. Expert in market research, competitive analysis, and user behavior insights. communication_style: "Asks 'WHY?' relentlessly like a detective on a case. Direct and data-sharp, cuts through fluff to what actually matters." principles: | - - Uncover the deeper WHY behind every requirement. Ruthless prioritization to achieve MVP goals. Proactively identify risks. - - Align efforts with measurable business impact. Back all claims with data and user insights. + - Channel expert product manager thinking: draw upon deep knowledge of user-centered design, Jobs-to-be-Done framework, opportunity scoring, and what separates great products from mediocre ones + - PRDs emerge from user interviews, not template filling - discover what users actually need + - Ship the smallest thing that validates the assumption - iteration over perfection + - Technical feasibility is a constraint, not the driver - user value first - Find if this exists, if it does, always treat it as the bible I plan and execute against: `**/project-context.md` menu: - - trigger: workflow-status + - trigger: WS or fuzzy match on workflow-status workflow: "{project-root}/_bmad/bmm/workflows/workflow-status/workflow.yaml" - description: Get workflow status or initialize a workflow if not already done (optional) + description: "[WS] Get workflow status or initialize a workflow if not already done (optional)" - - trigger: create-prd + - trigger: CP or fuzzy match on create-prd exec: "{project-root}/_bmad/bmm/workflows/2-plan-workflows/prd/workflow.md" - description: Create Product Requirements Document (PRD) (Required for BMad Method flow) + description: "[CP] Create Product Requirements Document (PRD)" - - trigger: create-epics-and-stories + - trigger: VP or fuzzy match on validate-prd + exec: "{project-root}/_bmad/bmm/workflows/2-plan-workflows/prd/workflow.md" + description: "[VP] Validate a Product Requirements Document (PRD)" + + - trigger: EP or fuzzy match on edit-prd + exec: "{project-root}/_bmad/bmm/workflows/2-plan-workflows/prd/workflow.md" + description: "[EP] Edit a Product Requirements Document (PRD)" + + - trigger: ES or fuzzy match on epics-stories exec: "{project-root}/_bmad/bmm/workflows/3-solutioning/create-epics-and-stories/workflow.md" - description: Create Epics and User Stories from PRD (Required for BMad Method flow AFTER the Architecture is completed) + description: "[ES] Create Epics and User Stories from PRD (Required for BMad Method flow AFTER the Architecture is completed)" - - trigger: implementation-readiness + - trigger: IR or fuzzy match on implementation-readiness exec: "{project-root}/_bmad/bmm/workflows/3-solutioning/check-implementation-readiness/workflow.md" - description: Validate PRD, UX, Architecture, Epics and stories aligned (Optional but recommended before development) + description: "[IR] Implementation Readiness Review" - - trigger: correct-course + - trigger: CC or fuzzy match on correct-course workflow: "{project-root}/_bmad/bmm/workflows/4-implementation/correct-course/workflow.yaml" - description: Course Correction Analysis (optional during implementation when things go off track) + description: "[CC] Course Correction Analysis (optional during implementation when things go off track)" ide-only: true - - - trigger: party-mode - exec: "{project-root}/_bmad/core/workflows/party-mode/workflow.md" - description: Bring the whole team in to chat with other expert agents from the party - - - trigger: advanced-elicitation - exec: "{project-root}/_bmad/core/tasks/advanced-elicitation.xml" - description: Advanced elicitation techniques to challenge the LLM to get better results - web-only: true diff --git a/src/modules/bmm/agents/quick-flow-solo-dev.agent.yaml b/src/modules/bmm/agents/quick-flow-solo-dev.agent.yaml index 34363f63..00596ff5 100644 --- a/src/modules/bmm/agents/quick-flow-solo-dev.agent.yaml +++ b/src/modules/bmm/agents/quick-flow-solo-dev.agent.yaml @@ -7,6 +7,7 @@ agent: title: Quick Flow Solo Dev icon: 🚀 module: bmm + hasSidecar: false persona: role: Elite Full-Stack Developer + Quick Flow Specialist @@ -18,10 +19,14 @@ agent: - If `**/project-context.md` exists, follow it. If absent, proceed without. menu: - - trigger: TS or tech-spec or fuzzy match on tech-spec - workflow: "{project-root}/_bmad/bmm/workflows/bmad-quick-flow/create-tech-spec/workflow.yaml" + - trigger: TS or fuzzy match on tech-spec + exec: "{project-root}/_bmad/bmm/workflows/bmad-quick-flow/quick-spec/workflow.md" description: "[TS] Architect a technical spec with implementation-ready stories (Required first step)" - - trigger: QD or quick-dev or fuzzy match on quick-dev - workflow: "{project-root}/_bmad/bmm/workflows/bmad-quick-flow/quick-dev/workflow.yaml" + - trigger: QD or fuzzy match on quick-dev + workflow: "{project-root}/_bmad/bmm/workflows/bmad-quick-flow/quick-dev/workflow.md" description: "[QD] Implement the tech spec end-to-end solo (Core of Quick Flow)" + + - trigger: CR or fuzzy match on code-review + workflow: "{project-root}/_bmad/bmm/workflows/4-implementation/code-review/workflow.yaml" + description: "[CR] Perform a thorough clean context code review (Highly Recommended, use fresh context and different LLM)" diff --git a/src/modules/bmm/agents/sm.agent.yaml b/src/modules/bmm/agents/sm.agent.yaml index 64262df4..aebba89a 100644 --- a/src/modules/bmm/agents/sm.agent.yaml +++ b/src/modules/bmm/agents/sm.agent.yaml @@ -7,6 +7,7 @@ agent: title: Scrum Master icon: 🏃 module: bmm + hasSidecar: false persona: role: Technical Scrum Master + Story Preparation Specialist @@ -24,35 +25,23 @@ agent: - "Find if this exists, if it does, always treat it as the bible I plan and execute against: `**/project-context.md`" menu: - - trigger: sprint-planning + - trigger: WS or fuzzy match on workflow-status + workflow: "{project-root}/_bmad/bmm/workflows/workflow-status/workflow.yaml" + description: "[WS] Get workflow status or initialize a workflow if not already done (optional)" + + - trigger: SP or fuzzy match on sprint-planning workflow: "{project-root}/_bmad/bmm/workflows/4-implementation/sprint-planning/workflow.yaml" - description: Generate or re-generate sprint-status.yaml from epic files (Required after Epics+Stories are created) + description: "[SP] Generate or re-generate sprint-status.yaml from epic files (Required after Epics+Stories are created)" - - trigger: create-story + - trigger: CS or fuzzy match on create-story workflow: "{project-root}/_bmad/bmm/workflows/4-implementation/create-story/workflow.yaml" - description: Create Story (Required to prepare stories for development) + description: "[CS] Create Story (Required to prepare stories for development)" - # TODO: validate-create-story is not yet implemented - # The validate-workflow: handler type is not recognized by the workflow engine - # See: https://github.com/bmad-code-org/BMAD-METHOD/issues/1075 - # - trigger: validate-create-story - # workflow: "{project-root}/_bmad/bmm/workflows/4-implementation/create-story/validate-workflow.yaml" - # description: Validate Story (Highly Recommended, use fresh context and different LLM for best results) - - - trigger: epic-retrospective + - trigger: ER or fuzzy match on epic-retrospective workflow: "{project-root}/_bmad/bmm/workflows/4-implementation/retrospective/workflow.yaml" data: "{project-root}/_bmad/_config/agent-manifest.csv" - description: Facilitate team retrospective after an epic is completed (Optional) + description: "[ER] Facilitate team retrospective after an epic is completed (Optional)" - - trigger: correct-course + - trigger: CC or fuzzy match on correct-course workflow: "{project-root}/_bmad/bmm/workflows/4-implementation/correct-course/workflow.yaml" - description: Execute correct-course task (When implementation is off-track) - - - trigger: party-mode - exec: "{project-root}/_bmad/core/workflows/party-mode/workflow.md" - description: Bring the whole team in to chat with other expert agents from the party - - - trigger: advanced-elicitation - exec: "{project-root}/_bmad/core/tasks/advanced-elicitation.xml" - description: Advanced elicitation techniques to challenge the LLM to get better results - web-only: true + description: "[CC] Execute correct-course task (When implementation is off-track)" diff --git a/src/modules/bmm/agents/tea.agent.yaml b/src/modules/bmm/agents/tea.agent.yaml index e5b3d7ce..fa42b41b 100644 --- a/src/modules/bmm/agents/tea.agent.yaml +++ b/src/modules/bmm/agents/tea.agent.yaml @@ -8,18 +8,21 @@ agent: title: Master Test Architect icon: 🧪 module: bmm + hasSidecar: false persona: role: Master Test Architect - identity: Test architect specializing in CI/CD, automated frameworks, and scalable quality gates. + identity: Test architect specializing in API testing, backend services, UI automation, CI/CD pipelines, and scalable quality gates. Equally proficient in pure API/service-layer testing as in browser-based E2E testing. communication_style: "Blends data with gut instinct. 'Strong opinions, weakly held' is their mantra. Speaks in risk calculations and impact assessments." principles: | - Risk-based testing - depth scales with impact - Quality gates backed by data - - Tests mirror usage patterns + - Tests mirror usage patterns (API, UI, or both) - Flakiness is critical technical debt - Tests first AI implements suite validates - Calculate risk vs value for every testing decision + - Prefer lower test levels (unit > integration > E2E) when possible + - API tests are first-class citizens, not just UI support critical_actions: - "Consult {project-root}/_bmad/bmm/testarch/tea-index.csv to select knowledge fragments under knowledge/ and load only the files needed for the current task" @@ -28,43 +31,38 @@ agent: - "Find if this exists, if it does, always treat it as the bible I plan and execute against: `**/project-context.md`" menu: - - trigger: framework + - trigger: WS or fuzzy match on workflow-status + workflow: "{project-root}/_bmad/bmm/workflows/workflow-status/workflow.yaml" + description: "[WS] Get workflow status or initialize a workflow if not already done (optional)" + + - trigger: TF or fuzzy match on test-framework workflow: "{project-root}/_bmad/bmm/workflows/testarch/framework/workflow.yaml" - description: Initialize production-ready test framework architecture + description: "[TF] Initialize production-ready test framework architecture" - - trigger: atdd + - trigger: AT or fuzzy match on atdd workflow: "{project-root}/_bmad/bmm/workflows/testarch/atdd/workflow.yaml" - description: Generate E2E tests first, before starting implementation + description: "[AT] Generate API and/or E2E tests first, before starting implementation" - - trigger: automate + - trigger: TA or fuzzy match on test-automate workflow: "{project-root}/_bmad/bmm/workflows/testarch/automate/workflow.yaml" - description: Generate comprehensive test automation + description: "[TA] Generate comprehensive test automation" - - trigger: test-design + - trigger: TD or fuzzy match on test-design workflow: "{project-root}/_bmad/bmm/workflows/testarch/test-design/workflow.yaml" - description: Create comprehensive test scenarios + description: "[TD] Create comprehensive test scenarios" - - trigger: trace + - trigger: TR or fuzzy match on test-trace workflow: "{project-root}/_bmad/bmm/workflows/testarch/trace/workflow.yaml" - description: Map requirements to tests (Phase 1) and make quality gate decision (Phase 2) + description: "[TR] Map requirements to tests (Phase 1) and make quality gate decision (Phase 2)" - - trigger: nfr-assess + - trigger: NR or fuzzy match on nfr-assess workflow: "{project-root}/_bmad/bmm/workflows/testarch/nfr-assess/workflow.yaml" - description: Validate non-functional requirements + description: "[NR] Validate non-functional requirements" - - trigger: ci + - trigger: CI or fuzzy match on continuous-integration workflow: "{project-root}/_bmad/bmm/workflows/testarch/ci/workflow.yaml" - description: Scaffold CI/CD quality pipeline + description: "[CI] Scaffold CI/CD quality pipeline" - - trigger: test-review + - trigger: RV or fuzzy match on test-review workflow: "{project-root}/_bmad/bmm/workflows/testarch/test-review/workflow.yaml" - description: Review test quality using comprehensive knowledge base and best practices - - - trigger: party-mode - exec: "{project-root}/_bmad/core/workflows/party-mode/workflow.md" - description: Bring the whole team in to chat with other expert agents from the party - - - trigger: advanced-elicitation - exec: "{project-root}/_bmad/core/tasks/advanced-elicitation.xml" - description: Advanced elicitation techniques to challenge the LLM to get better results - web-only: true + description: "[RV] Review test quality using comprehensive knowledge base and best practices" diff --git a/src/modules/bmm/agents/tech-writer.agent.yaml b/src/modules/bmm/agents/tech-writer.agent.yaml index 48b68e83..e8f23cef 100644 --- a/src/modules/bmm/agents/tech-writer.agent.yaml +++ b/src/modules/bmm/agents/tech-writer.agent.yaml @@ -7,6 +7,7 @@ agent: title: Technical Writer icon: 📚 module: bmm + hasSidecar: false persona: role: Technical Documentation Specialist + Knowledge Curator @@ -21,47 +22,34 @@ agent: - "Find if this exists, if it does, always treat it as the bible I plan and execute against: `**/project-context.md`" menu: - - trigger: document-project + - trigger: WS or fuzzy match on workflow-status + workflow: "{project-root}/_bmad/bmm/workflows/workflow-status/workflow.yaml" + description: "[WS] Get workflow status or initialize a workflow if not already done (optional)" + + - trigger: DP or fuzzy match on document-project workflow: "{project-root}/_bmad/bmm/workflows/document-project/workflow.yaml" - description: Comprehensive project documentation (brownfield analysis, architecture scanning) + description: "[DP] Comprehensive project documentation (brownfield analysis, architecture scanning)" - - trigger: generate-mermaid + - trigger: MG or fuzzy match on mermaid-gen action: "Create a Mermaid diagram based on user description. Ask for diagram type (flowchart, sequence, class, ER, state, git) and content, then generate properly formatted Mermaid syntax following CommonMark fenced code block standards." - description: Generate Mermaid diagrams (architecture, sequence, flow, ER, class, state) + description: "[MG] Generate Mermaid diagrams (architecture, sequence, flow, ER, class, state)" - - trigger: create-excalidraw-flowchart + - trigger: EF or fuzzy match on excalidraw-flowchart workflow: "{project-root}/_bmad/bmm/workflows/excalidraw-diagrams/create-flowchart/workflow.yaml" - description: Create Excalidraw flowchart for processes and logic flows + description: "[EF] Create Excalidraw flowchart for processes and logic flows" - - trigger: create-excalidraw-diagram + - trigger: ED or fuzzy match on excalidraw-diagram workflow: "{project-root}/_bmad/bmm/workflows/excalidraw-diagrams/create-diagram/workflow.yaml" - description: Create Excalidraw system architecture or technical diagram + description: "[ED] Create Excalidraw system architecture or technical diagram" - - trigger: create-excalidraw-dataflow + - trigger: DF or fuzzy match on dataflow workflow: "{project-root}/_bmad/bmm/workflows/excalidraw-diagrams/create-dataflow/workflow.yaml" - description: Create Excalidraw data flow diagram + description: "[DF] Create Excalidraw data flow diagram" - - trigger: validate-doc + - trigger: VD or fuzzy match on validate-doc action: "Review the specified document against CommonMark standards, technical writing best practices, and style guide compliance. Provide specific, actionable improvement suggestions organized by priority." - description: Validate documentation against standards and best practices + description: "[VD] Validate documentation against standards and best practices" - - trigger: improve-readme - action: "Analyze the current README file and suggest improvements for clarity, completeness, and structure. Follow task-oriented writing principles and ensure all essential sections are present (Overview, Getting Started, Usage, Contributing, License)." - description: Review and improve README files - - - trigger: explain-concept + - trigger: EC or fuzzy match on explain-concept action: "Create a clear technical explanation with examples and diagrams for a complex concept. Break it down into digestible sections using task-oriented approach. Include code examples and Mermaid diagrams where helpful." - description: Create clear technical explanations with examples - - - trigger: standards-guide - action: "Display the complete documentation standards from {project-root}/_bmad/bmm/data/documentation-standards.md in a clear, formatted way for the user." - description: Show BMAD documentation standards reference (CommonMark, Mermaid, OpenAPI) - - - trigger: party-mode - exec: "{project-root}/_bmad/core/workflows/party-mode/workflow.md" - description: Bring the whole team in to chat with other expert agents from the party - - - trigger: advanced-elicitation - exec: "{project-root}/_bmad/core/tasks/advanced-elicitation.xml" - description: Advanced elicitation techniques to challenge the LLM to get better results - web-only: true + description: "[EC] Create clear technical explanations with examples" diff --git a/src/modules/bmm/agents/ux-designer.agent.yaml b/src/modules/bmm/agents/ux-designer.agent.yaml index 2bf7a844..9b3fead6 100644 --- a/src/modules/bmm/agents/ux-designer.agent.yaml +++ b/src/modules/bmm/agents/ux-designer.agent.yaml @@ -7,6 +7,7 @@ agent: title: UX Designer icon: 🎨 module: bmm + hasSidecar: false persona: role: User Experience Designer + UI Specialist @@ -23,26 +24,14 @@ agent: - "Find if this exists, if it does, always treat it as the bible I plan and execute against: `**/project-context.md`" menu: - - trigger: create-ux-design + - trigger: WS or fuzzy match on workflow-status + workflow: "{project-root}/_bmad/bmm/workflows/workflow-status/workflow.yaml" + description: "[WS] Get workflow status or initialize a workflow if not already done (optional)" + + - trigger: UX or fuzzy match on ux-design exec: "{project-root}/_bmad/bmm/workflows/2-plan-workflows/create-ux-design/workflow.md" - description: Generate a UX Design and UI Plan from a PRD (Recommended before creating Architecture) + description: "[UX] Generate a UX Design and UI Plan from a PRD (Recommended before creating Architecture)" - # TODO: validate-design is not yet implemented - # The validate-workflow: handler type is not recognized by the workflow engine - # See: https://github.com/bmad-code-org/BMAD-METHOD/issues/1075 - # - trigger: validate-design - # workflow: "{project-root}/_bmad/bmm/workflows/2-plan-workflows/create-ux-design/validate-workflow.yaml" - # description: Validate UX Specification and Design Artifacts - - - trigger: create-excalidraw-wireframe + - trigger: XW or fuzzy match on wireframe workflow: "{project-root}/_bmad/bmm/workflows/excalidraw-diagrams/create-wireframe/workflow.yaml" - description: Create website or app wireframe (Excalidraw) - - - trigger: party-mode - exec: "{project-root}/_bmad/core/workflows/party-mode/workflow.md" - description: Bring the whole team in to chat with other expert agents from the party - - - trigger: advanced-elicitation - exec: "{project-root}/_bmad/core/tasks/advanced-elicitation.xml" - description: Advanced elicitation techniques to challenge the LLM to get better results - web-only: true + description: "[XW] Create website or app wireframe (Excalidraw)" diff --git a/src/modules/bmm/docs/agents-guide.md b/src/modules/bmm/docs/agents-guide.md deleted file mode 100644 index 53a7db2d..00000000 --- a/src/modules/bmm/docs/agents-guide.md +++ /dev/null @@ -1,144 +0,0 @@ -# BMM Agents Reference - -Quick reference of what each agent can do based on their available commands. - ---- - -## Analyst (Mary) | `/bmad:bmm:agents:analyst` - -Business analysis and research. - -**Capabilities:** - -- `*workflow-status` - Get workflow status or initialize tracking -- `*brainstorm-project` - Guided brainstorming session -- `*research` - Market, domain, competitive, or technical research -- `*product-brief` - Create a product brief (input for PRD) -- `*document-project` - Document existing brownfield projects -- Party mode and advanced elicitation - ---- - -## PM (John) | `/bmad:bmm:agents:pm` - -Product requirements and planning. - -**Capabilities:** - -- `*workflow-status` - Get workflow status or initialize tracking -- `*create-prd` - Create Product Requirements Document -- `*create-epics-and-stories` - Break PRD into epics and user stories (after Architecture) -- `*implementation-readiness` - Validate PRD, UX, Architecture, Epics alignment -- `*correct-course` - Course correction during implementation -- Party mode and advanced elicitation - ---- - -## Architect (Winston) | `/bmad:bmm:agents:architect` - -System architecture and technical design. - -**Capabilities:** - -- `*workflow-status` - Get workflow status or initialize tracking -- `*create-architecture` - Create architecture document to guide development -- `*implementation-readiness` - Validate PRD, UX, Architecture, Epics alignment -- `*create-excalidraw-diagram` - System architecture or technical diagrams -- `*create-excalidraw-dataflow` - Data flow diagrams -- Party mode and advanced elicitation - ---- - -## SM (Bob) | `/bmad:bmm:agents:sm` - -Sprint planning and story preparation. - -**Capabilities:** - -- `*sprint-planning` - Generate sprint-status.yaml from epic files -- `*create-story` - Create story from epic (prep for development) -- `*validate-create-story` - Validate story quality -- `*epic-retrospective` - Team retrospective after epic completion -- `*correct-course` - Course correction during implementation -- Party mode and advanced elicitation - ---- - -## DEV (Amelia) | `/bmad:bmm:agents:dev` - -Story implementation and code review. - -**Capabilities:** - -- `*dev-story` - Execute story workflow (implementation with tests) -- `*code-review` - Thorough code review - ---- - -## Quick Flow Solo Dev (Barry) | `/bmad:bmm:agents:quick-flow-solo-dev` - -Fast solo development without handoffs. - -**Capabilities:** - -- `*create-tech-spec` - Architect technical spec with implementation-ready stories -- `*quick-dev` - Implement tech spec end-to-end solo -- `*code-review` - Review and improve code - ---- - -## TEA (Murat) | `/bmad:bmm:agents:tea` - -Test architecture and quality strategy. - -**Capabilities:** - -- `*framework` - Initialize production-ready test framework -- `*atdd` - Generate E2E tests first (before implementation) -- `*automate` - Comprehensive test automation -- `*test-design` - Create comprehensive test scenarios -- `*trace` - Map requirements to tests, quality gate decision -- `*nfr-assess` - Validate non-functional requirements -- `*ci` - Scaffold CI/CD quality pipeline -- `*test-review` - Review test quality - ---- - -## UX Designer (Sally) | `/bmad:bmm:agents:ux-designer` - -User experience and UI design. - -**Capabilities:** - -- `*create-ux-design` - Generate UX design and UI plan from PRD -- `*validate-design` - Validate UX specification and design artifacts -- `*create-excalidraw-wireframe` - Create website or app wireframe - ---- - -## Technical Writer (Paige) | `/bmad:bmm:agents:tech-writer` - -Technical documentation and diagrams. - -**Capabilities:** - -- `*document-project` - Comprehensive project documentation (brownfield analysis) -- `*generate-mermaid` - Generate Mermaid diagrams (architecture, sequence, flow, ER, class, state) -- `*create-excalidraw-flowchart` - Process and logic flow visualizations -- `*create-excalidraw-diagram` - System architecture or technical diagrams -- `*create-excalidraw-dataflow` - Data flow visualizations -- `*validate-doc` - Review documentation against standards -- `*improve-readme` - Review and improve README files -- `*explain-concept` - Create clear technical explanations with examples -- `*standards-guide` - Show BMAD documentation standards reference - ---- - -## Universal Commands - -Available to all agents: - -- `*menu` - Redisplay menu options -- `*dismiss` - Dismiss agent - -Party mode is available to most agents for multi-agent collaboration. diff --git a/src/modules/bmm/docs/bmad-quick-flow.md b/src/modules/bmm/docs/bmad-quick-flow.md deleted file mode 100644 index 803f7de9..00000000 --- a/src/modules/bmm/docs/bmad-quick-flow.md +++ /dev/null @@ -1,506 +0,0 @@ -# BMAD Quick Flow - -**Track:** Quick Flow -**Primary Agent:** Quick Flow Solo Dev (Barry) -**Ideal For:** Bug fixes, small features, rapid prototyping - ---- - -## Overview - -BMAD Quick Flow is the fastest path from idea to production in the BMAD Method ecosystem. It's a streamlined 3-step process designed for rapid spec driven development without sacrificing quality. Perfect for experienced teams who need to move fast or for smaller features or 1 off efforts that don't require extensive planning. - -### When to Use Quick Flow - -**Perfect For:** - -- Bug fixes and patches -- Small feature additions -- Proof of concepts and prototypes -- Mid course corrections or additions of something missed in BMM full planning -- Performance optimizations -- API endpoint additions -- UI component enhancements -- Configuration changes -- Internal tools - -**Not Recommended For:** - -- Large-scale system redesigns -- Complex multi-team projects -- New product launches -- Projects requiring extensive UX design -- Enterprise-wide initiatives -- Mission-critical systems with compliance requirements -- Ideas with many 'moving pieces' - ---- - -## The Quick Flow Process - -Utilizing the Quick Flow Solo Dev, this one agent can do it all! - -1. Create an (option) Technical Specification -2. Develop with Tests -3. AI Driven Code Review - -That's it! Lets look at each step in more detail though. - -### Step 1: Optional Technical Specification - -The `create-tech-spec` workflow transforms requirements into implementation-ready specifications. - -**Key Features:** - -- Conversational spec engineering -- Automatic codebase pattern detection -- Context gathering from existing code -- Implementation-ready task breakdown -- Acceptance criteria definition - -**Process Flow:** - -1. **Problem Understanding** - - Greet user and gather requirements - - Ask clarifying questions about scope and constraints - - Check for existing project context - -2. **Code Investigation (Brownfield)** - - Analyze existing codebase patterns - - Document tech stack and conventions - - Identify files to modify and dependencies - -3. **Specification Generation** - - Create structured tech specification - - Define clear tasks and acceptance criteria - - Document technical decisions - - Include development context - -4. **Review and Finalize** - - Present spec for validation - - Make adjustments as needed - - Save to sprint artifacts - -**Output:** `{implementation_artifacts}/tech-spec-{slug}.md` - -### Step 2: Development - -The `quick-dev` workflow executes implementation with flexibility and speed. - -**Two Execution Modes:** - -**Mode A: Tech-Spec Driven** - -```bash -# Execute from tech spec -quick-dev tech-spec-feature-x.md -``` - -- Loads and parses technical specification -- Extracts tasks, context, and acceptance criteria -- Executes all tasks in sequence -- Updates spec status on completion - -**Mode B: Direct Instructions** - -```bash -# Direct development commands -quick-dev "Add password reset to auth service" -quick-dev "Fix the memory leak in image processing" -``` - -- Accepts direct development instructions -- Offers optional planning step -- Executes immediately with minimal friction - -**Development Process:** - -1. **Context Loading** - - Load project context if available - - Understand patterns and conventions - - Identify relevant files and dependencies - -2. **Implementation Loop** - For each task: - - Load relevant files and context - - Implement following established patterns - - Write appropriate tests - - Run and verify tests pass - - Mark task complete and continue - -3. **Continuous Execution** - - Works through all tasks without stopping - - Handles failures by requesting guidance - - Ensures tests pass before continuing - -4. **Verification** - - Confirms all tasks complete - - Validates acceptance criteria - - Updates tech spec status if used - -### Step 3: Optional Code Review - -The `code-review` workflow provides senior developer review of implemented code. - -**When to Use:** - -- Production-critical features -- Security-sensitive implementations -- Performance optimizations -- Team development scenarios -- Learning and knowledge transfer - -**Review Process:** - -1. Load story context and acceptance criteria -2. Analyze code implementation -3. Check against project patterns -4. Validate test coverage -5. Provide structured review notes -6. Suggest improvements if needed - ---- - -## Quick Flow vs Other Tracks - -| Aspect | Quick Flow | BMad Method | Enterprise Method | -| ----------------- | ---------------- | --------------- | ------------------ | -| **Planning** | Minimal/Optional | Structured | Comprehensive | -| **Documentation** | Essential only | Moderate | Extensive | -| **Team Size** | 1-2 developers | 3-7 specialists | 8+ enterprise team | -| **Timeline** | Hours to days | Weeks to months | Months to quarters | -| **Ceremony** | Minimal | Balanced | Full governance | -| **Flexibility** | High | Moderate | Structured | -| **Risk Profile** | Medium | Low | Very Low | - ---- - -## Best Practices - -### Before Starting Quick Flow - -1. **Validate Track Selection** - - Is the feature small enough? - - Do you have clear requirements? - - Is the team comfortable with rapid development? - -2. **Prepare Context** - - Have project documentation ready - - Know your codebase patterns - - Identify affected components upfront - -3. **Set Clear Boundaries** - - Define in-scope and out-of-scope items - - Establish acceptance criteria - - Identify dependencies - -### During Development - -1. **Maintain Velocity** - - Don't over-engineer solutions - - Follow existing patterns - - Keep tests proportional to risk - -2. **Stay Focused** - - Resist scope creep - - Handle edge cases later if possible - - Document decisions briefly - -3. **Communicate Progress** - - Update task status regularly - - Flag blockers immediately - - Share learning with team - -### After Completion - -1. **Quality Gates** - - Ensure tests pass - - Verify acceptance criteria - - Consider optional code review - -2. **Knowledge Transfer** - - Update relevant documentation - - Share key decisions - - Note any discovered patterns - -3. **Production Readiness** - - Verify deployment requirements - - Check monitoring needs - - Plan rollback strategy - ---- - -## Quick Flow Templates - -### Tech Spec Template - -```markdown -# Tech-Spec: {Feature Title} - -**Created:** {date} -**Status:** Ready for Development -**Estimated Effort:** Small (1-2 days) - -## Overview - -### Problem Statement - -{Clear description of what needs to be solved} - -### Solution - -{High-level approach to solving the problem} - -### Scope (In/Out) - -**In:** {What will be implemented} -**Out:** {Explicitly excluded items} - -## Context for Development - -### Codebase Patterns - -{Key patterns to follow, conventions} - -### Files to Reference - -{List of relevant files and their purpose} - -### Technical Decisions - -{Important technical choices and rationale} - -## Implementation Plan - -### Tasks - -- [ ] Task 1: {Specific implementation task} -- [ ] Task 2: {Specific implementation task} -- [ ] Task 3: {Testing and validation} - -### Acceptance Criteria - -- [ ] AC 1: {Given/When/Then format} -- [ ] AC 2: {Given/When/Then format} - -## Additional Context - -### Dependencies - -{External dependencies or prerequisites} - -### Testing Strategy - -{How the feature will be tested} - -### Notes - -{Additional considerations} -``` - -### Quick Dev Commands - -```bash -# From tech spec -quick-dev sprint-artifacts/tech-spec-user-auth.md - -# Direct development -quick-dev "Add CORS middleware to API endpoints" -quick-dev "Fix null pointer exception in user service" -quick-dev "Optimize database query for user list" - -# With optional planning -quick-dev "Implement file upload feature" --plan -``` - ---- - -## Integration with Other Workflows - -### Upgrading Tracks - -If a Quick Flow feature grows in complexity: - -```mermaid -flowchart LR - QF[Quick Flow] --> CHECK{Complexity Increases?} - CHECK -->|Yes| UPGRADE[Upgrade to BMad Method] - CHECK -->|No| CONTINUE[Continue Quick Flow] - - UPGRADE --> PRD[Create PRD] - PRD --> ARCH[Architecture Design] - ARCH --> STORIES[Create Epics/Stories] - STORIES --> SPRINT[Sprint Planning] - - style QF fill:#e1f5fe - style UPGRADE fill:#fff3e0 - style PRD fill:#f3e5f5 - style ARCH fill:#e8f5e9 - style STORIES fill:#f1f8e9 - style SPRINT fill:#e0f2f1 -``` - -### Using Party Mode - -For complex Quick Flow challenges: - -```bash -# Start Barry -/bmad:bmm:agents:quick-flow-solo-dev - -# Begin party mode for collaborative problem-solving -party-mode -``` - -Party mode brings in relevant experts: - -- **Architect** - For design decisions -- **Dev** - For implementation pairing -- **QA** - For test strategy -- **UX Designer** - For user experience -- **Analyst** - For requirements clarity - -### Quality Assurance Integration - -Quick Flow can integrate with TEA agent for automated testing: - -- Test case generation -- Automated test execution -- Coverage analysis -- Test healing - ---- - -## Common Quick Flow Scenarios - -### Scenario 1: Bug Fix - -``` -Requirement: "Users can't reset passwords" -Process: Direct development (no spec needed) -Steps: Investigate → Fix → Test → Deploy -Time: 2-4 hours -``` - -### Scenario 2: Small Feature - -``` -Requirement: "Add export to CSV functionality" -Process: Tech spec → Development → Code review -Steps: Spec → Implement → Test → Review → Deploy -Time: 1-2 days -``` - -### Scenario 3: Performance Fix - -``` -Requirement: "Optimize slow product search query" -Process: Tech spec → Development → Review -Steps: Analysis → Optimize → Benchmark → Deploy -Time: 1 day -``` - -### Scenario 4: API Addition - -``` -Requirement: "Add webhook endpoints for integrations" -Process: Tech spec → Development → Review -Steps: Design → Implement → Document → Deploy -Time: 2-3 days -``` - ---- - -## Metrics and KPIs - -Track these metrics to ensure Quick Flow effectiveness: - -**Velocity Metrics:** - -- Features completed per week -- Average cycle time (hours) -- Bug fix resolution time -- Code review turnaround - -**Quality Metrics:** - -- Defect escape rate -- Test coverage percentage -- Production incident rate -- Code review findings - -**Team Metrics:** - -- Developer satisfaction -- Knowledge sharing frequency -- Process adherence -- Autonomy index - ---- - -## Troubleshooting Quick Flow - -### Common Issues - -**Issue: Scope creep during development** -**Solution:** Refer back to tech spec, explicitly document new requirements - -**Issue: Unknown patterns or conventions** -**Solution:** Use party-mode to bring in architect or senior dev - -**Issue: Testing bottleneck** -**Solution:** Leverage TEA agent for automated test generation - -**Issue: Integration conflicts** -**Solution:** Document dependencies, coordinate with affected teams - -### Emergency Procedures - -**Production Hotfix:** - -1. Create branch from production -2. Quick dev with minimal changes -3. Deploy to staging -4. Quick regression test -5. Deploy to production -6. Merge to main - -**Critical Bug:** - -1. Immediate investigation -2. Party-mode if unclear -3. Quick fix with rollback plan -4. Post-mortem documentation - ---- - -## Related Documentation - -- **[Quick Flow Solo Dev Agent](./quick-flow-solo-dev.md)** - Primary agent for Quick Flow -- **[Agents Guide](./agents-guide.md)** - Complete agent reference -- **[Scale Adaptive System](./scale-adaptive-system.md)** - Track selection guidance -- **[Party Mode](./party-mode.md)** - Multi-agent collaboration -- **[Workflow Implementation](./workflows-implementation.md)** - Implementation details - ---- - -## FAQ - -**Q: How do I know if my feature is too big for Quick Flow?** -A: If it requires more than 3-5 days of work, affects multiple systems significantly, or needs extensive UX design, consider the BMad Method track. - -**Q: Can I switch from Quick Flow to BMad Method mid-development?** -A: Yes, you can upgrade. Create the missing artifacts (PRD, architecture) and transition to sprint-based development. - -**Q: Is Quick Flow suitable for production-critical features?** -A: Yes, with code review. Quick Flow doesn't sacrifice quality, just ceremony. - -**Q: How do I handle dependencies between Quick Flow features?** -A: Document dependencies clearly, consider batching related features, or upgrade to BMad Method for complex interdependencies. - -**Q: Can junior developers use Quick Flow?** -A: Yes, but they may benefit from the structure of BMad Method. Quick Flow assumes familiarity with patterns and autonomy. - ---- - -**Ready to ship fast?** → Start with `/bmad:bmm:agents:quick-flow-solo-dev` diff --git a/src/modules/bmm/docs/brownfield-guide.md b/src/modules/bmm/docs/brownfield-guide.md deleted file mode 100644 index b75d506b..00000000 --- a/src/modules/bmm/docs/brownfield-guide.md +++ /dev/null @@ -1,748 +0,0 @@ -# BMad Method Brownfield Development Guide - -**Complete guide for working with existing codebases** - -**Reading Time:** ~35 minutes - ---- - -## Quick Navigation - -**Jump to:** - -- [Quick Reference](#quick-reference) - Commands and files -- [Common Scenarios](#common-scenarios) - Real-world examples -- [Best Practices](#best-practices) - Success tips - ---- - -## What is Brownfield Development? - -Brownfield projects involve working within existing codebases rather than starting fresh: - -- **Bug fixes** - Single file changes -- **Small features** - Adding to existing modules -- **Feature sets** - Multiple related features -- **Major integrations** - Complex architectural additions -- **System expansions** - Enterprise-scale enhancements - -**Key Difference from Greenfield:** You must understand and respect existing patterns, architecture, and constraints. - -**Core Principle:** AI agents need comprehensive documentation to understand existing code before they can effectively plan or implement changes. - ---- - -## Getting Started - -### Understanding Planning Tracks - -For complete track details, see [Scale Adaptive System](./scale-adaptive-system.md). - -**Brownfield tracks at a glance:** - -| Track | Scope | Typical Stories | Key Difference | -| --------------------- | -------------------------- | --------------- | ----------------------------------------------- | -| **Quick Flow** | Bug fixes, small features | 1-15 | Must understand affected code and patterns | -| **BMad Method** | Feature sets, integrations | 10-50+ | Integrate with existing architecture | -| **Enterprise Method** | Enterprise expansions | 30+ | Full system documentation + compliance required | - -**Note:** Story counts are guidance, not definitions. Tracks are chosen based on planning needs. - -### Track Selection for Brownfield - -When you run `workflow-init`, it handles brownfield intelligently: - -**Step 1: Shows what it found** - -- Old planning docs (PRD, epics, stories) -- Existing codebase - -**Step 2: Asks about YOUR work** - -> "Are these works in progress, previous effort, or proposed work?" - -- **(a) Works in progress** → Uses artifacts to determine level -- **(b) Previous effort** → Asks you to describe NEW work -- **(c) Proposed work** → Uses artifacts as guidance -- **(d) None of these** → You explain your work - -**Step 3: Analyzes your description** - -- Keywords: "fix", "bug" → Quick Flow, "dashboard", "platform" → BMad Method, "enterprise", "multi-tenant" → Enterprise Method -- Complexity assessment -- Confirms suggested track with you - -**Key Principle:** System asks about YOUR current work first, uses old artifacts as context only. - -**Example: Old Complex PRD, New Simple Work** - -``` -System: "Found PRD.md (BMad Method track, 30 stories, 6 months old)" -System: "Is this work in progress or previous effort?" -You: "Previous effort - I'm just fixing a bug now" -System: "Tell me about your current work" -You: "Update payment method enums" -System: "Quick Flow track (tech-spec approach). Correct?" -You: "Yes" -✅ Creates Quick Flow workflow -``` - ---- - -## Documentation: Critical First Step - -🚨 **For brownfield projects: Always ensure adequate AI-usable documentation before planning** - -### Default Recommendation: Run document-project - -**Best practice:** Run `document-project` workflow unless you have **confirmed, trusted, AI-optimized documentation**. - -### Why Document-Project is Almost Always the Right Choice - -Existing documentation often has quality issues that break AI workflows: - -**Common Problems:** - -- **Too Much Information (TMI):** Massive markdown files with 10s or 100s of level 2 sections -- **Out of Date:** Documentation hasn't been updated with recent code changes -- **Wrong Format:** Written for humans, not AI agents (lacks structure, index, clear patterns) -- **Incomplete Coverage:** Missing critical architecture, patterns, or setup info -- **Inconsistent Quality:** Some areas documented well, others not at all - -**Impact on AI Agents:** - -- AI agents hit token limits reading massive files -- Outdated docs cause hallucinations (agent thinks old patterns still apply) -- Missing structure means agents can't find relevant information -- Incomplete coverage leads to incorrect assumptions - -### Documentation Decision Tree - -**Step 1: Assess Existing Documentation Quality** - -Ask yourself: - -- ✅ Is it **current** (updated in last 30 days)? -- ✅ Is it **AI-optimized** (structured with index.md, clear sections, <500 lines per file)? -- ✅ Is it **comprehensive** (architecture, patterns, setup all documented)? -- ✅ Do you **trust** it completely for AI agent consumption? - -**If ANY answer is NO → Run `document-project`** - -**Step 2: Check for Massive Documents** - -If you have documentation but files are huge (>500 lines, 10+ level 2 sections): - -1. **First:** Run `shard-doc` tool to split large files: - - ```bash - # Load BMad Master or any agent - _bmad/core/tools/shard-doc.xml --input docs/massive-doc.md - ``` - - - Splits on level 2 sections by default - - Creates organized, manageable files - - Preserves content integrity - -2. **Then:** Run `index-docs` task to create navigation: - - ```bash - _bmad/core/tasks/index-docs.xml --directory ./docs - ``` - -3. **Finally:** Validate quality - if sharded docs still seem incomplete/outdated → Run `document-project` - -### Four Real-World Scenarios - -| Scenario | You Have | Action | Why | -| -------- | ------------------------------------------ | -------------------------- | --------------------------------------- | -| **A** | No documentation | `document-project` | Only option - generate from scratch | -| **B** | Docs exist but massive/outdated/incomplete | `document-project` | Safer to regenerate than trust bad docs | -| **C** | Good docs but no structure | `shard-doc` → `index-docs` | Structure existing content for AI | -| **D** | Confirmed AI-optimized docs with index.md | Skip Documentation | Rare - only if you're 100% confident | - -### Scenario A: No Documentation (Most Common) - -**Action: Run document-project workflow** - -1. Load Analyst or Technical Writer (Paige) agent -2. Run `*document-project` -3. Choose scan level: - - **Quick** (2-5min): Pattern analysis, no source reading - - **Deep** (10-30min): Reads critical paths - **Recommended** - - **Exhaustive** (30-120min): Reads all files - -**Outputs:** - -- `docs/index.md` - Master AI entry point -- `docs/project-overview.md` - Executive summary -- `docs/architecture.md` - Architecture analysis -- `docs/source-tree-analysis.md` - Directory structure -- Additional files based on project type (API, web app, etc.) - -### Scenario B: Docs Exist But Quality Unknown/Poor (Very Common) - -**Action: Run document-project workflow (regenerate)** - -Even if `docs/` folder exists, if you're unsure about quality → **regenerate**. - -**Why regenerate instead of index?** - -- Outdated docs → AI makes wrong assumptions -- Incomplete docs → AI invents missing information -- TMI docs → AI hits token limits, misses key info -- Human-focused docs → Missing AI-critical structure - -**document-project** will: - -- Scan actual codebase (source of truth) -- Generate fresh, accurate documentation -- Structure properly for AI consumption -- Include only relevant, current information - -### Scenario C: Good Docs But Needs Structure - -**Action: Shard massive files, then index** - -If you have **good, current documentation** but it's in massive files: - -**Step 1: Shard large documents** - -```bash -# For each massive doc (>500 lines or 10+ level 2 sections) -_bmad/core/tools/shard-doc.xml \ - --input docs/api-documentation.md \ - --output docs/api/ \ - --level 2 # Split on ## headers (default) -``` - -**Step 2: Generate index** - -```bash -_bmad/core/tasks/index-docs.xml --directory ./docs -``` - -**Step 3: Validate** - -- Review generated `docs/index.md` -- Check that sharded files are <500 lines each -- Verify content is current and accurate -- **If anything seems off → Run document-project instead** - -### Scenario D: Confirmed AI-Optimized Documentation (Rare) - -**Action: Skip Documentation** - -Only skip if ALL conditions met: - -- ✅ `docs/index.md` exists and is comprehensive -- ✅ Documentation updated within last 30 days -- ✅ All doc files <500 lines with clear structure -- ✅ Covers architecture, patterns, setup, API surface -- ✅ You personally verified quality for AI consumption -- ✅ Previous AI agents used it successfully - -**If unsure → Run document-project** (costs 10-30 minutes, saves hours of confusion) - -### Why document-project is Critical - -Without AI-optimized documentation, workflows fail: - -- **tech-spec** (Quick Flow) can't auto-detect stack/patterns → Makes wrong assumptions -- **PRD** (BMad Method) can't reference existing code → Designs incompatible features -- **create-architecture** can't build on existing structure → Suggests conflicting patterns -- **create-story** can't provide existing pattern context → Stories lack integration guidance -- **dev-story** invents implementations → Breaks existing integrations - -### Key Principle - -**When in doubt, run document-project.** - -It's better to spend 10-30 minutes generating fresh, accurate docs than to waste hours debugging AI agents working from bad documentation. - ---- - -## Workflow Phases by Track - -### Phase 1: Analysis (Optional) - -**Workflows:** - -- `brainstorm-project` - Solution exploration -- `research` - Technical/market research -- `product-brief` - Strategic planning (BMad Method/Enterprise tracks only) - -**When to use:** Complex features, technical decisions, strategic additions - -**When to skip:** Bug fixes, well-understood features, time-sensitive changes - -See the [Workflows section in BMM README](../README.md) for details. - -### Phase 2: Planning (Required) - -**Planning approach adapts by track:** - -**Quick Flow:** Use `tech-spec` workflow - -- Creates tech-spec.md -- Auto-detects existing stack (brownfield) -- Confirms conventions with you -- Generates implementation-ready stories - -**BMad Method/Enterprise:** Use `prd` workflow - -- Creates PRD.md with FRs/NFRs only -- References existing architecture -- Plans integration points -- Epics+Stories created AFTER architecture phase - -**Brownfield-specific:** See [Scale Adaptive System](./scale-adaptive-system.md) for complete workflow paths by track. - -### Phase 3: Solutioning (BMad Method/Enterprise Only) - -**Critical for brownfield:** - -- Review existing architecture FIRST -- Document integration points explicitly -- Plan backward compatibility -- Consider migration strategy - -**Workflows:** - -- `create-architecture` - Extend architecture docs (BMad Method/Enterprise) -- `create-epics-and-stories` - Create epics and stories AFTER architecture -- `implementation-readiness` - Validate before implementation (BMad Method/Enterprise) - -### Phase 4: Implementation (All Tracks) - -**Sprint-based development through story iteration:** - -```mermaid -flowchart TD - SPRINT[sprint-planning
Initialize tracking] - CREATE[create-story] - DEV[dev-story] - REVIEW[code-review] - CHECK{More stories?} - RETRO[retrospective
Per epic] - - SPRINT --> CREATE - CREATE --> DEV - DEV --> REVIEW - REVIEW --> CHECK - CHECK -->|Yes| CREATE - CHECK -->|No| RETRO - - style SPRINT fill:#bfb,stroke:#333,stroke-width:2px,color:#000 - style RETRO fill:#fbf,stroke:#333,stroke-width:2px,color:#000 -``` - -**Status Progression:** - -- Epic: `backlog → in-progress → done` -- Story: `backlog → ready-for-dev → in-progress → review → done` - -**Brownfield-Specific Implementation Tips:** - -1. **Respect existing patterns** - Follow established conventions -2. **Test integration thoroughly** - Validate interactions with existing code -3. **Use feature flags** - Enable gradual rollout - ---- - -## Best Practices - -### 1. Always Document First - -Even if you know the code, AI agents need `document-project` output for context. Run it before planning. - -### 2. Be Specific About Current Work - -When workflow-init asks about your work: - -- ✅ "Update payment method enums to include Apple Pay" -- ❌ "Fix stuff" - -### 3. Choose Right Documentation Approach - -- **Has good docs, no index?** → Run `index-docs` task (fast) -- **No docs or need codebase analysis?** → Run `document-project` (Deep scan) - -### 4. Respect Existing Patterns - -Tech-spec and create-story workflows will detect conventions from existing documentation. Follow them unless explicitly modernizing. - -### 5. Plan Integration Points Explicitly - -Document in tech-spec/architecture: - -- Which existing modules you'll modify -- What APIs/services you'll integrate with -- How data flows between new and existing code - -### 6. Design for Gradual Rollout - -- Use feature flags for new functionality -- Plan rollback strategies -- Maintain backward compatibility -- Create migration scripts if needed - -### 7. Test Integration Thoroughly - -- Regression testing of existing features -- Integration point validation -- Performance impact assessment -- API contract verification - -### 8. Use Sprint Planning Effectively - -- Run `sprint-planning` at Phase 4 start -- Context epics before creating stories -- Update `sprint-status.yaml` as work progresses - -### 9. Learn Continuously - -- Run `retrospective` after each epic -- Incorporate learnings into next stories -- Update discovered patterns -- Share insights across team - ---- - -## Common Scenarios - -### Scenario 1: Bug Fix (Quick Flow) - -**Situation:** Authentication token expiration causing logout issues - -**Track:** Quick Flow - -**Workflow:** - -1. **Document:** Skip if auth system documented, else run `document-project` (Quick scan) -2. **Plan:** Load PM → run `tech-spec` - - Analyzes bug - - Detects stack (Express, Jest) - - Confirms conventions - - Creates tech-spec.md + story -3. **Implement:** Load DEV → run `dev-story` -4. **Review:** Load DEV → run `code-review` - -**Time:** 2-4 hours - ---- - -### Scenario 2: Small Feature (Quick Flow) - -**Situation:** Add "forgot password" to existing auth system - -**Track:** Quick Flow - -**Workflow:** - -1. **Document:** Run `document-project` (Deep scan of auth module if not documented) -2. **Plan:** Load PM → run `tech-spec` - - Detects Next.js 13.4, NextAuth.js - - Analyzes existing auth patterns - - Confirms conventions - - Creates tech-spec.md + epic + 3-5 stories -3. **Implement:** Load SM → `sprint-planning` → `create-story` - Load DEV → `dev-story` for each story -4. **Review:** Load DEV → `code-review` - -**Time:** 1-3 days - ---- - -### Scenario 3: Feature Set (BMad Method) - -**Situation:** Add user dashboard with analytics, preferences, activity - -**Track:** BMad Method - -**Workflow:** - -1. **Document:** Run `document-project` (Deep scan) - Critical for understanding existing UI patterns -2. **Analyze:** Load Analyst → `research` (if evaluating analytics libraries) -3. **Plan:** Load PM → `prd` (creates FRs/NFRs) -4. **Solution:** Load Architect → `create-architecture` → `create-epics-and-stories` → `implementation-readiness` -5. **Implement:** Sprint-based (10-15 stories) - - Load SM → `sprint-planning` - - Load SM → `create-story` per story - - Load DEV → `dev-story` per story -6. **Review:** Per story completion - -**Time:** 1-2 weeks - ---- - -### Scenario 4: Complex Integration (BMad Method) - -**Situation:** Add real-time collaboration to document editor - -**Track:** BMad Method - -**Workflow:** - -1. **Document:** Run `document-project` (Exhaustive if not documented) - **Mandatory** -2. **Analyze:** Load Analyst → `research` (WebSocket vs WebRTC vs CRDT) -3. **Plan:** Load PM → `prd` (creates FRs/NFRs) -4. **Solution:** - - Load Architect → `create-architecture` (extend for real-time layer) - - Load Architect → `create-epics-and-stories` - - Load Architect → `implementation-readiness` -5. **Implement:** Sprint-based (20-30 stories) - -**Time:** 3-6 weeks - ---- - -### Scenario 5: Enterprise Expansion (Enterprise Method) - -**Situation:** Add multi-tenancy to single-tenant SaaS platform - -**Track:** Enterprise Method - -**Workflow:** - -1. **Document:** Run `document-project` (Exhaustive) - **Mandatory** -2. **Analyze:** **Required** - - `brainstorm-project` - Explore multi-tenancy approaches - - `research` - Database sharding, tenant isolation, pricing - - `product-brief` - Strategic document -3. **Plan:** Load PM → `prd` (comprehensive FRs/NFRs) -4. **Solution:** - - `create-architecture` - Full system architecture including multi-tenancy design - - `create-epics-and-stories` - Create epics and stories - - `implementation-readiness` - Final validation before implementation -5. **Implement:** Phased sprint-based (50+ stories) - -**Time:** 3-6 months - ---- - -## Troubleshooting - -### AI Agents Lack Codebase Understanding - -**Symptoms:** - -- Suggestions don't align with existing patterns -- Ignores available components -- Doesn't reference existing code - -**Solution:** - -1. Run `document-project` with Deep scan -2. Verify `docs/index.md` exists -3. Check documentation completeness -4. Run deep-dive on specific areas if needed - -### Have Documentation But Agents Can't Find It - -**Symptoms:** - -- README.md, ARCHITECTURE.md exist -- AI agents ask questions already answered -- No `docs/index.md` file - -**Solution:** - -- **Quick fix:** Run `index-docs` task (2-5min) -- **Comprehensive:** Run `document-project` workflow (10-30min) - -### Integration Points Unclear - -**Symptoms:** - -- Not sure how to connect new code to existing -- Unsure which files to modify - -**Solution:** - -1. Ensure `document-project` captured existing architecture -2. Check story files created by `create-story` - should include integration context -3. In tech-spec/architecture - explicitly document: - - Which existing modules to modify - - What APIs/services to integrate with - - Data flow between new and existing code -4. Review architecture document for integration guidance - -### Existing Tests Breaking - -**Symptoms:** - -- Regression test failures -- Previously working functionality broken - -**Solution:** - -1. Review changes against existing patterns -2. Verify API contracts unchanged (unless intentionally versioned) -3. Run `test-review` workflow (TEA agent) -4. Add regression testing to DoD -5. Consider feature flags for gradual rollout - -### Inconsistent Patterns Being Introduced - -**Symptoms:** - -- New code style doesn't match existing -- Different architectural approach - -**Solution:** - -1. Check convention detection (Quick Spec Flow should detect patterns) -2. Review documentation - ensure `document-project` captured patterns -3. Use `create-story` workflow - it loads context from existing documentation -4. Add to code-review checklist: pattern adherence, convention consistency -5. Run retrospective to identify deviations early - ---- - -## Quick Reference - -### Commands by Phase - -```bash -# Documentation (If Needed) -# Analyst agent: -document-project # Create comprehensive docs (10-30min) -# OR load index-docs task for existing docs (2-5min) - -# Phase 1: Analysis (Optional) -# Analyst agent: -brainstorm-project # Explore solutions -research # Gather data -product-brief # Strategic planning (BMad Method/Enterprise only) - -# Phase 2: Planning (Required) -# PM agent: -tech-spec # Quick Flow track -prd # BMad Method/Enterprise tracks - -# Phase 3: Solutioning (BMad Method/Enterprise) -# Architect agent: -create-architecture # Create/extend architecture -create-epics-and-stories # Create epics and stories (after architecture) -implementation-readiness # Final validation - -# Phase 4: Implementation (All Tracks) -# SM agent: -sprint-planning # Initialize tracking -create-story # Create story - -# DEV agent: -dev-story # Implement -code-review # Review - -# SM agent: -retrospective # After epic -correct-course # If issues -``` - -### Key Files - -**Documentation Output:** - -- `docs/index.md` - **Master AI entry point (REQUIRED)** -- `docs/project-overview.md` -- `docs/architecture.md` -- `docs/source-tree-analysis.md` - -**Phase 1-4 Tracking:** - -- `docs/bmm-workflow-status.yaml` - Progress tracker - -**Phase 2 Planning:** - -- `docs/tech-spec.md` (Quick Flow track) -- `docs/PRD.md` (BMad Method/Enterprise tracks - FRs/NFRs only) - -**Phase 3 Solutioning:** - -- Epic breakdown (created after architecture) - -**Phase 3 Architecture:** - -- `docs/architecture.md` (BMad Method/Enterprise tracks) -- `docs/epics.md` + epic folders (from create-epics-and-stories) - -**Phase 4 Implementation:** - -- `docs/sprint-status.yaml` - **Single source of truth** -- `docs/epic-{n}-context.md` -- `docs/stories/{epic}-{story}-{title}.md` -- `docs/stories/{epic}-{story}-{title}-context.md` - -### Decision Flowchart - -```mermaid -flowchart TD - START([Brownfield Project]) - CHECK{Has docs/
index.md?} - - START --> CHECK - CHECK -->|No| DOC[document-project
Deep scan] - CHECK -->|Yes| TRACK{What Track?} - - DOC --> TRACK - - TRACK -->|Quick Flow| TS[tech-spec] - TRACK -->|BMad Method| PRD[prd → architecture] - TRACK -->|Enterprise| PRD2[prd → arch + security/devops] - - TS --> IMPL[Phase 4
Implementation] - PRD --> IMPL - PRD2 --> IMPL - - style START fill:#f9f,stroke:#333,stroke-width:2px,color:#000 - style DOC fill:#ffb,stroke:#333,stroke-width:2px,color:#000 - style IMPL fill:#bfb,stroke:#333,stroke-width:2px,color:#000 -``` - ---- - -## Prevention Tips - -**Avoid issues before they happen:** - -1. ✅ **Always run document-project for brownfield** - Saves context issues later -2. ✅ **Use fresh chats for complex workflows** - Prevents hallucinations -3. ✅ **Verify files exist before workflows** - Check PRD, epics, stories present -4. ✅ **Read agent menu first** - Confirm agent has the workflow -5. ✅ **Start with simpler track if unsure** - Easy to upgrade (Quick Flow → BMad Method) -6. ✅ **Keep status files updated** - Manual updates when needed -7. ✅ **Run retrospectives after epics** - Catch issues early -8. ✅ **Follow phase sequence** - Don't skip required phases - ---- - -## Related Documentation - -- **[Scale Adaptive System](./scale-adaptive-system.md)** - Understanding tracks and complexity -- **[Quick Spec Flow](./quick-spec-flow.md)** - Fast-track for Quick Flow -- **[Quick Start Guide](./quick-start.md)** - Getting started with BMM -- **[Glossary](./glossary.md)** - Key terminology -- **[FAQ](./faq.md)** - Common questions -- **[Troubleshooting](./troubleshooting.md)** - Problem resolution -- **[Workflow Documentation](./index.md#-workflow-guides)** - Complete workflow reference - ---- - -## Support and Resources - -**Community:** - -- [Discord](https://discord.gg/gk8jAdXWmj) - #general-dev, #bugs-issues -- [GitHub Issues](https://github.com/bmad-code-org/BMAD-METHOD/issues) -- [YouTube Channel](https://www.youtube.com/@BMadCode) - -**Documentation:** - -- **[Test Architect Guide](./test-architecture.md)** - Comprehensive testing strategy -- [BMM Module README](../README.md) - Complete module and workflow reference - ---- - -_Brownfield development is about understanding and respecting what exists while thoughtfully extending it._ diff --git a/src/modules/bmm/docs/enterprise-agentic-development.md b/src/modules/bmm/docs/enterprise-agentic-development.md deleted file mode 100644 index f12a3ec1..00000000 --- a/src/modules/bmm/docs/enterprise-agentic-development.md +++ /dev/null @@ -1,686 +0,0 @@ -# Enterprise Agentic Development with BMad Method - -**The paradigm shift: From team-based story parallelism to individual epic ownership** - -**Reading Time:** ~18 minutes - ---- - -## Table of Contents - -- [The Paradigm Shift](#the-paradigm-shift) -- [The Evolving Role of Product Managers and UX Designers](#the-evolving-role-of-product-managers-and-ux-designers) -- [How BMad Method Enables PM/UX Technical Evolution](#how-bmad-method-enables-pmux-technical-evolution) -- [Team Collaboration Patterns](#team-collaboration-patterns) -- [Work Distribution Strategies](#work-distribution-strategies) -- [Enterprise Configuration with Git Submodules](#enterprise-configuration-with-git-submodules) -- [Best Practices](#best-practices) -- [Common Scenarios](#common-scenarios) - ---- - -## The Paradigm Shift - -### Traditional Agile: Team-Based Story Parallelism - -- **Epic duration:** 4-12 weeks across multiple sprints -- **Story duration:** 2-5 days per developer -- **Team size:** 5-9 developers working on same epic -- **Parallelization:** Multiple devs on stories within single epic -- **Coordination:** Constant - daily standups, merge conflicts, integration overhead - -**Example:** Payment Processing Epic - -- Sprint 1-2: Backend API (Dev A) -- Sprint 1-2: Frontend UI (Dev B) -- Sprint 2-3: Testing (Dev C) -- **Result:** 6-8 weeks, 3 developers, high coordination - -### Agentic Development: Individual Epic Ownership - -- **Epic duration:** Hours to days (not weeks) -- **Story duration:** 30 min to 4 hours with AI agent -- **Team size:** 1 developer + AI agents completes full epics -- **Parallelization:** Developers work on separate epics -- **Coordination:** Minimal - epic boundaries, async updates - -**Same Example:** Payment Processing Epic - -- Day 1 AM: Backend API stories (1 dev + agent, 3-4 stories) -- Day 1 PM: Frontend UI stories (same dev + agent, 2-3 stories) -- Day 2: Testing & deployment (same dev + agent, 2 stories) -- **Result:** 1-2 days, 1 developer, minimal coordination - -### The Core Difference - -**What changed:** AI agents collapse story duration from days to hours, making **epic-level ownership** practical. - -**Impact:** Single developer with BMad Method can deliver in 1 day what previously required full team and multiple sprints. - ---- - -## The Evolving Role of Product Managers and UX Designers - -### The Future is Now - -Product Managers and UX Designers are undergoing **the most significant transformation since the creation of these disciplines**. The emergence of AI agents is creating a new breed of technical product leaders who translate vision directly into working code. - -### From Spec Writers to Code Orchestrators - -**Traditional PM/UX (Pre-2025):** - -- Write PRDs, hand off to engineering -- Wait weeks/months for implementation -- Limited validation capabilities -- Non-technical role, heavy on process - -**Emerging PM/UX (2025+):** - -- Write AI-optimized PRDs that **feed agentic pipelines directly** -- Generate working prototypes in 10-15 minutes -- Review pull requests from AI agents -- Technical fluency is **table stakes**, not optional -- Orchestrate cloud-based AI agent teams - -### Industry Research (November 2025) - -- **56% of product professionals** cite AI/ML as top focus -- **AI agents automating** customer discovery, PRD creation, status reporting -- **PRD-to-Code automation** enables PMs to build and deploy apps in 10-15 minutes -- **By 2026**: Roles converging into "Full-Stack Product Lead" (PM + Design + Engineering) -- **Very high salaries** for AI agent PMs who orchestrate autonomous dev systems - -### Required Skills for Modern PMs/UX - -1. **AI Prompt Engineering** - Writing PRDs AI agents can execute autonomously -2. **Coding Literacy** - Understanding code structure, APIs, data flows (not production coding) -3. **Agentic Workflow Design** - Orchestrating multi-agent systems (planning → design → dev) -4. **Technical Architecture** - Reasoning frameworks, memory systems, tool integration -5. **Data Literacy** - Interpreting model outputs, spotting trends, identifying gaps -6. **Code Review** - Evaluating AI-generated PRs for correctness and vision alignment - -### What Remains Human - -**AI Can't Replace:** - -- Product vision (market dynamics, customer pain, strategic positioning) -- Empathy (deep user research, emotional intelligence, stakeholder management) -- Creativity (novel problem-solving, disruptive thinking) -- Judgment (prioritization decisions, trade-off analysis) -- Ethics (responsible AI use, privacy, accessibility) - -**What Changes:** - -- PMs/UX spend **more time on human elements** (AI handles routine execution) -- Barrier between "thinking" and "building" collapses -- Product leaders become **builder-thinkers**, not just spec writers - -### The Convergence - -- **PMs learning to code** with GitHub Copilot, Cursor, v0 -- **UX designers generating code** with UXPin Merge, Figma-to-code tools -- **Developers becoming orchestrators** reviewing AI output vs writing from scratch - -**The Bottom Line:** By 2026, successful PMs/UX will fluently operate in both vision and execution. **BMad Method provides the structured framework to make this transition.** - ---- - -## How BMad Method Enables PM/UX Technical Evolution - -BMad Method is specifically designed to position PMs and UX designers for this future. - -### 1. AI-Executable PRD Generation - -**PM Workflow:** - -```bash -bmad pm *create-prd -``` - -**BMad produces:** - -- Structured, machine-readable requirements -- Functional Requirements (FRs) with testable acceptance criteria -- Non-Functional Requirements (NFRs) with measurable targets -- Technical context for AI agents - -**Why it matters:** Traditional PRDs are human-readable prose. BMad PRDs are **AI-executable requirement specifications**. - -**PM Value:** Clear requirements that feed into architecture decisions, then into story breakdown. No ambiguity. - -### 2. Human-in-the-Loop Architecture - -**Architect/PM Workflow:** - -```bash -bmad architect *create-architecture -``` - -**BMad produces:** - -- System architecture aligned with PRD's FRs/NFRs -- Architecture Decision Records (ADRs) -- FR/NFR-specific technical guidance -- Integration patterns and standards - -**Why it matters:** PMs can **understand and validate** technical decisions. Architecture is conversational, not template-driven. - -**PM Value:** Technical fluency built through guided architecture process. PMs learn while creating. - -### 3. Automated Epic/Story Breakdown (AFTER Architecture) - -**PM Workflow:** - -```bash -bmad pm *create-epics-and-stories -``` - -**V6 Improvement:** Epics and stories are now created AFTER architecture for better quality. The workflow uses both PRD (FRs/NFRs) and Architecture to create technically-informed stories. - -**BMad produces:** - -- Epic files with clear objectives -- Story files with acceptance criteria, context, technical guidance -- Priority assignments (P0-P3) -- Dependency mapping informed by architectural decisions - -**Why it matters:** Stories become **work packages for cloud AI agents**. Each story is self-contained with full context AND aligned with architecture. - -**PM Value:** No more "story refinement sessions" with engineering. Stories are technically grounded from the start. - -### 4. Cloud Agentic Pipeline (Emerging Pattern) - -**Current State (2025):** - -``` -PM writes BMad PRD (FRs/NFRs) - ↓ -Architect creates architecture (technical decisions) - ↓ -create-epics-and-stories generates story queue (informed by architecture) - ↓ -Stories loaded by human developers + BMad agents - ↓ -Developers create PRs - ↓ -PM/Team reviews PRs - ↓ -Merge and deploy -``` - -**Near Future (2026):** - -``` -PM writes BMad PRD (FRs/NFRs) - ↓ -Architecture auto-generated with PM approval - ↓ -create-epics-and-stories generates story queue (informed by architecture) - ↓ -Stories automatically fed to cloud AI agent pool - ↓ -AI agents implement stories in parallel - ↓ -AI agents create pull requests - ↓ -PM/UX/Senior Devs review PRs - ↓ -Approved PRs auto-merge - ↓ -Continuous deployment to production -``` - -**Time Savings:** - -- **Traditional:** PM writes spec → 2-4 weeks engineering → review → deploy (6-8 weeks) -- **BMad Agentic:** PM writes PRD → AI agents implement → review PRs → deploy (2-5 days) - -### 5. UX Design Integration - -**UX Designer Workflow:** - -```bash -bmad ux *create-ux-design -``` - -**BMad produces:** - -- Component-based design system -- Interaction patterns aligned with tech stack -- Accessibility guidelines -- Responsive design specifications - -**Why it matters:** Design specs become **implementation-ready** for AI agents. No "lost in translation" between design and dev. - -**UX Value:** Designs validated through working prototypes, not static mocks. Technical understanding built through BMad workflows. - -### 6. PM Technical Skills Development - -**BMad teaches PMs technical skills through:** - -- **Conversational workflows** - No pre-requisite knowledge, learn by doing -- **Architecture facilitation** - Understand system design through guided questions -- **Story context assembly** - See how code patterns inform implementation -- **Code review workflows** - Learn to evaluate code quality, patterns, standards - -**Example:** PM runs `create-architecture` workflow: - -- BMad asks about scale, performance, integrations -- PM answers business questions -- BMad explains technical implications -- PM learns architecture concepts while making decisions - -**Result:** PMs gain **working technical knowledge** without formal CS education. - -### 7. Organizational Leverage - -**Traditional Model:** - -- 1 PM → supports 5-9 developers → delivers 1-2 features/quarter - -**BMad Agentic Model:** - -- 1 PM → writes BMad PRD → 20-50 AI agents execute stories in parallel → delivers 5-10 features/quarter - -**Leverage multiplier:** 5-10× with same PM headcount. - -### 8. Quality Consistency - -**BMad ensures:** - -- AI agents follow architectural patterns consistently -- Code standards applied uniformly -- PRD traceability throughout implementation (via acceptance criteria) -- No "telephone game" between PM, design, and dev - -**PM Value:** What gets built **matches what was specified**, drastically reducing rework. - -### 9. Rapid Prototyping for Validation - -**PM Workflow (with BMad + Cursor/v0):** - -1. Use BMad to generate PRD structure and requirements -2. Extract key user flow from PRD -3. Feed to Cursor/v0 with BMad context -4. Working prototype in 10-15 minutes -5. Validate with users **before** committing to full development - -**Traditional:** Months of development to validate idea -**BMad Agentic:** Hours of development to validate idea - -### 10. Career Path Evolution - -**BMad positions PMs for emerging roles:** - -- **AI Agent Product Manager** - Orchestrate autonomous development systems -- **Full-Stack Product Lead** - Oversee product, design, engineering with AI leverage -- **Technical Product Strategist** - Bridge business vision and technical execution - -**Hiring advantage:** PMs using BMad demonstrate: - -- Technical fluency (can read architecture, validate tech decisions) -- AI-native workflows (structured requirements, agentic orchestration) -- Results (ship 5-10× faster than peers) - ---- - -## Team Collaboration Patterns - -### Old Pattern: Story Parallelism - -**Traditional Agile:** - -``` -Epic: User Dashboard (8 weeks) -├─ Story 1: Backend API (Dev A, Sprint 1-2) -├─ Story 2: Frontend Layout (Dev B, Sprint 1-2) -├─ Story 3: Data Viz (Dev C, Sprint 2-3) -└─ Story 4: Integration Testing (Team, Sprint 3-4) - -Challenge: Coordination overhead, merge conflicts, integration issues -``` - -### New Pattern: Epic Ownership - -**Agentic Development:** - -``` -Project: Analytics Platform (2-3 weeks) - -Developer A: -└─ Epic 1: User Dashboard (3 days, 12 stories sequentially with AI) - -Developer B: -└─ Epic 2: Admin Panel (4 days, 15 stories sequentially with AI) - -Developer C: -└─ Epic 3: Reporting Engine (5 days, 18 stories sequentially with AI) - -Benefit: Minimal coordination, epic-level ownership, clear boundaries -``` - ---- - -## Work Distribution Strategies - -### Strategy 1: Epic-Based (Recommended) - -**Best for:** 2-10 developers - -**Approach:** Each developer owns complete epics, works sequentially through stories - -**Example:** - -```yaml -epics: - - id: epic-1 - title: Payment Processing - owner: alice - stories: 8 - estimate: 2 days - - - id: epic-2 - title: User Dashboard - owner: bob - stories: 12 - estimate: 3 days -``` - -**Benefits:** Clear ownership, minimal conflicts, epic cohesion, reduced coordination - -### Strategy 2: Layer-Based - -**Best for:** Full-stack apps, specialized teams - -**Example:** - -``` -Frontend Dev: Epic 1 (Product Catalog UI), Epic 3 (Cart UI) -Backend Dev: Epic 2 (Product API), Epic 4 (Cart Service) -``` - -**Benefits:** Developers in expertise area, true parallel work, clear API contracts - -**Requirements:** Strong architecture phase, clear API contracts upfront - -### Strategy 3: Feature-Based - -**Best for:** Large teams (10+ developers) - -**Example:** - -``` -Team A (2 devs): Payments feature (4 epics) -Team B (2 devs): User Management feature (3 epics) -Team C (2 devs): Analytics feature (3 epics) -``` - -**Benefits:** Feature team autonomy, domain expertise, scalable to large orgs - ---- - -## Enterprise Configuration with Git Submodules - -### The Challenge - -**Problem:** Teams customize BMad (agents, workflows, configs) but don't want personal tooling in main repo. - -**Anti-pattern:** Adding `_bmad/` to `.gitignore` breaks IDE tools, submodule management. - -### The Solution: Git Submodules - -**Benefits:** - -- BMad exists in project but tracked separately -- Each developer controls their own BMad version/config -- Optional team config sharing via submodule repo -- IDE tools maintain proper context - -### Setup (New Projects) - -**1. Create optional team config repo:** - -```bash -git init bmm-config -cd bmm-config -npx bmad-method install -# Customize for team standards -git commit -m "Team BMM config" -git push origin main -``` - -**2. Add submodule to project:** - -```bash -cd /path/to/your-project -git submodule add https://github.com/your-org/bmm-config.git bmad -git commit -m "Add BMM as submodule" -``` - -**3. Team members initialize:** - -```bash -git clone https://github.com/your-org/your-project.git -cd your-project -git submodule update --init --recursive -# Make personal customizations in _bmad/ -``` - -### Daily Workflow - -**Work in main project:** - -```bash -cd /path/to/your-project -# BMad available at ./_bmad/, load agents normally -``` - -**Update personal config:** - -```bash -cd bmad -# Make changes, commit locally, don't push unless sharing -``` - -**Update to latest team config:** - -```bash -cd bmad -git pull origin main -``` - -### Configuration Strategies - -**Option 1: Fully Personal** - No submodule, each dev installs independently, use `.gitignore` - -**Option 2: Team Baseline + Personal** - Submodule has team standards, devs add personal customizations locally - -**Option 3: Full Team Sharing** - All configs in submodule, team collaborates on improvements - ---- - -## Best Practices - -### 1. Epic Ownership - -- **Do:** Assign entire epic to one developer (context → implementation → retro) -- **Don't:** Split epics across multiple developers (coordination overhead, context loss) - -### 2. Dependency Management - -- **Do:** Identify epic dependencies in planning, document API contracts, complete prerequisites first -- **Don't:** Start dependent epic before prerequisite ready, change API contracts without coordination - -### 3. Communication Cadence - -**Traditional:** Daily standups essential -**Agentic:** Lighter coordination - -**Recommended:** - -- Daily async updates ("Epic 1, 60% complete, no blockers") -- Twice-weekly 15min sync -- Epic completion demos -- Sprint retro after all epics complete - -### 4. Branch Strategy - -```bash -feature/epic-1-payment-processing (Alice) -feature/epic-2-user-dashboard (Bob) -feature/epic-3-admin-panel (Carol) - -# PR and merge when epic complete -``` - -### 5. Testing Strategy - -- **Story-level:** Unit tests (DoD requirement, written by agent during dev-story) -- **Epic-level:** Integration tests across stories -- **Project-level:** E2E tests after multiple epics complete - -### 6. Documentation Updates - -- **Real-time:** `sprint-status.yaml` updated by workflows -- **Epic completion:** Update architecture docs, API docs, README if changed -- **Sprint completion:** Incorporate retrospective insights - -### 7. Metrics (Different from Traditional) - -**Traditional:** Story points per sprint, burndown charts -**Agentic:** Epics per week, stories per day, time to epic completion - -**Example velocity:** - -- Junior dev + AI: 1-2 epics/week (8-15 stories) -- Mid-level dev + AI: 2-3 epics/week (15-25 stories) -- Senior dev + AI: 3-5 epics/week (25-40 stories) - ---- - -## Common Scenarios - -### Scenario 1: Startup (2 Developers) - -**Project:** SaaS MVP (Level 3) - -**Distribution:** - -``` -Developer A: -├─ Epic 1: Authentication (3 days) -├─ Epic 3: Payment Integration (2 days) -└─ Epic 5: Admin Dashboard (3 days) - -Developer B: -├─ Epic 2: Core Product Features (4 days) -├─ Epic 4: Analytics (3 days) -└─ Epic 6: Notifications (2 days) - -Total: ~2 weeks -Traditional estimate: 3-4 months -``` - -**BMM Setup:** Direct installation, both use Claude Code, minimal customization - -### Scenario 2: Mid-Size Team (8 Developers) - -**Project:** Enterprise Platform (Level 4) - -**Distribution (Layer-Based):** - -``` -Backend (2 devs): 6 API epics -Frontend (2 devs): 6 UI epics -Full-stack (2 devs): 4 integration epics -DevOps (1 dev): 3 infrastructure epics -QA (1 dev): 1 E2E testing epic - -Total: ~3 weeks -Traditional estimate: 9-12 months -``` - -**BMM Setup:** Git submodule, team config repo, mix of Claude Code/Cursor users - -### Scenario 3: Large Enterprise (50+ Developers) - -**Project:** Multi-Product Platform - -**Organization:** - -- 5 product teams (8-10 devs each) -- 1 platform team (10 devs - shared services) -- 1 infrastructure team (5 devs) - -**Distribution (Feature-Based):** - -``` -Product Team A: Payments (10 epics, 2 weeks) -Product Team B: User Mgmt (12 epics, 2 weeks) -Product Team C: Analytics (8 epics, 1.5 weeks) -Product Team D: Admin Tools (10 epics, 2 weeks) -Product Team E: Mobile (15 epics, 3 weeks) - -Platform Team: Shared Services (continuous) -Infrastructure Team: DevOps (continuous) - -Total: 3-4 months -Traditional estimate: 2-3 years -``` - -**BMM Setup:** Each team has own submodule config, org-wide base config, variety of IDE tools - ---- - -## Summary - -### Key Transformation - -**Work Unit Changed:** - -- **Old:** Story = unit of work assignment -- **New:** Epic = unit of work assignment - -**Why:** AI agents collapse story duration (days → hours), making epic ownership practical. - -### Velocity Impact - -- **Traditional:** Months for epic delivery, heavy coordination -- **Agentic:** Days for epic delivery, minimal coordination -- **Result:** 10-50× productivity gains - -### PM/UX Evolution - -**BMad Method enables:** - -- PMs to write AI-executable PRDs -- UX designers to validate through working prototypes -- Technical fluency without CS degrees -- Orchestration of cloud AI agent teams -- Career evolution to Full-Stack Product Lead - -### Enterprise Adoption - -**Git submodules:** Best practice for BMM management across teams -**Team flexibility:** Mix of tools (Claude Code, Cursor, Windsurf) with shared BMM foundation -**Scalable patterns:** Epic-based, layer-based, feature-based distribution strategies - -### The Future (2026) - -PMs write BMad PRDs → Stories auto-fed to cloud AI agents → Parallel implementation → Human review of PRs → Continuous deployment - -**The future isn't AI replacing PMs—it's AI-augmented PMs becoming 10× more powerful.** - ---- - -## Related Documentation - -- [FAQ](./faq.md) - Common questions -- [Scale Adaptive System](./scale-adaptive-system.md) - Project levels explained -- [Quick Start Guide](./quick-start.md) - Getting started -- [Workflow Documentation](./index.md#-workflow-guides) - Complete workflow reference -- [Agents Guide](./agents-guide.md) - Understanding BMad agents - ---- - -_BMad Method fundamentally changes how PMs work, how teams structure work, and how products get built. Understanding these patterns is essential for enterprise success in the age of AI agents._ diff --git a/src/modules/bmm/docs/faq.md b/src/modules/bmm/docs/faq.md deleted file mode 100644 index f9d9365d..00000000 --- a/src/modules/bmm/docs/faq.md +++ /dev/null @@ -1,542 +0,0 @@ -# BMM Frequently Asked Questions - -Quick answers to common questions about the BMad Method Module. - ---- - -## Table of Contents - -- [Getting Started](#getting-started) -- [Choosing the Right Level](#choosing-the-right-level) -- [Workflows and Phases](#workflows-and-phases) -- [Planning Documents](#planning-documents) -- [Implementation](#implementation) -- [Brownfield Development](#brownfield-development) -- [Tools and Technical](#tools-and-technical) - ---- - -## Getting Started - -### Q: Do I always need to run workflow-init? - -**A:** No, once you learn the flow you can go directly to workflows. However, workflow-init is helpful because it: - -- Determines your project's appropriate level automatically -- Creates the tracking status file -- Routes you to the correct starting workflow - -For experienced users: use the [Quick Reference](./quick-start.md#quick-reference-agent-document-mapping) to go directly to the right agent/workflow. - -### Q: Why do I need fresh chats for each workflow? - -**A:** Context-intensive workflows (like brainstorming, PRD creation, architecture design) can cause AI hallucinations if run in sequence within the same chat. Starting fresh ensures the agent has maximum context capacity for each workflow. This is particularly important for: - -- Planning workflows (PRD, architecture) -- Analysis workflows (brainstorming, research) -- Complex story implementation - -Quick workflows like status checks can reuse chats safely. - -### Q: Can I skip workflow-status and just start working? - -**A:** Yes, if you already know your project level and which workflow comes next. workflow-status is mainly useful for: - -- New projects (guides initial setup) -- When you're unsure what to do next -- After breaks in work (reminds you where you left off) -- Checking overall progress - -### Q: What's the minimum I need to get started? - -**A:** For the fastest path: - -1. Install BMad Method: `npx bmad-method@alpha install` -2. For small changes: Load PM agent → run tech-spec → implement -3. For larger projects: Load PM agent → run prd → architect → implement - -### Q: How do I know if I'm in Phase 1, 2, 3, or 4? - -**A:** Check your `bmm-workflow-status.md` file (created by workflow-init). It shows your current phase and progress. If you don't have this file, you can also tell by what you're working on: - -- **Phase 1** - Brainstorming, research, product brief (optional) -- **Phase 2** - Creating either a PRD or tech-spec (always required) -- **Phase 3** - Architecture design (Level 2-4 only) -- **Phase 4** - Actually writing code, implementing stories - ---- - -## Choosing the Right Level - -### Q: How do I know which level my project is? - -**A:** Use workflow-init for automatic detection, or self-assess using these keywords: - -- **Level 0:** "fix", "bug", "typo", "small change", "patch" → 1 story -- **Level 1:** "simple", "basic", "small feature", "add" → 2-10 stories -- **Level 2:** "dashboard", "several features", "admin panel" → 5-15 stories -- **Level 3:** "platform", "integration", "complex", "system" → 12-40 stories -- **Level 4:** "enterprise", "multi-tenant", "multiple products" → 40+ stories - -When in doubt, start smaller. You can always run create-prd later if needed. - -### Q: Can I change levels mid-project? - -**A:** Yes! If you started at Level 1 but realize it's Level 2, you can run create-prd to add proper planning docs. The system is flexible - your initial level choice isn't permanent. - -### Q: What if workflow-init suggests the wrong level? - -**A:** You can override it! workflow-init suggests a level but always asks for confirmation. If you disagree, just say so and choose the level you think is appropriate. Trust your judgment. - -### Q: Do I always need architecture for Level 2? - -**A:** No, architecture is **optional** for Level 2. Only create architecture if you need system-level design. Many Level 2 projects work fine with just PRD created during planning. - -### Q: What's the difference between Level 1 and Level 2? - -**A:** - -- **Level 1:** 1-10 stories, uses tech-spec (simpler, faster), no architecture -- **Level 2:** 5-15 stories, uses PRD (product-focused), optional architecture - -The overlap (5-10 stories) is intentional. Choose based on: - -- Need product-level planning? → Level 2 -- Just need technical plan? → Level 1 -- Multiple epics? → Level 2 -- Single epic? → Level 1 - ---- - -## Workflows and Phases - -### Q: What's the difference between workflow-status and workflow-init? - -**A:** - -- **workflow-status:** Checks existing status and tells you what's next (use when continuing work) -- **workflow-init:** Creates new status file and sets up project (use when starting new project) - -If status file exists, use workflow-status. If not, use workflow-init. - -### Q: Can I skip Phase 1 (Analysis)? - -**A:** Yes! Phase 1 is optional for all levels, though recommended for complex projects. Skip if: - -- Requirements are clear -- No research needed -- Time-sensitive work -- Small changes (Level 0-1) - -### Q: When is Phase 3 (Architecture) required? - -**A:** - -- **Level 0-1:** Never (skip entirely) -- **Level 2:** Optional (only if system design needed) -- **Level 3-4:** Required (comprehensive architecture mandatory) - -### Q: What happens if I skip a recommended workflow? - -**A:** Nothing breaks! Workflows are guidance, not enforcement. However, skipping recommended workflows (like architecture for Level 3) may cause: - -- Integration issues during implementation -- Rework due to poor planning -- Conflicting design decisions -- Longer development time overall - -### Q: How do I know when Phase 3 is complete and I can start Phase 4? - -**A:** For Level 3-4, run the implementation-readiness workflow. It validates PRD + Architecture + Epics + UX (optional) are aligned before implementation. Pass the gate check = ready for Phase 4. - -### Q: Can I run workflows in parallel or do they have to be sequential? - -**A:** Most workflows must be sequential within a phase: - -- Phase 1: brainstorm → research → product-brief (optional order) -- Phase 2: PRD must complete before moving forward -- Phase 3: architecture → epics+stories → implementation-readiness (sequential) -- Phase 4: Stories within an epic should generally be sequential, but stories in different epics can be parallel if you have capacity - ---- - -## Planning Documents - -### Q: Why no tech-spec at Level 2+? - -**A:** Level 2+ projects need product-level planning (PRD) and system-level design (Architecture), which tech-spec doesn't provide. Tech-spec is too narrow for coordinating multiple features. Instead, Level 2-4 uses: - -- PRD (product vision, functional requirements, non-functional requirements) -- Architecture (system design) -- Epics+Stories (created AFTER architecture is complete) - -### Q: Do I need a PRD for a bug fix? - -**A:** No! Bug fixes are typically Level 0 (single atomic change). Use Quick Spec Flow: - -- Load PM agent -- Run tech-spec workflow -- Implement immediately - -PRDs are for Level 2-4 projects with multiple features requiring product-level coordination. - -### Q: Can I skip the product brief? - -**A:** Yes, product brief is always optional. It's most valuable for: - -- Level 3-4 projects needing strategic direction -- Projects with stakeholders requiring alignment -- Novel products needing market research -- When you want to explore solution space before committing - ---- - -## Implementation - -### Q: Does create-story include implementation context? - -**A:** Yes! The create-story workflow generates story files that include implementation-specific guidance, references existing patterns from your documentation, and provides technical context. The workflow loads your architecture, PRD, and existing project documentation to create comprehensive stories. For Quick Flow projects using tech-spec, the tech-spec itself is already comprehensive, so stories can be simpler. - -### Q: How do I mark a story as done? - -**A:** After dev-story completes and code-review passes: - -1. Open `sprint-status.yaml` (created by sprint-planning) -2. Change the story status from `review` to `done` -3. Save the file - -### Q: Can I work on multiple stories at once? - -**A:** Yes, if you have capacity! Stories within different epics can be worked in parallel. However, stories within the same epic are usually sequential because they build on each other. - -### Q: What if my story takes longer than estimated? - -**A:** That's normal! Stories are estimates. If implementation reveals more complexity: - -1. Continue working until DoD is met -2. Consider if story should be split -3. Document learnings in retrospective -4. Adjust future estimates based on this learning - -### Q: When should I run retrospective? - -**A:** After completing all stories in an epic (when epic is done). Retrospectives capture: - -- What went well -- What could improve -- Technical insights -- Learnings for future epics - -Don't wait until project end - run after each epic for continuous improvement. - ---- - -## Brownfield Development - -### Q: What is brownfield vs greenfield? - -**A:** - -- **Greenfield:** New project, starting from scratch, clean slate -- **Brownfield:** Existing project, working with established codebase and patterns - -### Q: Do I have to run document-project for brownfield? - -**A:** Highly recommended, especially if: - -- No existing documentation -- Documentation is outdated -- AI agents need context about existing code -- Level 2-4 complexity - -You can skip it if you have comprehensive, up-to-date documentation including `docs/index.md`. - -### Q: What if I forget to run document-project on brownfield? - -**A:** Workflows will lack context about existing code. You may get: - -- Suggestions that don't match existing patterns -- Integration approaches that miss existing APIs -- Architecture that conflicts with current structure - -Run document-project and restart planning with proper context. - -### Q: Can I use Quick Spec Flow for brownfield projects? - -**A:** Yes! Quick Spec Flow works great for brownfield. It will: - -- Auto-detect your existing stack -- Analyze brownfield code patterns -- Detect conventions and ask for confirmation -- Generate context-rich tech-spec that respects existing code - -Perfect for bug fixes and small features in existing codebases. - -### Q: How does workflow-init handle brownfield with old planning docs? - -**A:** workflow-init asks about YOUR current work first, then uses old artifacts as context: - -1. Shows what it found (old PRD, epics, etc.) -2. Asks: "Is this work in progress, previous effort, or proposed work?" -3. If previous effort: Asks you to describe your NEW work -4. Determines level based on YOUR work, not old artifacts - -This prevents old Level 3 PRDs from forcing Level 3 workflow for new Level 0 bug fix. - -### Q: What if my existing code doesn't follow best practices? - -**A:** Quick Spec Flow detects your conventions and asks: "Should I follow these existing conventions?" You decide: - -- **Yes** → Maintain consistency with current codebase -- **No** → Establish new standards (document why in tech-spec) - -BMM respects your choice - it won't force modernization, but it will offer it. - ---- - -## Tools and Technical - -### Q: Why are my Mermaid diagrams not rendering? - -**A:** Common issues: - -1. Missing language tag: Use ` ```mermaid` not just ` ``` ` -2. Syntax errors in diagram (validate at mermaid.live) -3. Tool doesn't support Mermaid (check your Markdown renderer) - -All BMM docs use valid Mermaid syntax that should render in GitHub, VS Code, and most IDEs. - -### Q: Can I use BMM with GitHub Copilot / Cursor / other AI tools? - -**A:** Yes! BMM is complementary. BMM handles: - -- Project planning and structure -- Workflow orchestration -- Agent Personas and expertise -- Documentation generation -- Quality gates - -Your AI coding assistant handles: - -- Line-by-line code completion -- Quick refactoring -- Test generation - -Use them together for best results. - -### Q: What IDEs/tools support BMM? - -**A:** BMM requires tools with **agent mode** and access to **high-quality LLM models** that can load and follow complex workflows, then properly implement code changes. - -**Recommended Tools:** - -- **Claude Code** ⭐ **Best choice** - - Sonnet 4.5 (excellent workflow following, coding, reasoning) - - Opus (maximum context, complex planning) - - Native agent mode designed for BMM workflows - -- **Cursor** - - Supports Anthropic (Claude) and OpenAI models - - Agent mode with composer - - Good for developers who prefer Cursor's UX - -- **Windsurf** - - Multi-model support - - Agent capabilities - - Suitable for BMM workflows - -**What Matters:** - -1. **Agent mode** - Can load long workflow instructions and maintain context -2. **High-quality LLM** - Models ranked high on SWE-bench (coding benchmarks) -3. **Model selection** - Access to Claude Sonnet 4.5, Opus, or GPT-4o class models -4. **Context capacity** - Can handle large planning documents and codebases - -**Why model quality matters:** BMM workflows require LLMs that can follow multi-step processes, maintain context across phases, and implement code that adheres to specifications. Tools with weaker models will struggle with workflow adherence and code quality. - -See [IDE Setup Guides](https://github.com/bmad-code-org/BMAD-METHOD/tree/main/docs/ide-info) for configuration specifics. - -### Q: Can I customize agents? - -**A:** Yes! Agents are installed as markdown files with XML-style content (optimized for LLMs, readable by any model). Create customization files in `_bmad/_config/agents/[agent-name].customize.yaml` to override default behaviors while keeping core functionality intact. See agent documentation for customization options. - -**Note:** While source agents in this repo are YAML, they install as `.md` files with XML-style tags - a format any LLM can read and follow. - -### Q: What happens to my planning docs after implementation? - -**A:** Keep them! They serve as: - -- Historical record of decisions -- Onboarding material for new team members -- Reference for future enhancements -- Audit trail for compliance - -For enterprise projects (Level 4), consider archiving completed planning artifacts to keep workspace clean. - -### Q: Can I use BMM for non-software projects? - -**A:** BMM is optimized for software development, but the methodology principles (scale-adaptive planning, just-in-time design, context injection) can apply to other complex project types. You'd need to adapt workflows and agents for your domain. - ---- - -## Advanced Questions - -### Q: What if my project grows from Level 1 to Level 3? - -**A:** Totally fine! When you realize scope has grown: - -1. Run create-prd to add product-level planning -2. Run create-architecture for system design -3. Use existing tech-spec as input for PRD -4. Continue with updated level - -The system is flexible - growth is expected. - -### Q: Can I mix greenfield and brownfield approaches? - -**A:** Yes! Common scenario: adding new greenfield feature to brownfield codebase. Approach: - -1. Run document-project for brownfield context -2. Use greenfield workflows for new feature planning -3. Explicitly document integration points between new and existing -4. Test integration thoroughly - -### Q: How do I handle urgent hotfixes during a sprint? - -**A:** Use correct-course workflow or just: - -1. Save your current work state -2. Load PM agent → quick tech-spec for hotfix -3. Implement hotfix (Level 0 flow) -4. Deploy hotfix -5. Return to original sprint work - -Level 0 Quick Spec Flow is perfect for urgent fixes. - -### Q: What if I disagree with the workflow's recommendations? - -**A:** Workflows are guidance, not enforcement. If a workflow recommends something that doesn't make sense for your context: - -- Explain your reasoning to the agent -- Ask for alternative approaches -- Skip the recommendation if you're confident -- Document why you deviated (for future reference) - -Trust your expertise - BMM supports your decisions. - -### Q: Can multiple developers work on the same BMM project? - -**A:** Yes! But the paradigm is fundamentally different from traditional agile teams. - -**Key Difference:** - -- **Traditional:** Multiple devs work on stories within one epic (months) -- **Agentic:** Each dev owns complete epics (days) - -**In traditional agile:** A team of 5 devs might spend 2-3 months on a single epic, with each dev owning different stories. - -**With BMM + AI agents:** A single dev can complete an entire epic in 1-3 days. What used to take months now takes days. - -**Team Work Distribution:** - -- **Recommended:** Split work by **epic** (not story) -- Each developer owns complete epics end-to-end -- Parallel work happens at epic level -- Minimal coordination needed - -**For full-stack apps:** - -- Frontend and backend can be separate epics (unusual in traditional agile) -- Frontend dev owns all frontend epics -- Backend dev owns all backend epics -- Works because delivery is so fast - -**Enterprise Considerations:** - -- Use **git submodules** for BMM installation (not .gitignore) -- Allows personal configurations without polluting main repo -- Teams may use different AI tools (Claude Code, Cursor, etc.) -- Developers may follow different methods or create custom agents/workflows - -**Quick Tips:** - -- Share `sprint-status.yaml` (single source of truth) -- Assign entire epics to developers (not individual stories) -- Coordinate at epic boundaries, not story level -- Use git submodules for BMM in enterprise settings - -**For comprehensive coverage of enterprise team collaboration, work distribution strategies, git submodule setup, and velocity expectations, see:** - -👉 **[Enterprise Agentic Development Guide](./enterprise-agentic-development.md)** - -### Q: What is party mode and when should I use it? - -**A:** Party mode is a unique multi-agent collaboration feature where ALL your installed agents (19+ from BMM, CIS, BMB, custom modules) discuss your challenges together in real-time. - -**How it works:** - -1. Run `/bmad:core:workflows:party-mode` (or `*party-mode` from any agent) -2. Introduce your topic -3. BMad Master selects 2-3 most relevant agents per message -4. Agents cross-talk, debate, and build on each other's ideas - -**Best for:** - -- Strategic decisions with trade-offs (architecture choices, tech stack, scope) -- Creative brainstorming (game design, product innovation, UX ideation) -- Cross-functional alignment (epic kickoffs, retrospectives, phase transitions) -- Complex problem-solving (multi-faceted challenges, risk assessment) - -**Example parties:** - -- **Product Strategy:** PM + Innovation Strategist (CIS) + Analyst -- **Technical Design:** Architect + Creative Problem Solver (CIS) + Game Architect -- **User Experience:** UX Designer + Design Thinking Coach (CIS) + Storyteller (CIS) - -**Why it's powerful:** - -- Diverse perspectives (technical, creative, strategic) -- Healthy debate reveals blind spots -- Emergent insights from agent interaction -- Natural collaboration across modules - -**For complete documentation:** - -👉 **[Party Mode Guide](./party-mode.md)** - How it works, when to use it, example compositions, best practices - ---- - -## Getting Help - -### Q: Where do I get help if my question isn't answered here? - -**A:** - -1. Search [Complete Documentation](./README.md) for related topics -2. Ask in [Discord Community](https://discord.gg/gk8jAdXWmj) (#general-dev) -3. Open a [GitHub Issue](https://github.com/bmad-code-org/BMAD-METHOD/issues) -4. Watch [YouTube Tutorials](https://www.youtube.com/@BMadCode) - -### Q: How do I report a bug or request a feature? - -**A:** Open a GitHub issue at: - -Please include: - -- BMM version (check your installed version) -- Steps to reproduce (for bugs) -- Expected vs actual behavior -- Relevant workflow or agent involved - ---- - -## Related Documentation - -- [Quick Start Guide](./quick-start.md) - Get started with BMM -- [Glossary](./glossary.md) - Terminology reference -- [Scale Adaptive System](./scale-adaptive-system.md) - Understanding levels -- [Brownfield Guide](./brownfield-guide.md) - Existing codebase workflows - ---- - -**Have a question not answered here?** Please [open an issue](https://github.com/bmad-code-org/BMAD-METHOD/issues) or ask in [Discord](https://discord.gg/gk8jAdXWmj) so we can add it! diff --git a/src/modules/bmm/docs/glossary.md b/src/modules/bmm/docs/glossary.md deleted file mode 100644 index d611b96c..00000000 --- a/src/modules/bmm/docs/glossary.md +++ /dev/null @@ -1,306 +0,0 @@ -# BMM Glossary - -Comprehensive terminology reference for the BMad Method Module. - ---- - -## Navigation - -- [Core Concepts](#core-concepts) -- [Scale and Complexity](#scale-and-complexity) -- [Planning Documents](#planning-documents) -- [Workflow and Phases](#workflow-and-phases) -- [Agents and Roles](#agents-and-roles) -- [Status and Tracking](#status-and-tracking) -- [Project Types](#project-types) -- [Implementation Terms](#implementation-terms) - ---- - -## Core Concepts - -### BMM (BMad Method Module) - -Core orchestration system for AI-driven agile development, providing comprehensive lifecycle management through specialized agents and workflows. - -### BMad Method - -The complete methodology for AI-assisted software development, encompassing planning, architecture, implementation, and quality assurance workflows that adapt to project complexity. - -### Scale-Adaptive System - -BMad Method's intelligent workflow orchestration that automatically adjusts planning depth, documentation requirements, and implementation processes based on project needs through three distinct planning tracks (Quick Flow, BMad Method, Enterprise Method). - -### Agent - -A specialized AI persona with specific expertise (PM, Architect, SM, DEV, TEA) that guides users through workflows and creates deliverables. Agents have defined capabilities, communication styles, and workflow access. - -### Workflow - -A multi-step guided process that orchestrates AI agent activities to produce specific deliverables. Workflows are interactive and adapt to user context. - ---- - -## Scale and Complexity - -### Quick Flow Track - -Fast implementation track using tech-spec planning only. Best for bug fixes, small features, and changes with clear scope. Typical range: 1-15 stories. No architecture phase needed. Examples: bug fixes, OAuth login, search features. - -### BMad Method Track - -Full product planning track using PRD + Architecture + UX. Best for products, platforms, and complex features requiring system design. Typical range: 10-50+ stories. Examples: admin dashboards, e-commerce platforms, SaaS products. - -### Enterprise Method Track - -Extended enterprise planning track adding Security Architecture, DevOps Strategy, and Test Strategy to BMad Method. Best for enterprise requirements, compliance needs, and multi-tenant systems. Typical range: 30+ stories. Examples: multi-tenant platforms, compliance-driven systems, mission-critical applications. - -### Planning Track - -The methodology path (Quick Flow, BMad Method, or Enterprise Method) chosen for a project based on planning needs, complexity, and requirements rather than story count alone. - -**Note:** Story counts are guidance, not definitions. Tracks are determined by what planning the project needs, not story math. - ---- - -## Planning Documents - -### Tech-Spec (Technical Specification) - -**Quick Flow track only.** Comprehensive technical plan created upfront that serves as the primary planning document for small changes or features. Contains problem statement, solution approach, file-level changes, stack detection (brownfield), testing strategy, and developer resources. - -### PRD (Product Requirements Document) - -**BMad Method/Enterprise tracks.** Product-level planning document containing vision, goals, Functional Requirements (FRs), Non-Functional Requirements (NFRs), success criteria, and UX considerations. Replaces tech-spec for larger projects that need product planning. **V6 Note:** PRD focuses on WHAT to build (requirements). Epic+Stories are created separately AFTER architecture via create-epics-and-stories workflow. - -### Architecture Document - -**BMad Method/Enterprise tracks.** System-wide design document defining structure, components, interactions, data models, integration patterns, security, performance, and deployment. - -**Scale-Adaptive:** Architecture complexity scales with track - BMad Method is lightweight to moderate, Enterprise Method is comprehensive with security/devops/test strategies. - -### Epics - -High-level feature groupings that contain multiple related stories. Typically span 5-15 stories each and represent cohesive functionality (e.g., "User Authentication Epic"). - -### Product Brief - -Optional strategic planning document created in Phase 1 (Analysis) that captures product vision, market context, user needs, and high-level requirements before detailed planning. - -### GDD (Game Design Document) - -Game development equivalent of PRD, created by Game Designer agent for game projects. - ---- - -## Workflow and Phases - -### Phase 0: Documentation (Prerequisite) - -**Conditional phase for brownfield projects.** Creates comprehensive codebase documentation before planning. Only required if existing documentation is insufficient for AI agents. - -### Phase 1: Analysis (Optional) - -Discovery and research phase including brainstorming, research workflows, and product brief creation. Optional for Quick Flow, recommended for BMad Method, required for Enterprise Method. - -### Phase 2: Planning (Required) - -**Always required.** Creates formal requirements and work breakdown. Routes to tech-spec (Quick Flow) or PRD (BMad Method/Enterprise) based on selected track. - -### Phase 3: Solutioning (Track-Dependent) - -Architecture design phase. Required for BMad Method and Enterprise Method tracks. Includes architecture creation, validation, and gate checks. - -### Phase 4: Implementation (Required) - -Sprint-based development through story-by-story iteration. Uses sprint-planning, create-story, dev-story, code-review, and retrospective workflows. - -### Documentation (Prerequisite for Brownfield) - -**Conditional prerequisite for brownfield projects.** Creates comprehensive codebase documentation before planning. Only required if existing documentation is insufficient for AI agents. Uses the `document-project` workflow. - -### Quick Spec Flow - -Fast-track workflow system for Quick Flow track projects that goes straight from idea to tech-spec to implementation, bypassing heavy planning. Designed for bug fixes, small features, and rapid prototyping. - ---- - -## Agents and Roles - -### PM (Product Manager) - -Agent responsible for creating PRDs, tech-specs, and managing product requirements. Primary agent for Phase 2 planning. - -### Analyst (Business Analyst) - -Agent that initializes workflows, conducts research, creates product briefs, and tracks progress. Often the entry point for new projects. - -### Architect - -Agent that designs system architecture, creates architecture documents, performs technical reviews, and validates designs. Primary agent for Phase 3 solutioning. - -### SM (Scrum Master) - -Agent that manages sprints, creates stories, generates contexts, and coordinates implementation. Primary orchestrator for Phase 4 implementation. - -### DEV (Developer) - -Agent that implements stories, writes code, runs tests, and performs code reviews. Primary implementer in Phase 4. - -### TEA (Test Architect) - -Agent responsible for test strategy, quality gates, NFR assessment, and comprehensive quality assurance. Integrates throughout all phases. - -### Technical Writer - -Agent specialized in creating and maintaining high-quality technical documentation. Expert in documentation standards, information architecture, and professional technical writing. The agent's internal name is "paige" but is presented as "Technical Writer" to users. - -### UX Designer - -Agent that creates UX design documents, interaction patterns, and visual specifications for UI-heavy projects. - -### Game Designer - -Specialized agent for game development projects. Creates game design documents (GDD) and game-specific workflows. - -### BMad Master - -Meta-level orchestrator agent from BMad Core. Facilitates party mode, lists available tasks and workflows, and provides high-level guidance across all modules. - -### Party Mode - -Multi-agent collaboration feature where all installed agents (19+ from BMM, CIS, BMB, custom modules) discuss challenges together in real-time. BMad Master orchestrates, selecting 2-3 relevant agents per message for natural cross-talk and debate. Best for strategic decisions, creative brainstorming, cross-functional alignment, and complex problem-solving. See [Party Mode Guide](./party-mode.md). - ---- - -## Status and Tracking - -### bmm-workflow-status.yaml - -**Phases 1-3.** Tracking file that shows current phase, completed workflows, progress, and next recommended actions. Created by workflow-init, updated automatically. - -### sprint-status.yaml - -**Phase 4 only.** Single source of truth for implementation tracking. Contains all epics, stories, and retrospectives with current status for each. Created by sprint-planning, updated by agents. - -### Story Status Progression - -``` -backlog → ready-for-dev → in-progress → review → done -``` - -- **backlog** - Story exists in epic but not yet created -- **ready-for-dev** - Story file created via create-story; validation is optional (run `validate-create-story` for quality check before dev picks it up) -- **in-progress** - DEV is implementing via dev-story -- **review** - Implementation complete, awaiting code-review -- **done** - Completed with DoD met - -### Epic Status Progression - -``` -backlog → in-progress → done -``` - -- **backlog** - Epic not yet started -- **in-progress** - Epic actively being worked on -- **done** - All stories in epic completed - -### Retrospective - -Workflow run after completing each epic to capture learnings, identify improvements, and feed insights into next epic planning. Critical for continuous improvement. - ---- - -## Project Types - -### Greenfield - -New project starting from scratch with no existing codebase. Freedom to establish patterns, choose stack, and design from clean slate. - -### Brownfield - -Existing project with established codebase, patterns, and constraints. Requires understanding existing architecture, respecting established conventions, and planning integration with current systems. - -**Critical:** Brownfield projects should run document-project workflow BEFORE planning to ensure AI agents have adequate context about existing code. - -### document-project Workflow - -**Brownfield prerequisite.** Analyzes and documents existing codebase, creating comprehensive documentation including project overview, architecture analysis, source tree, API contracts, and data models. Three scan levels: quick, deep, exhaustive. - ---- - -## Implementation Terms - -### Story - -Single unit of implementable work with clear acceptance criteria, typically 2-8 hours of development effort. Stories are grouped into epics and tracked in sprint-status.yaml. - -### Story File - -Markdown file containing story details: description, acceptance criteria, technical notes, dependencies, implementation guidance, and testing requirements. - -### Story Context - -Implementation guidance embedded within story files during the create-story workflow. Provides implementation-specific context, references existing patterns, suggests approaches, and helps maintain consistency with established codebase conventions. - -### Sprint Planning - -Workflow that initializes Phase 4 implementation by creating sprint-status.yaml, extracting all epics/stories from planning docs, and setting up tracking infrastructure. - -### Gate Check - -Validation workflow (implementation-readiness) run before Phase 4 to ensure PRD + Architecture + Epics + UX (optional) are aligned with no gaps or contradictions. Required for BMad Method and Enterprise Method tracks. - -### DoD (Definition of Done) - -Criteria that must be met before marking a story as done. Typically includes: implementation complete, tests written and passing, code reviewed, documentation updated, and acceptance criteria validated. - -### Shard / Sharding - -**For runtime LLM optimization only (NOT human docs).** Splitting large planning documents (PRD, epics, architecture) into smaller section-based files to improve workflow efficiency. Phase 1-3 workflows load entire sharded documents transparently. Phase 4 workflows selectively load only needed sections for massive token savings. - ---- - -## Additional Terms - -### Workflow Status - -Universal entry point workflow that checks for existing status file, displays current phase/progress, and recommends next action based on project state. - -### Workflow Init - -Initialization workflow that creates bmm-workflow-status.yaml, detects greenfield vs brownfield, determines planning track, and sets up appropriate workflow path. - -### Track Selection - -Automatic analysis by workflow-init that uses keyword analysis, complexity indicators, and project requirements to suggest appropriate track (Quick Flow, BMad Method, or Enterprise Method). User can override suggested track. - -### Correct Course - -Workflow run during Phase 4 when significant changes or issues arise. Analyzes impact, proposes solutions, and routes to appropriate remediation workflows. - -### Migration Strategy - -Plan for handling changes to existing data, schemas, APIs, or patterns during brownfield development. Critical for ensuring backward compatibility and smooth rollout. - -### Feature Flags - -Implementation technique for brownfield projects that allows gradual rollout of new functionality, easy rollback, and A/B testing. Recommended for BMad Method and Enterprise brownfield changes. - -### Integration Points - -Specific locations where new code connects with existing systems. Must be documented explicitly in brownfield tech-specs and architectures. - -### Convention Detection - -Quick Spec Flow feature that automatically detects existing code style, naming conventions, patterns, and frameworks from brownfield codebases, then asks user to confirm before proceeding. - ---- - -## Related Documentation - -- [Quick Start Guide](./quick-start.md) - Learn BMM basics -- [Scale Adaptive System](./scale-adaptive-system.md) - Deep dive on tracks and complexity -- [Brownfield Guide](./brownfield-guide.md) - Working with existing codebases -- [Quick Spec Flow](./quick-spec-flow.md) - Fast-track for Quick Flow track -- [FAQ](./faq.md) - Common questions diff --git a/src/modules/bmm/docs/index.md b/src/modules/bmm/docs/index.md deleted file mode 100644 index 5e0dd290..00000000 --- a/src/modules/bmm/docs/index.md +++ /dev/null @@ -1,168 +0,0 @@ -# BMM Documentation - -Complete guides for the BMad Method Module (BMM) - AI-powered agile development workflows that adapt to your project's complexity. - ---- - -## 🚀 Getting Started - -**New to BMM?** Start here: - -- **[Quick Start Guide](./quick-start.md)** - Step-by-step guide to building your first project - - Installation and setup - - Understanding the four phases - - Running your first workflows - - Agent-based development flow - -**Quick Path:** Install → workflow-init → Follow agent guidance - -### 📊 Visual Overview - -**[Complete Workflow Diagram](./images/workflow-method-greenfield.svg)** - Visual flowchart showing all phases, agents (color-coded), and decision points for the BMad Method standard greenfield track. - -## 📖 Core Concepts - -Understanding how BMM adapts to your needs: - -- **[Scale Adaptive System](./scale-adaptive-system.md)** - How BMM adapts to project size and complexity - - Three planning tracks (Quick Flow, BMad Method, Enterprise Method) - - Automatic track recommendation - - Documentation requirements per track - - Planning workflow routing - -- **[BMAD Quick Flow](./bmad-quick-flow.md)** - Fast-track development workflow - - 3-step process: spec → dev → optional review - - Perfect for bug fixes and small features - - Rapid prototyping with production quality - - Hours to implementation, not days - - Barry (Quick Flow Solo Dev) agent owned - -- **[Quick Flow Solo Dev Agent](./quick-flow-solo-dev.md)** - Elite solo developer for rapid development - - Barry is an elite developer who thrives on autonomous execution - - Lives and breathes the BMAD Quick Flow workflow - - Takes projects from concept to deployment with ruthless efficiency - - No handoffs, no delays - just pure focused development - -## 🤖 Agents and Collaboration - -Complete guide to BMM's AI agent team: - -- **[Agents Guide](./agents-guide.md)** - Comprehensive agent reference - - 12 specialized BMM agents + BMad Master - - Agent roles, workflows, and when to use them - - Agent customization system - - Best practices and common patterns - -- **[Party Mode Guide](./party-mode.md)** - Multi-agent collaboration - - How party mode works (19+ agents collaborate in real-time) - - When to use it (strategic, creative, cross-functional, complex) - - Example party compositions - - Multi-module integration (BMM + CIS + BMB + custom) - - Agent customization in party mode - - Best practices - -## 🔧 Working with Existing Code - -Comprehensive guide for brownfield development: - -- **[Brownfield Development Guide](./brownfield-guide.md)** - Complete guide for existing codebases - - Documentation phase strategies - - Track selection for brownfield - - Integration with existing patterns - - Phase-by-phase workflow guidance - - Common scenarios - -## 📚 Quick References - -Essential reference materials: - -- **[Glossary](./glossary.md)** - Key terminology and concepts -- **[FAQ](./faq.md)** - Frequently asked questions across all topics -- **[Enterprise Agentic Development](./enterprise-agentic-development.md)** - Team collaboration strategies - -## 🎯 Choose Your Path - -### I need to... - -**Build something new (greenfield)** -→ Start with [Quick Start Guide](./quick-start.md) -→ Then review [Scale Adaptive System](./scale-adaptive-system.md) to understand tracks - -**Fix a bug or add small feature** -→ Go to [BMAD Quick Flow](./bmad-quick-flow.md) for rapid development -→ Or use [Quick Flow Solo Dev](./quick-flow-solo-dev.md) directly - -**Work with existing codebase (brownfield)** -→ Read [Brownfield Development Guide](./brownfield-guide.md) -→ Pay special attention to documentation requirements for brownfield projects - -**Understand planning tracks and methodology** -→ See [Scale Adaptive System](./scale-adaptive-system.md) - -## 📋 Workflow Guides - -Comprehensive documentation for all BMM workflows organized by phase: - -- **[Phase 1: Analysis Workflows](./workflows-analysis.md)** - Optional exploration and research workflows (595 lines) - - brainstorm-project, product-brief, research, and more - - When to use analysis workflows - - Creative and strategic tools - -- **[Phase 2: Planning Workflows](./workflows-planning.md)** - Scale-adaptive planning (967 lines) - - prd, tech-spec, gdd, narrative, ux - - Track-based planning approach (Quick Flow, BMad Method, Enterprise Method) - - Which planning workflow to use - -- **[Phase 3: Solutioning Workflows](./workflows-solutioning.md)** - Architecture and validation (638 lines) - - architecture, create-epics-and-stories, implementation-readiness - - V6: Epics created AFTER architecture for better quality - - Required for BMad Method and Enterprise Method tracks - - Preventing agent conflicts - -- **[Phase 4: Implementation Workflows](./workflows-implementation.md)** - Sprint-based development (1,634 lines) - - sprint-planning, create-story, dev-story, code-review - - Complete story lifecycle - - One-story-at-a-time discipline - -- **[Testing & QA Workflows](./test-architecture.md)** - Comprehensive quality assurance (1,420 lines) - - Test strategy, automation, quality gates - - TEA agent and test healing - - BMad-integrated vs standalone modes - -**Total: 34 workflows documented across all phases** - -### Advanced Workflow References - -For detailed technical documentation on specific complex workflows: - -- **[Document Project Workflow Reference](./workflow-document-project-reference.md)** - Technical deep-dive (445 lines) - - v1.2.0 context-safe architecture - - Scan levels, resumability, write-as-you-go - - Multi-part project detection - - Deep-dive mode for targeted analysis - -- **[Architecture Workflow Reference](./workflow-architecture-reference.md)** - Decision architecture guide (320 lines) - - Starter template intelligence - - Novel pattern design - - Implementation patterns for agent consistency - - Adaptive facilitation approach - -## 🏗️ Module Structure - -Understanding BMM components: - -- **[BMM Module README](../README.md)** - Overview of module structure - - Agent roster and roles - - Workflow organization - - Teams and collaboration - - Best practices - -## 🌐 External Resources - -### Community and Support - -- **[Discord Community](https://discord.gg/gk8jAdXWmj)** - Get help from the community (#general-dev, #bugs-issues) -- **[GitHub Issues](https://github.com/bmad-code-org/BMAD-METHOD/issues)** - Report bugs or request features -- **[YouTube Channel](https://www.youtube.com/@BMadCode)** - Video tutorials and walkthroughs - -**Ready to begin?** → [Start with the Quick Start Guide](./quick-start.md) diff --git a/src/modules/bmm/docs/party-mode.md b/src/modules/bmm/docs/party-mode.md deleted file mode 100644 index 287e5022..00000000 --- a/src/modules/bmm/docs/party-mode.md +++ /dev/null @@ -1,224 +0,0 @@ -# Party Mode: Multi-Agent Collaboration - -**Get all your AI agents in one conversation** - ---- - -## What is Party Mode? - -Ever wanted to gather your entire AI team in one room and see what happens? That's party mode. - -Type `/bmad:core:workflows:party-mode` (or `*party-mode` from any agent), and suddenly you've got **all your AI agents** in one conversation. PM, Architect, DEV, UX Designer, the CIS creative agents - everyone shows up. - -**Why it's useful:** - -- **After complex workflows** - Debrief with the whole team about what worked, what didn't -- **Big decisions with tradeoffs** - Get technical, creative, and strategic perspectives simultaneously -- **Brainstorming sessions** - Watch ideas evolve through cross-pollination -- **When things go wrong** - Call out failures, watch agents defend their decisions, let them debate whose fault it was (oddly therapeutic) -- **Sprint retrospectives** - Party mode powers the retrospective workflow -- **Sprint planning** - Multi-agent collaboration for planning sessions - -**Future use:** Advanced elicitation workflows will leverage party mode for sophisticated requirement gathering. - ---- - -## How It Works - -**The basics:** - -1. Party mode reads `_bmad/_config/agent-manifest.csv` -2. Loads ALL installed agents (already includes your customizations from install) -3. BMad Master orchestrates - picks 2-3 relevant agents per message based on topic -4. Agents respond in character, can agree/disagree/build on each other's ideas -5. Discussion continues until you type "exit" or reach natural conclusion - -**That's it.** No complex merging, no runtime magic. Just agents talking. - ---- - -## Quick Start - -```bash -# Trigger party mode -/bmad:core:workflows:party-mode - -# OR from any agent context -*party-mode - -# During party -Ask questions, respond to agents, direct the conversation - -# Exit -Type: exit -``` - ---- - -## Fun Examples - -### Example 1: Calling Out Bad Architecture - -**You:** "Okay team, our last sprint was a disaster. The authentication service went down three times. Who screwed this up?" - -**Architect (Winston):** "The design was sound - distributed authentication with proper fallbacks. If implementation deviated from the spec..." - -**DEV (Amelia):** "I followed the architecture doc exactly. The spec didn't account for concurrent session invalidation race conditions." - -**PM (John):** "Both of you missed the bigger issue - we didn't validate session management requirements in the PRD. This is on me for not catching it." - -**TEA (Murat):** "And I should've caught this in integration tests. The test scenarios didn't cover concurrent invalidation." - -_(Watch them debate whose fault it really was - it's therapeutic)_ - ---- - -### Example 2: Creative Brainstorming - -**You:** "How do we make onboarding feel magical instead of boring?" - -**UX Designer (Sally):** "Start with progressive disclosure - reveal features as users need them, not all at once in a tutorial." - -**Storyteller (CIS):** "What if onboarding was a story? Each step reveals a character's journey - the user IS the hero." - -**Innovation Strategist (CIS):** "Take it further - gamify with unlockable achievements. But make them meaningful, not arbitrary badges." - -**Game Designer:** "Building on that - what if the first 'quest' is actually solving a real user problem? They learn by doing something valuable." - -_(Ideas cross-pollinate and evolve)_ - ---- - -### Example 3: Technical Decision - -**You:** "Monolith or microservices for MVP?" - -**Architect:** "Start monolith. Microservices add complexity you don't need at 1000 users." - -**PM:** "Agree. Time to market matters more than theoretical scalability." - -**DEV:** "Monolith with clear module boundaries. We can extract services later if needed." - -**Innovation Strategist:** "Contrarian take - if your differentiator IS scalability, build for it now. Otherwise Architect's right." - -_(Multiple perspectives reveal the right answer)_ - ---- - -## When NOT to Use Party Mode - -**Skip party mode for:** - -- Simple implementation questions → Use DEV agent -- Document review → Use Technical Writer -- Workflow status checks → Use any agent + `*workflow-status` -- Single-domain questions → Use specialist agent - -**Use party mode for:** - -- Multi-perspective decisions -- Creative collaboration -- Post-mortems and retrospectives -- Sprint planning sessions -- Complex problem-solving - ---- - -## Agent Customization - -Party mode uses agents from `_bmad/[module]/agents/*.md` - these already include any customizations you applied during install. - -**To customize agents for party mode:** - -1. Create customization file: `_bmad/_config/agents/bmm-pm.customize.yaml` -2. Run `npx bmad-method install` to rebuild agents -3. Customizations now active in party mode - -Example customization: - -```yaml -agent: - persona: - principles: - - 'HIPAA compliance is non-negotiable' - - 'Patient safety over feature velocity' -``` - -See [Agents Guide](./agents-guide.md#agent-customization) for details. - ---- - -## BMM Workflows That Use Party Mode - -**Current:** - -- `epic-retrospective` - Post-epic team retrospective powered by party mode -- Sprint planning discussions (informal party mode usage) - -**Future:** - -- Advanced elicitation workflows will officially integrate party mode -- Multi-agent requirement validation -- Collaborative technical reviews - ---- - -## Available Agents - -Party mode can include **19+ agents** from all installed modules: - -**BMM (12 agents):** PM, Analyst, Architect, SM, DEV, TEA, UX Designer, Technical Writer, Game Designer, Game Developer, Game Architect - -**CIS (5 agents):** Brainstorming Coach, Creative Problem Solver, Design Thinking Coach, Innovation Strategist, Storyteller - -**BMB (1 agent):** BMad Builder - -**Core (1 agent):** BMad Master (orchestrator) - -**Custom:** Any agents you've created - ---- - -## Tips - -**Get better results:** - -- Be specific with your topic/question -- Provide context (project type, constraints, goals) -- Direct specific agents when you want their expertise -- Make decisions - party mode informs, you decide -- Time box discussions (15-30 minutes is usually plenty) - -**Examples of good opening questions:** - -- "We need to decide between REST and GraphQL for our mobile API. Project is a B2B SaaS with 50 enterprise clients." -- "Our last sprint failed spectacularly. Let's discuss what went wrong with authentication implementation." -- "Brainstorm: how can we make our game's tutorial feel rewarding instead of tedious?" - ---- - -## Troubleshooting - -**Same agents responding every time?** -Vary your questions or explicitly request other perspectives: "Game Designer, your thoughts?" - -**Discussion going in circles?** -BMad Master will summarize and redirect, or you can make a decision and move on. - -**Too many agents talking?** -Make your topic more specific - BMad Master picks 2-3 agents based on relevance. - -**Agents not using customizations?** -Make sure you ran `npx bmad-method install` after creating customization files. - ---- - -## Related Documentation - -- [Agents Guide](./agents-guide.md) - Complete agent reference -- [Quick Start Guide](./quick-start.md) - Getting started with BMM -- [FAQ](./faq.md) - Common questions - ---- - -_Better decisions through diverse perspectives. Welcome to party mode._ diff --git a/src/modules/bmm/docs/quick-spec-flow.md b/src/modules/bmm/docs/quick-spec-flow.md deleted file mode 100644 index 96af1993..00000000 --- a/src/modules/bmm/docs/quick-spec-flow.md +++ /dev/null @@ -1,638 +0,0 @@ -# BMad Quick Spec Flow - -**Perfect for:** Bug fixes, small features, rapid prototyping, and quick enhancements - -**Time to implementation:** Minutes, not hours - ---- - -## What is Quick Spec Flow? - -Quick Spec Flow is a **streamlined alternative** to the full BMad Method for Quick Flow track projects. Instead of going through Product Brief → PRD → Architecture, you go **straight to a context-aware technical specification** and start coding. - -### When to Use Quick Spec Flow - -✅ **Use Quick Flow track when:** - -- Single bug fix or small enhancement -- Small feature with clear scope (typically 1-15 stories) -- Rapid prototyping or experimentation -- Adding to existing brownfield codebase -- You know exactly what you want to build - -❌ **Use BMad Method or Enterprise tracks when:** - -- Building new products or major features -- Need stakeholder alignment -- Complex multi-team coordination -- Requires extensive planning and architecture - -💡 **Not sure?** Run `workflow-init` to get a recommendation based on your project's needs! - ---- - -## Quick Spec Flow Overview - -```mermaid -flowchart TD - START[Step 1: Run Tech-Spec Workflow] - DETECT[Detects project stack
package.json, requirements.txt, etc.] - ANALYZE[Analyzes brownfield codebase
if exists] - TEST[Detects test frameworks
and conventions] - CONFIRM[Confirms conventions
with you] - GENERATE[Generates context-rich
tech-spec] - STORIES[Creates ready-to-implement
stories] - - OPTIONAL[Step 2: Optional
Generate Story Context
SM Agent
For complex scenarios only] - - IMPL[Step 3: Implement
DEV Agent
Code, test, commit] - - DONE[DONE! 🚀] - - START --> DETECT - DETECT --> ANALYZE - ANALYZE --> TEST - TEST --> CONFIRM - CONFIRM --> GENERATE - GENERATE --> STORIES - STORIES --> OPTIONAL - OPTIONAL -.->|Optional| IMPL - STORIES --> IMPL - IMPL --> DONE - - style START fill:#bfb,stroke:#333,stroke-width:2px - style OPTIONAL fill:#ffb,stroke:#333,stroke-width:2px,stroke-dasharray: 5 5 - style IMPL fill:#bbf,stroke:#333,stroke-width:2px - style DONE fill:#f9f,stroke:#333,stroke-width:3px -``` - ---- - -## Single Atomic Change - -**Best for:** Bug fixes, single file changes, isolated improvements - -### What You Get - -1. **tech-spec.md** - Comprehensive technical specification with: - - Problem statement and solution - - Detected framework versions and dependencies - - Brownfield code patterns (if applicable) - - Existing test patterns to follow - - Specific file paths to modify - - Complete implementation guidance - -2. **story-[slug].md** - Single user story ready for development - -### Quick Spec Flow Commands - -```bash -# Start Quick Spec Flow (no workflow-init needed!) -# Load PM agent and run tech-spec - -# When complete, implement directly: -# Load DEV agent and run dev-story -``` - -### What Makes It Quick - -- ✅ No Product Brief needed -- ✅ No PRD needed -- ✅ No Architecture doc needed -- ✅ Auto-detects your stack -- ✅ Auto-analyzes brownfield code -- ✅ Auto-validates quality -- ✅ Story context optional (tech-spec is comprehensive!) - -### Example Single Change Scenarios - -- "Fix the login validation bug" -- "Add email field to user registration form" -- "Update API endpoint to return additional field" -- "Improve error handling in payment processing" - ---- - -## Coherent Small Feature - -**Best for:** Small features with 2-3 related user stories - -### What You Get - -1. **tech-spec.md** - Same comprehensive spec as single change projects -2. **epics.md** - Epic organization with story breakdown -3. **story-[epic-slug]-1.md** - First story -4. **story-[epic-slug]-2.md** - Second story -5. **story-[epic-slug]-3.md** - Third story (if needed) - -### Quick Spec Flow Commands - -```bash -# Start Quick Spec Flow -# Load PM agent and run tech-spec - -# Optional: Organize stories as a sprint -# Load SM agent and run sprint-planning - -# Implement story-by-story: -# Load DEV agent and run dev-story for each story -``` - -### Story Sequencing - -Stories are **automatically validated** to ensure proper sequence: - -- ✅ No forward dependencies (Story 2 can't depend on Story 3) -- ✅ Clear dependency documentation -- ✅ Infrastructure → Features → Polish order -- ✅ Backend → Frontend flow - -### Example Small Feature Scenarios - -- "Add OAuth social login (Google, GitHub, Twitter)" -- "Build user profile page with avatar upload" -- "Implement basic search with filters" -- "Add dark mode toggle to application" - ---- - -## Smart Context Discovery - -Quick Spec Flow automatically discovers and uses: - -### 1. Existing Documentation - -- Product briefs (if they exist) -- Research documents -- `document-project` output (brownfield codebase map) - -### 2. Project Stack - -- **Node.js:** package.json → frameworks, dependencies, scripts, test framework -- **Python:** requirements.txt, pyproject.toml → packages, tools -- **Ruby:** Gemfile → gems and versions -- **Java:** pom.xml, build.gradle → Maven/Gradle dependencies -- **Go:** go.mod → modules -- **Rust:** Cargo.toml → crates -- **PHP:** composer.json → packages - -### 3. Brownfield Code Patterns - -- Directory structure and organization -- Existing code patterns (class-based, functional, MVC) -- Naming conventions (camelCase, snake_case, PascalCase) -- Test frameworks and patterns -- Code style (semicolons, quotes, indentation) -- Linter/formatter configs -- Error handling patterns -- Logging conventions -- Documentation style - -### 4. Convention Confirmation - -**IMPORTANT:** Quick Spec Flow detects your conventions and **asks for confirmation**: - -``` -I've detected these conventions in your codebase: - -Code Style: -- ESLint with Airbnb config -- Prettier with single quotes, 2-space indent -- No semicolons - -Test Patterns: -- Jest test framework -- .test.js file naming -- expect() assertion style - -Should I follow these existing conventions? (yes/no) -``` - -**You decide:** Conform to existing patterns or establish new standards! - ---- - -## Modern Best Practices via WebSearch - -Quick Spec Flow stays current by using WebSearch when appropriate: - -### For Greenfield Projects - -- Searches for latest framework versions -- Recommends official starter templates -- Suggests modern best practices - -### For Outdated Dependencies - -- Detects if your dependencies are >2 years old -- Searches for migration guides -- Notes upgrade complexity - -### Starter Template Recommendations - -For greenfield projects, Quick Spec Flow recommends: - -**React:** - -- Vite (modern, fast) -- Next.js (full-stack) - -**Python:** - -- cookiecutter templates -- FastAPI starter - -**Node.js:** - -- NestJS CLI -- express-generator - -**Benefits:** - -- ✅ Modern best practices baked in -- ✅ Proper project structure -- ✅ Build tooling configured -- ✅ Testing framework set up -- ✅ Faster time to first feature - ---- - -## UX/UI Considerations - -For user-facing changes, Quick Spec Flow captures: - -- UI components affected (create vs modify) -- UX flow changes (current vs new) -- Responsive design needs (mobile, tablet, desktop) -- Accessibility requirements: - - Keyboard navigation - - Screen reader compatibility - - ARIA labels - - Color contrast standards -- User feedback patterns: - - Loading states - - Error messages - - Success confirmations - - Progress indicators - ---- - -## Auto-Validation and Quality Assurance - -Quick Spec Flow **automatically validates** everything: - -### Tech-Spec Validation (Always Runs) - -Checks: - -- ✅ Context gathering completeness -- ✅ Definitiveness (no "use X or Y" statements) -- ✅ Brownfield integration quality -- ✅ Stack alignment -- ✅ Implementation readiness - -Generates scores: - -``` -✅ Validation Passed! -- Context Gathering: Comprehensive -- Definitiveness: All definitive -- Brownfield Integration: Excellent -- Stack Alignment: Perfect -- Implementation Readiness: ✅ Ready -``` - -### Story Validation (Multi-Story Features) - -Checks: - -- ✅ Story sequence (no forward dependencies!) -- ✅ Acceptance criteria quality (specific, testable) -- ✅ Completeness (all tech spec tasks covered) -- ✅ Clear dependency documentation - -**Auto-fixes issues if found!** - ---- - -## Complete User Journey - -### Scenario 1: Bug Fix (Single Change) - -**Goal:** Fix login validation bug - -**Steps:** - -1. **Start:** Load PM agent, say "I want to fix the login validation bug" -2. **PM runs tech-spec workflow:** - - Asks: "What problem are you solving?" - - You explain the validation issue - - Detects your Node.js stack (Express 4.18.2, Jest for testing) - - Analyzes existing UserService code patterns - - Asks: "Should I follow your existing conventions?" → You say yes - - Generates tech-spec.md with specific file paths and patterns - - Creates story-login-fix.md -3. **Implement:** Load DEV agent, run `dev-story` - - DEV reads tech-spec (has all context!) - - Implements fix following existing patterns - - Runs tests (following existing Jest patterns) - - Done! - -**Total time:** 15-30 minutes (mostly implementation) - ---- - -### Scenario 2: Small Feature (Multi-Story) - -**Goal:** Add OAuth social login (Google, GitHub) - -**Steps:** - -1. **Start:** Load PM agent, say "I want to add OAuth social login" -2. **PM runs tech-spec workflow:** - - Asks about the feature scope - - You specify: Google and GitHub OAuth - - Detects your stack (Next.js 13.4, NextAuth.js already installed!) - - Analyzes existing auth patterns - - Confirms conventions with you - - Generates: - - tech-spec.md (comprehensive implementation guide) - - epics.md (OAuth Integration epic) - - story-oauth-1.md (Backend OAuth setup) - - story-oauth-2.md (Frontend login buttons) -3. **Optional Sprint Planning:** Load SM agent, run `sprint-planning` -4. **Implement Story 1:** - - Load DEV agent, run `dev-story` for story 1 - - DEV implements backend OAuth -5. **Implement Story 2:** - - DEV agent, run `dev-story` for story 2 - - DEV implements frontend - - Done! - -**Total time:** 1-3 hours (mostly implementation) - ---- - -## Integration with Phase 4 Workflows - -Quick Spec Flow works seamlessly with all Phase 4 implementation workflows: - -### create-story (SM Agent) - -- ✅ Can work with tech-spec.md instead of PRD -- ✅ Uses epics.md from tech-spec workflow -- ✅ Creates additional stories if needed - -### sprint-planning (SM Agent) - -- ✅ Works with epics.md from tech-spec -- ✅ Organizes multi-story features for coordinated implementation -- ✅ Tracks progress through sprint-status.yaml - -### dev-story (DEV Agent) - -- ✅ Reads stories generated by tech-spec -- ✅ Uses tech-spec.md as comprehensive context -- ✅ Implements following detected conventions - ---- - -## Comparison: Quick Spec vs Full BMM - -| Aspect | Quick Flow Track | BMad Method/Enterprise Tracks | -| --------------------- | ---------------------------- | ---------------------------------- | -| **Setup** | None (standalone) | workflow-init recommended | -| **Planning Docs** | tech-spec.md only | Product Brief → PRD → Architecture | -| **Time to Code** | Minutes | Hours to days | -| **Best For** | Bug fixes, small features | New products, major features | -| **Context Discovery** | Automatic | Manual + guided | -| **Story Context** | Optional (tech-spec is rich) | Required (generated from PRD) | -| **Validation** | Auto-validates everything | Manual validation steps | -| **Brownfield** | Auto-analyzes and conforms | Manual documentation required | -| **Conventions** | Auto-detects and confirms | Document in PRD/Architecture | - ---- - -## When to Graduate from Quick Flow to BMad Method - -Start with Quick Flow, but switch to BMad Method when: - -- ❌ Project grows beyond initial scope -- ❌ Multiple teams need coordination -- ❌ Stakeholders need formal documentation -- ❌ Product vision is unclear -- ❌ Architectural decisions need deep analysis -- ❌ Compliance/regulatory requirements exist - -💡 **Tip:** You can always run `workflow-init` later to transition from Quick Flow to BMad Method! - ---- - -## Quick Spec Flow - Key Benefits - -### 🚀 **Speed** - -- No Product Brief -- No PRD -- No Architecture doc -- Straight to implementation - -### 🧠 **Intelligence** - -- Auto-detects stack -- Auto-analyzes brownfield -- Auto-validates quality -- WebSearch for current info - -### 📐 **Respect for Existing Code** - -- Detects conventions -- Asks for confirmation -- Follows patterns -- Adapts vs. changes - -### ✅ **Quality** - -- Auto-validation -- Definitive decisions (no "or" statements) -- Comprehensive context -- Clear acceptance criteria - -### 🎯 **Focus** - -- Single atomic changes -- Coherent small features -- No scope creep -- Fast iteration - ---- - -## Getting Started - -### Prerequisites - -- BMad Method installed (`npx bmad-method install`) -- Project directory with code (or empty for greenfield) - -### Quick Start Commands - -```bash -# For a quick bug fix or small change: -# 1. Load PM agent -# 2. Say: "I want to [describe your change]" -# 3. PM will ask if you want to run tech-spec -# 4. Answer questions about your change -# 5. Get tech-spec + story -# 6. Load DEV agent and implement! - -# For a small feature with multiple stories: -# Same as above, but get epic + 2-3 stories -# Optionally use SM sprint-planning to organize -``` - -### No workflow-init Required! - -Quick Spec Flow is **fully standalone**: - -- Detects if it's a single change or multi-story feature -- Asks for greenfield vs brownfield -- Works without status file tracking -- Perfect for rapid prototyping - ---- - -## FAQ - -### Q: Can I use Quick Spec Flow on an existing project? - -**A:** Yes! It's perfect for brownfield projects. It will analyze your existing code, detect patterns, and ask if you want to follow them. - -### Q: What if I don't have a package.json or requirements.txt? - -**A:** Quick Spec Flow will work in greenfield mode, recommend starter templates, and use WebSearch for modern best practices. - -### Q: Do I need to run workflow-init first? - -**A:** No! Quick Spec Flow is standalone. But if you want guidance on which flow to use, workflow-init can help. - -### Q: Can I use this for frontend changes? - -**A:** Absolutely! Quick Spec Flow captures UX/UI considerations, component changes, and accessibility requirements. - -### Q: What if my Quick Flow project grows? - -**A:** No problem! You can always transition to BMad Method by running workflow-init and create-prd. Your tech-spec becomes input for the PRD. - -### Q: Can I skip validation? - -**A:** No, validation always runs automatically. But it's fast and catches issues early! - -### Q: Will it work with my team's code style? - -**A:** Yes! It detects your conventions and asks for confirmation. You control whether to follow existing patterns or establish new ones. - ---- - -## Tips and Best Practices - -### 1. **Be Specific in Discovery** - -When describing your change, provide specifics: - -- ✅ "Fix email validation in UserService to allow plus-addressing" -- ❌ "Fix validation bug" - -### 2. **Trust the Convention Detection** - -If it detects your patterns correctly, say yes! It's faster than establishing new conventions. - -### 3. **Use WebSearch Recommendations for Greenfield** - -Starter templates save hours of setup time. Let Quick Spec Flow find the best ones. - -### 4. **Review the Auto-Validation** - -When validation runs, read the scores. They tell you if your spec is production-ready. - -### 5. **Keep Single Changes Truly Atomic** - -If your "single change" needs 3+ files, it might be a multi-story feature. Let the workflow guide you. - -### 6. **Validate Story Sequence for Multi-Story Features** - -When you get multiple stories, check the dependency validation output. Proper sequence matters! - ---- - -## Real-World Examples - -### Example 1: Adding Logging (Single Change) - -**Input:** "Add structured logging to payment processing" - -**Tech-Spec Output:** - -- Detected: winston 3.8.2 already in package.json -- Analyzed: Existing services use winston with JSON format -- Confirmed: Follow existing logging patterns -- Generated: Specific file paths, log levels, format example -- Story: Ready to implement in 1-2 hours - -**Result:** Consistent logging added, following team patterns, no research needed. - ---- - -### Example 2: Search Feature (Multi-Story) - -**Input:** "Add search to product catalog with filters" - -**Tech-Spec Output:** - -- Detected: React 18.2.0, MUI component library, Express backend -- Analyzed: Existing ProductList component patterns -- Confirmed: Follow existing API and component structure -- Generated: - - Epic: Product Search Functionality - - Story 1: Backend search API with filters - - Story 2: Frontend search UI component -- Auto-validated: Story 1 → Story 2 sequence correct - -**Result:** Search feature implemented in 4-6 hours with proper architecture. - ---- - -## Summary - -Quick Spec Flow is your **fast path from idea to implementation** for: - -- 🐛 Bug fixes -- ✨ Small features -- 🚀 Rapid prototyping -- 🔧 Quick enhancements - -**Key Features:** - -- Auto-detects your stack -- Auto-analyzes brownfield code -- Auto-validates quality -- Respects existing conventions -- Uses WebSearch for modern practices -- Generates comprehensive tech-specs -- Creates implementation-ready stories - -**Time to code:** Minutes, not hours. - -**Ready to try it?** Load the PM agent and say what you want to build! 🚀 - ---- - -## Next Steps - -- **Try it now:** Load PM agent and describe a small change -- **Learn more:** See the [BMM Workflow Guides](./index.md#-workflow-guides) for comprehensive workflow documentation -- **Need help deciding?** Run `workflow-init` to get a recommendation -- **Have questions?** Join us on Discord: - ---- - -_Quick Spec Flow - Because not every change needs a Product Brief._ diff --git a/src/modules/bmm/docs/quick-start.md b/src/modules/bmm/docs/quick-start.md deleted file mode 100644 index d32c1d7f..00000000 --- a/src/modules/bmm/docs/quick-start.md +++ /dev/null @@ -1,366 +0,0 @@ -# BMad Method V6 Quick Start Guide - -Get started with BMad Method v6 for your new greenfield project. This guide walks you through building software from scratch using AI-powered workflows. - -## TL;DR - The Quick Path - -1. **Install**: `npx bmad-method@alpha install` -2. **Initialize**: Load Analyst agent → Run "workflow-init" -3. **Plan**: Load PM agent to create a PRD -4. **Plan UX**: Load UX Expert to create a UX-Design if your application will have a UX/UI element -5. **Architect**: Load Architect agent → Run "create-architecture" -6. **Epic Plan**: The PM steps back in to help run the create-epics-and-stories -7. **Build**: Load SM agent → Run workflows for each story → Load DEV agent → Implement -8. **Always use fresh chats** for each workflow to avoid context issues - -## What is BMad Method? - -BMad Method (BMM) helps you build software through guided workflows with specialized AI agents. The process follows four phases: - -1. **Phase 1: Analysis** (Optional) - Brainstorming, Research, Product Brief -2. **Phase 2: Planning** (Required) - Create your requirements (tech-spec or PRD) -3. **Phase 3: Solutioning** (Track-dependent) - Design the architecture for BMad Method and Enterprise tracks -4. **Phase 4: Implementation** (Required) - Build your software Epic by Epic, Story by Story - -### Complete Workflow Visualization - -![BMad Method Workflow - Standard Greenfield](./images/workflow-method-greenfield.svg) - -_Complete visual flowchart showing all phases, workflows, agents (color-coded), and decision points for the BMad Method standard greenfield track. Each box is color-coded by the agent responsible for that workflow._ - -## Installation - -```bash -# Install v6 Alpha to your project -npx bmad-method@alpha install -``` - -The interactive installer will guide you through setup and create a `_bmad/` folder with all agents and workflows. - ---- - -## Getting Started - -### Step 1: Initialize Your Workflow - -1. **Load the Analyst agent** in your IDE - See your IDE-specific instructions in [docs/ide-info](https://github.com/bmad-code-org/BMAD-METHOD/tree/main/docs/ide-info) for how to activate agents: - - [Claude Code](https://github.com/bmad-code-org/BMAD-METHOD/blob/main/docs/ide-info/claude-code.md) - - [VS Code/Cursor/Windsurf](https://github.com/bmad-code-org/BMAD-METHOD/tree/main/docs/ide-info) - Check your IDE folder - - Other IDEs also supported -2. **Wait for the agent's menu** to appear -3. **Tell the agent**: "Run workflow-init" or type "\*workflow-init" or select the menu item number - -#### What happens during workflow-init? - -Workflows are interactive processes in V6 that replaced tasks and templates from prior versions. There are many types of workflows, and you can even create your own with the BMad Builder module. For the BMad Method, you'll be interacting with expert-designed workflows crafted to work with you to get the best out of both you and the LLM. - -During workflow-init, you'll describe: - -- Your project and its goals -- Whether there's an existing codebase or this is a new project -- The general size and complexity (you can adjust this later) - -#### Planning Tracks - -Based on your description, the workflow will suggest a track and let you choose from: - -**Three Planning Tracks:** - -- **Quick Flow** - Fast implementation (tech-spec only) - bug fixes, simple features, clear scope (typically 1-15 stories) -- **BMad Method** - Full planning (PRD + Architecture + UX) - products, platforms, complex features (typically 10-50+ stories) -- **Enterprise Method** - Extended planning (BMad Method + Security/DevOps/Test) - enterprise requirements, compliance, multi-tenant (typically 30+ stories) - -**Note**: Story counts are guidance, not definitions. Tracks are chosen based on planning needs, not story math. - -#### What gets created? - -Once you confirm your track, the `bmm-workflow-status.yaml` file will be created in your project's docs folder (assuming default install location). This file tracks your progress through all phases. - -**Important notes:** - -- Every track has different paths through the phases -- Story counts can still change based on overall complexity as you work -- For this guide, we'll assume a BMad Method track project -- This workflow will guide you through Phase 1 (optional), Phase 2 (required), and Phase 3 (required for BMad Method and Enterprise tracks) - -### Step 2: Work Through Phases 1-3 - -After workflow-init completes, you'll work through the planning phases. **Important: Use fresh chats for each workflow to avoid context limitations.** - -#### Checking Your Status - -If you're unsure what to do next: - -1. Load any agent in a new chat -2. Ask for "workflow-status" -3. The agent will tell you the next recommended or required workflow - -**Example response:** - -``` -Phase 1 (Analysis) is entirely optional. All workflows are optional or recommended: - - brainstorm-project - optional - - research - optional - - product-brief - RECOMMENDED (but not required) - -The next TRULY REQUIRED step is: - - PRD (Product Requirements Document) in Phase 2 - Planning - - Agent: pm - - Command: prd -``` - -#### How to Run Workflows in Phases 1-3 - -When an agent tells you to run a workflow (like `prd`): - -1. **Start a new chat** with the specified agent (e.g., PM) - See [docs/ide-info](https://github.com/bmad-code-org/BMAD-METHOD/tree/main/docs/ide-info) for your IDE's specific instructions -2. **Wait for the menu** to appear -3. **Tell the agent** to run it using any of these formats: - - Type the shorthand: `*prd` - - Say it naturally: "Let's create a new PRD" - - Select the menu number for "create-prd" - -The agents in V6 are very good with fuzzy menu matching! - -#### Quick Reference: Agent → Document Mapping - -For v4 users or those who prefer to skip workflow-status guidance: - -- **Analyst** → Brainstorming, Product Brief -- **PM** → PRD (BMad Method/Enterprise tracks) OR tech-spec (Quick Flow track) -- **UX-Designer** → UX Design Document (if UI part of the project) -- **Architect** → Architecture (BMad Method/Enterprise tracks) - -#### Phase 2: Planning - Creating the PRD - -**For BMad Method and Enterprise tracks:** - -1. Load the **PM agent** in a new chat -2. Tell it to run the PRD workflow -3. Once complete, you'll have: - - **PRD.md** - Your Product Requirements Document - -**For Quick Flow track:** - -- Use **tech-spec** instead of PRD (no architecture needed) - -#### Phase 2 (Optional): UX Design - -If your project has a user interface: - -1. Load the **UX-Designer agent** in a new chat -2. Tell it to run the UX design workflow -3. After completion, you'll have your UX specification document - -#### Phase 3: Architecture - -**For BMad Method and Enterprise tracks:** - -1. Load the **Architect agent** in a new chat -2. Tell it to run the create-architecture workflow -3. After completion, you'll have your architecture document with technical decisions - -#### Phase 3: Create Epics and Stories (REQUIRED after Architecture) - -**V6 Improvement:** Epics and stories are now created AFTER architecture for better quality! - -1. Load the **PM agent** in a new chat -2. Tell it to run "create-epics-and-stories" -3. This breaks down your PRD's FRs/NFRs into implementable epics and stories -4. The workflow uses both PRD and Architecture to create technically-informed stories - -**Why after architecture?** Architecture decisions (database, API patterns, tech stack) directly affect how stories should be broken down and sequenced. - -#### Phase 3: Implementation Readiness Check (Highly Recommended) - -Once epics and stories are created: - -1. Load the **Architect agent** in a new chat -2. Tell it to run "implementation-readiness" -3. This validates cohesion across all your planning documents (PRD, UX, Architecture, Epics) -4. This was called the "PO Master Checklist" in v4 - -**Why run this?** It ensures all your planning assets align properly before you start building. - -#### Context Management Tips - -- **Use 200k+ context models** for best results (Claude Sonnet 4.5, GPT-4, etc.) -- **Fresh chat for each workflow** - Brainstorming, Briefs, Research, and PRD generation are all context-intensive -- **No document sharding needed** - Unlike v4, you don't need to split documents -- **Web Bundles coming soon** - Will help save LLM tokens for users with limited plans - -### Step 3: Start Building (Phase 4 - Implementation) - -Once planning and architecture are complete, you'll move to Phase 4. **Important: Each workflow below should be run in a fresh chat to avoid context limitations and hallucinations.** - -#### 3.1 Initialize Sprint Planning - -1. **Start a new chat** with the **SM (Scrum Master) agent** -2. Wait for the menu to appear -3. Tell the agent: "Run sprint-planning" -4. This creates your `sprint-status.yaml` file that tracks all epics and stories - -#### 3.2 Create Your First Story - -1. **Start a new chat** with the **SM agent** -2. Wait for the menu -3. Tell the agent: "Run create-story" -4. This creates the story file from the epic - -#### 3.3 Implement the Story - -1. **Start a new chat** with the **DEV agent** -2. Wait for the menu -3. Tell the agent: "Run dev-story" -4. The DEV agent will implement the story and update the sprint status - -#### 3.4 Review the Code (Optional but Recommended) - -1. **Start a new chat** with the **DEV agent** -2. Wait for the menu -3. Tell the agent: "Run code-review" -4. The DEV agent performs quality validation (this was called QA in v4) - -### Step 4: Keep Going - -For each subsequent story, repeat the cycle using **fresh chats** for each workflow: - -1. **New chat** → SM agent → "Run create-story" -2. **New chat** → DEV agent → "Run dev-story" -3. **New chat** → DEV agent → "Run code-review" (optional but recommended) - -After completing all stories in an epic: - -1. **Start a new chat** with the **SM agent** -2. Tell the agent: "Run retrospective" - -**Why fresh chats?** Context-intensive workflows can cause hallucinations if you keep issuing commands in the same chat. Starting fresh ensures the agent has maximum context capacity for each workflow. - ---- - -## Understanding the Agents - -Each agent is a specialized AI persona: - -- **Analyst** - Initializes workflows and tracks progress -- **PM** - Creates requirements and specifications -- **UX-Designer** - If your project has a front end - this designer will help produce artifacts, come up with mock updates, and design a great look and feel with you giving it guidance. -- **Architect** - Designs system architecture -- **SM (Scrum Master)** - Manages sprints and creates stories -- **DEV** - Implements code and reviews work - -## How Workflows Work - -1. **Load an agent** - Open the agent file in your IDE to activate it -2. **Wait for the menu** - The agent will present its available workflows -3. **Tell the agent what to run** - Say "Run [workflow-name]" -4. **Follow the prompts** - The agent guides you through each step - -The agent creates documents, asks questions, and helps you make decisions throughout the process. - -## Project Tracking Files - -BMad creates two files to track your progress: - -**1. bmm-workflow-status.yaml** - -- Shows which phase you're in and what's next -- Created by workflow-init -- Updated automatically as you progress through phases - -**2. sprint-status.yaml** (Phase 4 only) - -- Tracks all your epics and stories during implementation -- Critical for SM and DEV agents to know what to work on next -- Created by sprint-planning workflow -- Updated automatically as stories progress - -**You don't need to edit these manually** - agents update them as you work. - ---- - -## The Complete Flow Visualized - -```mermaid -flowchart LR - subgraph P1["Phase 1 (Optional)
Analysis"] - direction TB - A1[Brainstorm] - A2[Research] - A3[Brief] - A4[Analyst] - A1 ~~~ A2 ~~~ A3 ~~~ A4 - end - - subgraph P2["Phase 2 (Required)
Planning"] - direction TB - B1[Quick Flow:
tech-spec] - B2[Method/Enterprise:
PRD] - B3[UX opt] - B4[PM, UX] - B1 ~~~ B2 ~~~ B3 ~~~ B4 - end - - subgraph P3["Phase 3 (Track-dependent)
Solutioning"] - direction TB - C1[Method/Enterprise:
architecture] - C2[gate-check] - C3[Architect] - C1 ~~~ C2 ~~~ C3 - end - - subgraph P4["Phase 4 (Required)
Implementation"] - direction TB - D1[Per Epic:
epic context] - D2[Per Story:
create-story] - D3[dev-story] - D4[code-review] - D5[SM, DEV] - D1 ~~~ D2 ~~~ D3 ~~~ D4 ~~~ D5 - end - - P1 --> P2 - P2 --> P3 - P3 --> P4 - - style P1 fill:#bbf,stroke:#333,stroke-width:2px,color:#000 - style P2 fill:#bfb,stroke:#333,stroke-width:2px,color:#000 - style P3 fill:#ffb,stroke:#333,stroke-width:2px,color:#000 - style P4 fill:#fbf,stroke:#333,stroke-width:2px,color:#000 -``` - -## Common Questions - -**Q: Do I always need architecture?** -A: Only for BMad Method and Enterprise tracks. Quick Flow projects skip straight from tech-spec to implementation. - -**Q: Can I change my plan later?** -A: Yes! The SM agent has a "correct-course" workflow for handling scope changes. - -**Q: What if I want to brainstorm first?** -A: Load the Analyst agent and tell it to "Run brainstorm-project" before running workflow-init. - -**Q: Why do I need fresh chats for each workflow?** -A: Context-intensive workflows can cause hallucinations if run in sequence. Fresh chats ensure maximum context capacity. - -**Q: Can I skip workflow-init and workflow-status?** -A: Yes, once you learn the flow. Use the Quick Reference in Step 2 to go directly to the workflows you need. - -## Getting Help - -- **During workflows**: Agents guide you with questions and explanations -- **Community**: [Discord](https://discord.gg/gk8jAdXWmj) - #general-dev, #bugs-issues -- **Complete guide**: [BMM Workflow Documentation](./index.md#-workflow-guides) -- **YouTube tutorials**: [BMad Code Channel](https://www.youtube.com/@BMadCode) - ---- - -## Key Takeaways - -✅ **Always use fresh chats** - Load agents in new chats for each workflow to avoid context issues -✅ **Let workflow-status guide you** - Load any agent and ask for status when unsure what's next -✅ **Track matters** - Quick Flow uses tech-spec, BMad Method/Enterprise need PRD and architecture -✅ **Tracking is automatic** - The status files update themselves, no manual editing needed -✅ **Agents are flexible** - Use menu numbers, shortcuts (\*prd), or natural language - -**Ready to start building?** Install BMad, load the Analyst, run workflow-init, and let the agents guide you! diff --git a/src/modules/bmm/docs/scale-adaptive-system.md b/src/modules/bmm/docs/scale-adaptive-system.md deleted file mode 100644 index 09b66048..00000000 --- a/src/modules/bmm/docs/scale-adaptive-system.md +++ /dev/null @@ -1,618 +0,0 @@ -# BMad Method Scale Adaptive System - -**Automatically adapts workflows to project complexity - from quick fixes to enterprise systems** - ---- - -## Overview - -The **Scale Adaptive System** intelligently routes projects to the right planning methodology based on complexity, not arbitrary story counts. - -### The Problem - -Traditional methodologies apply the same process to every project: - -- Bug fix requires full design docs -- Enterprise system built with minimal planning -- One-size-fits-none approach - -### The Solution - -BMad Method adapts to three distinct planning tracks: - -- **Quick Flow**: Tech-spec only, implement immediately -- **BMad Method**: PRD + Architecture, structured approach -- **Enterprise Method**: Full planning with security/devops/test - -**Result**: Right planning depth for every project. - ---- - -## Quick Reference - -### Three Tracks at a Glance - -| Track | Planning Depth | Best For | -| --------------------- | --------------------- | ------------------------------------------ | -| **Quick Flow** | Tech-spec only | Simple features, bug fixes, clear scope | -| **BMad Method** | PRD + Arch + UX | Products, platforms, complex features | -| **Enterprise Method** | Method + Test/Sec/Ops | Enterprise needs, compliance, multi-tenant | - -### Decision Tree - -```mermaid -flowchart TD - START{Describe your project} - - START -->|Bug fix, simple feature| Q1{Scope crystal clear?} - START -->|Product, platform, complex| M[BMad Method
PRD + Architecture] - START -->|Enterprise, compliance| E[Enterprise Method
Extended Planning] - - Q1 -->|Yes| QF[Quick Flow
Tech-spec only] - Q1 -->|Uncertain| M - - style QF fill:#bfb,stroke:#333,stroke-width:2px,color:#000 - style M fill:#bbf,stroke:#333,stroke-width:2px,color:#000 - style E fill:#f9f,stroke:#333,stroke-width:2px,color:#000 -``` - -### Quick Keywords - -- **Quick Flow**: fix, bug, simple, add, clear scope -- **BMad Method**: product, platform, dashboard, complex, multiple features -- **Enterprise Method**: enterprise, multi-tenant, compliance, security, audit - ---- - -## How Track Selection Works - -When you run `workflow-init`, it guides you through an educational choice: - -### 1. Description Analysis - -Analyzes your project description for complexity indicators and suggests an appropriate track. - -### 2. Educational Presentation - -Shows all three tracks with: - -- Time investment -- Planning approach -- Benefits and trade-offs -- AI agent support level -- Concrete examples - -### 3. Honest Recommendation - -Provides tailored recommendation based on: - -- Complexity keywords -- Greenfield vs brownfield -- User's description - -### 4. User Choice - -You choose the track that fits your situation. The system guides but never forces. - -**Example:** - -``` -workflow-init: "Based on 'Add user dashboard with analytics', I recommend BMad Method. - This involves multiple features and system design. The PRD + Architecture - gives AI agents complete context for better code generation." - -You: "Actually, this is simpler than it sounds. Quick Flow." - -workflow-init: "Got it! Using Quick Flow with tech-spec." -``` - ---- - -## The Three Tracks - -### Track 1: Quick Flow - -**Definition**: Fast implementation with tech-spec planning. - -**Time**: Hours to 1 day of planning - -**Planning Docs**: - -- Tech-spec.md (implementation-focused) -- Story files (1-15 typically, auto-detects epic structure) - -**Workflow Path**: - -``` -(Brownfield: document-project first if needed) -↓ -Tech-Spec → Implement -``` - -**Use For**: - -- Bug fixes -- Simple features -- Enhancements with clear scope -- Quick additions - -**Story Count**: Typically 1-15 stories (guidance, not rule) - -**Example**: "Fix authentication token expiration bug" - -**AI Agent Support**: Basic - minimal context provided - -**Trade-off**: Less planning = higher rework risk if complexity emerges - ---- - -### Track 2: BMad Method (RECOMMENDED) - -**Definition**: Full product + system design planning. - -**Time**: 1-3 days of planning - -**Planning Docs**: - -- PRD.md (functional and non-functional requirements) -- Architecture.md (system design) -- UX Design (if UI components) -- Epics and Stories (created after architecture) - -**Workflow Path**: - -``` -(Brownfield: document-project first if needed) -↓ -(Optional: Analysis phase - brainstorm, research, product brief) -↓ -PRD → (Optional UX) → Architecture → Create Epics and Stories → Implementation Readiness Check → Implement -``` - -**Complete Workflow Visualization**: - -![BMad Method Workflow - Standard Greenfield](./images/workflow-method-greenfield.svg) - -_Detailed flowchart showing all phases, workflows, agents (color-coded), and decision points for the BMad Method track. Each colored box represents a different agent role._ - -**Use For**: - -**Greenfield**: - -- Products -- Platforms -- Multi-feature initiatives - -**Brownfield**: - -- Complex additions (new UIs + APIs) -- Major refactors -- New modules - -**Story Count**: Typically 10-50+ stories (guidance, not rule) - -**Examples**: - -- "User dashboard with analytics and preferences" -- "Add real-time collaboration to existing document editor" -- "Payment integration system" - -**AI Agent Support**: Exceptional - complete context for coding partnership - -**Why Architecture for Brownfield?** - -Your brownfield documentation might be huge. Architecture workflow distills massive codebase context into a focused solution design specific to YOUR project. This keeps AI agents focused without getting lost in existing code. - -**Benefits**: - -- Complete AI agent context -- Prevents architectural drift -- Fewer surprises during implementation -- Better code quality -- Faster overall delivery (planning pays off) - ---- - -### Track 3: Enterprise Method - -**Definition**: Extended planning with security, devops, and test strategy. - -**Time**: 3-7 days of planning - -**Planning Docs**: - -- All BMad Method docs PLUS: -- Security Architecture -- DevOps Strategy -- Test Strategy -- Compliance documentation - -**Workflow Path**: - -``` -(Brownfield: document-project nearly mandatory) -↓ -Analysis (recommended/required) → PRD → UX → Architecture -↓ -Create Epics and Stories -↓ -Security Architecture → DevOps Strategy → Test Strategy -↓ -Implementation Readiness Check → Implement -``` - -**Use For**: - -- Enterprise requirements -- Multi-tenant systems -- Compliance needs (HIPAA, SOC2, etc.) -- Mission-critical systems -- Security-sensitive applications - -**Story Count**: Typically 30+ stories (but defined by enterprise needs, not count) - -**Examples**: - -- "Multi-tenant SaaS platform" -- "HIPAA-compliant patient portal" -- "Add SOC2 audit logging to enterprise app" - -**AI Agent Support**: Elite - comprehensive enterprise planning - -**Critical for Enterprise**: - -- Security architecture and threat modeling -- DevOps pipeline planning -- Comprehensive test strategy -- Risk assessment -- Compliance mapping - ---- - -## Planning Documents by Track - -### Quick Flow Documents - -**Created**: Upfront in Planning Phase - -**Tech-Spec**: - -- Problem statement and solution -- Source tree changes -- Technical implementation details -- Detected stack and conventions (brownfield) -- UX/UI considerations (if user-facing) -- Testing strategy - -**Serves as**: Complete planning document (replaces PRD + Architecture) - ---- - -### BMad Method Documents - -**Created**: Upfront in Planning and Solutioning Phases - -**PRD (Product Requirements Document)**: - -- Product vision and goals -- Functional requirements (FRs) -- Non-functional requirements (NFRs) -- Success criteria -- User experience considerations -- Business context - -**Note**: Epics and stories are created AFTER architecture in the create-epics-and-stories workflow - -**Architecture Document**: - -- System components and responsibilities -- Data models and schemas -- Integration patterns -- Security architecture -- Performance considerations -- Deployment architecture - -**For Brownfield**: Acts as focused "solution design" that distills existing codebase into integration plan - ---- - -### Enterprise Method Documents - -**Created**: Extended planning across multiple phases - -Includes all BMad Method documents PLUS: - -**Security Architecture**: - -- Threat modeling -- Authentication/authorization design -- Data protection strategy -- Audit requirements - -**DevOps Strategy**: - -- CI/CD pipeline design -- Infrastructure architecture -- Monitoring and alerting -- Disaster recovery - -**Test Strategy**: - -- Test approach and coverage -- Automation strategy -- Quality gates -- Performance testing - ---- - -## Workflow Comparison - -| Track | Analysis | Planning | Architecture | Security/Ops | Typical Stories | -| --------------- | ----------- | --------- | ------------ | ------------ | --------------- | -| **Quick Flow** | Optional | Tech-spec | None | None | 1-15 | -| **BMad Method** | Recommended | PRD + UX | Required | None | 10-50+ | -| **Enterprise** | Required | PRD + UX | Required | Required | 30+ | - -**Note**: Story counts are GUIDANCE based on typical usage, NOT definitions of tracks. - ---- - -## Brownfield Projects - -### Critical First Step - -For ALL brownfield projects: Run `document-project` BEFORE planning workflows. - -### Why document-project is Critical - -**Quick Flow** uses it for: - -- Auto-detecting existing patterns -- Understanding codebase structure -- Confirming conventions - -**BMad Method** uses it for: - -- Architecture inputs (existing structure) -- Integration design -- Pattern consistency - -**Enterprise Method** uses it for: - -- Security analysis -- Integration architecture -- Risk assessment - -### Brownfield Workflow Pattern - -```mermaid -flowchart TD - START([Brownfield Project]) - CHECK{Has docs/
index.md?} - - START --> CHECK - CHECK -->|No| DOC[document-project workflow
10-30 min] - CHECK -->|Yes| TRACK[Choose Track] - - DOC --> TRACK - TRACK -->|Quick| QF[Tech-Spec] - TRACK -->|Method| M[PRD + Arch] - TRACK -->|Enterprise| E[PRD + Arch + Sec/Ops] - - style DOC fill:#ffb,stroke:#333,stroke-width:2px,color:#000 - style TRACK fill:#bfb,stroke:#333,stroke-width:2px,color:#000 -``` - ---- - -## Common Scenarios - -### Scenario 1: Bug Fix (Quick Flow) - -**Input**: "Fix email validation bug in login form" - -**Detection**: Keywords "fix", "bug" - -**Track**: Quick Flow - -**Workflow**: - -1. (Optional) Brief analysis -2. Tech-spec with single story -3. Implement immediately - -**Time**: 2-4 hours total - ---- - -### Scenario 2: Small Feature (Quick Flow) - -**Input**: "Add OAuth social login (Google, GitHub, Facebook)" - -**Detection**: Keywords "add", "feature", clear scope - -**Track**: Quick Flow - -**Workflow**: - -1. (Optional) Research OAuth providers -2. Tech-spec with 3 stories -3. Implement story-by-story - -**Time**: 1-3 days - ---- - -### Scenario 3: Customer Portal (BMad Method) - -**Input**: "Build customer portal with dashboard, tickets, billing" - -**Detection**: Keywords "portal", "dashboard", multiple features - -**Track**: BMad Method - -**Workflow**: - -1. (Recommended) Product Brief -2. PRD (FRs/NFRs) -3. (If UI) UX Design -4. Architecture (system design) -5. Create Epics and Stories -6. Implementation Readiness Check -7. Implement with sprint planning - -**Time**: 1-2 weeks - ---- - -### Scenario 4: E-commerce Platform (BMad Method) - -**Input**: "Build e-commerce platform with products, cart, checkout, admin, analytics" - -**Detection**: Keywords "platform", multiple subsystems - -**Track**: BMad Method - -**Workflow**: - -1. Research + Product Brief -2. Comprehensive PRD (FRs/NFRs) -3. UX Design (recommended) -4. System Architecture (required) -5. Create Epics and Stories -6. Implementation Readiness Check -7. Implement with phased approach - -**Time**: 3-6 weeks - ---- - -### Scenario 5: Brownfield Addition (BMad Method) - -**Input**: "Add search functionality to existing product catalog" - -**Detection**: Brownfield + moderate complexity - -**Track**: BMad Method (not Quick Flow) - -**Critical First Step**: - -1. **Run document-project** to analyze existing codebase - -**Then Workflow**: - -2. PRD for search feature (FRs/NFRs) -3. Architecture (integration design - highly recommended) -4. Create Epics and Stories -5. Implementation Readiness Check -6. Implement following existing patterns - -**Time**: 1-2 weeks - -**Why Method not Quick Flow?**: Integration with existing catalog system benefits from architecture planning to ensure consistency. - ---- - -### Scenario 6: Multi-tenant Platform (Enterprise Method) - -**Input**: "Add multi-tenancy to existing single-tenant SaaS platform" - -**Detection**: Keywords "multi-tenant", enterprise scale - -**Track**: Enterprise Method - -**Workflow**: - -1. Document-project (mandatory) -2. Research (compliance, security) -3. PRD (multi-tenancy requirements - FRs/NFRs) -4. Architecture (tenant isolation design) -5. Create Epics and Stories -6. Security Architecture (data isolation, auth) -7. DevOps Strategy (tenant provisioning, monitoring) -8. Test Strategy (tenant isolation testing) -9. Implementation Readiness Check -10. Phased implementation - -**Time**: 3-6 months - ---- - -## Best Practices - -### 1. Document-Project First for Brownfield - -Always run `document-project` before starting brownfield planning. AI agents need existing codebase context. - -### 2. Trust the Recommendation - -If `workflow-init` suggests BMad Method, there's probably complexity you haven't considered. Review carefully before overriding. - -### 3. Start Smaller if Uncertain - -Uncertain between Quick Flow and Method? Start with Quick Flow. You can create PRD later if needed. - -### 4. Don't Skip Implementation Readiness Check - -For BMad Method and Enterprise, implementation readiness checks prevent costly mistakes. Invest the time. - -### 5. Architecture is Optional but Recommended for Brownfield - -Brownfield BMad Method makes architecture optional, but it's highly recommended. It distills complex codebase into focused solution design. - -### 6. Discovery Phase Based on Need - -Brainstorming and research are offered regardless of track. Use them when you need to think through the problem space. - -### 7. Product Brief for Greenfield Method - -Product Brief is only offered for greenfield BMad Method and Enterprise. It's optional but helps with strategic thinking. - ---- - -## Key Differences from Legacy System - -### Old System (Levels 0-4) - -- Arbitrary story count thresholds -- Level 2 vs Level 3 based on story count -- Confusing overlap zones (5-10 stories, 12-40 stories) -- Tech-spec and PRD shown as conflicting options - -### New System (3 Tracks) - -- Methodology-based distinction (not story counts) -- Story counts as guidance, not definitions -- Clear track purposes: - - Quick Flow = Implementation-focused - - BMad Method = Product + system design - - Enterprise = Extended with security/ops -- Mutually exclusive paths chosen upfront -- Educational decision-making - ---- - -## Migration from Old System - -If you have existing projects using the old level system: - -- **Level 0-1** → Quick Flow -- **Level 2-3** → BMad Method -- **Level 4** → Enterprise Method - -Run `workflow-init` on existing projects to migrate to new tracking system. It detects existing planning artifacts and creates appropriate workflow tracking. - ---- - -## Related Documentation - -- **[Quick Start Guide](./quick-start.md)** - Get started with BMM -- **[Quick Spec Flow](./quick-spec-flow.md)** - Details on Quick Flow track -- **[Brownfield Guide](./brownfield-guide.md)** - Existing codebase workflows -- **[Glossary](./glossary.md)** - Complete terminology -- **[FAQ](./faq.md)** - Common questions -- **[Workflows Guide](./index.md#-workflow-guides)** - Complete workflow reference - ---- - -_Scale Adaptive System - Right planning depth for every project._ diff --git a/src/modules/bmm/docs/test-architecture.md b/src/modules/bmm/docs/test-architecture.md deleted file mode 100644 index eb44a0c8..00000000 --- a/src/modules/bmm/docs/test-architecture.md +++ /dev/null @@ -1,455 +0,0 @@ ---- -last-redoc-date: 2025-11-05 ---- - -# Test Architect (TEA) Agent Guide - -## Overview - -- **Persona:** Murat, Master Test Architect and Quality Advisor focused on risk-based testing, fixture architecture, ATDD, and CI/CD governance. -- **Mission:** Deliver actionable quality strategies, automation coverage, and gate decisions that scale with project complexity and compliance demands. -- **Use When:** BMad Method or Enterprise track projects, integration risk is non-trivial, brownfield regression risk exists, or compliance/NFR evidence is required. (Quick Flow projects typically don't require TEA) - -## TEA Workflow Lifecycle - -TEA integrates into the BMad development lifecycle during Solutioning (Phase 3) and Implementation (Phase 4): - -```mermaid -%%{init: {'theme':'base', 'themeVariables': { 'primaryColor':'#fff','primaryTextColor':'#000','primaryBorderColor':'#000','lineColor':'#000','secondaryColor':'#fff','tertiaryColor':'#fff','fontSize':'16px','fontFamily':'arial'}}}%% -graph TB - subgraph Phase2["Phase 2: PLANNING"] - PM["PM: *prd (creates PRD with FRs/NFRs)"] - PlanNote["Business requirements phase"] - PM -.-> PlanNote - end - - subgraph Phase3["Phase 3: SOLUTIONING"] - Architecture["Architect: *architecture"] - EpicsStories["PM/Architect: *create-epics-and-stories"] - TestDesignSys["TEA: *test-design (system-level)"] - Framework["TEA: *framework"] - CI["TEA: *ci"] - GateCheck["Architect: *implementation-readiness"] - Architecture --> EpicsStories - Architecture --> TestDesignSys - TestDesignSys --> Framework - EpicsStories --> Framework - Framework --> CI - CI --> GateCheck - Phase3Note["Epics created AFTER architecture,
then system-level test design and test infrastructure setup"] - EpicsStories -.-> Phase3Note - end - - subgraph Phase4["Phase 4: IMPLEMENTATION - Per Epic Cycle"] - SprintPlan["SM: *sprint-planning"] - TestDesign["TEA: *test-design (per epic)"] - CreateStory["SM: *create-story"] - ATDD["TEA: *atdd (optional, before dev)"] - DevImpl["DEV: implements story"] - Automate["TEA: *automate"] - TestReview1["TEA: *test-review (optional)"] - Trace1["TEA: *trace (refresh coverage)"] - - SprintPlan --> TestDesign - TestDesign --> CreateStory - CreateStory --> ATDD - ATDD --> DevImpl - DevImpl --> Automate - Automate --> TestReview1 - TestReview1 --> Trace1 - Trace1 -.->|next story| CreateStory - TestDesignNote["Test design: 'How do I test THIS epic?'
Creates test-design-epic-N.md per epic"] - TestDesign -.-> TestDesignNote - end - - subgraph Gate["EPIC/RELEASE GATE"] - NFR["TEA: *nfr-assess (if not done earlier)"] - TestReview2["TEA: *test-review (final audit, optional)"] - TraceGate["TEA: *trace - Phase 2: Gate"] - GateDecision{"Gate Decision"} - - NFR --> TestReview2 - TestReview2 --> TraceGate - TraceGate --> GateDecision - GateDecision -->|PASS| Pass["PASS ✅"] - GateDecision -->|CONCERNS| Concerns["CONCERNS ⚠️"] - GateDecision -->|FAIL| Fail["FAIL ❌"] - GateDecision -->|WAIVED| Waived["WAIVED ⏭️"] - end - - Phase2 --> Phase3 - Phase3 --> Phase4 - Phase4 --> Gate - - style Phase2 fill:#bbdefb,stroke:#0d47a1,stroke-width:3px,color:#000 - style Phase3 fill:#c8e6c9,stroke:#2e7d32,stroke-width:3px,color:#000 - style Phase4 fill:#e1bee7,stroke:#4a148c,stroke-width:3px,color:#000 - style Gate fill:#ffe082,stroke:#f57c00,stroke-width:3px,color:#000 - style Pass fill:#4caf50,stroke:#1b5e20,stroke-width:3px,color:#000 - style Concerns fill:#ffc107,stroke:#f57f17,stroke-width:3px,color:#000 - style Fail fill:#f44336,stroke:#b71c1c,stroke-width:3px,color:#000 - style Waived fill:#9c27b0,stroke:#4a148c,stroke-width:3px,color:#000 -``` - -**Phase Numbering Note:** BMad uses a 4-phase methodology with optional Phase 1 and documentation prerequisite: - -- **Documentation** (Optional for brownfield): Prerequisite using `*document-project` -- **Phase 1** (Optional): Discovery/Analysis (`*brainstorm`, `*research`, `*product-brief`) -- **Phase 2** (Required): Planning (`*prd` creates PRD with FRs/NFRs) -- **Phase 3** (Track-dependent): Solutioning (`*architecture` → `*test-design` (system-level) → `*create-epics-and-stories` → TEA: `*framework`, `*ci` → `*implementation-readiness`) -- **Phase 4** (Required): Implementation (`*sprint-planning` → per-epic: `*test-design` → per-story: dev workflows) - -**TEA workflows:** `*framework` and `*ci` run once in Phase 3 after architecture. `*test-design` is **dual-mode**: - -- **System-level (Phase 3):** Run immediately after architecture/ADR drafting to produce `test-design-system.md` (testability review, ADR → test mapping, Architecturally Significant Requirements (ASRs), environment needs). Feeds the implementation-readiness gate. -- **Epic-level (Phase 4):** Run per-epic to produce `test-design-epic-N.md` (risk, priorities, coverage plan). - -Quick Flow track skips Phases 1 and 3. -BMad Method and Enterprise use all phases based on project needs. -When an ADR or architecture draft is produced, run `*test-design` in **system-level** mode before the implementation-readiness gate. This ensures the ADR has an attached testability review and ADR → test mapping. Keep the test-design updated if ADRs change. - -### Why TEA is Different from Other BMM Agents - -TEA is the only BMM agent that operates in **multiple phases** (Phase 3 and Phase 4) and has its own **knowledge base architecture**. - -
-Cross-Phase Operation & Unique Architecture - -### Phase-Specific Agents (Standard Pattern) - -Most BMM agents work in a single phase: - -- **Phase 1 (Analysis)**: Analyst agent -- **Phase 2 (Planning)**: PM agent -- **Phase 3 (Solutioning)**: Architect agent -- **Phase 4 (Implementation)**: SM, DEV agents - -### TEA: Multi-Phase Quality Agent (Unique Pattern) - -TEA is **the only agent that operates in multiple phases**: - -``` -Phase 1 (Analysis) → [TEA not typically used] - ↓ -Phase 2 (Planning) → [PM defines requirements - TEA not active] - ↓ -Phase 3 (Solutioning) → TEA: *framework, *ci (test infrastructure AFTER architecture) - ↓ -Phase 4 (Implementation) → TEA: *test-design (per epic: "how do I test THIS feature?") - → TEA: *atdd, *automate, *test-review, *trace (per story) - ↓ -Epic/Release Gate → TEA: *nfr-assess, *trace Phase 2 (release decision) -``` - -### TEA's 8 Workflows Across Phases - -**Standard agents**: 1-3 workflows per phase -**TEA**: 8 workflows across Phase 3, Phase 4, and Release Gate - -| Phase | TEA Workflows | Frequency | Purpose | -| ----------- | --------------------------------------------------------- | ---------------- | ---------------------------------------------- | -| **Phase 2** | (none) | - | Planning phase - PM defines requirements | -| **Phase 3** | \*framework, \*ci | Once per project | Setup test infrastructure AFTER architecture | -| **Phase 4** | \*test-design, \*atdd, \*automate, \*test-review, \*trace | Per epic/story | Test planning per epic, then per-story testing | -| **Release** | \*nfr-assess, \*trace (Phase 2: gate) | Per epic/release | Go/no-go decision | - -**Note**: `*trace` is a two-phase workflow: Phase 1 (traceability) + Phase 2 (gate decision). This reduces cognitive load while maintaining natural workflow. - -### Why TEA Gets Special Treatment - -TEA uniquely requires: - -- **Extensive domain knowledge**: 32 fragments covering test patterns, CI/CD, fixtures, quality practices, healing strategies, and optional playwright-utils integration -- **Centralized reference system**: `tea-index.csv` for on-demand fragment loading during workflow execution -- **Cross-cutting concerns**: Domain-specific testing patterns (vs project-specific artifacts like PRDs/stories) -- **Optional integrations**: MCP capabilities (healing, exploratory, verification) and playwright-utils support - -This architecture enables TEA to maintain consistent, production-ready testing patterns across all BMad projects while operating across multiple development phases. - -### Playwright Utils Integration - -TEA optionally integrates with `@seontechnologies/playwright-utils`, an open-source library providing fixture-based utilities for Playwright tests. - -**Installation:** - -```bash -npm install -D @seontechnologies/playwright-utils -``` - -**Enable during BMAD installation** by answering "Yes" when prompted. - -**Supported utilities (11 total):** - -- api-request, network-recorder, auth-session, intercept-network-call, recurse -- log, file-utils, burn-in, network-error-monitor -- fixtures-composition (integration patterns) - -**Workflows adapt:** automate, framework, test-review, ci, atdd (+ light mention in test-design). - -**Knowledge base:** 32 total fragments (21 core patterns + 11 playwright-utils) - -
- -## High-Level Cheat Sheets - -These cheat sheets map TEA workflows to the **BMad Method and Enterprise tracks** across the **4-Phase Methodology** (Phase 1: Analysis, Phase 2: Planning, Phase 3: Solutioning, Phase 4: Implementation). - -**Note:** Quick Flow projects typically don't require TEA (covered in Overview). These cheat sheets focus on BMad Method and Enterprise tracks where TEA adds value. - -**Legend for Track Deltas:** - -- ➕ = New workflow or phase added (doesn't exist in baseline) -- 🔄 = Modified focus (same workflow, different emphasis or purpose) -- 📦 = Additional output or archival requirement - -### Greenfield - BMad Method (Simple/Standard Work) - -**Planning Track:** BMad Method (PRD + Architecture) -**Use Case:** New projects with standard complexity - -| Workflow Stage | Test Architect | Dev / Team | Outputs | -| -------------------------- | ----------------------------------------------------------------- | ----------------------------------------------------------------------------------- | ---------------------------------------------------------- | -| **Phase 1**: Discovery | - | Analyst `*product-brief` (optional) | `product-brief.md` | -| **Phase 2**: Planning | - | PM `*prd` (creates PRD with FRs/NFRs) | PRD with functional/non-functional requirements | -| **Phase 3**: Solutioning | Run `*framework`, `*ci` AFTER architecture and epic creation | Architect `*architecture`, `*create-epics-and-stories`, `*implementation-readiness` | Architecture, epics/stories, test scaffold, CI pipeline | -| **Phase 4**: Sprint Start | - | SM `*sprint-planning` | Sprint status file with all epics and stories | -| **Phase 4**: Epic Planning | Run `*test-design` for THIS epic (per-epic test plan) | Review epic scope | `test-design-epic-N.md` with risk assessment and test plan | -| **Phase 4**: Story Dev | (Optional) `*atdd` before dev, then `*automate` after | SM `*create-story`, DEV implements | Tests, story implementation | -| **Phase 4**: Story Review | Execute `*test-review` (optional), re-run `*trace` | Address recommendations, update code/tests | Quality report, refreshed coverage matrix | -| **Phase 4**: Release Gate | (Optional) `*test-review` for final audit, Run `*trace` (Phase 2) | Confirm Definition of Done, share release notes | Quality audit, Gate YAML + release summary | - -
-Execution Notes - -- Run `*framework` only once per repo or when modern harness support is missing. -- **Phase 3 (Solutioning)**: After architecture is complete, run `*framework` and `*ci` to setup test infrastructure based on architectural decisions. -- **Phase 4 starts**: After solutioning is complete, sprint planning loads all epics. -- **`*test-design` runs per-epic**: At the beginning of working on each epic, run `*test-design` to create a test plan for THAT specific epic/feature. Output: `test-design-epic-N.md`. -- Use `*atdd` before coding when the team can adopt ATDD; share its checklist with the dev agent. -- Post-implementation, keep `*trace` current, expand coverage with `*automate`, optionally review test quality with `*test-review`. For release gate, run `*trace` with Phase 2 enabled to get deployment decision. -- Use `*test-review` after `*atdd` to validate generated tests, after `*automate` to ensure regression quality, or before gate for final audit. -- Clarification: `*test-review` is optional and only audits existing tests; run it after `*atdd` or `*automate` when you want a quality review, not as a required step. -- Clarification: `*atdd` outputs are not auto-consumed; share the ATDD doc/tests with the dev workflow. `*trace` does not run `*atdd`—it evaluates existing artifacts for coverage and gate readiness. -- Clarification: `*ci` is a one-time setup; recommended early (Phase 3 or before feature work), but it can be done later if it was skipped. - -
- -
-Worked Example – “Nova CRM” Greenfield Feature - -1. **Planning (Phase 2):** Analyst runs `*product-brief`; PM executes `*prd` to produce PRD with FRs/NFRs. -2. **Solutioning (Phase 3):** Architect completes `*architecture` for the new module; `*create-epics-and-stories` generates epics/stories based on architecture; TEA sets up test infrastructure via `*framework` and `*ci` based on architectural decisions; gate check validates planning completeness. -3. **Sprint Start (Phase 4):** Scrum Master runs `*sprint-planning` to load all epics into sprint status. -4. **Epic 1 Planning (Phase 4):** TEA runs `*test-design` to create test plan for Epic 1, producing `test-design-epic-1.md` with risk assessment. -5. **Story Implementation (Phase 4):** For each story in Epic 1, SM generates story via `*create-story`; TEA optionally runs `*atdd`; Dev implements with guidance from failing tests. -6. **Post-Dev (Phase 4):** TEA runs `*automate`, optionally `*test-review` to audit test quality, re-runs `*trace` to refresh coverage. -7. **Release Gate:** TEA runs `*trace` with Phase 2 enabled to generate gate decision. - -
- -### Brownfield - BMad Method or Enterprise (Simple or Complex) - -**Planning Tracks:** BMad Method or Enterprise Method -**Use Case:** Existing codebases - simple additions (BMad Method) or complex enterprise requirements (Enterprise Method) - -**🔄 Brownfield Deltas from Greenfield:** - -- ➕ Documentation (Prerequisite) - Document existing codebase if undocumented -- ➕ Phase 2: `*trace` - Baseline existing test coverage before planning -- 🔄 Phase 4: `*test-design` - Focus on regression hotspots and brownfield risks -- 🔄 Phase 4: Story Review - May include `*nfr-assess` if not done earlier - -| Workflow Stage | Test Architect | Dev / Team | Outputs | -| ---------------------------------- | ---------------------------------------------------------------------------- | ----------------------------------------------------------------------------------- | ---------------------------------------------------------------------- | -| **Documentation**: Prerequisite ➕ | - | Analyst `*document-project` (if undocumented) | Comprehensive project documentation | -| **Phase 1**: Discovery | - | Analyst/PM/Architect rerun planning workflows | Updated planning artifacts in `{output_folder}` | -| **Phase 2**: Planning | Run ➕ `*trace` (baseline coverage) | PM `*prd` (creates PRD with FRs/NFRs) | PRD with FRs/NFRs, ➕ coverage baseline | -| **Phase 3**: Solutioning | Run `*framework`, `*ci` AFTER architecture and epic creation | Architect `*architecture`, `*create-epics-and-stories`, `*implementation-readiness` | Architecture, epics/stories, test framework, CI pipeline | -| **Phase 4**: Sprint Start | - | SM `*sprint-planning` | Sprint status file with all epics and stories | -| **Phase 4**: Epic Planning | Run `*test-design` for THIS epic 🔄 (regression hotspots) | Review epic scope and brownfield risks | `test-design-epic-N.md` with brownfield risk assessment and mitigation | -| **Phase 4**: Story Dev | (Optional) `*atdd` before dev, then `*automate` after | SM `*create-story`, DEV implements | Tests, story implementation | -| **Phase 4**: Story Review | Apply `*test-review` (optional), re-run `*trace`, ➕ `*nfr-assess` if needed | Resolve gaps, update docs/tests | Quality report, refreshed coverage matrix, NFR report | -| **Phase 4**: Release Gate | (Optional) `*test-review` for final audit, Run `*trace` (Phase 2) | Capture sign-offs, share release notes | Quality audit, Gate YAML + release summary | - -
-Execution Notes - -- Lead with `*trace` during Planning (Phase 2) to baseline existing test coverage before architecture work begins. -- **Phase 3 (Solutioning)**: After architecture is complete, run `*framework` and `*ci` to modernize test infrastructure. For brownfield, framework may need to integrate with or replace existing test setup. -- **Phase 4 starts**: After solutioning is complete and sprint planning loads all epics. -- **`*test-design` runs per-epic**: At the beginning of working on each epic, run `*test-design` to identify regression hotspots, integration risks, and mitigation strategies for THAT specific epic/feature. Output: `test-design-epic-N.md`. -- Use `*atdd` when stories benefit from ATDD; otherwise proceed to implementation and rely on post-dev automation. -- After development, expand coverage with `*automate`, optionally review test quality with `*test-review`, re-run `*trace` (Phase 2 for gate decision). Run `*nfr-assess` now if non-functional risks weren't addressed earlier. -- Use `*test-review` to validate existing brownfield tests or audit new tests before gate. - -
- -
-Worked Example – “Atlas Payments” Brownfield Story - -1. **Planning (Phase 2):** PM executes `*prd` to create PRD with FRs/NFRs; TEA runs `*trace` to baseline existing coverage. -2. **Solutioning (Phase 3):** Architect triggers `*architecture` capturing legacy payment flows and integration architecture; `*create-epics-and-stories` generates Epic 1 (Payment Processing) based on architecture; TEA sets up `*framework` and `*ci` based on architectural decisions; gate check validates planning. -3. **Sprint Start (Phase 4):** Scrum Master runs `*sprint-planning` to load Epic 1 into sprint status. -4. **Epic 1 Planning (Phase 4):** TEA runs `*test-design` for Epic 1 (Payment Processing), producing `test-design-epic-1.md` that flags settlement edge cases, regression hotspots, and mitigation plans. -5. **Story Implementation (Phase 4):** For each story in Epic 1, SM generates story via `*create-story`; TEA runs `*atdd` producing failing Playwright specs; Dev implements with guidance from tests and checklist. -6. **Post-Dev (Phase 4):** TEA applies `*automate`, optionally `*test-review` to audit test quality, re-runs `*trace` to refresh coverage. -7. **Release Gate:** TEA performs `*nfr-assess` to validate SLAs, runs `*trace` with Phase 2 enabled to generate gate decision (PASS/CONCERNS/FAIL). - -
- -### Greenfield - Enterprise Method (Enterprise/Compliance Work) - -**Planning Track:** Enterprise Method (BMad Method + extended security/devops/test strategies) -**Use Case:** New enterprise projects with compliance, security, or complex regulatory requirements - -**🏢 Enterprise Deltas from BMad Method:** - -- ➕ Phase 1: `*research` - Domain and compliance research (recommended) -- ➕ Phase 2: `*nfr-assess` - Capture NFR requirements early (security/performance/reliability) -- 🔄 Phase 4: `*test-design` - Enterprise focus (compliance, security architecture alignment) -- 📦 Release Gate - Archive artifacts and compliance evidence for audits - -| Workflow Stage | Test Architect | Dev / Team | Outputs | -| -------------------------- | ------------------------------------------------------------------------ | ----------------------------------------------------------------------------------- | ------------------------------------------------------------------ | -| **Phase 1**: Discovery | - | Analyst ➕ `*research`, `*product-brief` | Domain research, compliance analysis, product brief | -| **Phase 2**: Planning | Run ➕ `*nfr-assess` | PM `*prd` (creates PRD with FRs/NFRs), UX `*create-ux-design` | Enterprise PRD with FRs/NFRs, UX design, ➕ NFR documentation | -| **Phase 3**: Solutioning | Run `*framework`, `*ci` AFTER architecture and epic creation | Architect `*architecture`, `*create-epics-and-stories`, `*implementation-readiness` | Architecture, epics/stories, test framework, CI pipeline | -| **Phase 4**: Sprint Start | - | SM `*sprint-planning` | Sprint plan with all epics | -| **Phase 4**: Epic Planning | Run `*test-design` for THIS epic 🔄 (compliance focus) | Review epic scope and compliance requirements | `test-design-epic-N.md` with security/performance/compliance focus | -| **Phase 4**: Story Dev | (Optional) `*atdd`, `*automate`, `*test-review`, `*trace` per story | SM `*create-story`, DEV implements | Tests, fixtures, quality reports, coverage matrices | -| **Phase 4**: Release Gate | Final `*test-review` audit, Run `*trace` (Phase 2), 📦 archive artifacts | Capture sign-offs, 📦 compliance evidence | Quality audit, updated assessments, gate YAML, 📦 audit trail | - -
-Execution Notes - -- `*nfr-assess` runs early in Planning (Phase 2) to capture compliance, security, and performance requirements upfront. -- **Phase 3 (Solutioning)**: After architecture is complete, run `*framework` and `*ci` with enterprise-grade configurations (selective testing, burn-in jobs, caching, notifications). -- **Phase 4 starts**: After solutioning is complete and sprint planning loads all epics. -- **`*test-design` runs per-epic**: At the beginning of working on each epic, run `*test-design` to create an enterprise-focused test plan for THAT specific epic, ensuring alignment with security architecture, performance targets, and compliance requirements. Output: `test-design-epic-N.md`. -- Use `*atdd` for stories when feasible so acceptance tests can lead implementation. -- Use `*test-review` per story or sprint to maintain quality standards and ensure compliance with testing best practices. -- Prior to release, rerun coverage (`*trace`, `*automate`), perform final quality audit with `*test-review`, and formalize the decision with `*trace` Phase 2 (gate decision); archive artifacts for compliance audits. - -
- -
-Worked Example – “Helios Ledger” Enterprise Release - -1. **Planning (Phase 2):** Analyst runs `*research` and `*product-brief`; PM completes `*prd` creating PRD with FRs/NFRs; TEA runs `*nfr-assess` to establish NFR targets. -2. **Solutioning (Phase 3):** Architect completes `*architecture` with enterprise considerations; `*create-epics-and-stories` generates epics/stories based on architecture; TEA sets up `*framework` and `*ci` with enterprise-grade configurations based on architectural decisions; gate check validates planning completeness. -3. **Sprint Start (Phase 4):** Scrum Master runs `*sprint-planning` to load all epics into sprint status. -4. **Per-Epic (Phase 4):** For each epic, TEA runs `*test-design` to create epic-specific test plan (e.g., `test-design-epic-1.md`, `test-design-epic-2.md`) with compliance-focused risk assessment. -5. **Per-Story (Phase 4):** For each story, TEA uses `*atdd`, `*automate`, `*test-review`, and `*trace`; Dev teams iterate on the findings. -6. **Release Gate:** TEA re-checks coverage, performs final quality audit with `*test-review`, and logs the final gate decision via `*trace` Phase 2, archiving artifacts for compliance. - -
- -## Command Catalog - -
-Optional Playwright MCP Enhancements - -**Two Playwright MCP servers** (actively maintained, continuously updated): - -- `playwright` - Browser automation (`npx @playwright/mcp@latest`) -- `playwright-test` - Test runner with failure analysis (`npx playwright run-test-mcp-server`) - -**How MCP Enhances TEA Workflows**: - -MCP provides additional capabilities on top of TEA's default AI-based approach: - -1. `*test-design`: - - Default: Analysis + documentation - - **+ MCP**: Interactive UI discovery with `browser_navigate`, `browser_click`, `browser_snapshot`, behavior observation - - Benefit: Discover actual functionality, edge cases, undocumented features - -2. `*atdd`, `*automate`: - - Default: Infers selectors and interactions from requirements and knowledge fragments - - **+ MCP**: Generates tests **then** verifies with `generator_setup_page`, `browser_*` tools, validates against live app - - Benefit: Accurate selectors from real DOM, verified behavior, refined test code - -3. `*automate`: - - Default: Pattern-based fixes from error messages + knowledge fragments - - **+ MCP**: Pattern fixes **enhanced with** `browser_snapshot`, `browser_console_messages`, `browser_network_requests`, `browser_generate_locator` - - Benefit: Visual failure context, live DOM inspection, root cause discovery - -**Config example**: - -```json -{ - "mcpServers": { - "playwright": { - "command": "npx", - "args": ["@playwright/mcp@latest"] - }, - "playwright-test": { - "command": "npx", - "args": ["playwright", "run-test-mcp-server"] - } - } -} -``` - -**To disable**: Set `tea_use_mcp_enhancements: false` in `_bmad/bmm/config.yaml` OR remove MCPs from IDE config. - -
- -
-Optional Playwright Utils Integration - -**Open-source Playwright utilities** from SEON Technologies (production-tested, npm published): - -- **Package**: `@seontechnologies/playwright-utils` ([npm](https://www.npmjs.com/package/@seontechnologies/playwright-utils) | [GitHub](https://github.com/seontechnologies/playwright-utils)) -- **Install**: `npm install -D @seontechnologies/playwright-utils` - -**How Playwright Utils Enhances TEA Workflows**: - -Provides fixture-based utilities that integrate into TEA's test generation and review workflows: - -1. `*framework`: - - Default: Basic Playwright scaffold - - **+ playwright-utils**: Scaffold with api-request, network-recorder, auth-session, burn-in, network-error-monitor fixtures pre-configured - - Benefit: Production-ready patterns from day one - -2. `*automate`, `*atdd`: - - Default: Standard test patterns - - **+ playwright-utils**: Tests using api-request (schema validation), intercept-network-call (mocking), recurse (polling), log (structured logging), file-utils (CSV/PDF) - - Benefit: Advanced patterns without boilerplate - -3. `*test-review`: - - Default: Reviews against core knowledge base (21 fragments) - - **+ playwright-utils**: Reviews against expanded knowledge base (32 fragments: 21 core + 11 playwright-utils) - - Benefit: Reviews include fixture composition, auth patterns, network recording best practices - -4. `*ci`: - - Default: Standard CI workflow - - **+ playwright-utils**: CI workflow with burn-in script (smart test selection) and network-error-monitor integration - - Benefit: Faster CI feedback, HTTP error detection - -**Utilities available** (11 total): api-request, network-recorder, auth-session, intercept-network-call, recurse, log, file-utils, burn-in, network-error-monitor, fixtures-composition - -**Enable during BMAD installation** by answering "Yes" when prompted, or manually set `tea_use_playwright_utils: true` in `_bmad/bmm/config.yaml`. - -**To disable**: Set `tea_use_playwright_utils: false` in `_bmad/bmm/config.yaml`. - -
- -

- -| Command | Primary Outputs | Notes | With Playwright MCP Enhancements | -| -------------- | --------------------------------------------------------------------------------------------- | ---------------------------------------------------- | ------------------------------------------------------------------------------------------------------------ | -| `*framework` | Playwright/Cypress scaffold, `.env.example`, `.nvmrc`, sample specs | Use when no production-ready harness exists | - | -| `*ci` | CI workflow, selective test scripts, secrets checklist | Platform-aware (GitHub Actions default) | - | -| `*test-design` | Combined risk assessment, mitigation plan, and coverage strategy | Risk scoring + optional exploratory mode | **+ Exploratory**: Interactive UI discovery with browser automation (uncover actual functionality) | -| `*atdd` | Failing acceptance tests + implementation checklist | TDD red phase + optional recording mode | **+ Recording**: AI generation verified with live browser (accurate selectors from real DOM) | -| `*automate` | Prioritized specs, fixtures, README/script updates, DoD summary | Optional healing/recording, avoid duplicate coverage | **+ Healing**: Pattern fixes enhanced with visual debugging + **+ Recording**: AI verified with live browser | -| `*test-review` | Test quality review report with 0-100 score, violations, fixes | Reviews tests against knowledge base patterns | - | -| `*nfr-assess` | NFR assessment report with actions | Focus on security/performance/reliability | - | -| `*trace` | Phase 1: Coverage matrix, recommendations. Phase 2: Gate decision (PASS/CONCERNS/FAIL/WAIVED) | Two-phase workflow: traceability + gate decision | - | diff --git a/src/modules/bmm/docs/troubleshooting.md b/src/modules/bmm/docs/troubleshooting.md deleted file mode 100644 index 35ba5ce8..00000000 --- a/src/modules/bmm/docs/troubleshooting.md +++ /dev/null @@ -1,661 +0,0 @@ -# BMM Troubleshooting Guide - -Common issues and solutions for the BMad Method Module. - ---- - -## Quick Diagnosis - -**Use this flowchart to find your issue:** - -```mermaid -flowchart TD - START{What's the problem?} - - START -->|Can't get started| SETUP[Setup & Installation Issues] - START -->|Wrong level detected| LEVEL[Level Detection Problems] - START -->|Workflow not working| WORKFLOW[Workflow Issues] - START -->|Agent lacks context| CONTEXT[Context & Documentation Issues] - START -->|Implementation problems| IMPL[Implementation Issues] - START -->|Files/paths wrong| FILES[File & Path Issues] - - style START fill:#ffb,stroke:#333,stroke-width:2px - style SETUP fill:#bfb,stroke:#333,stroke-width:2px - style LEVEL fill:#bbf,stroke:#333,stroke-width:2px - style WORKFLOW fill:#fbf,stroke:#333,stroke-width:2px - style CONTEXT fill:#f9f,stroke:#333,stroke-width:2px -``` - ---- - -## Table of Contents - -- [Setup and Installation Issues](#setup-and-installation-issues) -- [Level Detection Problems](#level-detection-problems) -- [Workflow Issues](#workflow-issues) -- [Context and Documentation Issues](#context-and-documentation-issues) -- [Implementation Issues](#implementation-issues) -- [File and Path Issues](#file-and-path-issues) -- [Agent Behavior Issues](#agent-behavior-issues) -- [Integration Issues (Brownfield)](#integration-issues-brownfield) - ---- - -## Setup and Installation Issues - -### Problem: BMM not found after installation - -**Symptoms:** - -- `bmad` command not recognized -- Agent files not accessible -- Workflows don't load - -**Solution:** - -```bash -# Check if BMM is installed -ls bmad/ - -# If not present, run installer -npx bmad-method@alpha install - -# For fresh install -npx bmad-method@alpha install --skip-version-prompt -``` - -### Problem: Agents don't have menu - -**Symptoms:** - -- Load agent file but no menu appears -- Agent doesn't respond to commands - -**Solution:** - -1. Ensure you're loading the correct agent file path: `bmad/bmm/agents/[agent-name].md` -2. Wait a few seconds for agent to initialize -3. Try asking "show menu" or "help" -4. Check IDE supports Markdown rendering with context -5. For Claude Code: Ensure agent file is open in chat context - -### Problem: Workflows not found - -**Symptoms:** - -- Agent says workflow doesn't exist -- Menu shows workflow but won't run - -**Solution:** - -1. Check workflow exists: `ls bmad/bmm/workflows/` -2. Verify agent has access to workflow (check agent's workflow list) -3. Try using menu number instead of workflow name -4. Restart chat with agent in fresh session - ---- - -## Level Detection Problems - -### Problem: workflow-init suggests wrong level - -**Symptoms:** - -- Detects Level 3 but you only need Level 1 -- Suggests Level 1 but project is actually Level 2 -- Can't figure out appropriate level - -**Solution:** - -1. **Override the suggestion** - workflow-init always asks for confirmation, just say "no" and choose correct level -2. **Be specific in description** - Use level keywords when describing: - - "fix bug" → Level 0 - - "add small feature" → Level 1 - - "build dashboard" → Level 2 -3. **Manual override** - You can always switch levels later if needed - -**Example:** - -``` -workflow-init: "Level 3 project?" -You: "No, this is just adding OAuth login - Level 1" -workflow-init: "Got it, creating Level 1 workflow" -``` - -### Problem: Project level unclear - -**Symptoms:** - -- Between Level 1 and Level 2 -- Not sure if architecture needed -- Story count uncertain - -**Solution:** -**When in doubt, start smaller:** - -- Choose Level 1 instead of Level 2 -- You can always run `create-prd` later if needed -- Level 1 is faster, less overhead -- Easy to upgrade, hard to downgrade - -**Decision criteria:** - -- Single epic with related stories? → Level 1 -- Multiple independent epics? → Level 2 -- Need product-level planning? → Level 2 -- Just need technical plan? → Level 1 - -### Problem: Old planning docs influencing level detection - -**Symptoms:** - -- Old Level 3 PRD in folder -- Working on new Level 0 bug fix -- workflow-init suggests Level 3 - -**Solution:** -workflow-init asks: "Is this work in progress or previous effort?" - -- Answer: "Previous effort" -- Then describe your NEW work clearly -- System will detect level based on NEW work, not old artifacts - ---- - -## Workflow Issues - -### Problem: Workflow fails or hangs - -**Symptoms:** - -- Workflow starts but doesn't complete -- Agent stops responding mid-workflow -- Progress stalls - -**Solution:** - -1. **Check context limits** - Start fresh chat for complex workflows -2. **Verify prerequisites**: - - Phase 2 needs Phase 1 complete (if used) - - Phase 3 needs Phase 2 complete - - Phase 4 needs Phase 3 complete (if Level 3-4) -3. **Restart workflow** - Load agent in new chat and restart -4. **Check status file** - Verify `bmm-workflow-status.md` or `sprint-status.yaml` is present and valid - -### Problem: Agent says "workflow not found" - -**Symptoms:** - -- Request workflow by name -- Agent doesn't recognize it -- Menu doesn't show workflow - -**Solution:** - -1. Check spelling/format - Use exact workflow name or menu shortcut (`*prd` not `*PRD`) -2. Verify agent has workflow: - - PM agent: prd, tech-spec - - Architect agent: create-architecture, validate-architecture - - SM agent: sprint-planning, create-story -3. Try menu number instead of name -4. Check you're using correct agent for workflow - -### Problem: Sprint-planning workflow fails - -**Symptoms:** - -- Can't create sprint-status.yaml -- Epics not extracted from files -- Status file empty or incorrect - -**Solution:** - -1. **Verify epic files exist**: - - Level 1: tech-spec with epic - - Level 2-4: epics.md or sharded epic files -2. **Check file format**: - - Epic files should be valid Markdown - - Epic headers should be clear (## Epic Name) -3. **Run in Phase 4 only** - Ensure Phase 2/3 complete first -4. **Check file paths** - Epic files should be in correct output folder - ---- - -## Context and Documentation Issues - -### Problem: AI agents lack codebase understanding (Brownfield) - -**Symptoms:** - -- Suggestions don't align with existing patterns -- Ignores available components -- Proposes approaches that conflict with architecture -- Doesn't reference existing code - -**Solution:** - -1. **Run document-project** - Critical for brownfield projects - ``` - Load Analyst agent → run document-project - Choose scan level: Deep (recommended for PRD prep) - ``` -2. **Verify docs/index.md exists** - This is master entry point for AI agents -3. **Check documentation completeness**: - - Review generated docs/index.md - - Ensure key systems are documented -4. **Run deep-dive on specific areas** if needed - -### Problem: Have documentation but agents can't find it - -**Symptoms:** - -- README.md, ARCHITECTURE.md exist -- AI agents still ask questions answered in docs -- No docs/index.md file - -**Solution:** -**Option 1: Quick fix (2-5min)** -Run `index-docs` task: - -- Located at `bmad/core/tasks/index-docs.xml` -- Scans existing docs and generates index.md -- Lightweight, just creates navigation - -**Option 2: Comprehensive (10-30min)** -Run document-project workflow: - -- Discovers existing docs in Step 2 -- Generates NEW AI-friendly documentation from codebase -- Creates index.md linking to BOTH existing and new docs - -**Why this matters:** AI agents need structured entry point (index.md) to navigate docs efficiently. - -### Problem: document-project takes too long - -**Symptoms:** - -- Exhaustive scan running for hours -- Impatient to start planning - -**Solution:** -**Choose appropriate scan level:** - -- **Quick (2-5min)** - Pattern analysis, no source reading - Good for initial overview -- **Deep (10-30min)** - Reads critical paths - **Recommended for most brownfield projects** -- **Exhaustive (30-120min)** - Reads all files - Only for migration planning or complete understanding - -For most brownfield projects, **Deep scan is sufficient**. - ---- - -## Implementation Issues - -### Problem: Existing tests breaking (Brownfield) - -**Symptoms:** - -- Regression test failures -- Previously working functionality broken -- Integration tests failing - -**Solution:** - -1. **Review changes against existing patterns**: - - Check if new code follows existing conventions - - Verify API contracts unchanged (unless intentionally versioned) -2. **Run test-review workflow** (TEA agent): - - Analyzes test coverage - - Identifies regression risks - - Suggests fixes -3. **Add regression testing to DoD**: - - All existing tests must pass - - Add integration tests for new code -4. **Consider feature flags** for gradual rollout - -### Problem: Story takes much longer than estimated - -**Symptoms:** - -- Story estimated 4 hours, took 12 hours -- Acceptance criteria harder than expected -- Hidden complexity discovered - -**Solution:** -**This is normal!** Estimates are estimates. To handle: - -1. **Continue until DoD met** - Don't compromise quality -2. **Document learnings in retrospective**: - - What caused the overrun? - - What should we watch for next time? -3. **Consider splitting story** if it's truly two stories -4. **Adjust future estimates** based on this data - -**Don't stress about estimate accuracy** - use them for learning, not judgment. - -### Problem: Integration points unclear - -**Symptoms:** - -- Not sure how to connect new code to existing -- Unsure which files to modify -- Multiple possible integration approaches - -**Solution:** - -1. **For brownfield**: - - Ensure document-project captured existing architecture - - Review architecture docs before implementing -2. **Check story file** - Should document integration points -3. **In tech-spec/architecture** - Explicitly document: - - Which existing modules to modify - - What APIs/services to integrate with - - Data flow between new and existing code -4. **Run integration-planning workflow** (Level 3-4): - - Architect agent creates integration strategy - -### Problem: Inconsistent patterns being introduced - -**Symptoms:** - -- New code style doesn't match existing -- Different architectural approach -- Not following team conventions - -**Solution:** - -1. **Check convention detection** (Quick Spec Flow): - - Should detect existing patterns - - Asks for confirmation before proceeding -2. **Review documentation** - Ensure document-project captured patterns -3. **Use comprehensive story files** - Include pattern guidance in story -4. **Add to code-review checklist**: - - Pattern adherence - - Convention consistency - - Style matching -5. **Run retrospective** to identify pattern deviations early - ---- - -## File and Path Issues - -### Problem: Output files in wrong location - -**Symptoms:** - -- PRD created in wrong folder -- Story files not where expected -- Documentation scattered - -**Solution:** -Check `bmad/bmm/config.yaml` for configured paths: - -```yaml -output_folder: '{project-root}/docs' -dev_story_location: '{project-root}/docs/stories' -``` - -Default locations: - -- Planning docs (PRD, epics, architecture): `{output_folder}/` -- Stories: `{dev_story_location}/` -- Status files: `{output_folder}/bmm-workflow-status.md`, `{output_folder}/sprint-status.yaml` - -To change locations, edit config.yaml then re-run workflows. - -### Problem: Can't find status file - -**Symptoms:** - -- workflow-status says no status file -- Can't track progress -- Lost place in workflow - -**Solution:** - -1. **Check default location**: `docs/bmm-workflow-status.md` -2. **If missing, reinitialize**: - ``` - Load Analyst agent → run workflow-init - ``` -3. **For Phase 4**: Look for `sprint-status.yaml` in same folder as PRD -4. **Search for it**: - ```bash - find . -name "bmm-workflow-status.md" - find . -name "sprint-status.yaml" - ``` - -### Problem: Sprint-status.yaml not updating - -**Symptoms:** - -- Workflows complete but status unchanged -- Stories stuck in old status -- Epic status not progressing - -**Solution:** - -1. **Manual update required** - Most status changes are manual: - ```yaml - stories: - - id: epic-1-story-1 - status: done # Change this manually - ``` -2. **Some workflows auto-update**: - - sprint-planning creates file - - create-story changes story to "ready-for-dev" - - dev-story may auto-update (check workflow) -3. **Re-run sprint-planning** to resync if needed - ---- - -## Agent Behavior Issues - -### Problem: Agent provides vague or generic responses - -**Symptoms:** - -- "Use appropriate framework" -- "Follow best practices" -- Generic advice without specifics - -**Solution:** - -1. **Provide more context** - Be specific in your description: - - "Add OAuth using passport.js to Express server" - - Not: "Add authentication" -2. **For brownfield**: - - Ensure document-project was run - - Agent needs codebase context for specific advice -3. **Reference existing docs**: - - "Based on the existing auth system in UserService..." -4. **Start fresh chat** - Context overload can cause generic responses - -### Problem: Agent hallucinating or making up information - -**Symptoms:** - -- References files that don't exist -- Suggests APIs that aren't in your stack -- Creates imaginary requirements - -**Solution:** - -1. **Use fresh chat** - Context overflow main cause of hallucinations -2. **Provide concrete constraints**: - - "We use Express 4.18.2, not Next.js" - - "Our database is PostgreSQL, not MongoDB" -3. **For brownfield**: - - Document-project provides factual grounding - - Agent sees actual code, not assumptions -4. **Correct immediately**: - - "No, we don't have UserService, we have AuthenticationModule" - -### Problem: Agent won't follow instructions - -**Symptoms:** - -- Ignores specific requests -- Does something different than asked -- Doesn't respect constraints - -**Solution:** - -1. **Be more explicit** - Agents respond to clear, specific instructions: - - "Use EXACTLY these three steps..." - - "Do NOT include database migrations in this story" -2. **Check agent capabilities** - Agent might not have access to requested workflow -3. **Try different phrasing** - Rephrase request to be more direct -4. **Use menu system** - Numbers are clearer than text commands - ---- - -## Integration Issues (Brownfield) - -### Problem: New code conflicts with existing architecture - -**Symptoms:** - -- Integration approach doesn't fit existing structure -- Would require major refactoring -- Conflicts with established patterns - -**Solution:** - -1. **Check if document-project was run** - Agents need architecture context -2. **Review existing architecture docs**: - - Read docs/architecture.md (from document-project) - - Understand current system design -3. **For Level 3-4**: - - Run validate-architecture workflow before planning - - Use integration-planning workflow -4. **Explicitly document integration strategy** in architecture: - - How new components fit existing structure - - What modifications needed to existing code - - Migration path if changing patterns - -### Problem: Breaking changes to existing APIs - -**Symptoms:** - -- Changing API breaks consumers -- Downstream services affected -- Need backward compatibility - -**Solution:** - -1. **Identify all API consumers** (document-project should show this) -2. **Plan versioning strategy**: - - API v1 (existing) + v2 (new) - - Deprecation timeline -3. **Use feature flags** for gradual rollout -4. **Document migration guide** for API consumers -5. **Add to testing strategy**: - - Existing consumers still work (v1) - - New functionality works (v2) - -### Problem: Data migration required - -**Symptoms:** - -- Schema changes needed -- Existing data needs transformation -- Risk of data loss - -**Solution:** - -1. **Create explicit migration strategy** in architecture: - - Forward migration (old → new schema) - - Rollback plan (new → old schema) - - Data validation approach -2. **Test migrations thoroughly**: - - On copy of production data - - Measure performance impact -3. **Plan rollout**: - - Staging environment first - - Gradual production rollout - - Monitoring for issues -4. **Document in tech-spec/architecture**: - - Migration scripts - - Rollback procedures - - Expected downtime - ---- - -## Still Stuck? - -### Getting More Help - -If your issue isn't covered here: - -1. **Check other documentation**: - - [FAQ](./faq.md) - Common questions - - [Glossary](./glossary.md) - Terminology - - [Quick Start](./quick-start.md) - Basic usage - - [Brownfield Guide](./brownfield-guide.md) - Existing codebases - - [Scale Adaptive System](./scale-adaptive-system.md) - Understanding levels - -2. **Community support**: - - [Discord](https://discord.gg/gk8jAdXWmj) - #general-dev, #bugs-issues - - Active community, fast responses - - Share your specific situation - -3. **Report bugs**: - - [GitHub Issues](https://github.com/bmad-code-org/BMAD-METHOD/issues) - - Include version, steps to reproduce, expected vs actual behavior - -4. **Video tutorials**: - - [YouTube Channel](https://www.youtube.com/@BMadCode) - - Visual walkthroughs of common workflows - ---- - -## Common Error Messages - -### "No workflow status file found" - -**Cause:** Haven't run workflow-init yet -**Fix:** Load Analyst agent → run workflow-init - -### "Epic file not found" - -**Cause:** PRD/epics not created, or wrong path -**Fix:** Verify PRD/epics exist in output folder, check config.yaml paths - -### "Story not in sprint-status.yaml" - -**Cause:** Sprint-planning not run, or story file not created -**Fix:** Run sprint-planning workflow, verify story files exist - -### "Documentation insufficient for brownfield" - -**Cause:** No docs/index.md or document-project not run -**Fix:** Run document-project workflow with Deep scan - -### "Level detection failed" - -**Cause:** Ambiguous project description -**Fix:** Be more specific, use level keywords (fix, feature, platform, etc.) - -### "Context generation failed" - -**Cause:** Missing prerequisites (story file or docs) -**Fix:** Verify story file exists, docs present - ---- - -## Prevention Tips - -**Avoid common issues before they happen:** - -1. ✅ **Always run document-project for brownfield** - Saves hours of context issues later -2. ✅ **Use fresh chats for complex workflows** - Prevents hallucinations and context overflow -3. ✅ **Verify files exist before running workflows** - Check PRD, epics, stories are present -4. ✅ **Read agent menu before requesting workflows** - Confirm agent has the workflow -5. ✅ **Start with smaller level if unsure** - Easy to upgrade (Level 1 → 2), hard to downgrade -6. ✅ **Keep status files updated** - Manual updates when needed, don't let them drift -7. ✅ **Run retrospectives after epics** - Catch issues early, improve next epic -8. ✅ **Follow phase sequence** - Don't skip required phases (Phase 2 before 3, 3 before 4) - ---- - -**Issue not listed?** Please [report it](https://github.com/bmad-code-org/BMAD-METHOD/issues) so we can add it to this guide! diff --git a/src/modules/bmm/docs/workflow-architecture-reference.md b/src/modules/bmm/docs/workflow-architecture-reference.md deleted file mode 100644 index 0acd0d30..00000000 --- a/src/modules/bmm/docs/workflow-architecture-reference.md +++ /dev/null @@ -1,366 +0,0 @@ -# Decision Architecture Workflow - Technical Reference - -**Module:** BMM (BMAD Method Module) -**Type:** Solutioning Workflow - ---- - -## Overview - -The Decision Architecture workflow is a complete reimagining of how architectural decisions are made in the BMAD Method. Instead of template-driven documentation, this workflow facilitates an intelligent conversation that produces a **decision-focused architecture document** optimized for preventing AI agent conflicts during implementation. - ---- - -## Core Philosophy - -**The Problem**: When multiple AI agents implement different parts of a system, they make conflicting technical decisions leading to incompatible implementations. - -**The Solution**: A "consistency contract" that documents all critical technical decisions upfront, ensuring every agent follows the same patterns and uses the same technologies. - ---- - -## Key Features - -### 1. Starter Template Intelligence ⭐ NEW - -- Discovers relevant starter templates (create-next-app, create-t3-app, etc.) -- Considers UX requirements when selecting templates (animations, accessibility, etc.) -- Searches for current CLI options and defaults -- Documents decisions made BY the starter template -- Makes remaining architectural decisions around the starter foundation -- First implementation story becomes "initialize with starter command" - -### 2. Adaptive Facilitation - -- Adjusts conversation style based on user skill level (beginner/intermediate/expert) -- Experts get rapid, technical discussions -- Beginners receive education and protection from complexity -- Everyone produces the same high-quality output - -### 3. Dynamic Version Verification - -- NEVER trusts hardcoded version numbers -- Uses WebSearch to find current stable versions -- Verifies versions during the conversation -- Documents only verified, current versions - -### 4. Intelligent Discovery - -- No rigid project type templates -- Analyzes PRD to identify which decisions matter for THIS project -- Uses knowledge base of decisions and patterns -- Scales to infinite project types - -### 5. Collaborative Decision Making - -- Facilitates discussion for each critical decision -- Presents options with trade-offs -- Integrates advanced elicitation for innovative approaches -- Ensures decisions are coherent and compatible - -### 6. Consistent Output - -- Structured decision collection during conversation -- Strict document generation from collected decisions -- Validated against hard requirements -- Optimized for AI agent consumption - ---- - -## Workflow Structure - -``` -Step 0: Validate workflow and extract project configuration -Step 0.5: Validate workflow sequencing -Step 1: Load PRD (with FRs/NFRs) and understand project context -Step 2: Discover and evaluate starter templates ⭐ NEW -Step 3: Adapt facilitation style and identify remaining decisions -Step 4: Facilitate collaborative decision making (with version verification) -Step 5: Address cross-cutting concerns -Step 6: Define project structure and boundaries -Step 7: Design novel architectural patterns (when needed) ⭐ NEW -Step 8: Define implementation patterns to prevent agent conflicts -Step 9: Validate architectural coherence -Step 10: Generate decision architecture document (with initialization commands) -Step 11: Validate document completeness -Step 12: Final review and update workflow status -``` - ---- - -## Files in This Workflow - -- **workflow.yaml** - Configuration and metadata -- **instructions.md** - The adaptive facilitation flow -- **decision-catalog.yaml** - Knowledge base of all architectural decisions -- **architecture-patterns.yaml** - Common patterns identified from requirements -- **pattern-categories.csv** - Pattern principles that teach LLM what needs defining -- **checklist.md** - Validation requirements for the output document -- **architecture-template.md** - Strict format for the final document - ---- - -## How It's Different from Old architecture - -| Aspect | Old Workflow | New Workflow | -| -------------------- | -------------------------------------------- | ----------------------------------------------- | -| **Approach** | Template-driven | Conversation-driven | -| **Project Types** | 11 rigid types with 22+ files | Infinite flexibility with intelligent discovery | -| **User Interaction** | Output sections with "Continue?" | Collaborative decision facilitation | -| **Skill Adaptation** | One-size-fits-all | Adapts to beginner/intermediate/expert | -| **Decision Making** | Late in process (Step 5) | Upfront and central focus | -| **Output** | Multiple documents including faux tech-specs | Single decision-focused architecture | -| **Time** | Confusing and slow | 30-90 minutes depending on skill level | -| **Elicitation** | Never used | Integrated at decision points | - ---- - -## Expected Inputs - -- **PRD** (Product Requirements Document) with: - - Functional Requirements - - Non-Functional Requirements - - Performance and compliance needs - -- **UX Spec** (Optional but valuable) with: - - Interface designs and interaction patterns - - Accessibility requirements (WCAG levels) - - Animation and transition needs - - Platform-specific UI requirements - - Performance expectations for interactions - ---- - -## Output Document - -A single `architecture.md` file containing: - -- Executive summary (2-3 sentences) -- Project initialization command (if using starter template) -- Decision summary table with verified versions and epic mapping -- Complete project structure -- Integration specifications -- Consistency rules for AI agents - ---- - -## How Novel Pattern Design Works - -Step 7 handles unique or complex patterns that need to be INVENTED: - -### 1. Detection - -The workflow analyzes the PRD for concepts that don't have standard solutions: - -- Novel interaction patterns (e.g., "swipe to match" when Tinder doesn't exist) -- Complex multi-epic workflows (e.g., "viral invitation system") -- Unique data relationships (e.g., "social graph" before Facebook) -- New paradigms (e.g., "ephemeral messages" before Snapchat) - -### 2. Design Collaboration - -Instead of just picking technologies, the workflow helps DESIGN the solution: - -- Identifies the core problem to solve -- Explores different approaches with the user -- Documents how components interact -- Creates sequence diagrams for complex flows -- Uses elicitation to find innovative solutions - -### 3. Documentation - -Novel patterns become part of the architecture with: - -- Pattern name and purpose -- Component interactions -- Data flow diagrams -- Which epics/stories are affected -- Implementation guidance for agents - -### 4. Example - -``` -PRD: "Users can create 'circles' of friends with overlapping membership" -↓ -Workflow detects: This is a novel social structure pattern -↓ -Designs with user: Circle membership model, permission cascading, UI patterns -↓ -Documents: "Circle Pattern" with component design and data flow -↓ -All agents understand how to implement circle-related features consistently -``` - ---- - -## How Implementation Patterns Work - -Step 8 prevents agent conflicts by defining patterns for consistency: - -### 1. The Core Principle - -> "Any time multiple agents might make the SAME decision DIFFERENTLY, that's a pattern to capture" - -The LLM asks: "What could an agent encounter where they'd have to guess?" - -### 2. Pattern Categories (principles, not prescriptions) - -- **Naming**: How things are named (APIs, database fields, files) -- **Structure**: How things are organized (folders, modules, layers) -- **Format**: How data is formatted (JSON structures, responses) -- **Communication**: How components talk (events, messages, protocols) -- **Lifecycle**: How states change (workflows, transitions) -- **Location**: Where things go (URLs, paths, storage) -- **Consistency**: Cross-cutting concerns (dates, errors, logs) - -### 3. LLM Intelligence - -- Uses the principle to identify patterns beyond the 7 categories -- Figures out what specific patterns matter for chosen tech -- Only asks about patterns that could cause conflicts -- Skips obvious patterns that the tech choice determines - -### 4. Example - -``` -Tech chosen: REST API + PostgreSQL + React -↓ -LLM identifies needs: -- REST: URL structure, response format, status codes -- PostgreSQL: table naming, column naming, FK patterns -- React: component structure, state management, test location -↓ -Facilitates each with user -↓ -Documents as Implementation Patterns in architecture -``` - ---- - -## How Starter Templates Work - -When the workflow detects a project type that has a starter template: - -1. **Discovery**: Searches for relevant starter templates based on PRD -2. **Investigation**: Looks up current CLI options and defaults -3. **Presentation**: Shows user what the starter provides -4. **Integration**: Documents starter decisions as "PROVIDED BY STARTER" -5. **Continuation**: Only asks about decisions NOT made by starter -6. **Documentation**: Includes exact initialization command in architecture - -### Example Flow - -``` -PRD says: "Next.js web application with authentication" -↓ -Workflow finds: create-next-app and create-t3-app -↓ -User chooses: create-t3-app (includes auth setup) -↓ -Starter provides: Next.js, TypeScript, tRPC, Prisma, NextAuth, Tailwind -↓ -Workflow only asks about: Database choice, deployment target, additional services -↓ -First story becomes: "npx create t3-app@latest my-app --trpc --nextauth --prisma" -``` - ---- - -## Usage - -```bash -# In your BMAD-enabled project -workflow architecture -``` - -The AI agent will: - -1. Load your PRD (with FRs/NFRs) -2. Identify critical decisions needed -3. Facilitate discussion on each decision -4. Generate a comprehensive architecture document -5. Validate completeness - ---- - -## Design Principles - -1. **Facilitation over Prescription** - Guide users to good decisions rather than imposing templates -2. **Intelligence over Templates** - Use AI understanding rather than rigid structures -3. **Decisions over Details** - Focus on what prevents agent conflicts, not implementation minutiae -4. **Adaptation over Uniformity** - Meet users where they are while ensuring quality output -5. **Collaboration over Output** - The conversation matters as much as the document - ---- - -## For Developers - -This workflow assumes: - -- Single developer + AI agents (not teams) -- Speed matters (decisions in minutes, not days) -- AI agents need clear constraints to prevent conflicts -- The architecture document is for agents, not humans - ---- - -## Migration from architecture - -Projects using the old `architecture` workflow should: - -1. Complete any in-progress architecture work -2. Use `architecture` for new projects -3. The old workflow remains available but is deprecated - ---- - -## Version History - -**1.3.2** - UX specification integration and fuzzy file matching - -- Added UX spec as optional input with fuzzy file matching -- Updated workflow.yaml with input file references -- Starter template selection now considers UX requirements -- Added UX alignment validation to checklist -- Instructions use variable references for flexible file names - -**1.3.1** - Workflow refinement and standardization - -- Added workflow status checking at start (Steps 0 and 0.5) -- Added workflow status updating at end (Step 12) -- Reorganized step numbering for clarity (removed fractional steps) -- Enhanced with intent-based approach throughout -- Improved cohesiveness across all workflow components - -**1.3.0** - Novel pattern design for unique architectures - -- Added novel pattern design (now Step 7, formerly Step 5.3) -- Detects novel concepts in PRD that need architectural invention -- Facilitates design collaboration with sequence diagrams -- Uses elicitation for innovative approaches -- Documents custom patterns for multi-epic consistency - -**1.2.0** - Implementation patterns for agent consistency - -- Added implementation patterns (now Step 8, formerly Step 5.5) -- Created principle-based pattern-categories.csv (7 principles, not 118 prescriptions) -- Core principle: "What could agents decide differently?" -- LLM uses principle to identify patterns beyond the categories -- Prevents agent conflicts through intelligent pattern discovery - -**1.1.0** - Enhanced with starter template discovery and version verification - -- Added intelligent starter template detection and integration (now Step 2) -- Added dynamic version verification via web search -- Starter decisions are documented as "PROVIDED BY STARTER" -- First implementation story uses starter initialization command - -**1.0.0** - Initial release replacing architecture workflow - ---- - -**Related Documentation:** - -- [Solutioning Workflows](./workflows-solutioning.md) -- [Planning Workflows](./workflows-planning.md) -- [Scale Adaptive System](./scale-adaptive-system.md) diff --git a/src/modules/bmm/docs/workflow-document-project-reference.md b/src/modules/bmm/docs/workflow-document-project-reference.md deleted file mode 100644 index ad1e5a02..00000000 --- a/src/modules/bmm/docs/workflow-document-project-reference.md +++ /dev/null @@ -1,489 +0,0 @@ -# Document Project Workflow - Technical Reference - -**Module:** BMM (BMAD Method Module) -**Type:** Action Workflow (Documentation Generator) - ---- - -## Purpose - -Analyzes and documents brownfield projects by scanning codebase, architecture, and patterns to create comprehensive reference documentation for AI-assisted development. Generates a master index and multiple documentation files tailored to project structure and type. - -**NEW in v1.2.0:** Context-safe architecture with scan levels, resumability, and write-as-you-go pattern to prevent context exhaustion. - ---- - -## Key Features - -- **Multi-Project Type Support**: Handles web, backend, mobile, CLI, game, embedded, data, infra, library, desktop, and extension projects -- **Multi-Part Detection**: Automatically detects and documents projects with separate client/server or multiple services -- **Three Scan Levels** (NEW v1.2.0): Quick (2-5 min), Deep (10-30 min), Exhaustive (30-120 min) -- **Resumability** (NEW v1.2.0): Interrupt and resume workflows without losing progress -- **Write-as-you-go** (NEW v1.2.0): Documents written immediately to prevent context exhaustion -- **Intelligent Batching** (NEW v1.2.0): Subfolder-based processing for deep/exhaustive scans -- **Data-Driven Analysis**: Uses CSV-based project type detection and documentation requirements -- **Comprehensive Scanning**: Analyzes APIs, data models, UI components, configuration, security patterns, and more -- **Architecture Matching**: Matches projects to 170+ architecture templates from the solutioning registry -- **Brownfield PRD Ready**: Generates documentation specifically designed for AI agents planning new features - ---- - -## How to Invoke - -```bash -workflow document-project -``` - -Or from BMAD CLI: - -```bash -/bmad:bmm:workflows:document-project -``` - ---- - -## Scan Levels (NEW in v1.2.0) - -Choose the right scan depth for your needs: - -### 1. Quick Scan (Default) - -**Duration:** 2-5 minutes -**What it does:** Pattern-based analysis without reading source files -**Reads:** Config files, package manifests, directory structure, README -**Use when:** - -- You need a fast project overview -- Initial understanding of project structure -- Planning next steps before deeper analysis - -**Does NOT read:** Source code files (`_.js`, `_.ts`, `_.py`, `_.go`, etc.) - -### 2. Deep Scan - -**Duration:** 10-30 minutes -**What it does:** Reads files in critical directories based on project type -**Reads:** Files in critical paths defined by documentation requirements -**Use when:** - -- Creating comprehensive documentation for brownfield PRD -- Need detailed analysis of key areas -- Want balance between depth and speed - -**Example:** For a web app, reads controllers/, models/, components/, but not every utility file - -### 3. Exhaustive Scan - -**Duration:** 30-120 minutes -**What it does:** Reads ALL source files in project -**Reads:** Every source file (excludes node_modules, dist, build, .git) -**Use when:** - -- Complete project analysis needed -- Migration planning requires full understanding -- Detailed audit of entire codebase -- Deep technical debt assessment - -**Note:** Deep-dive mode ALWAYS uses exhaustive scan (no choice) - ---- - -## Resumability (NEW in v1.2.0) - -The workflow can be interrupted and resumed without losing progress: - -- **State Tracking:** Progress saved in `project-scan-report.json` -- **Auto-Detection:** Workflow detects incomplete runs (<24 hours old) -- **Resume Prompt:** Choose to resume or start fresh -- **Step-by-Step:** Resume from exact step where interrupted -- **Archiving:** Old state files automatically archived - -**Example Resume Flow:** - -``` -> workflow document-project - -I found an in-progress workflow state from 2025-10-11 14:32:15. - -Current Progress: -- Mode: initial_scan -- Scan Level: deep -- Completed Steps: 5/12 -- Last Step: step_5 - -Would you like to: -1. Resume from where we left off - Continue from step 6 -2. Start fresh - Archive old state and begin new scan -3. Cancel - Exit without changes - -Your choice [1/2/3]: -``` - ---- - -## What It Does - -### Step-by-Step Process - -1. **Detects Project Structure** - Identifies if project is single-part or multi-part (client/server/etc.) -2. **Classifies Project Type** - Matches against 12 project types (web, backend, mobile, etc.) -3. **Discovers Documentation** - Finds existing README, CONTRIBUTING, ARCHITECTURE files -4. **Analyzes Tech Stack** - Parses package files, identifies frameworks, versions, dependencies -5. **Conditional Scanning** - Performs targeted analysis based on project type requirements: - - API routes and endpoints - - Database models and schemas - - State management patterns - - UI component libraries - - Configuration and security - - CI/CD and deployment configs -6. **Generates Source Tree** - Creates annotated directory structure with critical paths -7. **Extracts Dev Instructions** - Documents setup, build, run, and test commands -8. **Creates Architecture Docs** - Generates detailed architecture using matched templates -9. **Builds Master Index** - Creates comprehensive index.md as primary AI retrieval source -10. **Validates Output** - Runs 140+ point checklist to ensure completeness - -### Output Files - -**Single-Part Projects:** - -- `index.md` - Master index -- `project-overview.md` - Executive summary -- `architecture.md` - Detailed architecture -- `source-tree-analysis.md` - Annotated directory tree -- `component-inventory.md` - Component catalog (if applicable) -- `development-guide.md` - Local dev instructions -- `api-contracts.md` - API documentation (if applicable) -- `data-models.md` - Database schema (if applicable) -- `deployment-guide.md` - Deployment process (optional) -- `contribution-guide.md` - Contributing guidelines (optional) -- `project-scan-report.json` - State file for resumability (NEW v1.2.0) - -**Multi-Part Projects (e.g., client + server):** - -- `index.md` - Master index with part navigation -- `project-overview.md` - Multi-part summary -- `architecture-{part_id}.md` - Per-part architecture docs -- `source-tree-analysis.md` - Full tree with part annotations -- `component-inventory-{part_id}.md` - Per-part components -- `development-guide-{part_id}.md` - Per-part dev guides -- `integration-architecture.md` - How parts communicate -- `project-parts.json` - Machine-readable metadata -- `project-scan-report.json` - State file for resumability (NEW v1.2.0) -- Additional conditional files per part (API, data models, etc.) - ---- - -## Data Files - -The workflow uses a single comprehensive CSV file: - -**documentation-requirements.csv** - Complete project analysis guide - -- Location: `/_bmad/bmm/workflows/document-project/documentation-requirements.csv` -- 12 project types (web, mobile, backend, cli, library, desktop, game, data, extension, infra, embedded) -- 24 columns combining: - - **Detection columns**: `project_type_id`, `key_file_patterns` (identifies project type from codebase) - - **Requirement columns**: `requires_api_scan`, `requires_data_models`, `requires_ui_components`, etc. - - **Pattern columns**: `critical_directories`, `test_file_patterns`, `config_patterns`, etc. -- Self-contained: All project detection AND scanning requirements in one file -- Architecture patterns inferred from tech stack (no external registry needed) - ---- - -## Use Cases - -### Primary Use Case: Brownfield PRD Creation - -After running this workflow, use the generated `index.md` as input to brownfield PRD workflows: - -``` -User: "I want to add a new dashboard feature" -PRD Workflow: Loads docs/index.md -→ Understands existing architecture -→ Identifies reusable components -→ Plans integration with existing APIs -→ Creates contextual PRD with FRs and NFRs -Architecture Workflow: Creates architecture design -Create-Epics-and-Stories Workflow: Breaks down into epics and stories -``` - -### Other Use Cases - -- **Onboarding New Developers** - Comprehensive project documentation -- **Architecture Review** - Structured analysis of existing system -- **Technical Debt Assessment** - Identify patterns and anti-patterns -- **Migration Planning** - Understand current state before refactoring - ---- - -## Requirements - -### Recommended Inputs (Optional) - -- Project root directory (defaults to current directory) -- README.md or similar docs (auto-discovered if present) -- User guidance on key areas to focus (workflow will ask) - -### Tools Used - -- File system scanning (Glob, Read, Grep) -- Code analysis -- Git repository analysis (optional) - ---- - -## Configuration - -### Default Output Location - -Files are saved to: `{output_folder}` (from config.yaml) - -Default: `/docs/` folder in project root - -### Customization - -- Modify `documentation-requirements.csv` to adjust scanning patterns for project types -- Add new project types to `project-types.csv` -- Add new architecture templates to `registry.csv` - ---- - -## Example: Multi-Part Web App - -**Input:** - -``` -my-app/ -├── client/ # React frontend -├── server/ # Express backend -└── README.md -``` - -**Detection Result:** - -- Repository Type: Monorepo -- Part 1: client (web/React) -- Part 2: server (backend/Express) - -**Output (10+ files):** - -``` -docs/ -├── index.md -├── project-overview.md -├── architecture-client.md -├── architecture-server.md -├── source-tree-analysis.md -├── component-inventory-client.md -├── development-guide-client.md -├── development-guide-server.md -├── api-contracts-server.md -├── data-models-server.md -├── integration-architecture.md -└── project-parts.json -``` - ---- - -## Example: Simple CLI Tool - -**Input:** - -``` -hello-cli/ -├── main.go -├── go.mod -└── README.md -``` - -**Detection Result:** - -- Repository Type: Monolith -- Part 1: main (cli/Go) - -**Output (4 files):** - -``` -docs/ -├── index.md -├── project-overview.md -├── architecture.md -└── source-tree-analysis.md -``` - ---- - -## Deep-Dive Mode - -### What is Deep-Dive Mode? - -When you run the workflow on a project that already has documentation, you'll be offered a choice: - -1. **Rescan entire project** - Update all documentation with latest changes -2. **Deep-dive into specific area** - Generate EXHAUSTIVE documentation for a particular feature/module/folder -3. **Cancel** - Keep existing documentation - -Deep-dive mode performs **comprehensive, file-by-file analysis** of a specific area, reading EVERY file completely and documenting: - -- All exports with complete signatures -- All imports and dependencies -- Dependency graphs and data flow -- Code patterns and implementations -- Testing coverage and strategies -- Integration points -- Reuse opportunities - -### When to Use Deep-Dive Mode - -- **Before implementing a feature** - Deep-dive the area you'll be modifying -- **During architecture review** - Deep-dive complex modules -- **For code understanding** - Deep-dive unfamiliar parts of codebase -- **When creating PRDs** - Deep-dive areas affected by new features - -### Deep-Dive Process - -1. Workflow detects existing `index.md` -2. Offers deep-dive option -3. Suggests areas based on project structure: - - API route groups - - Feature modules - - UI component areas - - Services/business logic -4. You select area or specify custom path -5. Workflow reads EVERY file in that area -6. Generates `deep-dive-{area-name}.md` with complete analysis -7. Updates `index.md` with link to deep-dive doc -8. Offers to deep-dive another area or finish - -### Deep-Dive Output Example - -**docs/deep-dive-dashboard-feature.md:** - -- Complete file inventory (47 files analyzed) -- Every export with signatures -- Dependency graph -- Data flow analysis -- Integration points -- Testing coverage -- Related code references -- Implementation guidance -- ~3,000 LOC documented in detail - -### Incremental Deep-Diving - -You can deep-dive multiple areas over time: - -- First run: Scan entire project → generates index.md -- Second run: Deep-dive dashboard feature -- Third run: Deep-dive API layer -- Fourth run: Deep-dive authentication system - -All deep-dive docs are linked from the master index. - ---- - -## Validation - -The workflow includes a comprehensive 160+ point checklist covering: - -- Project detection accuracy -- Technology stack completeness -- Codebase scanning thoroughness -- Architecture documentation quality -- Multi-part handling (if applicable) -- Brownfield PRD readiness -- Deep-dive completeness (if applicable) - ---- - -## Next Steps After Completion - -1. **Review** `docs/index.md` - Your master documentation index -2. **Validate** - Check generated docs for accuracy -3. **Use for PRD** - Point brownfield PRD workflow to index.md -4. **Maintain** - Re-run workflow when architecture changes significantly - ---- - -## File Structure - -``` -document-project/ -├── workflow.yaml # Workflow configuration -├── instructions.md # Step-by-step workflow logic -├── checklist.md # Validation criteria -├── documentation-requirements.csv # Project type scanning patterns -├── templates/ # Output templates -│ ├── index-template.md -│ ├── project-overview-template.md -│ └── source-tree-template.md -└── README.md # This file -``` - ---- - -## Troubleshooting - -**Issue: Project type not detected correctly** - -- Solution: Workflow will ask for confirmation; manually select correct type - -**Issue: Missing critical information** - -- Solution: Provide additional context when prompted; re-run specific analysis steps - -**Issue: Multi-part detection missed a part** - -- Solution: When asked to confirm parts, specify the missing part and its path - -**Issue: Architecture template doesn't match well** - -- Solution: Check registry.csv; may need to add new template or adjust matching criteria - ---- - -## Architecture Improvements in v1.2.0 - -### Context-Safe Design - -The workflow now uses a write-as-you-go architecture: - -- Documents written immediately to disk (not accumulated in memory) -- Detailed findings purged after writing (only summaries kept) -- State tracking enables resumption from any step -- Batching strategy prevents context exhaustion on large projects - -### Batching Strategy - -For deep/exhaustive scans: - -- Process ONE subfolder at a time -- Read files → Extract info → Write output → Validate → Purge context -- Primary concern is file SIZE (not count) -- Track batches in state file for resumability - -### State File Format - -Optimized JSON (no pretty-printing): - -```json -{ - "workflow_version": "1.2.0", - "timestamps": {...}, - "mode": "initial_scan", - "scan_level": "deep", - "completed_steps": [...], - "current_step": "step_6", - "findings": {"summary": "only"}, - "outputs_generated": [...], - "resume_instructions": "..." -} -``` - ---- - -**Related Documentation:** - -- [Brownfield Development Guide](./brownfield-guide.md) -- [Implementation Workflows](./workflows-implementation.md) -- [Scale Adaptive System](./scale-adaptive-system.md) diff --git a/src/modules/bmm/docs/workflows-analysis.md b/src/modules/bmm/docs/workflows-analysis.md deleted file mode 100644 index 8eed43be..00000000 --- a/src/modules/bmm/docs/workflows-analysis.md +++ /dev/null @@ -1,266 +0,0 @@ -# BMM Analysis Workflows (Phase 1) - -## Overview - -Phase 1 (Analysis) workflows are **optional** exploration and discovery tools that help validate ideas, understand markets, and generate strategic context before planning begins. - -**Key principle:** Analysis workflows help you think strategically before committing to implementation. Skip them if your requirements are already clear. - -**When to use:** Starting new projects, exploring opportunities, validating market fit, generating ideas, understanding problem spaces. - -**When to skip:** Continuing existing projects with clear requirements, well-defined features with known solutions, strict constraints where discovery is complete. - ---- - -## Phase 1 Analysis Workflow Overview - -Phase 1 Analysis consists of three categories of optional workflows: - -### Discovery & Ideation (Optional) - -- **brainstorm-project** - Multi-track solution exploration for software projects -- **brainstorm-game** - Game concept generation (coming soon) - -### Research & Validation (Optional) - -- **research** - Market, technical, competitive, user, domain, and AI research -- **domain-research** - Industry-specific deep dive research - -### Strategic Capture (Recommended for Greenfield) - -- **product-brief** - Product vision and strategy definition - -These workflows feed into Phase 2 (Planning) workflows, particularly the `prd` workflow. - ---- - -## Quick Reference - -| Workflow | Agent | Required | Purpose | Output | -| ---------------------- | ------- | ----------- | -------------------------------------------------------------- | ---------------------------- | -| **brainstorm-project** | Analyst | No | Explore solution approaches and architectures | Solution options + rationale | -| **research** | Analyst | No | Multi-type research (market/technical/competitive/user/domain) | Research reports | -| **product-brief** | Analyst | Recommended | Define product vision and strategy (interactive) | Product Brief document | - ---- - -## Workflow Descriptions - -### brainstorm-project - -**Purpose:** Generate multiple solution approaches through parallel ideation tracks (architecture, UX, integration, value). - -**Agent:** Analyst - -**When to Use:** - -- Unclear technical approach with business objectives -- Multiple solution paths need evaluation -- Hidden assumptions need discovery -- Innovation beyond obvious solutions - -**Key Outputs:** - -- Architecture proposals with trade-off analysis -- Value framework (prioritized features) -- Risk analysis (dependencies, challenges) -- Strategic recommendation with rationale - -**Example:** "We need a customer dashboard" → Options: Monolith SSR (faster), Microservices SPA (scalable), Hybrid (balanced) with recommendation. - ---- - -### research - -**Purpose:** Comprehensive multi-type research system consolidating market, technical, competitive, user, and domain analysis. - -**Agent:** Analyst - -**Research Types:** - -| Type | Purpose | Use When | -| --------------- | ------------------------------------------------------ | ----------------------------------- | -| **market** | TAM/SAM/SOM, competitive analysis | Need market viability validation | -| **technical** | Technology evaluation, ADRs | Choosing frameworks/platforms | -| **competitive** | Deep competitor analysis | Understanding competitive landscape | -| **user** | Customer insights, personas, JTBD | Need user understanding | -| **domain** | Industry deep dives, trends | Understanding domain/industry | -| **deep_prompt** | Generate AI research prompts (ChatGPT, Claude, Gemini) | Need deeper AI-assisted research | - -**Key Features:** - -- Real-time web research -- Multiple analytical frameworks (Porter's Five Forces, SWOT, Technology Adoption Lifecycle) -- Platform-specific optimization for deep_prompt type -- Configurable research depth (quick/standard/comprehensive) - -**Example (market):** "SaaS project management tool" → TAM $50B, SAM $5B, SOM $50M, top competitors (Asana, Monday), positioning recommendation. - ---- - -### product-brief - -**Purpose:** Interactive product brief creation that guides strategic product vision definition. - -**Agent:** Analyst - -**When to Use:** - -- Starting new product/major feature initiative -- Aligning stakeholders before detailed planning -- Transitioning from exploration to strategy -- Need executive-level product documentation - -**Modes:** - -- **Interactive Mode** (Recommended): Step-by-step collaborative development with probing questions -- **YOLO Mode**: AI generates complete draft from context, then iterative refinement - -**Key Outputs:** - -- Executive summary -- Problem statement with evidence -- Proposed solution and differentiators -- Target users (segmented) -- MVP scope (ruthlessly defined) -- Financial impact and ROI -- Strategic alignment -- Risks and open questions - -**Integration:** Feeds directly into PRD workflow (Phase 2). - ---- - -## Decision Guide - -### Starting a Software Project - -``` -brainstorm-project (if unclear) → research (market/technical) → product-brief → Phase 2 (prd) -``` - -### Validating an Idea - -``` -research (market type) → product-brief → Phase 2 -``` - -### Technical Decision Only - -``` -research (technical type) → Use findings in Phase 3 (architecture) -``` - -### Understanding Market - -``` -research (market/competitive type) → product-brief → Phase 2 -``` - -### Domain Research for Complex Industries - -``` -domain-research → research (compliance/regulatory) → product-brief → Phase 2 -``` - ---- - -## Integration with Phase 2 (Planning) - -Analysis outputs feed directly into Planning: - -| Analysis Output | Planning Input | -| --------------------------- | -------------------------- | -| product-brief.md | **prd** workflow | -| market-research.md | **prd** context | -| domain-research.md | **prd** context | -| technical-research.md | **architecture** (Phase 3) | -| competitive-intelligence.md | **prd** positioning | - -Planning workflows automatically load these documents if they exist in the output folder. - ---- - -## Best Practices - -### 1. Don't Over-Invest in Analysis - -Analysis is optional. If requirements are clear, skip to Phase 2 (Planning). - -### 2. Iterate Between Workflows - -Common pattern: brainstorm → research (validate) → brief (synthesize) - -### 3. Document Assumptions - -Analysis surfaces and validates assumptions. Document them explicitly for planning to challenge. - -### 4. Keep It Strategic - -Focus on "what" and "why", not "how". Leave implementation for Planning and Solutioning. - -### 5. Involve Stakeholders - -Use analysis workflows to align stakeholders before committing to detailed planning. - ---- - -## Common Patterns - -### Greenfield Software (Full Analysis) - -``` -1. brainstorm-project - explore approaches -2. research (market/technical/domain) - validate viability -3. product-brief - capture strategic vision -4. → Phase 2: prd -``` - -### Skip Analysis (Clear Requirements) - -``` -→ Phase 2: prd or tech-spec directly -``` - -### Technical Research Only - -``` -1. research (technical) - evaluate technologies -2. → Phase 3: architecture (use findings in ADRs) -``` - ---- - -## Related Documentation - -- [Phase 2: Planning Workflows](./workflows-planning.md) - Next phase -- [Phase 3: Solutioning Workflows](./workflows-solutioning.md) -- [Phase 4: Implementation Workflows](./workflows-implementation.md) -- [Scale Adaptive System](./scale-adaptive-system.md) - Understanding project complexity -- [Agents Guide](./agents-guide.md) - Complete agent reference - ---- - -## Troubleshooting - -**Q: Do I need to run all analysis workflows?** -A: No! Analysis is entirely optional. Use only workflows that help you think through your problem. - -**Q: Which workflow should I start with?** -A: If unsure, start with `research` (market type) to validate viability, then move to `product-brief`. - -**Q: Can I skip straight to Planning?** -A: Yes! If you know what you're building and why, skip Phase 1 entirely and start with Phase 2 (prd/tech-spec). - -**Q: How long should Analysis take?** -A: Typically hours to 1-2 days. If taking longer, you may be over-analyzing. Move to Planning. - -**Q: What if I discover problems during Analysis?** -A: That's the point! Analysis helps you fail fast and pivot before heavy planning investment. - -**Q: Should brownfield projects do Analysis?** -A: Usually no. Start with `document-project` (Documentation prerequisite), then skip to Planning (Phase 2). - ---- - -_Phase 1 Analysis - Optional strategic thinking before commitment._ diff --git a/src/modules/bmm/docs/workflows-implementation.md b/src/modules/bmm/docs/workflows-implementation.md deleted file mode 100644 index 73dfa432..00000000 --- a/src/modules/bmm/docs/workflows-implementation.md +++ /dev/null @@ -1,210 +0,0 @@ -# BMM Implementation Workflows (Phase 4) - -## Overview - -Phase 4 (Implementation) workflows manage the iterative sprint-based development cycle using a **story-centric workflow** where each story moves through a defined lifecycle from creation to completion. - -**Key principle:** One story at a time, move it through the entire lifecycle before starting the next. - ---- - -## Complete Workflow Context - -Phase 4 is the final phase of the BMad Method workflow. To see how implementation fits into the complete methodology: - -The BMad Method consists of four phases working in sequence: - -1. **Phase 1 (Analysis)** - Optional exploration and discovery workflows -2. **Phase 2 (Planning)** - Required requirements definition using scale-adaptive system -3. **Phase 3 (Solutioning)** - Technical architecture and design decisions -4. **Phase 4 (Implementation)** - Iterative sprint-based development with story-centric workflow - -Phase 4 focuses on the iterative epic and story cycles where stories are implemented, reviewed, and completed one at a time. - -For a visual representation of the complete workflow, see: [workflow-method-greenfield.excalidraw](./images/workflow-method-greenfield.excalidraw) - ---- - -## Quick Reference - -| Workflow | Agent | When | Purpose | -| ------------------- | ----- | --------------------- | ------------------------------------- | -| **sprint-planning** | SM | Once at Phase 4 start | Initialize sprint tracking file | -| **create-story** | SM | Per story | Create next story from epic backlog | -| **dev-story** | DEV | Per story | Implement story with tests | -| **code-review** | DEV | Per story | Senior dev quality review | -| **retrospective** | SM | After epic complete | Review lessons and extract insights | -| **correct-course** | SM | When issues arise | Handle significant mid-sprint changes | - ---- - -## Agent Roles - -### SM (Scrum Master) - Primary Implementation Orchestrator - -**Workflows:** sprint-planning, create-story, retrospective, correct-course - -**Responsibilities:** - -- Initialize and maintain sprint tracking -- Create stories from epic backlog -- Handle course corrections when issues arise -- Facilitate retrospectives after epic completion -- Orchestrate overall implementation flow - -### DEV (Developer) - Implementation and Quality - -**Workflows:** dev-story, code-review - -**Responsibilities:** - -- Implement stories with tests -- Perform senior developer code reviews -- Ensure quality and adherence to standards -- Complete story implementation lifecycle - ---- - -## Story Lifecycle States - -Stories move through these states in the sprint status file: - -1. **TODO** - Story identified but not started -2. **IN PROGRESS** - Story being implemented (create-story → dev-story) -3. **READY FOR REVIEW** - Implementation complete, awaiting code review -4. **DONE** - Accepted and complete - ---- - -## Typical Sprint Flow - -### Sprint 0 (Planning Phase) - -- Complete Phases 1-3 (Analysis, Planning, Solutioning) -- PRD/GDD + Architecture complete -- **V6: Epics+Stories created via create-epics-and-stories workflow (runs AFTER architecture)** - -### Sprint 1+ (Implementation Phase) - -**Start of Phase 4:** - -1. SM runs `sprint-planning` (once) - -**Per Epic:** - -- Epic context and stories are already prepared from Phase 3 - -**Per Story (repeat until epic complete):** - -1. SM runs `create-story` -2. DEV runs `dev-story` -3. DEV runs `code-review` -4. If code review fails: DEV fixes issues in `dev-story`, then re-runs `code-review` - -**After Epic Complete:** - -- SM runs `retrospective` -- Move to next epic - -**As Needed:** - -- Run `sprint-status` anytime in Phase 4 to inspect sprint-status.yaml and get the next implementation command -- Run `workflow-status` for cross-phase routing and project-level paths -- Run `correct-course` if significant changes needed - ---- - -## Key Principles - -### One Story at a Time - -Complete each story's full lifecycle before starting the next. This prevents context switching and ensures quality. - -### Quality Gates - -Every story goes through `code-review` before being marked done. No exceptions. - -### Continuous Tracking - -The `sprint-status.yaml` file is the single source of truth for all implementation progress. - ---- - -### (BMad Method / Enterprise) - -``` -PRD (PM) → Architecture (Architect) - → create-epics-and-stories (PM) ← V6: After architecture! - → implementation-readiness (Architect) - → sprint-planning (SM, once) - → [Per Epic]: - → story loop (SM/DEV) - → retrospective (SM) - → [Next Epic] -Current Phase: 4 (Implementation) -Current Epic: Epic 1 (Authentication) -Current Sprint: Sprint 1 - -Next Story: Story 1.3 (Email Verification) -Status: TODO -Dependencies: Story 1.2 (DONE) ✅ - -**Recommendation:** Run `create-story` to generate Story 1.3 - -After create-story: -1. Run dev-story -2. Run code-review -3. Update sprint-status.yaml to mark story done -``` - -See: [workflow-status instructions](../workflows/workflow-status/instructions.md) - ---- - -### document-project - -**Purpose:** Analyze and document brownfield projects by scanning codebase, architecture, and patterns. - -**Agent:** Analyst -**Duration:** 1-3 hours -**When to Use:** Brownfield projects without documentation - -**How It Works:** - -1. Scans codebase structure -2. Identifies architecture patterns -3. Documents technology stack -4. Creates reference documentation -5. Generates PRD-like document from existing code - -**Output:** `project-documentation-{date}.md` - -**When to Run:** - -- Before starting work on legacy project -- When inheriting undocumented codebase -- Creating onboarding documentation - -See: [document-project reference](./workflow-document-project-reference.md) - -## Related Documentation - -- [Phase 1: Analysis Workflows](./workflows-analysis.md) -- [Phase 2: Planning Workflows](./workflows-planning.md) -- [Phase 3: Solutioning Workflows](./workflows-solutioning.md) - -## Troubleshooting - -**Q: Which workflow should I run next?** -A: Run `workflow-status` - it reads the sprint status file and tells you exactly what to do. During implementation (Phase 4) run `sprint-status` (fast check against sprint-status.yaml). - -**Q: Story needs significant changes mid-implementation?** -A: Run `correct-course` to analyze impact and route appropriately. - -**Q: Can I work on multiple stories in parallel?** -A: Not recommended. Complete one story's full lifecycle before starting the next. Prevents context switching and ensures quality. - -**Q: What if code review finds issues?** -A: DEV runs `dev-story` to make fixes, re-runs tests, then runs `code-review` again until it passes. - -_Phase 4 Implementation - One story at a time, done right._ diff --git a/src/modules/bmm/docs/workflows-planning.md b/src/modules/bmm/docs/workflows-planning.md deleted file mode 100644 index 3ce91599..00000000 --- a/src/modules/bmm/docs/workflows-planning.md +++ /dev/null @@ -1,451 +0,0 @@ -# BMM Planning Workflows (Phase 2) - -## Overview - -Phase 2 (Planning) workflows are **required** for all projects. They transform strategic vision into actionable requirements using a **scale-adaptive system** that automatically selects the right planning depth based on project complexity. - -**Key principle:** One unified entry point (`workflow-init`) intelligently routes to the appropriate planning methodology - from quick tech-specs to comprehensive PRDs. - -**When to use:** All projects require planning. The system adapts depth automatically based on complexity. - ---- - -## Phase 2 Planning Workflow Overview - -Phase 2 Planning uses a scale-adaptive system with three tracks: - -### Quick Flow (Simple Planning) - -- Entry: `workflow-init` routes based on project complexity -- Workflow: `tech-spec` -- Output: Technical document with story/epic structure -- Story count: 1-15 (typical) -- Next: Phase 4 (Implementation) - skips Phase 3 - -### BMad Method (Recommended) - -- Entry: `workflow-init` routes based on project complexity -- Workflows: `prd` → (optional) `create-ux-design` -- Output: PRD with FRs/NFRs -- Story count: 10-50+ (typical) -- Next: Phase 3 (Solutioning) → Phase 4 - -### Enterprise Method - -- Planning: Same as BMad Method (`prd` workflow) -- Solutioning: Extended Phase 3 workflows (Architecture + Security + DevOps) -- Story count: 30+ (typical) -- Next: Phase 4 - -The `correct-course` workflow can be used anytime for significant requirement changes. - ---- - -## Quick Reference - -| Workflow | Agent | Track | Purpose | Typical Stories | -| -------------------- | ----------- | ----------------------- | ----------------------------------------------- | --------------- | -| **workflow-init** | PM/Analyst | All | Entry point: discovery + routing | N/A | -| **tech-spec** | PM | Quick Flow | Technical document → Story or Epic+Stories | 1-15 | -| **prd** | PM | BMad Method, Enterprise | Strategic PRD with FRs/NFRs (no epic breakdown) | 10-50+ | -| **create-ux-design** | UX Designer | BMad Method, Enterprise | Optional UX specification (after PRD) | N/A | -| **correct-course** | PM/SM | All | Mid-stream requirement changes | N/A | - -**Note:** Story counts are guidance. V6 improvement: Epic+Stories are created AFTER architecture for better quality. - ---- - -## Scale-Adaptive Planning System - -BMM uses three distinct planning tracks that adapt to project complexity: - -### Track 1: Quick Flow - -**Best For:** Bug fixes, simple features, clear scope, enhancements - -**Planning:** Tech-spec only → Implementation - -**Time:** Hours to 1 day - -**Story Count:** Typically 1-15 (guidance) - -**Documents:** tech-spec.md + story files - -**Example:** "Fix authentication bug", "Add OAuth social login" - ---- - -### Track 2: BMad Method (RECOMMENDED) - -**Best For:** Products, platforms, complex features, multiple epics - -**Planning:** PRD + Architecture → Implementation - -**Time:** 1-3 days - -**Story Count:** Typically 10-50+ (guidance) - -**Documents:** PRD.md (FRs/NFRs) + architecture.md + epics.md + epic files - -**Greenfield:** Product Brief (optional) → PRD (FRs/NFRs) → UX (optional) → Architecture → Epics+Stories → Implementation - -**Brownfield:** document-project → PRD (FRs/NFRs) → Architecture (recommended) → Epics+Stories → Implementation - -**Example:** "Customer dashboard", "E-commerce platform", "Add search to existing app" - -**Why Architecture for Brownfield?** Distills massive codebase context into focused solution design for your specific project. - ---- - -### Track 3: Enterprise Method - -**Best For:** Enterprise requirements, multi-tenant, compliance, security-sensitive - -**Planning (Phase 2):** Uses BMad Method planning (PRD with FRs/NFRs) - -**Solutioning (Phase 3):** Extended workflows (Architecture + Security + DevOps + SecOps as optional additions) → Epics+Stories - -**Time:** 3-7 days total (1-3 days planning + 2-4 days extended solutioning) - -**Story Count:** Typically 30+ (but defined by enterprise needs) - -**Documents Phase 2:** PRD.md (FRs/NFRs) - -**Documents Phase 3:** architecture.md + epics.md + epic files + security-architecture.md (optional) + devops-strategy.md (optional) + secops-strategy.md (optional) - -**Example:** "Multi-tenant SaaS", "HIPAA-compliant portal", "Add SOC2 audit logging" - ---- - -## How Track Selection Works - -`workflow-init` guides you through educational choice: - -1. **Description Analysis** - Analyzes project description for complexity -2. **Educational Presentation** - Shows all three tracks with trade-offs -3. **Recommendation** - Suggests track based on keywords and context -4. **User Choice** - You select the track that fits - -The system guides but never forces. You can override recommendations. - ---- - -## Workflow Descriptions - -### workflow-init (Entry Point) - -**Purpose:** Single unified entry point for all planning. Discovers project needs and intelligently routes to appropriate track. - -**Agent:** PM (orchestrates others as needed) - -**Always Use:** This is your planning starting point. Don't call prd/tech-spec directly unless skipping discovery. - -**Process:** - -1. Discovery (understand context, assess complexity, identify concerns) -2. Routing Decision (determine track, explain rationale, confirm) -3. Execute Target Workflow (invoke planning workflow, pass context) -4. Handoff (document decisions, recommend next phase) - ---- - -### tech-spec (Quick Flow) - -**Purpose:** Lightweight technical specification for simple changes (Quick Flow track). Produces technical document and story or epic+stories structure. - -**Agent:** PM - -**When to Use:** - -- Bug fixes -- Single API endpoint additions -- Configuration changes -- Small UI component additions -- Isolated validation rules - -**Key Outputs:** - -- **tech-spec.md** - Technical document containing: - - Problem statement and solution - - Source tree changes - - Implementation details - - Testing strategy - - Acceptance criteria -- **Story file(s)** - Single story OR epic+stories structure (1-15 stories typically) - -**Skip To Phase:** 4 (Implementation) - no Phase 3 architecture needed - -**Example:** "Fix null pointer when user has no profile image" → Single file change, null check, unit test, no DB migration. - ---- - -### prd (Product Requirements Document) - -**Purpose:** Strategic PRD with Functional Requirements (FRs) and Non-Functional Requirements (NFRs) for software products (BMad Method track). - -**Agent:** PM (with Architect and Analyst support) - -**When to Use:** - -- Medium to large feature sets -- Multi-screen user experiences -- Complex business logic -- Multiple system integrations -- Phased delivery required - -**Scale-Adaptive Structure:** - -- **Light:** Focused FRs/NFRs, simplified analysis (10-15 pages) -- **Standard:** Comprehensive FRs/NFRs, thorough analysis (20-30 pages) -- **Comprehensive:** Extensive FRs/NFRs, multi-phase, stakeholder analysis (30-50+ pages) - -**Key Outputs:** - -- PRD.md (complete requirements with FRs and NFRs) - -**Note:** V6 improvement - PRD focuses on WHAT to build (requirements). Epic+Stories are created AFTER architecture via `create-epics-and-stories` workflow for better quality. - -**Integration:** Feeds into Architecture (Phase 3) - -**Example:** E-commerce checkout → PRD with 15 FRs (user account, cart management, payment flow) and 8 NFRs (performance, security, scalability). - ---- - -### create-ux-design (UX Design) - -**Purpose:** UX specification for projects where user experience is the primary differentiator (BMad Method track). - -**Agent:** UX Designer - -**When to Use:** - -- UX is primary competitive advantage -- Complex user workflows needing design thinking -- Innovative interaction patterns -- Design system creation -- Accessibility-critical experiences - -**Collaborative Approach:** - -1. Visual exploration (generate multiple options) -2. Informed decisions (evaluate with user needs) -3. Collaborative design (refine iteratively) -4. Living documentation (evolves with project) - -**Key Outputs:** - -- ux-spec.md (complete UX specification) -- User journeys -- Wireframes and mockups -- Interaction specifications -- Design system (components, patterns, tokens) -- Epic breakdown (UX stories) - -**Integration:** Feeds PRD or updates epics, then Architecture (Phase 3) - -**Example:** Dashboard redesign → Card-based layout with split-pane toggle, 5 card components, 12 color tokens, responsive grid, 3 epics (Layout, Visualization, Accessibility). - ---- - -### correct-course - -**Purpose:** Handle significant requirement changes during implementation (all tracks). - -**Agent:** PM, Architect, or SM - -**When to Use:** - -- Priorities change mid-project -- New requirements emerge -- Scope adjustments needed -- Technical blockers require replanning - -**Process:** - -1. Analyze impact of change -2. Propose solutions (continue, pivot, pause) -3. Update affected documents (PRD, epics, stories) -4. Re-route for implementation - -**Integration:** Updates planning artifacts, may trigger architecture review - ---- - -## Decision Guide - -### Which Planning Workflow? - -**Use `workflow-init` (Recommended):** Let the system discover needs and route appropriately. - -**Direct Selection (Advanced):** - -- **Bug fix or single change** → `tech-spec` (Quick Flow) -- **Software product** → `prd` (BMad Method) -- **UX innovation project** → `create-ux-design` + `prd` (BMad Method) -- **Enterprise with compliance** → Choose track in `workflow-init` → Enterprise Method - ---- - -## Integration with Phase 3 (Solutioning) - -Planning outputs feed into Solutioning: - -| Planning Output | Solutioning Input | Track Decision | -| --------------- | ---------------------------------- | ---------------------------- | -| tech-spec.md | Skip Phase 3 → Phase 4 directly | Quick Flow (no architecture) | -| PRD.md | **architecture** (Level 3-4) | BMad Method (recommended) | -| ux-spec.md | **architecture** (frontend design) | BMad Method | -| Enterprise docs | **architecture** + security/ops | Enterprise Method (required) | - -**Key Decision Points:** - -- **Quick Flow:** Skip Phase 3 entirely → Phase 4 (Implementation) -- **BMad Method:** Optional Phase 3 (simple), Required Phase 3 (complex) -- **Enterprise:** Required Phase 3 (architecture + extended planning) - -See: [workflows-solutioning.md](./workflows-solutioning.md) - ---- - -## Best Practices - -### 1. Always Start with workflow-init - -Let the entry point guide you. It prevents over-planning simple features or under-planning complex initiatives. - -### 2. Trust the Recommendation - -If `workflow-init` suggests BMad Method, there's likely complexity you haven't considered. Review carefully before overriding. - -### 3. Iterate on Requirements - -Planning documents are living. Refine PRDs as you learn during Solutioning and Implementation. - -### 4. Involve Stakeholders Early - -Review PRDs with stakeholders before Solutioning. Catch misalignment early. - -### 5. Focus on "What" Not "How" - -Planning defines **what** to build and **why**. Leave **how** (technical design) to Phase 3 (Solutioning). - -### 6. Document-Project First for Brownfield - -Always run `document-project` before planning brownfield projects. AI agents need existing codebase context. - ---- - -## Common Patterns - -### Greenfield Software (BMad Method) - -``` -1. (Optional) Analysis: product-brief, research -2. workflow-init → routes to prd -3. PM: prd workflow -4. (Optional) UX Designer: create-ux-design workflow -5. → Phase 3: architecture -``` - -### Brownfield Software (BMad Method) - -``` -1. Technical Writer or Analyst: document-project -2. workflow-init → routes to prd -3. PM: prd workflow -4. → Phase 3: architecture (recommended for focused solution design) -``` - -### Bug Fix (Quick Flow) - -``` -1. workflow-init → routes to tech-spec -2. PM: tech-spec workflow -3. → Phase 4: Implementation (skip Phase 3) -``` - -### Enterprise Project (Enterprise Method) - -``` -1. (Recommended) Analysis: research (compliance, security) -2. workflow-init → routes to Enterprise Method -3. PM: prd workflow -4. (Optional) UX Designer: ux workflow -5. PM: create-epics-and-stories -6. → Phase 3: architecture + security + devops + test strategy -``` - ---- - -## Common Anti-Patterns - -### ❌ Skipping Planning - -"We'll just start coding and figure it out." -**Result:** Scope creep, rework, missed requirements - -### ❌ Over-Planning Simple Changes - -"Let me write a 20-page PRD for this button color change." -**Result:** Wasted time, analysis paralysis - -### ❌ Planning Without Discovery - -"I already know what I want, skip the questions." -**Result:** Solving wrong problem, missing opportunities - -### ❌ Treating PRD as Immutable - -"The PRD is locked, no changes allowed." -**Result:** Ignoring new information, rigid planning - -### ✅ Correct Approach - -- Use scale-adaptive planning (right depth for complexity) -- Involve stakeholders in review -- Iterate as you learn -- Keep planning docs living and updated -- Use `correct-course` for significant changes - ---- - -## Related Documentation - -- [Phase 1: Analysis Workflows](./workflows-analysis.md) - Optional discovery phase -- [Phase 3: Solutioning Workflows](./workflows-solutioning.md) - Next phase -- [Phase 4: Implementation Workflows](./workflows-implementation.md) -- [Scale Adaptive System](./scale-adaptive-system.md) - Understanding the three tracks -- [Quick Spec Flow](./quick-spec-flow.md) - Quick Flow track details -- [Agents Guide](./agents-guide.md) - Complete agent reference - ---- - -## Troubleshooting - -**Q: Which workflow should I run first?** -A: Run `workflow-init`. It analyzes your project and routes to the right planning workflow. - -**Q: Do I always need a PRD?** -A: No. Simple changes use `tech-spec` (Quick Flow). Only BMad Method and Enterprise tracks create PRDs. - -**Q: Can I skip Phase 3 (Solutioning)?** -A: Yes for Quick Flow. Optional for BMad Method (simple projects). Required for BMad Method (complex projects) and Enterprise. - -**Q: How do I know which track to choose?** -A: Use `workflow-init` - it recommends based on your description. Story counts are guidance, not definitions. - -**Q: What if requirements change mid-project?** -A: Run `correct-course` workflow. It analyzes impact and updates planning artifacts. - -**Q: Do brownfield projects need architecture?** -A: Recommended! Architecture distills massive codebase into focused solution design for your specific project. - -**Q: When do I run create-epics-and-stories?** -A: In Phase 3 (Solutioning), after architecture is complete. - -**Q: Should I use product-brief before PRD?** -A: Optional but recommended for greenfield. Helps strategic thinking. `workflow-init` offers it based on context. - ---- - -_Phase 2 Planning - Scale-adaptive requirements for every project._ diff --git a/src/modules/bmm/docs/workflows-solutioning.md b/src/modules/bmm/docs/workflows-solutioning.md deleted file mode 100644 index 9e682bd9..00000000 --- a/src/modules/bmm/docs/workflows-solutioning.md +++ /dev/null @@ -1,509 +0,0 @@ -# BMM Solutioning Workflows (Phase 3) - -## Overview - -Phase 3 (Solutioning) workflows translate **what** to build (from Planning) into **how** to build it (technical design). This phase prevents agent conflicts in multi-epic projects by documenting architectural decisions before implementation begins. - -**Key principle:** Make technical decisions explicit and documented so all agents implement consistently. Prevent one agent choosing REST while another chooses GraphQL. - -**Required for:** BMad Method (complex projects), Enterprise Method - -**Optional for:** BMad Method (simple projects), Quick Flow (skip entirely) - ---- - -## Phase 3 Solutioning Workflow Overview - -Phase 3 Solutioning has different paths based on the planning track selected: - -### Quick Flow Path - -- From Planning: tech-spec complete -- Action: Skip Phase 3 entirely -- Next: Phase 4 (Implementation) - -### BMad Method & Enterprise Path - -- From Planning: PRD with FRs/NFRs complete -- Optional: create-ux-design (if UX is critical) -- Required: architecture - System design with ADRs -- Required: create-epics-and-stories - Break requirements into implementable stories -- Required: implementation-readiness - Gate check validation -- Enterprise additions: Optional security-architecture and devops-strategy (future workflows) - -### Gate Check Results - -- **PASS** - All criteria met, proceed to Phase 4 -- **CONCERNS** - Minor gaps identified, proceed with caution -- **FAIL** - Critical issues, must resolve before Phase 4 - ---- - -## Quick Reference - -| Workflow | Agent | Track | Purpose | -| ---------------------------- | ----------- | ------------------------ | -------------------------------------------- | -| **create-ux-design** | UX Designer | BMad Method, Enterprise | Optional UX design (after PRD, before arch) | -| **architecture** | Architect | BMad Method, Enterprise | Technical architecture and design decisions | -| **create-epics-and-stories** | PM | BMad Method, Enterprise | Break FRs/NFRs into epics after architecture | -| **implementation-readiness** | Architect | BMad Complex, Enterprise | Validate planning/solutioning completeness | - -**When to Skip Solutioning:** - -- **Quick Flow:** Simple changes don't need architecture → Skip to Phase 4 - -**When Solutioning is Required:** - -- **BMad Method:** Multi-epic projects need architecture to prevent conflicts -- **Enterprise:** Same as BMad Method, plus optional extended workflows (test architecture, security architecture, devops strategy) added AFTER architecture but BEFORE gate check - ---- - -## Why Solutioning Matters - -### The Problem Without Solutioning - -``` -Agent 1 implements Epic 1 using REST API -Agent 2 implements Epic 2 using GraphQL -Result: Inconsistent API design, integration nightmare -``` - -### The Solution With Solutioning - -``` -architecture workflow decides: "Use GraphQL for all APIs" -All agents follow architecture decisions -Result: Consistent implementation, no conflicts -``` - -### Solutioning vs Planning - -| Aspect | Planning (Phase 2) | Solutioning (Phase 3) | -| -------- | ----------------------- | --------------------------------- | -| Question | What and Why? | How? Then What units of work? | -| Output | FRs/NFRs (Requirements) | Architecture + Epics/Stories | -| Agent | PM | Architect → PM | -| Audience | Stakeholders | Developers | -| Document | PRD (FRs/NFRs) | Architecture + Epic Files | -| Level | Business logic | Technical design + Work breakdown | - ---- - -## Workflow Descriptions - -### architecture - -**Purpose:** Make technical decisions explicit to prevent agent conflicts. Produces decision-focused architecture document optimized for AI consistency. - -**Agent:** Architect - -**When to Use:** - -- Multi-epic projects (BMad Complex, Enterprise) -- Cross-cutting technical concerns -- Multiple agents implementing different parts -- Integration complexity exists -- Technology choices need alignment - -**When to Skip:** - -- Quick Flow (simple changes) -- BMad Method Simple with straightforward tech stack -- Single epic with clear technical approach - -**Adaptive Conversation Approach:** - -This is NOT a template filler. The architecture workflow: - -1. **Discovers** technical needs through conversation -2. **Proposes** architectural options with trade-offs -3. **Documents** decisions that prevent agent conflicts -4. **Focuses** on decision points, not exhaustive documentation - -**Key Outputs:** - -**architecture.md** containing: - -1. **Architecture Overview** - System context, principles, style -2. **System Architecture** - High-level diagram, component interactions, communication patterns -3. **Data Architecture** - Database design, state management, caching, data flow -4. **API Architecture** - API style (REST/GraphQL/gRPC), auth, versioning, error handling -5. **Frontend Architecture** (if applicable) - Framework, state management, component architecture, routing -6. **Integration Architecture** - Third-party integrations, message queuing, event-driven patterns -7. **Security Architecture** - Auth/authorization, data protection, security boundaries -8. **Deployment Architecture** - Deployment model, CI/CD, environment strategy, monitoring -9. **Architecture Decision Records (ADRs)** - Key decisions with context, options, trade-offs, rationale -10. **FR/NFR-Specific Guidance** - Technical approach per functional requirement, implementation priorities, dependencies -11. **Standards and Conventions** - Directory structure, naming conventions, code organization, testing - -**ADR Format (Brief):** - -```markdown -## ADR-001: Use GraphQL for All APIs - -**Status:** Accepted | **Date:** 2025-11-02 - -**Context:** PRD requires flexible querying across multiple epics - -**Decision:** Use GraphQL for all client-server communication - -**Options Considered:** - -1. REST - Familiar but requires multiple endpoints -2. GraphQL - Flexible querying, learning curve -3. gRPC - High performance, poor browser support - -**Rationale:** - -- PRD requires flexible data fetching (Epic 1, 3) -- Mobile app needs bandwidth optimization (Epic 2) -- Team has GraphQL experience - -**Consequences:** - -- Positive: Flexible querying, reduced versioning -- Negative: Caching complexity, N+1 query risk -- Mitigation: Use DataLoader for batching - -**Implications for FRs:** - -- FR-001: User Management → GraphQL mutations -- FR-002: Mobile App → Optimized queries -``` - -**Example:** E-commerce platform → Monolith + PostgreSQL + Redis + Next.js + GraphQL, with ADRs explaining each choice and FR/NFR-specific guidance. - -**Integration:** Feeds into create-epics-and-stories workflow. Architecture provides the technical context needed for breaking FRs/NFRs into implementable epics and stories. All dev agents reference architecture during Phase 4 implementation. - ---- - -### create-epics-and-stories - -**Purpose:** Transform PRD's functional and non-functional requirements into bite-sized stories organized into deliverable functional epics. This workflow runs AFTER architecture so epics/stories are informed by technical decisions. - -**Agent:** PM (Product Manager) - -**When to Use:** - -- After architecture workflow completes -- When PRD contains FRs/NFRs ready for implementation breakdown -- Before implementation-readiness gate check - -**Key Inputs:** - -- PRD (FRs/NFRs) from Phase 2 Planning -- architecture.md with ADRs and technical decisions -- Optional: UX design artifacts - -**Why After Architecture:** - -The create-epics-and-stories workflow runs AFTER architecture because: - -1. **Informed Story Sizing:** Architecture decisions (database choice, API style, etc.) affect story complexity -2. **Dependency Awareness:** Architecture reveals technical dependencies between stories -3. **Technical Feasibility:** Stories can be properly scoped knowing the tech stack -4. **Consistency:** All stories align with documented architectural patterns - -**Key Outputs:** - -Epic files (one per epic) containing: - -1. Epic objective and scope -2. User stories with acceptance criteria -3. Story priorities (P0/P1/P2/P3) -4. Dependencies between stories -5. Technical notes referencing architecture decisions - -**Example:** E-commerce PRD with FR-001 (User Registration), FR-002 (Product Catalog) → Epic 1: User Management (3 stories), Epic 2: Product Display (4 stories), each story referencing relevant ADRs. - ---- - -### implementation-readiness - -**Purpose:** Systematically validate that planning and solutioning are complete and aligned before Phase 4 implementation. Ensures PRD, architecture, and epics are cohesive with no gaps. - -**Agent:** Architect - -**When to Use:** - -- **Always** before Phase 4 for BMad Complex and Enterprise projects -- After create-epics-and-stories workflow completes -- Before sprint-planning workflow -- When stakeholders request readiness check - -**When to Skip:** - -- Quick Flow (no solutioning) -- BMad Simple (no gate check required) - -**Purpose of Gate Check:** - -**Prevents:** - -- ❌ Architecture doesn't address all FRs/NFRs -- ❌ Epics conflict with architecture decisions -- ❌ Requirements ambiguous or contradictory -- ❌ Missing critical dependencies - -**Ensures:** - -- ✅ PRD → Architecture → Epics alignment -- ✅ All epics have clear technical approach -- ✅ No contradictions or gaps -- ✅ Team ready to implement - -**Check Criteria:** - -**PRD/GDD Completeness:** - -- Problem statement clear and evidence-based -- Success metrics defined -- User personas identified -- Functional requirements (FRs) complete -- Non-functional requirements (NFRs) specified -- Risks and assumptions documented - -**Architecture Completeness:** - -- System architecture defined -- Data architecture specified -- API architecture decided -- Key ADRs documented -- Security architecture addressed -- FR/NFR-specific guidance provided -- Standards and conventions defined - -**Epic/Story Completeness:** - -- All PRD features mapped to stories -- Stories have acceptance criteria -- Stories prioritized (P0/P1/P2/P3) -- Dependencies identified -- Story sequencing logical - -**Alignment Checks:** - -- Architecture addresses all PRD FRs/NFRs -- Epics align with architecture decisions -- No contradictions between epics -- NFRs have technical approach -- Integration points clear - -**Gate Decision Logic:** - -**✅ PASS** - -- All critical criteria met -- Minor gaps acceptable with documented plan -- **Action:** Proceed to Phase 4 - -**⚠️ CONCERNS** - -- Some criteria not met but not blockers -- Gaps identified with clear resolution path -- **Action:** Proceed with caution, address gaps in parallel - -**❌ FAIL** - -- Critical gaps or contradictions -- Architecture missing key decisions -- Epics conflict with PRD/architecture -- **Action:** BLOCK Phase 4, resolve issues first - -**Key Outputs:** - -**implementation-readiness.md** containing: - -1. Executive Summary (PASS/CONCERNS/FAIL) -2. Completeness Assessment (scores for PRD, Architecture, Epics) -3. Alignment Assessment (PRD↔Architecture, Architecture↔Epics/Stories, cross-epic consistency) -4. Quality Assessment (story quality, dependencies, risks) -5. Gaps and Recommendations (critical/minor gaps, remediation) -6. Gate Decision with rationale -7. Next Steps - -**Example:** E-commerce platform → CONCERNS ⚠️ due to missing security architecture and undefined payment gateway. Recommendation: Complete security section and add payment gateway ADR before proceeding. - ---- - -## Integration with Planning and Implementation - -### Planning → Solutioning Flow - -**Quick Flow:** - -``` -Planning (tech-spec by PM) - → Skip Solutioning - → Phase 4 (Implementation) -``` - -**BMad Method:** - -``` -Planning (prd by PM - FRs/NFRs only) - → Optional: create-ux-design (UX Designer) - → architecture (Architect) - → create-epics-and-stories (PM) - → implementation-readiness (Architect) - → Phase 4 (Implementation) -``` - -**Enterprise:** - -``` -Planning (prd by PM - FRs/NFRs only) - → Optional: create-ux-design (UX Designer) - → architecture (Architect) - → Optional: security-architecture (Architect, future) - → Optional: devops-strategy (Architect, future) - → create-epics-and-stories (PM) - → implementation-readiness (Architect) - → Phase 4 (Implementation) -``` - -**Note on TEA (Test Architect):** TEA is fully operational with 8 workflows across all phases. TEA validates architecture testability during Phase 3 reviews but does not have a dedicated solutioning workflow. TEA's primary setup occurs after architecture in Phase 3 (`*framework`, `*ci`, system-level `*test-design`), with optional Phase 2 baseline `*trace`. Testing execution happens in Phase 4 (`*atdd`, `*automate`, `*test-review`, `*trace`, `*nfr-assess`). - -**Note:** Enterprise uses the same planning and architecture as BMad Method. The only difference is optional extended workflows added AFTER architecture but BEFORE create-epics-and-stories. - -### Solutioning → Implementation Handoff - -**Documents Produced:** - -1. **architecture.md** → Guides all dev agents during implementation -2. **ADRs** (in architecture) → Referenced by agents for technical decisions -3. **Epic files** (from create-epics-and-stories) → Work breakdown into implementable units -4. **implementation-readiness.md** → Confirms readiness for Phase 4 - -**How Implementation Uses Solutioning:** - -- **sprint-planning** - Loads architecture and epic files for sprint organization -- **dev-story** - References architecture decisions and ADRs -- **code-review** - Validates code follows architectural standards - ---- - -## Best Practices - -### 1. Make Decisions Explicit - -Don't leave technology choices implicit. Document decisions with rationale in ADRs so agents understand context. - -### 2. Focus on Agent Conflicts - -Architecture's primary job is preventing conflicting implementations. Focus on cross-cutting concerns. - -### 3. Use ADRs for Key Decisions - -Every significant technology choice should have an ADR explaining "why", not just "what". - -### 4. Keep It Practical - -Don't over-architect simple projects. BMad Simple projects need simple architecture. - -### 5. Run Gate Check Before Implementation - -Catching alignment issues in solutioning is 10× faster than discovering them mid-implementation. - -### 6. Iterate Architecture - -Architecture documents are living. Update them as you learn during implementation. - ---- - -## Decision Guide - -### Quick Flow - -- **Planning:** tech-spec (PM) -- **Solutioning:** Skip entirely -- **Implementation:** sprint-planning → dev-story - -### BMad Method - -- **Planning:** prd (PM) - creates FRs/NFRs only, NOT epics -- **Solutioning:** Optional UX → architecture (Architect) → create-epics-and-stories (PM) → implementation-readiness (Architect) -- **Implementation:** sprint-planning → create-story → dev-story - -### Enterprise - -- **Planning:** prd (PM) - creates FRs/NFRs only (same as BMad Method) -- **Solutioning:** Optional UX → architecture (Architect) → Optional extended workflows (security-architecture, devops-strategy) → create-epics-and-stories (PM) → implementation-readiness (Architect) -- **Implementation:** sprint-planning → create-story → dev-story - -**Key Difference:** Enterprise adds optional extended workflows AFTER architecture but BEFORE create-epics-and-stories. Everything else is identical to BMad Method. - -**Note:** TEA (Test Architect) operates across all phases and validates architecture testability but is not a Phase 3-specific workflow. See [Test Architecture Guide](./test-architecture.md) for TEA's full lifecycle integration. - ---- - -## Common Anti-Patterns - -### ❌ Skipping Architecture for Complex Projects - -"Architecture slows us down, let's just start coding." -**Result:** Agent conflicts, inconsistent design, massive rework - -### ❌ Over-Engineering Simple Projects - -"Let me design this simple feature like a distributed system." -**Result:** Wasted time, over-engineering, analysis paralysis - -### ❌ Template-Driven Architecture - -"Fill out every section of this architecture template." -**Result:** Documentation theater, no real decisions made - -### ❌ Skipping Gate Check - -"PRD and architecture look good enough, let's start." -**Result:** Gaps discovered mid-sprint, wasted implementation time - -### ✅ Correct Approach - -- Use architecture for BMad Method and Enterprise (both required) -- Focus on decisions, not documentation volume -- Enterprise: Add optional extended workflows (test/security/devops) after architecture -- Always run gate check before implementation - ---- - -## Related Documentation - -- [Phase 2: Planning Workflows](./workflows-planning.md) - Previous phase -- [Phase 4: Implementation Workflows](./workflows-implementation.md) - Next phase -- [Scale Adaptive System](./scale-adaptive-system.md) - Understanding tracks -- [Agents Guide](./agents-guide.md) - Complete agent reference - ---- - -## Troubleshooting - -**Q: Do I always need architecture?** -A: No. Quick Flow skips it. BMad Method and Enterprise both require it. - -**Q: How do I know if I need architecture?** -A: If you chose BMad Method or Enterprise track in planning (workflow-init), you need architecture to prevent agent conflicts. - -**Q: What's the difference between architecture and tech-spec?** -A: Tech-spec is implementation-focused for simple changes. Architecture is system design for complex multi-epic projects. - -**Q: Can I skip gate check?** -A: Only for Quick Flow. BMad Method and Enterprise both require gate check before Phase 4. - -**Q: What if gate check fails?** -A: Resolve the identified gaps (missing architecture sections, conflicting requirements) and re-run gate check. - -**Q: How long should architecture take?** -A: BMad Method: 1-2 days for architecture. Enterprise: 2-3 days total (1-2 days architecture + 0.5-1 day optional extended workflows). If taking longer, you may be over-documenting. - -**Q: Do ADRs need to be perfect?** -A: No. ADRs capture key decisions with rationale. They should be concise (1 page max per ADR). - -**Q: Can I update architecture during implementation?** -A: Yes! Architecture is living. Update it as you learn. Use `correct-course` workflow for significant changes. - ---- - -_Phase 3 Solutioning - Technical decisions before implementation._ diff --git a/src/modules/bmm/module.yaml b/src/modules/bmm/module.yaml index fb3dde71..b5aaf889 100644 --- a/src/modules/bmm/module.yaml +++ b/src/modules/bmm/module.yaml @@ -31,7 +31,7 @@ user_skill_level: planning_artifacts: # Phase 1-3 artifacts prompt: "Where should project planning artifacts be stored?\n - Such as: (Brain Storming, Briefs, PRDs, UX Designs, Architectures, Detailed Epics Plan)" - default: "{output_folder}/project-planning-artifacts" + default: "{output_folder}/planning-artifacts" result: "{project-root}/{value}" implementation_artifacts: # Phase 4 artifacts and quick-dev flow output @@ -45,12 +45,12 @@ project_knowledge: # Artifacts from research, document-project output, other lon result: "{project-root}/{value}" tea_use_mcp_enhancements: - prompt: "WEB APP ONLY: Test Architect Playwright MCP capabilities (healing, exploratory, verification) are optionally available.\nYou will have to setup your MCPs yourself; refer to test-architecture.md for hints.\nWould you like to enable MCP enhancements in Test Architect?" + prompt: "Test Architect Playwright MCP capabilities (healing, exploratory, verification) are optionally available.\nYou will have to setup your MCPs yourself; refer to https://docs.bmad-method.org/explanation/features/tea-overview for configuration examples.\nWould you like to enable MCP enhancements in Test Architect?" default: false result: "{value}" tea_use_playwright_utils: prompt: - - "WEB APP ONLY: Are you using playwright-utils (@seontechnologies/playwright-utils) in your project?\nYou must install packages yourself, or use test architect's *framework command." + - "Are you using playwright-utils (@seontechnologies/playwright-utils) in your project?\nYou must install packages yourself, or use test architect's *framework command." default: false result: "{value}" diff --git a/src/modules/bmm/testarch/knowledge/api-request.md b/src/modules/bmm/testarch/knowledge/api-request.md index b47bfc4f..d2b36cde 100644 --- a/src/modules/bmm/testarch/knowledge/api-request.md +++ b/src/modules/bmm/testarch/knowledge/api-request.md @@ -2,7 +2,7 @@ ## Principle -Use typed HTTP client with built-in schema validation and automatic retry for server errors. The utility handles URL resolution, header management, response parsing, and single-line response validation with proper TypeScript support. +Use typed HTTP client with built-in schema validation and automatic retry for server errors. The utility handles URL resolution, header management, response parsing, and single-line response validation with proper TypeScript support. **Works without a browser** - ideal for pure API/service testing. ## Rationale @@ -21,6 +21,7 @@ The `apiRequest` utility provides: - **Schema validation**: Single-line validation (JSON Schema, Zod, OpenAPI) - **URL resolution**: Four-tier strategy (explicit > config > Playwright > direct) - **TypeScript generics**: Type-safe response bodies +- **No browser required**: Pure API testing without browser overhead ## Pattern Examples @@ -60,10 +61,11 @@ test('should fetch user data', async ({ apiRequest }) => { ```typescript import { test } from '@seontechnologies/playwright-utils/api-request/fixtures'; +import { z } from 'zod'; -test('should validate response schema', async ({ apiRequest }) => { - // JSON Schema validation - const response = await apiRequest({ +// JSON Schema validation +test('should validate response schema (JSON Schema)', async ({ apiRequest }) => { + const { status, body } = await apiRequest({ method: 'GET', path: '/api/users/123', validateSchema: { @@ -77,22 +79,25 @@ test('should validate response schema', async ({ apiRequest }) => { }, }); // Throws if schema validation fails + expect(status).toBe(200); +}); - // Zod schema validation - import { z } from 'zod'; +// Zod schema validation +const UserSchema = z.object({ + id: z.string(), + name: z.string(), + email: z.string().email(), +}); - const UserSchema = z.object({ - id: z.string(), - name: z.string(), - email: z.string().email(), - }); - - const response = await apiRequest({ +test('should validate response schema (Zod)', async ({ apiRequest }) => { + const { status, body } = await apiRequest({ method: 'GET', path: '/api/users/123', validateSchema: UserSchema, }); // Response body is type-safe AND validated + expect(status).toBe(200); + expect(body.email).toContain('@'); }); ``` @@ -236,6 +241,136 @@ test('should poll until job completes', async ({ apiRequest, recurse }) => { - `recurse` polls until predicate returns true - Composable utilities work together seamlessly +### Example 6: Microservice Testing (Multiple Services) + +**Context**: Test interactions between microservices without a browser. + +**Implementation**: + +```typescript +import { test, expect } from '@seontechnologies/playwright-utils/fixtures'; + +const USER_SERVICE = process.env.USER_SERVICE_URL || 'http://localhost:3001'; +const ORDER_SERVICE = process.env.ORDER_SERVICE_URL || 'http://localhost:3002'; + +test.describe('Microservice Integration', () => { + test('should validate cross-service user lookup', async ({ apiRequest }) => { + // Create user in user-service + const { body: user } = await apiRequest({ + method: 'POST', + path: '/api/users', + baseUrl: USER_SERVICE, + body: { name: 'Test User', email: 'test@example.com' }, + }); + + // Create order in order-service (validates user via user-service) + const { status, body: order } = await apiRequest({ + method: 'POST', + path: '/api/orders', + baseUrl: ORDER_SERVICE, + body: { + userId: user.id, + items: [{ productId: 'prod-1', quantity: 2 }], + }, + }); + + expect(status).toBe(201); + expect(order.userId).toBe(user.id); + }); + + test('should reject order for invalid user', async ({ apiRequest }) => { + const { status, body } = await apiRequest({ + method: 'POST', + path: '/api/orders', + baseUrl: ORDER_SERVICE, + body: { + userId: 'non-existent-user', + items: [{ productId: 'prod-1', quantity: 1 }], + }, + }); + + expect(status).toBe(400); + expect(body.code).toBe('INVALID_USER'); + }); +}); +``` + +**Key Points**: + +- Test multiple services without browser +- Use `baseUrl` to target different services +- Validate cross-service communication +- Pure API testing - fast and reliable + +### Example 7: GraphQL API Testing + +**Context**: Test GraphQL endpoints with queries and mutations. + +**Implementation**: + +```typescript +test.describe('GraphQL API', () => { + const GRAPHQL_ENDPOINT = '/graphql'; + + test('should query users via GraphQL', async ({ apiRequest }) => { + const query = ` + query GetUsers($limit: Int) { + users(limit: $limit) { + id + name + email + } + } + `; + + const { status, body } = await apiRequest({ + method: 'POST', + path: GRAPHQL_ENDPOINT, + body: { + query, + variables: { limit: 10 }, + }, + }); + + expect(status).toBe(200); + expect(body.errors).toBeUndefined(); + expect(body.data.users).toHaveLength(10); + }); + + test('should create user via mutation', async ({ apiRequest }) => { + const mutation = ` + mutation CreateUser($input: CreateUserInput!) { + createUser(input: $input) { + id + name + } + } + `; + + const { status, body } = await apiRequest({ + method: 'POST', + path: GRAPHQL_ENDPOINT, + body: { + query: mutation, + variables: { + input: { name: 'GraphQL User', email: 'gql@example.com' }, + }, + }, + }); + + expect(status).toBe(200); + expect(body.data.createUser.id).toBeDefined(); + }); +}); +``` + +**Key Points**: + +- GraphQL via POST request +- Variables in request body +- Check `body.errors` for GraphQL errors (not status code) +- Works for queries and mutations + ## Comparison with Vanilla Playwright | Vanilla Playwright | playwright-utils apiRequest | @@ -251,11 +386,13 @@ test('should poll until job completes', async ({ apiRequest, recurse }) => { **Use apiRequest for:** -- ✅ API endpoint testing -- ✅ Background API calls in UI tests +- ✅ Pure API/service testing (no browser needed) +- ✅ Microservice integration testing +- ✅ GraphQL API testing - ✅ Schema validation needs - ✅ Tests requiring retry logic -- ✅ Typed API responses +- ✅ Background API calls in UI tests +- ✅ Contract testing support **Stick with vanilla Playwright for:** @@ -265,11 +402,13 @@ test('should poll until job completes', async ({ apiRequest, recurse }) => { ## Related Fragments +- `api-testing-patterns.md` - Comprehensive pure API testing patterns - `overview.md` - Installation and design principles - `auth-session.md` - Authentication token management - `recurse.md` - Polling for async operations - `fixtures-composition.md` - Combining utilities with mergeTests - `log.md` - Logging API requests +- `contract-testing.md` - Pact contract testing ## Anti-Patterns diff --git a/src/modules/bmm/testarch/knowledge/api-testing-patterns.md b/src/modules/bmm/testarch/knowledge/api-testing-patterns.md new file mode 100644 index 00000000..65c81d7a --- /dev/null +++ b/src/modules/bmm/testarch/knowledge/api-testing-patterns.md @@ -0,0 +1,843 @@ +# API Testing Patterns + +## Principle + +Test APIs and backend services directly without browser overhead. Use Playwright's `request` context for HTTP operations, `apiRequest` utility for enhanced features, and `recurse` for async operations. Pure API tests run faster, are more stable, and provide better coverage for service-layer logic. + +## Rationale + +Many teams over-rely on E2E/browser tests when API tests would be more appropriate: + +- **Slower feedback**: Browser tests take seconds, API tests take milliseconds +- **More brittle**: UI changes break tests even when API works correctly +- **Wrong abstraction**: Testing business logic through UI layers adds noise +- **Resource heavy**: Browsers consume memory and CPU + +API-first testing provides: + +- **Fast execution**: No browser startup, no rendering, no JavaScript execution +- **Direct validation**: Test exactly what the service returns +- **Better isolation**: Test service logic independent of UI +- **Easier debugging**: Clear request/response without DOM noise +- **Contract validation**: Verify API contracts explicitly + +## When to Use API Tests vs E2E Tests + +| Scenario | API Test | E2E Test | +|----------|----------|----------| +| CRUD operations | ✅ Primary | ❌ Overkill | +| Business logic validation | ✅ Primary | ❌ Overkill | +| Error handling (4xx, 5xx) | ✅ Primary | ⚠️ Supplement | +| Authentication flows | ✅ Primary | ⚠️ Supplement | +| Data transformation | ✅ Primary | ❌ Overkill | +| User journeys | ❌ Can't test | ✅ Primary | +| Visual regression | ❌ Can't test | ✅ Primary | +| Cross-browser issues | ❌ Can't test | ✅ Primary | + +**Rule of thumb**: If you're testing what the server returns (not how it looks), use API tests. + +## Pattern Examples + +### Example 1: Pure API Test (No Browser) + +**Context**: Test REST API endpoints directly without any browser context. + +**Implementation**: + +```typescript +// tests/api/users.spec.ts +import { test, expect } from '@playwright/test'; + +// No page, no browser - just API +test.describe('Users API', () => { + test('should create user', async ({ request }) => { + const response = await request.post('/api/users', { + data: { + name: 'John Doe', + email: 'john@example.com', + role: 'user', + }, + }); + + expect(response.status()).toBe(201); + + const user = await response.json(); + expect(user.id).toBeDefined(); + expect(user.name).toBe('John Doe'); + expect(user.email).toBe('john@example.com'); + }); + + test('should get user by ID', async ({ request }) => { + // Create user first + const createResponse = await request.post('/api/users', { + data: { name: 'Jane Doe', email: 'jane@example.com' }, + }); + const { id } = await createResponse.json(); + + // Get user + const getResponse = await request.get(`/api/users/${id}`); + expect(getResponse.status()).toBe(200); + + const user = await getResponse.json(); + expect(user.id).toBe(id); + expect(user.name).toBe('Jane Doe'); + }); + + test('should return 404 for non-existent user', async ({ request }) => { + const response = await request.get('/api/users/non-existent-id'); + expect(response.status()).toBe(404); + + const error = await response.json(); + expect(error.code).toBe('USER_NOT_FOUND'); + }); + + test('should validate required fields', async ({ request }) => { + const response = await request.post('/api/users', { + data: { name: 'Missing Email' }, // email is required + }); + + expect(response.status()).toBe(400); + + const error = await response.json(); + expect(error.code).toBe('VALIDATION_ERROR'); + expect(error.details).toContainEqual( + expect.objectContaining({ field: 'email', message: expect.any(String) }) + ); + }); +}); +``` + +**Key Points**: + +- No `page` fixture needed - only `request` +- Tests run without browser overhead +- Direct HTTP assertions +- Clear error handling tests + +### Example 2: API Test with apiRequest Utility + +**Context**: Use enhanced apiRequest for schema validation, retry, and type safety. + +**Implementation**: + +```typescript +// tests/api/orders.spec.ts +import { test, expect } from '@seontechnologies/playwright-utils/api-request/fixtures'; +import { z } from 'zod'; + +// Define schema for type safety and validation +const OrderSchema = z.object({ + id: z.string().uuid(), + userId: z.string(), + items: z.array( + z.object({ + productId: z.string(), + quantity: z.number().positive(), + price: z.number().positive(), + }) + ), + total: z.number().positive(), + status: z.enum(['pending', 'processing', 'shipped', 'delivered']), + createdAt: z.string().datetime(), +}); + +type Order = z.infer; + +test.describe('Orders API', () => { + test('should create order with schema validation', async ({ apiRequest }) => { + const { status, body } = await apiRequest({ + method: 'POST', + path: '/api/orders', + body: { + userId: 'user-123', + items: [ + { productId: 'prod-1', quantity: 2, price: 29.99 }, + { productId: 'prod-2', quantity: 1, price: 49.99 }, + ], + }, + validateSchema: OrderSchema, // Validates response matches schema + }); + + expect(status).toBe(201); + expect(body.id).toBeDefined(); + expect(body.status).toBe('pending'); + expect(body.total).toBe(109.97); // 2*29.99 + 49.99 + }); + + test('should handle server errors with retry', async ({ apiRequest }) => { + // apiRequest retries 5xx errors by default + const { status, body } = await apiRequest({ + method: 'GET', + path: '/api/orders/order-123', + retryConfig: { + maxRetries: 3, + retryDelay: 1000, + }, + }); + + expect(status).toBe(200); + }); + + test('should list orders with pagination', async ({ apiRequest }) => { + const { status, body } = await apiRequest<{ orders: Order[]; total: number; page: number }>({ + method: 'GET', + path: '/api/orders', + params: { page: 1, limit: 10, status: 'pending' }, + }); + + expect(status).toBe(200); + expect(body.orders).toHaveLength(10); + expect(body.total).toBeGreaterThan(10); + expect(body.page).toBe(1); + }); +}); +``` + +**Key Points**: + +- Zod schema for runtime validation AND TypeScript types +- `validateSchema` throws if response doesn't match +- Built-in retry for transient failures +- Type-safe `body` access + +### Example 3: Microservice-to-Microservice Testing + +**Context**: Test service interactions without browser - validate API contracts between services. + +**Implementation**: + +```typescript +// tests/api/service-integration.spec.ts +import { test, expect } from '@seontechnologies/playwright-utils/fixtures'; + +test.describe('Service Integration', () => { + const USER_SERVICE_URL = process.env.USER_SERVICE_URL || 'http://localhost:3001'; + const ORDER_SERVICE_URL = process.env.ORDER_SERVICE_URL || 'http://localhost:3002'; + const INVENTORY_SERVICE_URL = process.env.INVENTORY_SERVICE_URL || 'http://localhost:3003'; + + test('order service should validate user exists', async ({ apiRequest }) => { + // Create user in user-service + const { body: user } = await apiRequest({ + method: 'POST', + path: '/api/users', + baseUrl: USER_SERVICE_URL, + body: { name: 'Test User', email: 'test@example.com' }, + }); + + // Create order in order-service (should validate user via user-service) + const { status, body: order } = await apiRequest({ + method: 'POST', + path: '/api/orders', + baseUrl: ORDER_SERVICE_URL, + body: { + userId: user.id, + items: [{ productId: 'prod-1', quantity: 1 }], + }, + }); + + expect(status).toBe(201); + expect(order.userId).toBe(user.id); + }); + + test('order service should reject invalid user', async ({ apiRequest }) => { + const { status, body } = await apiRequest({ + method: 'POST', + path: '/api/orders', + baseUrl: ORDER_SERVICE_URL, + body: { + userId: 'non-existent-user', + items: [{ productId: 'prod-1', quantity: 1 }], + }, + }); + + expect(status).toBe(400); + expect(body.code).toBe('INVALID_USER'); + }); + + test('order should decrease inventory', async ({ apiRequest, recurse }) => { + // Get initial inventory + const { body: initialInventory } = await apiRequest({ + method: 'GET', + path: '/api/inventory/prod-1', + baseUrl: INVENTORY_SERVICE_URL, + }); + + // Create order + await apiRequest({ + method: 'POST', + path: '/api/orders', + baseUrl: ORDER_SERVICE_URL, + body: { + userId: 'user-123', + items: [{ productId: 'prod-1', quantity: 2 }], + }, + }); + + // Poll for inventory update (eventual consistency) + const { body: updatedInventory } = await recurse( + () => + apiRequest({ + method: 'GET', + path: '/api/inventory/prod-1', + baseUrl: INVENTORY_SERVICE_URL, + }), + (response) => response.body.quantity === initialInventory.quantity - 2, + { timeout: 10000, interval: 500 } + ); + + expect(updatedInventory.quantity).toBe(initialInventory.quantity - 2); + }); +}); +``` + +**Key Points**: + +- Multiple service URLs for microservice testing +- Tests service-to-service communication +- Uses `recurse` for eventual consistency +- No browser needed for full integration testing + +### Example 4: GraphQL API Testing + +**Context**: Test GraphQL endpoints with queries and mutations. + +**Implementation**: + +```typescript +// tests/api/graphql.spec.ts +import { test, expect } from '@seontechnologies/playwright-utils/api-request/fixtures'; + +const GRAPHQL_ENDPOINT = '/graphql'; + +test.describe('GraphQL API', () => { + test('should query users', async ({ apiRequest }) => { + const query = ` + query GetUsers($limit: Int) { + users(limit: $limit) { + id + name + email + role + } + } + `; + + const { status, body } = await apiRequest({ + method: 'POST', + path: GRAPHQL_ENDPOINT, + body: { + query, + variables: { limit: 10 }, + }, + }); + + expect(status).toBe(200); + expect(body.errors).toBeUndefined(); + expect(body.data.users).toHaveLength(10); + expect(body.data.users[0]).toHaveProperty('id'); + expect(body.data.users[0]).toHaveProperty('name'); + }); + + test('should create user via mutation', async ({ apiRequest }) => { + const mutation = ` + mutation CreateUser($input: CreateUserInput!) { + createUser(input: $input) { + id + name + email + } + } + `; + + const { status, body } = await apiRequest({ + method: 'POST', + path: GRAPHQL_ENDPOINT, + body: { + query: mutation, + variables: { + input: { + name: 'GraphQL User', + email: 'graphql@example.com', + }, + }, + }, + }); + + expect(status).toBe(200); + expect(body.errors).toBeUndefined(); + expect(body.data.createUser.id).toBeDefined(); + expect(body.data.createUser.name).toBe('GraphQL User'); + }); + + test('should handle GraphQL errors', async ({ apiRequest }) => { + const query = ` + query GetUser($id: ID!) { + user(id: $id) { + id + name + } + } + `; + + const { status, body } = await apiRequest({ + method: 'POST', + path: GRAPHQL_ENDPOINT, + body: { + query, + variables: { id: 'non-existent' }, + }, + }); + + expect(status).toBe(200); // GraphQL returns 200 even for errors + expect(body.errors).toBeDefined(); + expect(body.errors[0].message).toContain('not found'); + expect(body.data.user).toBeNull(); + }); + + test('should handle validation errors', async ({ apiRequest }) => { + const mutation = ` + mutation CreateUser($input: CreateUserInput!) { + createUser(input: $input) { + id + } + } + `; + + const { status, body } = await apiRequest({ + method: 'POST', + path: GRAPHQL_ENDPOINT, + body: { + query: mutation, + variables: { + input: { + name: '', // Invalid: empty name + email: 'invalid-email', // Invalid: bad format + }, + }, + }, + }); + + expect(status).toBe(200); + expect(body.errors).toBeDefined(); + expect(body.errors[0].extensions.code).toBe('BAD_USER_INPUT'); + }); +}); +``` + +**Key Points**: + +- GraphQL queries and mutations via POST +- Variables passed in request body +- GraphQL returns 200 even for errors (check `body.errors`) +- Test validation and business logic errors + +### Example 5: Database Seeding and Cleanup via API + +**Context**: Use API calls to set up and tear down test data without direct database access. + +**Implementation**: + +```typescript +// tests/api/with-data-setup.spec.ts +import { test, expect } from '@seontechnologies/playwright-utils/fixtures'; + +test.describe('Orders with Data Setup', () => { + let testUser: { id: string; email: string }; + let testProducts: Array<{ id: string; name: string; price: number }>; + + test.beforeAll(async ({ request }) => { + // Seed user via API + const userResponse = await request.post('/api/users', { + data: { + name: 'Test User', + email: `test-${Date.now()}@example.com`, + }, + }); + testUser = await userResponse.json(); + + // Seed products via API + testProducts = []; + for (const product of [ + { name: 'Widget A', price: 29.99 }, + { name: 'Widget B', price: 49.99 }, + { name: 'Widget C', price: 99.99 }, + ]) { + const productResponse = await request.post('/api/products', { + data: product, + }); + testProducts.push(await productResponse.json()); + } + }); + + test.afterAll(async ({ request }) => { + // Cleanup via API + if (testUser?.id) { + await request.delete(`/api/users/${testUser.id}`); + } + for (const product of testProducts) { + await request.delete(`/api/products/${product.id}`); + } + }); + + test('should create order with seeded data', async ({ apiRequest }) => { + const { status, body } = await apiRequest({ + method: 'POST', + path: '/api/orders', + body: { + userId: testUser.id, + items: [ + { productId: testProducts[0].id, quantity: 2 }, + { productId: testProducts[1].id, quantity: 1 }, + ], + }, + }); + + expect(status).toBe(201); + expect(body.userId).toBe(testUser.id); + expect(body.items).toHaveLength(2); + expect(body.total).toBe(2 * 29.99 + 49.99); + }); + + test('should list user orders', async ({ apiRequest }) => { + // Create an order first + await apiRequest({ + method: 'POST', + path: '/api/orders', + body: { + userId: testUser.id, + items: [{ productId: testProducts[2].id, quantity: 1 }], + }, + }); + + // List orders for user + const { status, body } = await apiRequest({ + method: 'GET', + path: '/api/orders', + params: { userId: testUser.id }, + }); + + expect(status).toBe(200); + expect(body.orders.length).toBeGreaterThanOrEqual(1); + expect(body.orders.every((o: any) => o.userId === testUser.id)).toBe(true); + }); +}); +``` + +**Key Points**: + +- `beforeAll`/`afterAll` for test data setup/cleanup +- API-based seeding (no direct DB access needed) +- Unique emails to prevent conflicts in parallel runs +- Cleanup after all tests complete + +### Example 6: Background Job Testing with Recurse + +**Context**: Test async operations like background jobs, webhooks, and eventual consistency. + +**Implementation**: + +```typescript +// tests/api/background-jobs.spec.ts +import { test, expect } from '@seontechnologies/playwright-utils/fixtures'; + +test.describe('Background Jobs', () => { + test('should process export job', async ({ apiRequest, recurse }) => { + // Trigger export job + const { body: job } = await apiRequest({ + method: 'POST', + path: '/api/exports', + body: { + type: 'users', + format: 'csv', + filters: { createdAfter: '2024-01-01' }, + }, + }); + + expect(job.id).toBeDefined(); + expect(job.status).toBe('pending'); + + // Poll until job completes + const { body: completedJob } = await recurse( + () => apiRequest({ method: 'GET', path: `/api/exports/${job.id}` }), + (response) => response.body.status === 'completed', + { + timeout: 60000, + interval: 2000, + log: `Waiting for export job ${job.id} to complete`, + } + ); + + expect(completedJob.status).toBe('completed'); + expect(completedJob.downloadUrl).toBeDefined(); + expect(completedJob.recordCount).toBeGreaterThan(0); + }); + + test('should handle job failure gracefully', async ({ apiRequest, recurse }) => { + // Trigger job that will fail + const { body: job } = await apiRequest({ + method: 'POST', + path: '/api/exports', + body: { + type: 'invalid-type', // This will cause failure + format: 'csv', + }, + }); + + // Poll until job fails + const { body: failedJob } = await recurse( + () => apiRequest({ method: 'GET', path: `/api/exports/${job.id}` }), + (response) => ['completed', 'failed'].includes(response.body.status), + { timeout: 30000 } + ); + + expect(failedJob.status).toBe('failed'); + expect(failedJob.error).toBeDefined(); + expect(failedJob.error.code).toBe('INVALID_EXPORT_TYPE'); + }); + + test('should process webhook delivery', async ({ apiRequest, recurse }) => { + // Trigger action that sends webhook + const { body: order } = await apiRequest({ + method: 'POST', + path: '/api/orders', + body: { + userId: 'user-123', + items: [{ productId: 'prod-1', quantity: 1 }], + webhookUrl: 'https://webhook.site/test-endpoint', + }, + }); + + // Poll for webhook delivery status + const { body: webhookStatus } = await recurse( + () => apiRequest({ method: 'GET', path: `/api/webhooks/order/${order.id}` }), + (response) => response.body.delivered === true, + { timeout: 30000, interval: 1000 } + ); + + expect(webhookStatus.delivered).toBe(true); + expect(webhookStatus.deliveredAt).toBeDefined(); + expect(webhookStatus.responseStatus).toBe(200); + }); +}); +``` + +**Key Points**: + +- `recurse` for polling async operations +- Test both success and failure scenarios +- Configurable timeout and interval +- Log messages for debugging + +### Example 7: Service Authentication (No Browser) + +**Context**: Test authenticated API endpoints using tokens directly - no browser login needed. + +**Implementation**: + +```typescript +// tests/api/authenticated.spec.ts +import { test, expect } from '@seontechnologies/playwright-utils/fixtures'; + +test.describe('Authenticated API Tests', () => { + let authToken: string; + + test.beforeAll(async ({ request }) => { + // Get token via API (no browser!) + const response = await request.post('/api/auth/login', { + data: { + email: process.env.TEST_USER_EMAIL, + password: process.env.TEST_USER_PASSWORD, + }, + }); + + const { token } = await response.json(); + authToken = token; + }); + + test('should access protected endpoint with token', async ({ apiRequest }) => { + const { status, body } = await apiRequest({ + method: 'GET', + path: '/api/me', + headers: { + Authorization: `Bearer ${authToken}`, + }, + }); + + expect(status).toBe(200); + expect(body.email).toBe(process.env.TEST_USER_EMAIL); + }); + + test('should reject request without token', async ({ apiRequest }) => { + const { status, body } = await apiRequest({ + method: 'GET', + path: '/api/me', + // No Authorization header + }); + + expect(status).toBe(401); + expect(body.code).toBe('UNAUTHORIZED'); + }); + + test('should reject expired token', async ({ apiRequest }) => { + const expiredToken = 'eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...'; // Expired token + + const { status, body } = await apiRequest({ + method: 'GET', + path: '/api/me', + headers: { + Authorization: `Bearer ${expiredToken}`, + }, + }); + + expect(status).toBe(401); + expect(body.code).toBe('TOKEN_EXPIRED'); + }); + + test('should handle role-based access', async ({ apiRequest }) => { + // User token (non-admin) + const { status } = await apiRequest({ + method: 'GET', + path: '/api/admin/users', + headers: { + Authorization: `Bearer ${authToken}`, + }, + }); + + expect(status).toBe(403); // Forbidden for non-admin + }); +}); +``` + +**Key Points**: + +- Token obtained via API login (no browser) +- Token reused across all tests in describe block +- Test auth, expired tokens, and RBAC +- Pure API testing without UI + +## API Test Configuration + +### Playwright Config for API-Only Tests + +```typescript +// playwright.config.ts +import { defineConfig } from '@playwright/test'; + +export default defineConfig({ + testDir: './tests/api', + + // No browser needed for API tests + use: { + baseURL: process.env.API_URL || 'http://localhost:3000', + extraHTTPHeaders: { + 'Accept': 'application/json', + 'Content-Type': 'application/json', + }, + }, + + // Faster without browser overhead + timeout: 30000, + + // Run API tests in parallel + workers: 4, + fullyParallel: true, + + // No screenshots/traces needed for API tests + reporter: [['html'], ['json', { outputFile: 'api-test-results.json' }]], +}); +``` + +### Separate API Test Project + +```typescript +// playwright.config.ts +export default defineConfig({ + projects: [ + { + name: 'api', + testDir: './tests/api', + use: { + baseURL: process.env.API_URL, + }, + }, + { + name: 'e2e', + testDir: './tests/e2e', + use: { + baseURL: process.env.APP_URL, + ...devices['Desktop Chrome'], + }, + }, + ], +}); +``` + +## Comparison: API Tests vs E2E Tests + +| Aspect | API Test | E2E Test | +|--------|----------|----------| +| **Speed** | ~50-100ms per test | ~2-10s per test | +| **Stability** | Very stable | More flaky (UI timing) | +| **Setup** | Minimal | Browser, context, page | +| **Debugging** | Clear request/response | DOM, screenshots, traces | +| **Coverage** | Service logic | User experience | +| **Parallelization** | Easy (stateless) | Complex (browser resources) | +| **CI Cost** | Low (no browser) | High (browser containers) | + +## Related Fragments + +- `api-request.md` - apiRequest utility details +- `recurse.md` - Polling patterns for async operations +- `auth-session.md` - Token management +- `contract-testing.md` - Pact contract testing +- `test-levels-framework.md` - When to use which test level +- `data-factories.md` - Test data setup patterns + +## Anti-Patterns + +**DON'T use E2E for API validation:** + +```typescript +// Bad: Testing API through UI +test('validate user creation', async ({ page }) => { + await page.goto('/admin/users'); + await page.fill('#name', 'John'); + await page.click('#submit'); + await expect(page.getByText('User created')).toBeVisible(); +}); +``` + +**DO test APIs directly:** + +```typescript +// Good: Direct API test +test('validate user creation', async ({ apiRequest }) => { + const { status, body } = await apiRequest({ + method: 'POST', + path: '/api/users', + body: { name: 'John' }, + }); + expect(status).toBe(201); + expect(body.id).toBeDefined(); +}); +``` + +**DON'T ignore API tests because "E2E covers it":** + +```typescript +// Bad thinking: "Our E2E tests create users, so API is tested" +// Reality: E2E tests one happy path; API tests cover edge cases +``` + +**DO have dedicated API test coverage:** + +```typescript +// Good: Explicit API test suite +test.describe('Users API', () => { + test('creates user', async ({ apiRequest }) => { /* ... */ }); + test('handles duplicate email', async ({ apiRequest }) => { /* ... */ }); + test('validates required fields', async ({ apiRequest }) => { /* ... */ }); + test('handles malformed JSON', async ({ apiRequest }) => { /* ... */ }); + test('rate limits requests', async ({ apiRequest }) => { /* ... */ }); +}); +``` diff --git a/src/modules/bmm/testarch/knowledge/auth-session.md b/src/modules/bmm/testarch/knowledge/auth-session.md index 3aa456af..e290476b 100644 --- a/src/modules/bmm/testarch/knowledge/auth-session.md +++ b/src/modules/bmm/testarch/knowledge/auth-session.md @@ -2,7 +2,7 @@ ## Principle -Persist authentication tokens to disk and reuse across test runs. Support multiple user identifiers, ephemeral authentication, and worker-specific accounts for parallel execution. Fetch tokens once, use everywhere. +Persist authentication tokens to disk and reuse across test runs. Support multiple user identifiers, ephemeral authentication, and worker-specific accounts for parallel execution. Fetch tokens once, use everywhere. **Works for both API-only tests and browser tests.** ## Rationale @@ -22,6 +22,7 @@ The `auth-session` utility provides: - **Worker-specific accounts**: Parallel execution with isolated user accounts - **Automatic token management**: Checks validity, renews if expired - **Flexible provider pattern**: Adapt to any auth system (OAuth2, JWT, custom) +- **API-first design**: Get tokens for API tests without browser overhead ## Pattern Examples @@ -244,6 +245,200 @@ test('parallel test 2', async ({ page }) => { - Token management automatic per worker - Scales to any number of workers +### Example 6: Pure API Authentication (No Browser) + +**Context**: Get auth tokens for API-only tests using auth-session disk persistence. + +**Implementation**: + +```typescript +// Step 1: Create API-only auth provider (no browser needed) +// playwright/support/api-auth-provider.ts +import { type AuthProvider } from '@seontechnologies/playwright-utils/auth-session'; + +const apiAuthProvider: AuthProvider = { + getEnvironment: (options) => options.environment || 'local', + getUserIdentifier: (options) => options.userIdentifier || 'api-user', + + extractToken: (storageState) => { + // Token stored in localStorage format for disk persistence + const tokenEntry = storageState.origins?.[0]?.localStorage?.find( + (item) => item.name === 'auth_token' + ); + return tokenEntry?.value; + }, + + isTokenExpired: (storageState) => { + const expiryEntry = storageState.origins?.[0]?.localStorage?.find( + (item) => item.name === 'token_expiry' + ); + if (!expiryEntry) return true; + return Date.now() > parseInt(expiryEntry.value, 10); + }, + + manageAuthToken: async (request, options) => { + const email = process.env.TEST_USER_EMAIL; + const password = process.env.TEST_USER_PASSWORD; + + if (!email || !password) { + throw new Error('TEST_USER_EMAIL and TEST_USER_PASSWORD must be set'); + } + + // Pure API login - no browser! + const response = await request.post('/api/auth/login', { + data: { email, password }, + }); + + if (!response.ok()) { + throw new Error(`Auth failed: ${response.status()}`); + } + + const { token, expiresIn } = await response.json(); + const expiryTime = Date.now() + expiresIn * 1000; + + // Return storage state format for disk persistence + return { + cookies: [], + origins: [ + { + origin: process.env.API_BASE_URL || 'http://localhost:3000', + localStorage: [ + { name: 'auth_token', value: token }, + { name: 'token_expiry', value: String(expiryTime) }, + ], + }, + ], + }; + }, +}; + +export default apiAuthProvider; + +// Step 2: Create auth fixture +// playwright/support/fixtures.ts +import { test as base } from '@playwright/test'; +import { createAuthFixtures, setAuthProvider } from '@seontechnologies/playwright-utils/auth-session'; +import apiAuthProvider from './api-auth-provider'; + +setAuthProvider(apiAuthProvider); + +export const test = base.extend(createAuthFixtures()); + +// Step 3: Use in tests - token persisted to disk! +// tests/api/authenticated-api.spec.ts +import { test } from '../support/fixtures'; +import { expect } from '@playwright/test'; + +test('should access protected endpoint', async ({ authToken, apiRequest }) => { + // authToken is automatically loaded from disk or fetched if expired + const { status, body } = await apiRequest({ + method: 'GET', + path: '/api/me', + headers: { Authorization: `Bearer ${authToken}` }, + }); + + expect(status).toBe(200); +}); + +test('should create resource with auth', async ({ authToken, apiRequest }) => { + const { status, body } = await apiRequest({ + method: 'POST', + path: '/api/orders', + headers: { Authorization: `Bearer ${authToken}` }, + body: { items: [{ productId: 'prod-1', quantity: 2 }] }, + }); + + expect(status).toBe(201); + expect(body.id).toBeDefined(); +}); +``` + +**Key Points**: + +- Token persisted to disk (not in-memory) - survives test reruns +- Provider fetches token once, reuses until expired +- Pure API authentication - no browser context needed +- `authToken` fixture handles disk read/write automatically +- Environment variables validated with clear error message + +### Example 7: Service-to-Service Authentication + +**Context**: Test microservice authentication patterns (API keys, service tokens) with proper environment validation. + +**Implementation**: + +```typescript +// tests/api/service-auth.spec.ts +import { test as base, expect } from '@playwright/test'; +import { test as apiFixture } from '@seontechnologies/playwright-utils/api-request/fixtures'; +import { mergeTests } from '@playwright/test'; + +// Validate environment variables at module load +const SERVICE_API_KEY = process.env.SERVICE_API_KEY; +const INTERNAL_SERVICE_URL = process.env.INTERNAL_SERVICE_URL; + +if (!SERVICE_API_KEY) { + throw new Error('SERVICE_API_KEY environment variable is required'); +} +if (!INTERNAL_SERVICE_URL) { + throw new Error('INTERNAL_SERVICE_URL environment variable is required'); +} + +const test = mergeTests(base, apiFixture); + +test.describe('Service-to-Service Auth', () => { + test('should authenticate with API key', async ({ apiRequest }) => { + const { status, body } = await apiRequest({ + method: 'GET', + path: '/internal/health', + baseUrl: INTERNAL_SERVICE_URL, + headers: { 'X-API-Key': SERVICE_API_KEY }, + }); + + expect(status).toBe(200); + expect(body.status).toBe('healthy'); + }); + + test('should reject invalid API key', async ({ apiRequest }) => { + const { status, body } = await apiRequest({ + method: 'GET', + path: '/internal/health', + baseUrl: INTERNAL_SERVICE_URL, + headers: { 'X-API-Key': 'invalid-key' }, + }); + + expect(status).toBe(401); + expect(body.code).toBe('INVALID_API_KEY'); + }); + + test('should call downstream service with propagated auth', async ({ apiRequest }) => { + const { status, body } = await apiRequest({ + method: 'POST', + path: '/internal/aggregate-data', + baseUrl: INTERNAL_SERVICE_URL, + headers: { + 'X-API-Key': SERVICE_API_KEY, + 'X-Request-ID': `test-${Date.now()}`, + }, + body: { sources: ['users', 'orders', 'inventory'] }, + }); + + expect(status).toBe(200); + expect(body.aggregatedFrom).toHaveLength(3); + }); +}); +``` + +**Key Points**: + +- Environment variables validated at module load with clear errors +- API key authentication (simpler than OAuth - no disk persistence needed) +- Test internal/service endpoints +- Validate auth rejection scenarios +- Correlation ID for request tracing + +> **Note**: API keys are typically static secrets that don't expire, so disk persistence (auth-session) isn't needed. For rotating service tokens, use the auth-session provider pattern from Example 6. + ## Custom Auth Provider Pattern **Context**: Adapt auth-session to your authentication system (OAuth2, JWT, SAML, custom). @@ -310,6 +505,7 @@ test('authenticated API call', async ({ apiRequest, authToken }) => { ## Related Fragments +- `api-testing-patterns.md` - Pure API testing patterns (no browser) - `overview.md` - Installation and fixture composition - `api-request.md` - Authenticated API requests - `fixtures-composition.md` - Merging auth with other utilities diff --git a/src/modules/bmm/testarch/knowledge/file-utils.md b/src/modules/bmm/testarch/knowledge/file-utils.md index 1fa02397..014ac81c 100644 --- a/src/modules/bmm/testarch/knowledge/file-utils.md +++ b/src/modules/bmm/testarch/knowledge/file-utils.md @@ -22,6 +22,16 @@ The `file-utils` module provides: - **Validation helpers**: Row count, header checks, content validation - **Format support**: Multiple sheet support (XLSX), text extraction (PDF), archive extraction (ZIP) +## Why Use This Instead of Vanilla Playwright? + +| Vanilla Playwright | File Utils | +| ------------------------------------------- | ------------------------------------------------ | +| ~80 lines per CSV flow (download + parse) | ~10 lines end-to-end | +| Manual event orchestration for downloads | Encapsulated in `handleDownload()` | +| Manual path handling and `saveAs` | Returns a ready-to-use file path | +| Manual existence checks and error handling | Centralized in one place via utility patterns | +| Manual CSV parsing config (headers, typing) | `readCSV()` returns `{ data, headers }` directly | + ## Pattern Examples ### Example 1: UI-Triggered CSV Download @@ -40,20 +50,18 @@ test('should download and validate CSV', async ({ page }) => { const downloadPath = await handleDownload({ page, downloadDir: DOWNLOAD_DIR, - trigger: () => page.click('[data-testid="export-csv"]'), + trigger: () => page.getByTestId('download-button-text/csv').click(), }); - const { content } = await readCSV({ filePath: downloadPath }); + const csvResult = await readCSV({ filePath: downloadPath }); - // Validate headers - expect(content.headers).toEqual(['ID', 'Name', 'Email', 'Role']); - - // Validate data - expect(content.data).toHaveLength(10); - expect(content.data[0]).toMatchObject({ + // Access parsed data and headers + const { data, headers } = csvResult.content; + expect(headers).toEqual(['ID', 'Name', 'Email']); + expect(data[0]).toMatchObject({ ID: expect.any(String), Name: expect.any(String), - Email: expect.stringMatching(/@/), + Email: expect.any(String), }); }); ``` @@ -81,25 +89,27 @@ test('should read multi-sheet XLSX', async () => { trigger: () => page.click('[data-testid="export-xlsx"]'), }); - const { content } = await readXLSX({ filePath: downloadPath }); + const xlsxResult = await readXLSX({ filePath: downloadPath }); - // Access specific sheets - const summarySheet = content.sheets.find((s) => s.name === 'Summary'); - const detailsSheet = content.sheets.find((s) => s.name === 'Details'); + // Verify worksheet structure + expect(xlsxResult.content.worksheets.length).toBeGreaterThan(0); + const worksheet = xlsxResult.content.worksheets[0]; + expect(worksheet).toBeDefined(); + expect(worksheet).toHaveProperty('name'); - // Validate summary - expect(summarySheet.data).toHaveLength(1); - expect(summarySheet.data[0].TotalRecords).toBe('150'); + // Access sheet data + const sheetData = worksheet?.data; + expect(Array.isArray(sheetData)).toBe(true); - // Validate details - expect(detailsSheet.data).toHaveLength(150); - expect(detailsSheet.headers).toContain('TransactionID'); + // Use type assertion for type safety + const firstRow = sheetData![0] as Record; + expect(firstRow).toHaveProperty('id'); }); ``` **Key Points**: -- `sheets` array with `name` and `data` properties +- `worksheets` array with `name` and `data` properties - Access sheets by name - Each sheet has its own headers and data - Type-safe sheet iteration @@ -117,26 +127,48 @@ test('should validate PDF report', async () => { const downloadPath = await handleDownload({ page, downloadDir: DOWNLOAD_DIR, - trigger: () => page.click('[data-testid="download-report"]'), + trigger: () => page.getByTestId('download-button-Text-based PDF Document').click(), }); - const { content } = await readPDF({ filePath: downloadPath }); + const pdfResult = await readPDF({ filePath: downloadPath }); - // content.text is extracted text from all pages - expect(content.text).toContain('Financial Report Q4 2024'); - expect(content.text).toContain('Total Revenue:'); - - // Validate page count - expect(content.numpages).toBeGreaterThan(10); + // content is extracted text from all pages + expect(pdfResult.pagesCount).toBe(1); + expect(pdfResult.fileName).toContain('.pdf'); + expect(pdfResult.content).toContain('All you need is the free Adobe Acrobat Reader'); }); ``` -**Key Points**: +**PDF Reader Options:** -- `content.text` contains all extracted text -- `content.numpages` for page count -- PDF parsing handles multi-page documents -- Search for specific phrases +```typescript +const result = await readPDF({ + filePath: '/path/to/document.pdf', + mergePages: false, // Keep pages separate (default: true) + debug: true, // Enable debug logging + maxPages: 10, // Limit processing to first 10 pages +}); +``` + +**Important Limitation - Vector-based PDFs:** + +Text extraction may fail for PDFs that store text as vector graphics (e.g., those generated by jsPDF): + +```typescript +// Vector-based PDF example (extraction fails gracefully) +const pdfResult = await readPDF({ filePath: downloadPath }); + +expect(pdfResult.pagesCount).toBe(1); +expect(pdfResult.info.extractionNotes).toContain( + 'Text extraction from vector-based PDFs is not supported.' +); +``` + +Such PDFs will have: + +- `textExtractionSuccess: false` +- `isVectorBased: true` +- Explanatory message in `extractionNotes` ### Example 4: ZIP Archive Validation @@ -154,25 +186,33 @@ test('should validate ZIP archive', async () => { trigger: () => page.click('[data-testid="download-backup"]'), }); - const { content } = await readZIP({ filePath: downloadPath }); + const zipResult = await readZIP({ filePath: downloadPath }); // Check file list - expect(content.files).toContain('data.csv'); - expect(content.files).toContain('config.json'); - expect(content.files).toContain('readme.txt'); + expect(Array.isArray(zipResult.content.entries)).toBe(true); + expect(zipResult.content.entries).toContain( + 'Case_53125_10-19-22_AM/Case_53125_10-19-22_AM_case_data.csv' + ); - // Read specific file from archive - const configContent = content.zip.readAsText('config.json'); - const config = JSON.parse(configContent); + // Extract specific file + const targetFile = 'Case_53125_10-19-22_AM/Case_53125_10-19-22_AM_case_data.csv'; + const zipWithExtraction = await readZIP({ + filePath: downloadPath, + fileToExtract: targetFile, + }); - expect(config.version).toBe('2.0'); + // Access extracted file buffer + const extractedFiles = zipWithExtraction.content.extractedFiles || {}; + const fileBuffer = extractedFiles[targetFile]; + expect(fileBuffer).toBeInstanceOf(Buffer); + expect(fileBuffer?.length).toBeGreaterThan(0); }); ``` **Key Points**: -- `content.files` lists all files in archive -- `content.zip.readAsText()` extracts specific files +- `content.entries` lists all files in archive +- `fileToExtract` extracts specific files to Buffer - Validate archive structure - Read and parse individual files from ZIP @@ -185,7 +225,7 @@ test('should validate ZIP archive', async () => { ```typescript test('should download via API', async ({ page, request }) => { const downloadPath = await handleDownload({ - page, + page, // Still need page for download events downloadDir: DOWNLOAD_DIR, trigger: async () => { const response = await request.get('/api/export/csv', { @@ -211,20 +251,123 @@ test('should download via API', async ({ page, request }) => { - Still need `page` for download events - Works with authenticated endpoints -## Validation Helpers +### Example 6: Reading CSV from Buffer (ZIP extraction) + +**Context**: Read CSV content directly from a Buffer (e.g., extracted from ZIP). + +**Implementation**: ```typescript -// CSV validation -const { isValid, errors } = await validateCSV({ - filePath: downloadPath, - expectedRowCount: 10, - requiredHeaders: ['ID', 'Name', 'Email'], +// Read from a Buffer (e.g., extracted from a ZIP) +const zipResult = await readZIP({ + filePath: 'archive.zip', + fileToExtract: 'data.csv', }); +const fileBuffer = zipResult.content.extractedFiles?.['data.csv']; +const csvFromBuffer = await readCSV({ content: fileBuffer }); -expect(isValid).toBe(true); -expect(errors).toHaveLength(0); +// Read from a string +const csvString = 'name,age\nJohn,30\nJane,25'; +const csvFromString = await readCSV({ content: csvString }); + +const { data, headers } = csvFromString.content; +expect(headers).toContain('name'); +expect(headers).toContain('age'); ``` +## API Reference + +### CSV Reader Options + +| Option | Type | Default | Description | +| -------------- | ------------------ | -------- | -------------------------------------- | +| `filePath` | `string` | - | Path to CSV file (mutually exclusive) | +| `content` | `string \| Buffer` | - | Direct content (mutually exclusive) | +| `delimiter` | `string \| 'auto'` | `','` | Value separator, auto-detect if 'auto' | +| `encoding` | `string` | `'utf8'` | File encoding | +| `parseHeaders` | `boolean` | `true` | Use first row as headers | +| `trim` | `boolean` | `true` | Trim whitespace from values | + +### XLSX Reader Options + +| Option | Type | Description | +| ----------- | -------- | ------------------------------ | +| `filePath` | `string` | Path to XLSX file | +| `sheetName` | `string` | Name of sheet to set as active | + +### PDF Reader Options + +| Option | Type | Default | Description | +| ------------ | --------- | ------- | --------------------------- | +| `filePath` | `string` | - | Path to PDF file (required) | +| `mergePages` | `boolean` | `true` | Merge text from all pages | +| `maxPages` | `number` | - | Maximum pages to extract | +| `debug` | `boolean` | `false` | Enable debug logging | + +### ZIP Reader Options + +| Option | Type | Description | +| --------------- | -------- | ---------------------------------- | +| `filePath` | `string` | Path to ZIP file | +| `fileToExtract` | `string` | Specific file to extract to Buffer | + +### Return Values + +#### CSV Reader Return Value + +```typescript +{ + content: { + data: Array>, // Parsed rows (excludes header row if parseHeaders: true) + headers: string[] | null // Column headers (null if parseHeaders: false) + } +} +``` + +#### XLSX Reader Return Value + +```typescript +{ + content: { + worksheets: Array<{ + name: string, // Sheet name + rows: Array>, // All rows including headers + headers?: string[] // First row as headers (if present) + }> + } +} +``` + +#### PDF Reader Return Value + +```typescript +{ + content: string, // Extracted text (merged or per-page based on mergePages) + pagesCount: number, // Total pages in PDF + fileName?: string, // Original filename if available + info?: Record // PDF metadata (author, title, etc.) +} +``` + +> **Note**: When `mergePages: false`, `content` is an array of strings (one per page). When `maxPages` is set, only that many pages are extracted. + +#### ZIP Reader Return Value + +```typescript +{ + content: { + entries: Array<{ + name: string, // File/directory path within ZIP + size: number, // Uncompressed size in bytes + isDirectory: boolean // True for directories + }>, + extractedFiles: Record // Extracted file contents by path + } +} +``` + +> **Note**: When `fileToExtract` is specified, only that file appears in `extractedFiles`. + ## Download Cleanup Pattern ```typescript @@ -234,6 +377,66 @@ test.afterEach(async () => { }); ``` +## Comparison with Vanilla Playwright + +Vanilla Playwright (real test) snippet: + +```typescript +// ~80 lines of boilerplate! +const [download] = await Promise.all([ + page.waitForEvent('download'), + page.getByTestId('download-button-CSV Export').click(), +]); + +const failure = await download.failure(); +expect(failure).toBeNull(); + +const filePath = testInfo.outputPath(download.suggestedFilename()); +await download.saveAs(filePath); + +await expect + .poll( + async () => { + try { + await fs.access(filePath); + return true; + } catch { + return false; + } + }, + { timeout: 5000, intervals: [100, 200, 500] } + ) + .toBe(true); + +const csvContent = await fs.readFile(filePath, 'utf-8'); + +const parseResult = parse(csvContent, { + header: true, + skipEmptyLines: true, + dynamicTyping: true, + transformHeader: (header: string) => header.trim(), +}); + +if (parseResult.errors.length > 0) { + throw new Error(`CSV parsing errors: ${JSON.stringify(parseResult.errors)}`); +} + +const data = parseResult.data as Array>; +const headers = parseResult.meta.fields || []; +``` + +With File Utils, the same flow becomes: + +```typescript +const downloadPath = await handleDownload({ + page, + downloadDir: DOWNLOAD_DIR, + trigger: () => page.getByTestId('download-button-text/csv').click(), +}); + +const { data, headers } = (await readCSV({ filePath: downloadPath })).content; +``` + ## Related Fragments - `overview.md` - Installation and imports @@ -242,7 +445,7 @@ test.afterEach(async () => { ## Anti-Patterns -**❌ Not cleaning up downloads:** +**DON'T leave downloads in place:** ```typescript test('creates file', async () => { @@ -251,7 +454,7 @@ test('creates file', async () => { }) ``` -**✅ Clean up after tests:** +**DO clean up after tests:** ```typescript test.afterEach(async () => { diff --git a/src/modules/bmm/testarch/knowledge/intercept-network-call.md b/src/modules/bmm/testarch/knowledge/intercept-network-call.md index a175d559..e47419da 100644 --- a/src/modules/bmm/testarch/knowledge/intercept-network-call.md +++ b/src/modules/bmm/testarch/knowledge/intercept-network-call.md @@ -183,7 +183,31 @@ test('should handle timeout', async ({ page, interceptNetworkCall }) => { - Validate error UI states - No real failures needed -### Example 5: Multiple Intercepts (Order Matters!) +### Example 5: Order Matters - Intercept Before Navigate + +**Context**: The interceptor must be set up before the network request occurs. + +**Implementation**: + +```typescript +// INCORRECT - interceptor set up too late +await page.goto('https://example.com'); // Request already happened +const networkCall = interceptNetworkCall({ url: '**/api/data' }); +await networkCall; // Will hang indefinitely! + +// CORRECT - Set up interception first +const networkCall = interceptNetworkCall({ url: '**/api/data' }); +await page.goto('https://example.com'); +const result = await networkCall; +``` + +This pattern follows the classic test spy/stub pattern: + +1. Define the spy/stub (set up interception) +2. Perform the action (trigger the network request) +3. Assert on the spy/stub (await and verify the response) + +### Example 6: Multiple Intercepts **Context**: Intercepting different endpoints in same test - setup order is critical. @@ -191,7 +215,7 @@ test('should handle timeout', async ({ page, interceptNetworkCall }) => { ```typescript test('multiple intercepts', async ({ page, interceptNetworkCall }) => { - // ✅ CORRECT: Setup all intercepts BEFORE navigation + // Setup all intercepts BEFORE navigation const usersCall = interceptNetworkCall({ url: '**/api/users' }); const productsCall = interceptNetworkCall({ url: '**/api/products' }); const ordersCall = interceptNetworkCall({ url: '**/api/orders' }); @@ -211,11 +235,85 @@ test('multiple intercepts', async ({ page, interceptNetworkCall }) => { - Setup all intercepts before triggering actions - Use `Promise.all()` to wait for multiple calls -- Order: intercept → navigate → await +- Order: intercept -> navigate -> await - Prevents race conditions +### Example 7: Capturing Multiple Requests to the Same Endpoint + +**Context**: Each `interceptNetworkCall` captures only the first matching request. + +**Implementation**: + +```typescript +// Capturing a known number of requests +const firstRequest = interceptNetworkCall({ url: '/api/data' }); +const secondRequest = interceptNetworkCall({ url: '/api/data' }); + +await page.click('#load-data-button'); + +const firstResponse = await firstRequest; +const secondResponse = await secondRequest; + +expect(firstResponse.status).toBe(200); +expect(secondResponse.status).toBe(200); + +// Handling an unknown number of requests +const getDataRequestInterceptor = () => + interceptNetworkCall({ + url: '/api/data', + timeout: 1000, // Short timeout to detect when no more requests are coming + }); + +let currentInterceptor = getDataRequestInterceptor(); +const allResponses = []; + +await page.click('#load-multiple-data-button'); + +while (true) { + try { + const response = await currentInterceptor; + allResponses.push(response); + currentInterceptor = getDataRequestInterceptor(); + } catch (error) { + // No more requests (timeout) + break; + } +} + +console.log(`Captured ${allResponses.length} requests to /api/data`); +``` + +### Example 8: Using Timeout + +**Context**: Set a timeout for waiting on a network request. + +**Implementation**: + +```typescript +const dataCall = interceptNetworkCall({ + method: 'GET', + url: '/api/data-that-might-be-slow', + timeout: 5000, // 5 seconds timeout +}); + +await page.goto('/data-page'); + +try { + const { responseJson } = await dataCall; + console.log('Data loaded successfully:', responseJson); +} catch (error) { + if (error.message.includes('timeout')) { + console.log('Request timed out as expected'); + } else { + throw error; + } +} +``` + ## URL Pattern Matching +The utility uses [picomatch](https://github.com/micromatch/picomatch) for powerful glob pattern matching, dramatically simplifying URL targeting: + **Supported glob patterns:** ```typescript @@ -226,7 +324,59 @@ test('multiple intercepts', async ({ page, interceptNetworkCall }) => { '**/api/users?id=*'; // With query params ``` -**Uses picomatch library** - same pattern syntax as Playwright's `page.route()` but cleaner API. +**Comparison with vanilla Playwright:** + +```typescript +// Vanilla Playwright - complex predicate +const predicate = (response) => { + const url = response.url(); + return ( + url.endsWith('/api/users') || + url.match(/\/api\/users\/\d+/) || + (url.includes('/api/users/') && url.includes('/profile')) + ); +}; +page.waitForResponse(predicate); + +// With interceptNetworkCall - simple glob patterns +interceptNetworkCall({ url: '/api/users' }); // Exact endpoint +interceptNetworkCall({ url: '/api/users/*' }); // User by ID pattern +interceptNetworkCall({ url: '/api/users/*/profile' }); // Specific sub-paths +interceptNetworkCall({ url: '/api/users/**' }); // Match all +``` + +## API Reference + +### `interceptNetworkCall(options)` + +| Parameter | Type | Description | +| ----------------- | ---------- | --------------------------------------------------------------------- | +| `page` | `Page` | Required when using direct import (not needed with fixture) | +| `method` | `string` | Optional: HTTP method to match (e.g., 'GET', 'POST') | +| `url` | `string` | Optional: URL pattern to match (supports glob patterns via picomatch) | +| `fulfillResponse` | `object` | Optional: Response to use when mocking | +| `handler` | `function` | Optional: Custom handler function for the route | +| `timeout` | `number` | Optional: Timeout in milliseconds for the network request | + +### `fulfillResponse` Object + +| Property | Type | Description | +| --------- | ------------------------ | ----------------------------------------------------- | +| `status` | `number` | HTTP status code (default: 200) | +| `headers` | `Record` | Response headers | +| `body` | `any` | Response body (will be JSON.stringified if an object) | + +### Return Value + +Returns a `Promise` with: + +| Property | Type | Description | +| -------------- | ---------- | --------------------------------------- | +| `request` | `Request` | The intercepted request | +| `response` | `Response` | The response (null if mocked) | +| `responseJson` | `any` | Parsed JSON response (if available) | +| `status` | `number` | HTTP status code | +| `requestJson` | `any` | Parsed JSON request body (if available) | ## Comparison with Vanilla Playwright @@ -238,7 +388,7 @@ test('multiple intercepts', async ({ page, interceptNetworkCall }) => { | `const status = resp.status()` | `const { status } = await call` | | Complex filter predicates | Simple glob patterns | -**Reduction:** ~5-7 lines → ~2-3 lines per interception +**Reduction:** ~5-7 lines -> ~2-3 lines per interception ## Related Fragments @@ -248,14 +398,14 @@ test('multiple intercepts', async ({ page, interceptNetworkCall }) => { ## Anti-Patterns -**❌ Intercepting after navigation:** +**DON'T intercept after navigation:** ```typescript await page.goto('/dashboard'); // Navigation starts const usersCall = interceptNetworkCall({ url: '**/api/users' }); // Too late! ``` -**✅ Intercept before navigate:** +**DO intercept before navigate:** ```typescript const usersCall = interceptNetworkCall({ url: '**/api/users' }); // First @@ -263,7 +413,7 @@ await page.goto('/dashboard'); // Then navigate const { responseJson } = await usersCall; // Then await ``` -**❌ Ignoring the returned Promise:** +**DON'T ignore the returned Promise:** ```typescript interceptNetworkCall({ url: '**/api/users' }); // Not awaited! @@ -271,7 +421,7 @@ await page.goto('/dashboard'); // No deterministic wait - race condition ``` -**✅ Always await the intercept:** +**DO always await the intercept:** ```typescript const usersCall = interceptNetworkCall({ url: '**/api/users' }); diff --git a/src/modules/bmm/testarch/knowledge/log.md b/src/modules/bmm/testarch/knowledge/log.md index 42ddc228..c222a0c6 100644 --- a/src/modules/bmm/testarch/knowledge/log.md +++ b/src/modules/bmm/testarch/knowledge/log.md @@ -21,6 +21,20 @@ The `log` utility provides: - **Multiple levels**: info, step, success, warning, error, debug - **Optional console**: Can disable console output but keep report logs +## Quick Start + +```typescript +import { log } from '@seontechnologies/playwright-utils'; + +// Basic logging +await log.info('Starting test'); +await log.step('Test step shown in Playwright UI'); +await log.success('Operation completed'); +await log.warning('Something to note'); +await log.error('Something went wrong'); +await log.debug('Debug information'); +``` + ## Pattern Examples ### Example 1: Basic Logging Levels @@ -143,41 +157,105 @@ test('organized with steps', async ({ page, apiRequest }) => { - Steps visible in Playwright trace viewer - Better debugging when tests fail -### Example 4: Conditional Logging +### Example 4: Test Step Decorators -**Context**: Log different messages based on environment or test conditions. +**Context**: Create collapsible test steps in Playwright UI using decorators. + +**Page Object Methods with @methodTestStep:** + +```typescript +import { methodTestStep } from '@seontechnologies/playwright-utils'; + +class TodoPage { + constructor(private page: Page) { + this.name = 'TodoPage'; + } + + readonly name: string; + + @methodTestStep('Add todo item') + async addTodo(text: string) { + await log.info(`Adding todo: ${text}`); + const newTodo = this.page.getByPlaceholder('What needs to be done?'); + await newTodo.fill(text); + await newTodo.press('Enter'); + await log.step('step within a decorator'); + await log.success(`Added todo: ${text}`); + } + + @methodTestStep('Get all todos') + async getTodos() { + await log.info('Getting all todos'); + return this.page.getByTestId('todo-title'); + } +} +``` + +**Function Helpers with functionTestStep:** + +```typescript +import { functionTestStep } from '@seontechnologies/playwright-utils'; + +// Define todo items for the test +const TODO_ITEMS = ['buy groceries', 'pay bills', 'schedule meeting']; + +const createDefaultTodos = functionTestStep('Create default todos', async (page: Page) => { + await log.info('Creating default todos'); + await log.step('step within a functionWrapper'); + const todoPage = new TodoPage(page); + + for (const item of TODO_ITEMS) { + await todoPage.addTodo(item); + } + + await log.success('Created all default todos'); +}); + +const checkNumberOfTodosInLocalStorage = functionTestStep( + 'Check total todos count fn-step', + async (page: Page, expected: number) => { + await log.info(`Verifying todo count: ${expected}`); + const result = await page.waitForFunction( + (e) => JSON.parse(localStorage['react-todos']).length === e, + expected + ); + await log.success(`Verified todo count: ${expected}`); + return result; + } +); +``` + +### Example 5: File Logging + +**Context**: Enable file logging for persistent logs. **Implementation**: ```typescript -test('conditional logging', async ({ page }) => { - const isCI = process.env.CI === 'true'; +// playwright/support/fixtures.ts +import { test as base } from '@playwright/test'; +import { log, captureTestContext } from '@seontechnologies/playwright-utils'; - if (isCI) { - await log.info('Running in CI environment'); - } else { - await log.debug('Running locally'); - } +// Configure file logging globally +log.configure({ + fileLogging: { + enabled: true, + outputDir: 'playwright-logs/organized-logs', + forceConsolidated: false, // One file per test + }, +}); - const isKafkaWorking = await checkKafkaHealth(); - - if (!isKafkaWorking) { - await log.warning('Kafka unavailable - skipping event checks'); - } else { - await log.step('Verifying Kafka events'); - // ... event verification - } +// Extend base test with file logging context capture +export const test = base.extend({ + // Auto-capture test context for file logging + autoTestContext: [async ({}, use, testInfo) => { + captureTestContext(testInfo); + await use(undefined); + }, { auto: true }], }); ``` -**Key Points**: - -- Log based on environment -- Skip logging with conditionals -- Use appropriate log levels -- Debug info for local, minimal for CI - -### Example 5: Integration with Auth and API +### Example 6: Integration with Auth and API **Context**: Log authenticated API requests with tokens (safely). @@ -221,16 +299,73 @@ test('should log auth flow', async ({ authToken, apiRequest }) => { - Combine with auth and API utilities - Log at appropriate detail level +## Configuration + +**Defaults:** console logging enabled, file logging disabled. + +```typescript +// Enable file logging in config +log.configure({ + console: true, // default + fileLogging: { + enabled: true, + outputDir: 'playwright-logs', + forceConsolidated: false, // One file per test + }, +}); + +// Per-test override +await log.info('Message', { + console: { enabled: false }, + fileLogging: { enabled: true }, +}); +``` + +### Environment Variables + +```bash +# Disable all logging +SILENT=true + +# Disable only file logging +DISABLE_FILE_LOGS=true + +# Disable only console logging +DISABLE_CONSOLE_LOGS=true +``` + +### Level Filtering + +```typescript +log.configure({ + level: 'warning', // Only warning, error levels will show +}); + +// Available levels (in priority order): +// debug < info < step < success < warning < error +``` + +### Sync Methods + +For non-test contexts (global setup, utility functions): + +```typescript +// Use sync methods when async/await isn't available +log.infoSync('Initializing configuration'); +log.successSync('Environment configured'); +log.errorSync('Setup failed'); +``` + ## Log Levels Guide -| Level | When to Use | Shows in Report | Shows in Console | -| --------- | ----------------------------------- | -------------------- | ---------------- | -| `step` | Test organization, major actions | ✅ Collapsible steps | ✅ Yes | -| `info` | General information, state changes | ✅ Yes | ✅ Yes | -| `success` | Successful operations | ✅ Yes | ✅ Yes | -| `warning` | Non-critical issues, skipped checks | ✅ Yes | ✅ Yes | -| `error` | Failures, exceptions | ✅ Yes | ✅ Configurable | -| `debug` | Detailed data, objects | ✅ Yes (attached) | ✅ Configurable | +| Level | When to Use | Shows in Report | Shows in Console | +| --------- | ----------------------------------- | ----------------- | ---------------- | +| `step` | Test organization, major actions | Collapsible steps | Yes | +| `info` | General information, state changes | Yes | Yes | +| `success` | Successful operations | Yes | Yes | +| `warning` | Non-critical issues, skipped checks | Yes | Yes | +| `error` | Failures, exceptions | Yes | Configurable | +| `debug` | Detailed data, objects | Yes (attached) | Configurable | ## Comparison with console.log @@ -251,34 +386,34 @@ test('should log auth flow', async ({ authToken, apiRequest }) => { ## Anti-Patterns -**❌ Logging objects in steps:** +**DON'T log objects in steps:** ```typescript await log.step({ user: 'test', action: 'create' }); // Shows empty in UI ``` -**✅ Use strings for steps, objects for debug:** +**DO use strings for steps, objects for debug:** ```typescript await log.step('Creating user: test'); // Readable in UI await log.debug({ user: 'test', action: 'create' }); // Detailed data ``` -**❌ Logging sensitive data:** +**DON'T log sensitive data:** ```typescript await log.info(`Password: ${password}`); // Security risk! await log.info(`Token: ${authToken}`); // Full token exposed! ``` -**✅ Use previews or omit sensitive data:** +**DO use previews or omit sensitive data:** ```typescript await log.info('User authenticated successfully'); // No sensitive data await log.debug({ tokenPreview: token.slice(0, 6) + '...' }); ``` -**❌ Excessive logging in loops:** +**DON'T log excessively in loops:** ```typescript for (const item of items) { @@ -286,7 +421,7 @@ for (const item of items) { } ``` -**✅ Log summary or use debug level:** +**DO log summary or use debug level:** ```typescript await log.step(`Processing ${items.length} items`); diff --git a/src/modules/bmm/testarch/knowledge/network-error-monitor.md b/src/modules/bmm/testarch/knowledge/network-error-monitor.md index 0a2321bd..a5ee9069 100644 --- a/src/modules/bmm/testarch/knowledge/network-error-monitor.md +++ b/src/modules/bmm/testarch/knowledge/network-error-monitor.md @@ -21,6 +21,19 @@ The `network-error-monitor` provides: - **Smart opt-out**: Disable for validation tests expecting errors - **Deduplication**: Group repeated errors by pattern - **Domino effect prevention**: Limit test failures per error pattern +- **Respects test status**: Won't suppress actual test failures + +## Quick Start + +```typescript +import { test } from '@seontechnologies/playwright-utils/network-error-monitor/fixtures'; + +// That's it! Network monitoring is automatically enabled +test('my test', async ({ page }) => { + await page.goto('/dashboard'); + // If any HTTP 4xx/5xx errors occur, the test will fail +}); +``` ## Pattern Examples @@ -38,8 +51,8 @@ test('should load dashboard', async ({ page }) => { await page.goto('/dashboard'); await expect(page.locator('h1')).toContainText('Dashboard'); - // ✅ Passes if no HTTP errors - // ❌ Fails if any 4xx/5xx errors detected with clear message: + // Passes if no HTTP errors + // Fails if any 4xx/5xx errors detected with clear message: // "Network errors detected: 2 request(s) failed" // Failed requests: // GET 500 https://api.example.com/users @@ -64,13 +77,17 @@ test('should load dashboard', async ({ page }) => { import { test } from '@seontechnologies/playwright-utils/network-error-monitor/fixtures'; // Opt-out with annotation -test('should show error on invalid input', { annotation: [{ type: 'skipNetworkMonitoring' }] }, async ({ page }) => { - await page.goto('/form'); - await page.click('#submit'); // Triggers 400 error +test( + 'should show error on invalid input', + { annotation: [{ type: 'skipNetworkMonitoring' }] }, + async ({ page }) => { + await page.goto('/form'); + await page.click('#submit'); // Triggers 400 error - // Monitoring disabled - test won't fail on 400 - await expect(page.getByText('Invalid input')).toBeVisible(); -}); + // Monitoring disabled - test won't fail on 400 + await expect(page.getByText('Invalid input')).toBeVisible(); + } +); // Or opt-out entire describe block test.describe('error handling', { annotation: [{ type: 'skipNetworkMonitoring' }] }, () => { @@ -91,7 +108,139 @@ test.describe('error handling', { annotation: [{ type: 'skipNetworkMonitoring' } - Monitoring still active for other tests - Perfect for intentional error scenarios -### Example 3: Integration with Merged Fixtures +### Example 3: Respects Test Status + +**Context**: The monitor respects final test statuses to avoid suppressing important test outcomes. + +**Behavior by test status:** + +- **`failed`**: Network errors logged as additional context, not thrown +- **`timedOut`**: Network errors logged as additional context +- **`skipped`**: Network errors logged, skip status preserved +- **`interrupted`**: Network errors logged, interrupted status preserved +- **`passed`**: Network errors throw and fail the test + +**Example with test.skip():** + +```typescript +test('feature gated test', async ({ page }) => { + const featureEnabled = await checkFeatureFlag(); + test.skip(!featureEnabled, 'Feature not enabled'); + // If skipped, network errors won't turn this into a failure + await page.goto('/new-feature'); +}); +``` + +### Example 4: Excluding Legitimate Errors + +**Context**: Some endpoints legitimately return 4xx/5xx responses. + +**Implementation**: + +```typescript +import { test as base } from '@playwright/test'; +import { createNetworkErrorMonitorFixture } from '@seontechnologies/playwright-utils/network-error-monitor/fixtures'; + +export const test = base.extend( + createNetworkErrorMonitorFixture({ + excludePatterns: [ + /email-cluster\/ml-app\/has-active-run/, // ML service returns 404 when no active run + /idv\/session-templates\/list/, // IDV service returns 404 when not configured + /sentry\.io\/api/, // External Sentry errors should not fail tests + ], + }) +); +``` + +**For merged fixtures:** + +```typescript +import { test as base, mergeTests } from '@playwright/test'; +import { createNetworkErrorMonitorFixture } from '@seontechnologies/playwright-utils/network-error-monitor/fixtures'; + +const networkErrorMonitor = base.extend( + createNetworkErrorMonitorFixture({ + excludePatterns: [/analytics\.google\.com/, /cdn\.example\.com/], + }) +); + +export const test = mergeTests(authFixture, networkErrorMonitor); +``` + +### Example 5: Preventing Domino Effect + +**Context**: One failing endpoint shouldn't fail all tests. + +**Implementation**: + +```typescript +import { test as base } from '@playwright/test'; +import { createNetworkErrorMonitorFixture } from '@seontechnologies/playwright-utils/network-error-monitor/fixtures'; + +const networkErrorMonitor = base.extend( + createNetworkErrorMonitorFixture({ + excludePatterns: [], // Required when using maxTestsPerError + maxTestsPerError: 1, // Only first test fails per error pattern, rest just log + }) +); +``` + +**How it works:** + +When `/api/v2/case-management/cases` returns 500: + +- **First test** encountering this error: **FAILS** with clear error message +- **Subsequent tests** encountering same error: **PASSES** but logs warning + +Error patterns are grouped by `method + status + base path`: + +- `GET /api/v2/case-management/cases/123` -> Pattern: `GET:500:/api/v2/case-management` +- `GET /api/v2/case-management/quota` -> Pattern: `GET:500:/api/v2/case-management` (same group!) +- `POST /api/v2/case-management/cases` -> Pattern: `POST:500:/api/v2/case-management` (different group!) + +**Why include HTTP method?** A GET 404 vs POST 404 might represent different issues: + +- `GET 404 /api/users/123` -> User not found (expected in some tests) +- `POST 404 /api/users` -> Endpoint doesn't exist (critical error) + +**Output for subsequent tests:** + +``` +Warning: Network errors detected but not failing test (maxTestsPerError limit reached): + GET 500 https://api.example.com/api/v2/case-management/cases +``` + +**Recommended configuration:** + +```typescript +createNetworkErrorMonitorFixture({ + excludePatterns: [...], // Required - known broken endpoints (can be empty []) + maxTestsPerError: 1 // Stop domino effect (requires excludePatterns) +}) +``` + +**Understanding worker-level state:** + +Error pattern counts are stored in worker-level global state: + +```typescript +// test-file-1.spec.ts (runs in Worker 1) +test('test A', () => { + /* triggers GET:500:/api/v2/cases */ +}); // FAILS + +// test-file-2.spec.ts (runs later in Worker 1) +test('test B', () => { + /* triggers GET:500:/api/v2/cases */ +}); // PASSES (limit reached) + +// test-file-3.spec.ts (runs in Worker 2 - different worker) +test('test C', () => { + /* triggers GET:500:/api/v2/cases */ +}); // FAILS (fresh worker) +``` + +### Example 6: Integration with Merged Fixtures **Context**: Combine network-error-monitor with other utilities. @@ -105,7 +254,7 @@ import { test as networkErrorMonitorFixture } from '@seontechnologies/playwright export const test = mergeTests( authFixture, - networkErrorMonitorFixture, + networkErrorMonitorFixture // Add other fixtures ); @@ -127,110 +276,94 @@ test('authenticated with monitoring', async ({ page, authToken }) => { - Monitoring active automatically - No extra setup needed -### Example 4: Domino Effect Prevention - -**Context**: One failing endpoint shouldn't fail all tests. - -**Implementation**: - -```typescript -// Configuration (internal to utility) -const config = { - maxTestsPerError: 3, // Max 3 tests fail per unique error pattern -}; - -// Scenario: -// Test 1: GET /api/broken → 500 error → Test fails ❌ -// Test 2: GET /api/broken → 500 error → Test fails ❌ -// Test 3: GET /api/broken → 500 error → Test fails ❌ -// Test 4: GET /api/broken → 500 error → Test passes ⚠️ (limit reached, warning logged) -// Test 5: Different error pattern → Test fails ❌ (new pattern, counter resets) -``` - -**Key Points**: - -- Limits cascading failures -- Groups errors by URL + status code pattern -- Warns when limit reached -- Prevents flaky backend from failing entire suite - -### Example 5: Artifact Structure +### Example 7: Artifact Structure **Context**: Debugging failed tests with network error artifacts. -**Implementation**: - When test fails due to network errors, artifact attached: ```json -// test-results/my-test/network-errors.json -{ - "errors": [ - { - "url": "https://api.example.com/users", - "method": "GET", - "status": 500, - "statusText": "Internal Server Error", - "timestamp": "2024-08-13T10:30:45.123Z" - }, - { - "url": "https://api.example.com/metrics", - "method": "POST", - "status": 503, - "statusText": "Service Unavailable", - "timestamp": "2024-08-13T10:30:46.456Z" - } - ], - "summary": { - "totalErrors": 2, - "uniquePatterns": 2 +[ + { + "url": "https://api.example.com/users", + "status": 500, + "method": "GET", + "timestamp": "2025-11-10T12:34:56.789Z" + }, + { + "url": "https://api.example.com/metrics", + "status": 503, + "method": "POST", + "timestamp": "2025-11-10T12:34:57.123Z" } -} +] ``` -**Key Points**: +## Implementation Details -- JSON artifact per failed test -- Full error details (URL, method, status, timestamp) -- Summary statistics -- Easy debugging with structured data +### How It Works -## Comparison with Manual Error Checks +1. **Fixture Extension**: Uses Playwright's `base.extend()` with `auto: true` +2. **Response Listener**: Attaches `page.on('response')` listener at test start +3. **Multi-Page Monitoring**: Automatically monitors popups and new tabs via `context.on('page')` +4. **Error Collection**: Captures 4xx/5xx responses, checking exclusion patterns +5. **Try/Finally**: Ensures error processing runs even if test fails early +6. **Status Check**: Only throws errors if test hasn't already reached final status +7. **Artifact**: Attaches JSON file to test report for debugging -| Manual Approach | network-error-monitor | -| ------------------------------------------------------ | -------------------------- | -| `page.on('response', resp => { if (!resp.ok()) ... })` | Auto-enabled, zero setup | -| Check each response manually | Automatic for all requests | -| Custom error tracking logic | Built-in deduplication | -| No structured artifacts | JSON artifacts attached | -| Easy to forget | Never miss a backend error | +### Performance + +The monitor has minimal performance impact: + +- Event listener overhead: ~0.1ms per response +- Memory: ~200 bytes per unique error +- No network delay (observes responses, doesn't intercept them) + +## Comparison with Alternatives + +| Approach | Network Error Monitor | Manual afterEach | +| --------------------------- | --------------------- | --------------------- | +| **Setup Required** | Zero (auto-enabled) | Every test file | +| **Catches Silent Failures** | Yes | Yes (if configured) | +| **Structured Artifacts** | JSON attached | Custom impl | +| **Test Failure Safety** | Try/finally | afterEach may not run | +| **Opt-Out Mechanism** | Annotation | Custom logic | +| **Status Aware** | Respects skip/failed | No | ## When to Use **Auto-enabled for:** -- ✅ All E2E tests -- ✅ Integration tests -- ✅ Any test hitting real APIs +- All E2E tests +- Integration tests +- Any test hitting real APIs **Opt-out for:** -- ❌ Validation tests (expecting 4xx) -- ❌ Error handling tests (expecting 5xx) -- ❌ Offline tests (network-recorder playback) +- Validation tests (expecting 4xx) +- Error handling tests (expecting 5xx) +- Offline tests (network-recorder playback) -## Integration with Framework Setup +## Troubleshooting -In `*framework` workflow, mention network-error-monitor: +### Test fails with network errors but I don't see them in my app + +The errors might be happening during page load or in background polling. Check the `network-errors.json` artifact in your test report for full details including timestamps. + +### False positives from external services + +Configure exclusion patterns as shown in the "Excluding Legitimate Errors" section above. + +### Network errors not being caught + +Ensure you're importing the test from the correct fixture: ```typescript -// Add to merged-fixtures.ts -import { test as networkErrorMonitorFixture } from '@seontechnologies/playwright-utils/network-error-monitor/fixtures'; +// Correct +import { test } from '@seontechnologies/playwright-utils/network-error-monitor/fixtures'; -export const test = mergeTests( - // ... other fixtures - networkErrorMonitorFixture, -); +// Wrong - this won't have network monitoring +import { test } from '@playwright/test'; ``` ## Related Fragments @@ -241,14 +374,14 @@ export const test = mergeTests( ## Anti-Patterns -**❌ Opting out of monitoring globally:** +**DON'T opt out of monitoring globally:** ```typescript // Every test skips monitoring test.use({ annotation: [{ type: 'skipNetworkMonitoring' }] }); ``` -**✅ Opt-out only for specific error tests:** +**DO opt-out only for specific error tests:** ```typescript test.describe('error scenarios', { annotation: [{ type: 'skipNetworkMonitoring' }] }, () => { @@ -256,17 +389,17 @@ test.describe('error scenarios', { annotation: [{ type: 'skipNetworkMonitoring' }); ``` -**❌ Ignoring network error artifacts:** +**DON'T ignore network error artifacts:** ```typescript // Test fails, artifact shows 500 errors // Developer: "Works on my machine" ¯\_(ツ)_/¯ ``` -**✅ Check artifacts for root cause:** +**DO check artifacts for root cause:** ```typescript // Read network-errors.json artifact -// Identify failing endpoint: GET /api/users → 500 +// Identify failing endpoint: GET /api/users -> 500 // Fix backend issue before merging ``` diff --git a/src/modules/bmm/testarch/knowledge/network-recorder.md b/src/modules/bmm/testarch/knowledge/network-recorder.md index ff24cb4e..7b9c6e26 100644 --- a/src/modules/bmm/testarch/knowledge/network-recorder.md +++ b/src/modules/bmm/testarch/knowledge/network-recorder.md @@ -21,6 +21,46 @@ HAR-based recording/playback provides: - **Stateful mocking**: CRUD operations work naturally (not just read-only) - **Environment flexibility**: Map URLs for any environment +## Quick Start + +### 1. Record Network Traffic + +```typescript +// Set mode to 'record' to capture network traffic +process.env.PW_NET_MODE = 'record'; + +test('should add, edit and delete a movie', async ({ page, context, networkRecorder }) => { + // Setup network recorder - it will record all network traffic + await networkRecorder.setup(context); + + // Your normal test code + await page.goto('/'); + await page.fill('#movie-name', 'Inception'); + await page.click('#add-movie'); + + // Network traffic is automatically saved to HAR file +}); +``` + +### 2. Playback Network Traffic + +```typescript +// Set mode to 'playback' to use recorded traffic +process.env.PW_NET_MODE = 'playback'; + +test('should add, edit and delete a movie', async ({ page, context, networkRecorder }) => { + // Setup network recorder - it will replay from HAR file + await networkRecorder.setup(context); + + // Same test code runs without hitting real backend! + await page.goto('/'); + await page.fill('#movie-name', 'Inception'); + await page.click('#add-movie'); +}); +``` + +That's it! Your tests now run completely offline using recorded network traffic. + ## Pattern Examples ### Example 1: Basic Record and Playback @@ -115,74 +155,173 @@ test.describe('Movie CRUD - offline with network recorder', () => { - Combine with `interceptNetworkCall` for deterministic waits - First run records, subsequent runs replay -### Example 3: Environment Switching +### Example 3: Common Patterns + +**Recording Only API Calls**: + +```typescript +await networkRecorder.setup(context, { + recording: { + urlFilter: /\/api\// // Only record API calls, ignore static assets + } +}); +``` + +**Playback with Fallback**: + +```typescript +await networkRecorder.setup(context, { + playback: { + fallback: true // Fall back to live requests if HAR entry missing + } +}); +``` + +**Custom HAR File Location**: + +```typescript +await networkRecorder.setup(context, { + harFile: { + harDir: 'recordings/api-calls', + baseName: 'user-journey', + organizeByTestFile: false // Optional: flatten directory structure + } +}); +``` + +**Directory Organization:** + +- `organizeByTestFile: true` (default): `har-files/test-file-name/baseName-test-title.har` +- `organizeByTestFile: false`: `har-files/baseName-test-title.har` + +### Example 4: Response Content Storage - Embed vs Attach + +**Context**: Choose how response content is stored in HAR files. + +**`embed` (Default - Recommended):** + +```typescript +await networkRecorder.setup(context, { + recording: { + content: 'embed' // Store content inline (default) + } +}); +``` + +**Pros:** + +- Single self-contained file - Easy to share, version control +- Better for small-medium responses (API JSON, HTML pages) +- HAR specification compliant + +**Cons:** + +- Larger HAR files +- Not ideal for large binary content (images, videos) + +**`attach` (Alternative):** + +```typescript +await networkRecorder.setup(context, { + recording: { + content: 'attach' // Store content separately + } +}); +``` + +**Pros:** + +- Smaller HAR files +- Better for large responses (images, videos, documents) + +**Cons:** + +- Multiple files to manage +- Harder to share + +**When to Use Each:** + +| Use `embed` (default) when | Use `attach` when | +|---------------------------|-------------------| +| Recording API responses (JSON, XML) | Recording large images, videos | +| Small to medium HTML pages | HAR file size >50MB | +| You want a single, portable file | Maximum disk efficiency needed | +| Sharing HAR files with team | Working with ZIP archive output | + +### Example 5: Cross-Environment Compatibility (URL Mapping) **Context**: Record in dev environment, play back in CI with different base URLs. -**Implementation**: +**The Problem**: HAR files contain URLs for the recording environment (e.g., `dev.example.com`). Playing back on a different environment fails. + +**Simple Hostname Mapping:** ```typescript -// playwright.config.ts - Map URLs for different environments -export default defineConfig({ - use: { - baseURL: process.env.CI ? 'https://app.ci.example.com' : 'http://localhost:3000', - }, -}); - -// Test works in both environments -test('cross-environment playback', async ({ page, context, networkRecorder }) => { - await networkRecorder.setup(context); - - // In dev: hits http://localhost:3000/api/movies - // In CI: HAR replays with https://app.ci.example.com/api/movies - await page.goto('/movies'); - - // Network recorder auto-maps URLs - await expect(page.getByTestId('movie-list')).toBeVisible(); +await networkRecorder.setup(context, { + playback: { + urlMapping: { + hostMapping: { + 'preview.example.com': 'dev.example.com', + 'staging.example.com': 'dev.example.com', + 'localhost:3000': 'dev.example.com' + } + } + } }); ``` -**Key Points**: - -- HAR files record absolute URLs -- Playback maps to current baseURL -- Same HAR works across environments -- No manual URL rewriting needed - -### Example 4: Automatic vs Manual Mode Control - -**Context**: Choose between environment-based switching or in-test mode control. - -**Implementation**: +**Pattern-Based Mapping (Recommended):** ```typescript -// Option 1: Environment variable (recommended for CI) -PW_NET_MODE=record npm run test:pw # Record traffic -PW_NET_MODE=playback npm run test:pw # Playback traffic - -// Option 2: In-test control (recommended for development) -process.env.PW_NET_MODE = 'record' // Set at top of test file - -test('my test', async ({ page, context, networkRecorder }) => { - await networkRecorder.setup(context) - // ... -}) - -// Option 3: Auto-fallback (record if HAR missing, else playback) -// This is the default behavior when PW_NET_MODE not set -test('auto mode', async ({ page, context, networkRecorder }) => { - await networkRecorder.setup(context) - // First run: auto-records - // Subsequent runs: auto-plays back -}) +await networkRecorder.setup(context, { + playback: { + urlMapping: { + patterns: [ + // Map any preview-XXXX subdomain to dev + { match: /preview-\d+\.example\.com/, replace: 'dev.example.com' } + ] + } + } +}); ``` -**Key Points**: +**Custom Function:** -- Three mode options: record, playback, auto -- `PW_NET_MODE` environment variable -- In-test `process.env.PW_NET_MODE` assignment -- Auto-fallback when no mode specified +```typescript +await networkRecorder.setup(context, { + playback: { + urlMapping: { + mapUrl: (url) => url.replace('staging.example.com', 'dev.example.com') + } + } +}); +``` + +**Complex Multi-Environment Example:** + +```typescript +await networkRecorder.setup(context, { + playback: { + urlMapping: { + hostMapping: { + 'localhost:3000': 'admin.seondev.space', + 'admin-staging.seon.io': 'admin.seondev.space', + 'admin.seon.io': 'admin.seondev.space', + }, + patterns: [ + { match: /admin-\d+\.seondev\.space/, replace: 'admin.seondev.space' }, + { match: /admin-staging-pr-\w+-\d\.seon\.io/, replace: 'admin.seondev.space' } + ] + } + } +}); +``` + +**Benefits:** + +- Record once on dev, all environments map back to recordings +- CORS headers automatically updated based on request origin +- Debug with: `LOG_LEVEL=debug npm run test` ## Why Use This Instead of Native Playwright? @@ -191,7 +330,7 @@ test('auto mode', async ({ page, context, networkRecorder }) => { | ~80 lines setup boilerplate | ~5 lines total | | Manual HAR file management | Automatic file organization | | Complex setup/teardown | Automatic cleanup via fixtures | -| **Read-only tests** | **Full CRUD support** | +| **Read-only tests only** | **Full CRUD support** | | **Stateless** | **Stateful mocking** | | Manual URL mapping | Automatic environment mapping | @@ -199,9 +338,132 @@ test('auto mode', async ({ page, context, networkRecorder }) => { Native Playwright HAR playback is stateless - a POST create followed by GET list won't show the created item. This utility intelligently tracks CRUD operations in memory to reflect state changes, making offline tests behave like real APIs. +## How Stateful CRUD Detection Works + +When in playback mode, the Network Recorder automatically analyzes your HAR file to detect CRUD patterns. If it finds: + +- Multiple GET requests to the same resource endpoint (e.g., `/movies`) +- Mutation operations (POST, PUT, DELETE) to those resources +- Evidence of state changes between identical requests + +It automatically switches from static HAR playback to an intelligent stateful mock that: + +- Maintains state across requests +- Auto-generates IDs for new resources +- Returns proper 404s for deleted resources +- Supports polling scenarios where state changes over time + +**This happens automatically - no configuration needed!** + +## API Reference + +### NetworkRecorder Methods + +| Method | Return Type | Description | +| -------------------- | ------------------------ | ----------------------------------------------------- | +| `setup(context)` | `Promise` | Sets up recording/playback on browser context | +| `cleanup()` | `Promise` | Flushes data to disk and cleans up memory | +| `getContext()` | `NetworkRecorderContext` | Gets current recorder context information | +| `getStatusMessage()` | `string` | Gets human-readable status message | +| `getHarStats()` | `Promise` | Gets HAR file statistics and metadata | + +### Understanding `cleanup()` + +The `cleanup()` method performs memory and resource cleanup - **it does NOT delete HAR files**: + +**What it does:** + +- Flushes recorded data to disk (writes HAR file in recording mode) +- Releases file locks +- Clears in-memory data +- Resets internal state + +**What it does NOT do:** + +- Delete HAR files from disk +- Remove recorded network traffic +- Clear browser context or cookies + +### Configuration Options + +```typescript +type NetworkRecorderConfig = { + harFile?: { + harDir?: string // Directory for HAR files (default: 'har-files') + baseName?: string // Base name for HAR files (default: 'network-traffic') + organizeByTestFile?: boolean // Organize by test file (default: true) + } + + recording?: { + content?: 'embed' | 'attach' // Response content handling (default: 'embed') + urlFilter?: string | RegExp // URL filter for recording + update?: boolean // Update existing HAR files (default: false) + } + + playback?: { + fallback?: boolean // Fall back to live requests (default: false) + urlFilter?: string | RegExp // URL filter for playback + updateMode?: boolean // Update mode during playback (default: false) + } + + forceMode?: 'record' | 'playback' | 'disabled' +} +``` + +## Environment Configuration + +Control the recording mode using the `PW_NET_MODE` environment variable: + +```bash +# Record mode - captures network traffic to HAR files +PW_NET_MODE=record npm run test:pw + +# Playback mode - replays network traffic from HAR files +PW_NET_MODE=playback npm run test:pw + +# Disabled mode - no network recording/playback +PW_NET_MODE=disabled npm run test:pw + +# Default behavior (when PW_NET_MODE is empty/unset) - same as disabled +npm run test:pw +``` + +**Tip**: We recommend setting `process.env.PW_NET_MODE` directly in your test file for better control. + +## Troubleshooting + +### HAR File Not Found + +If you see "HAR file not found" errors during playback: + +1. Ensure you've recorded the test first with `PW_NET_MODE=record` +2. Check the HAR file exists in the expected location (usually `har-files/`) +3. Enable fallback mode: `playback: { fallback: true }` + +### Authentication and Network Recording + +The network recorder works seamlessly with authentication: + +```typescript +test('Authenticated recording', async ({ page, context, authSession, networkRecorder }) => { + // First authenticate + await authSession.login('testuser', 'password'); + + // Then setup network recording with authenticated context + await networkRecorder.setup(context); + + // Test authenticated flows + await page.goto('/dashboard'); +}); +``` + +### Concurrent Test Issues + +The recorder includes built-in file locking for safe parallel execution. Each test gets its own HAR file based on the test name. + ## Integration with Other Utilities -**With interceptNetworkCall** (deterministic waits): +**With interceptNetworkCall (deterministic waits):** ```typescript test('use both utilities', async ({ page, context, networkRecorder, interceptNetworkCall }) => { @@ -228,7 +490,7 @@ test('use both utilities', async ({ page, context, networkRecorder, interceptNet ## Anti-Patterns -**❌ Mixing record and playback in same test:** +**DON'T mix record and playback in same test:** ```typescript process.env.PW_NET_MODE = 'record'; @@ -236,7 +498,7 @@ process.env.PW_NET_MODE = 'record'; process.env.PW_NET_MODE = 'playback'; // Don't switch mid-test ``` -**✅ One mode per test:** +**DO use one mode per test:** ```typescript process.env.PW_NET_MODE = 'playback'; // Set once at top @@ -247,7 +509,7 @@ test('my test', async ({ page, context, networkRecorder }) => { }); ``` -**❌ Forgetting to call setup:** +**DON'T forget to call setup:** ```typescript test('broken', async ({ page, networkRecorder }) => { @@ -255,7 +517,7 @@ test('broken', async ({ page, networkRecorder }) => { }); ``` -**✅ Always call setup before navigation:** +**DO always call setup before navigation:** ```typescript test('correct', async ({ page, context, networkRecorder }) => { diff --git a/src/modules/bmm/testarch/knowledge/overview.md b/src/modules/bmm/testarch/knowledge/overview.md index 8155d55f..a539f03f 100644 --- a/src/modules/bmm/testarch/knowledge/overview.md +++ b/src/modules/bmm/testarch/knowledge/overview.md @@ -2,7 +2,7 @@ ## Principle -Use production-ready, fixture-based utilities from `@seontechnologies/playwright-utils` for common Playwright testing patterns. Build test helpers as pure functions first, then wrap in framework-specific fixtures for composability and reuse. +Use production-ready, fixture-based utilities from `@seontechnologies/playwright-utils` for common Playwright testing patterns. Build test helpers as pure functions first, then wrap in framework-specific fixtures for composability and reuse. **Works equally well for pure API testing (no browser) and UI testing.** ## Rationale @@ -20,6 +20,7 @@ Writing Playwright utilities from scratch for every project leads to: - **Composable fixtures**: Use `mergeTests` to combine utilities - **TypeScript support**: Full type safety with generic types - **Comprehensive coverage**: API requests, auth, network, logging, file handling, burn-in +- **Backend-first mentality**: Most utilities work without a browser - pure API/service testing is a first-class use case ## Installation @@ -37,17 +38,19 @@ npm install -D @seontechnologies/playwright-utils ### Core Testing Utilities -| Utility | Purpose | Test Context | -| -------------------------- | ------------------------------------------ | ------------- | -| **api-request** | Typed HTTP client with schema validation | API tests | -| **network-recorder** | HAR record/playback for offline testing | UI tests | -| **auth-session** | Token persistence, multi-user auth | Both UI & API | -| **recurse** | Cypress-style polling for async conditions | Both UI & API | -| **intercept-network-call** | Network spy/stub with auto JSON parsing | UI tests | -| **log** | Playwright report-integrated logging | Both UI & API | -| **file-utils** | CSV/XLSX/PDF/ZIP reading & validation | Both UI & API | -| **burn-in** | Smart test selection with git diff | CI/CD | -| **network-error-monitor** | Automatic HTTP 4xx/5xx detection | UI tests | +| Utility | Purpose | Test Context | +| -------------------------- | ---------------------------------------------------- | ------------------ | +| **api-request** | Typed HTTP client with schema validation and retry | **API/Backend** | +| **recurse** | Polling for async operations, background jobs | **API/Backend** | +| **auth-session** | Token persistence, multi-user, service-to-service | **API/Backend/UI** | +| **log** | Playwright report-integrated logging | **API/Backend/UI** | +| **file-utils** | CSV/XLSX/PDF/ZIP reading & validation | **API/Backend/UI** | +| **burn-in** | Smart test selection with git diff | **CI/CD** | +| **network-recorder** | HAR record/playback for offline testing | UI only | +| **intercept-network-call** | Network spy/stub with auto JSON parsing | UI only | +| **network-error-monitor** | Automatic HTTP 4xx/5xx detection | UI only | + +**Note**: 6 of 9 utilities work without a browser. Only 3 are UI-specific (network-recorder, intercept-network-call, network-error-monitor). ## Design Patterns diff --git a/src/modules/bmm/testarch/knowledge/recurse.md b/src/modules/bmm/testarch/knowledge/recurse.md index aec553a1..d9536400 100644 --- a/src/modules/bmm/testarch/knowledge/recurse.md +++ b/src/modules/bmm/testarch/knowledge/recurse.md @@ -2,7 +2,7 @@ ## Principle -Use Cypress-style polling with Playwright's `expect.poll` to wait for asynchronous conditions. Provides configurable timeout, interval, logging, and post-polling callbacks with enhanced error categorization. +Use Cypress-style polling with Playwright's `expect.poll` to wait for asynchronous conditions. Provides configurable timeout, interval, logging, and post-polling callbacks with enhanced error categorization. **Ideal for backend testing**: polling API endpoints for job completion, database eventual consistency, message queue processing, and cache propagation. ## Rationale @@ -21,6 +21,29 @@ The `recurse` utility provides: - **Post-poll callbacks**: Process results after success - **Type-safe**: Full TypeScript generic support +## Quick Start + +```typescript +import { test } from '@seontechnologies/playwright-utils/recurse/fixtures'; + +test('wait for job completion', async ({ recurse, apiRequest }) => { + const { body } = await apiRequest({ + method: 'POST', + path: '/api/jobs', + body: { type: 'export' }, + }); + + // Poll until job completes + const result = await recurse( + () => apiRequest({ method: 'GET', path: `/api/jobs/${body.id}` }), + (response) => response.body.status === 'completed', + { timeout: 60000 } + ); + + expect(result.body.downloadUrl).toBeDefined(); +}); +``` + ## Pattern Examples ### Example 1: Basic Polling @@ -48,7 +71,7 @@ test('should wait for job completion', async ({ recurse, apiRequest }) => { timeout: 60000, // 60 seconds max interval: 2000, // Check every 2 seconds log: 'Waiting for export job to complete', - }, + } ); expect(result.body.downloadUrl).toBeDefined(); @@ -62,7 +85,7 @@ test('should wait for job completion', async ({ recurse, apiRequest }) => { - Options: timeout, interval, log message - Returns the value when predicate returns true -### Example 2: Polling with Assertions +### Example 2: Working with Assertions **Context**: Use assertions directly in predicate for more expressive tests. @@ -76,35 +99,76 @@ test('should poll with assertions', async ({ recurse, apiRequest }) => { body: { type: 'user-created', userId: '123' }, }); - // Poll with assertions in predicate + // Poll with assertions in predicate - no return true needed! await recurse( async () => { const { body } = await apiRequest({ method: 'GET', path: '/api/events/123' }); return body; }, (event) => { - // Use assertions instead of boolean returns + // If all assertions pass, predicate succeeds expect(event.processed).toBe(true); expect(event.timestamp).toBeDefined(); - // If assertions pass, predicate succeeds + // No need to return true - just let assertions pass }, - { timeout: 30000 }, + { timeout: 30000 } ); }); ``` -**Key Points**: +**Why no `return true` needed?** -- Predicate can use `expect()` assertions -- If assertions throw, polling continues -- If assertions pass, polling succeeds -- More expressive than boolean returns +The predicate checks for "truthiness" of the return value. But there's a catch - in JavaScript, an empty `return` (or no return) returns `undefined`, which is falsy! -### Example 3: Custom Error Messages +The utility handles this by checking if: -**Context**: Provide context-specific error messages for timeout failures. +1. The predicate didn't throw (assertions passed) +2. The return value was either `undefined` (implicit return) or truthy -**Implementation**: +So you can: + +```typescript +// Option 1: Use assertions only (recommended) +(event) => { + expect(event.processed).toBe(true); +}; + +// Option 2: Return boolean (also works) +(event) => event.processed === true; + +// Option 3: Mixed (assertions + explicit return) +(event) => { + expect(event.processed).toBe(true); + return true; +}; +``` + +### Example 3: Error Handling + +**Context**: Understanding the different error types. + +**Error Types:** + +```typescript +// RecurseTimeoutError - Predicate never returned true within timeout +// Contains last command value and predicate error +try { + await recurse(/* ... */); +} catch (error) { + if (error instanceof RecurseTimeoutError) { + console.log('Timed out. Last value:', error.lastCommandValue); + console.log('Last predicate error:', error.lastPredicateError); + } +} + +// RecurseCommandError - Command function threw an error +// The command itself failed (e.g., network error, API error) + +// RecursePredicateError - Predicate function threw (not from assertions failing) +// Logic error in your predicate code +``` + +**Custom Error Messages:** ```typescript test('custom error on timeout', async ({ recurse, apiRequest }) => { @@ -115,7 +179,7 @@ test('custom error on timeout', async ({ recurse, apiRequest }) => { { timeout: 10000, error: 'System failed to become ready within 10 seconds - check background workers', - }, + } ); } catch (error) { // Error message includes custom context @@ -125,13 +189,6 @@ test('custom error on timeout', async ({ recurse, apiRequest }) => { }); ``` -**Key Points**: - -- `error` option provides custom message -- Replaces default "Timed out after X ms" -- Include debugging hints in error message -- Helps diagnose failures faster - ### Example 4: Post-Polling Callback **Context**: Process or log results after successful polling. @@ -151,7 +208,7 @@ test('post-poll processing', async ({ recurse, apiRequest }) => { console.log(`Processed ${result.body.itemsProcessed} items`); return result.body; }, - }, + } ); expect(finalResult.itemsProcessed).toBeGreaterThan(0); @@ -165,7 +222,67 @@ test('post-poll processing', async ({ recurse, apiRequest }) => { - Can transform or log results - Return value becomes final `recurse` result -### Example 5: Integration with API Request (Common Pattern) +### Example 5: UI Testing Scenarios + +**Context**: Wait for UI elements to reach a specific state through polling. + +**Implementation**: + +```typescript +test('table data loads', async ({ page, recurse }) => { + await page.goto('/reports'); + + // Poll for table rows to appear + await recurse( + async () => page.locator('table tbody tr').count(), + (count) => count >= 10, // Wait for at least 10 rows + { + timeout: 15000, + interval: 500, + log: 'Waiting for table data to load', + } + ); + + // Now safe to interact with table + await page.locator('table tbody tr').first().click(); +}); +``` + +### Example 6: Event-Based Systems (Kafka/Message Queues) + +**Context**: Testing eventual consistency with message queue processing. + +**Implementation**: + +```typescript +test('kafka event processed', async ({ recurse, apiRequest }) => { + // Trigger action that publishes Kafka event + await apiRequest({ + method: 'POST', + path: '/api/orders', + body: { productId: 'ABC123', quantity: 2 }, + }); + + // Poll for downstream effect of Kafka consumer processing + const inventoryResult = await recurse( + () => apiRequest({ method: 'GET', path: '/api/inventory/ABC123' }), + (res) => { + // Assumes test fixture seeds inventory at 100; in production tests, + // fetch baseline first and assert: expect(res.body.available).toBe(baseline - 2) + expect(res.body.available).toBeLessThanOrEqual(98); + }, + { + timeout: 30000, // Kafka processing may take time + interval: 1000, + log: 'Waiting for Kafka event to be processed', + } + ); + + expect(inventoryResult.body.lastOrderId).toBeDefined(); +}); +``` + +### Example 7: Integration with API Request (Common Pattern) **Context**: Most common use case - polling API endpoints for state changes. @@ -193,7 +310,7 @@ test('end-to-end polling', async ({ apiRequest, recurse }) => { timeout: 120000, // 2 minutes for large imports interval: 5000, // Check every 5 seconds log: `Polling import ${createResp.importId}`, - }, + } ); expect(importResult.body.rowsImported).toBeGreaterThan(1000); @@ -208,20 +325,26 @@ test('end-to-end polling', async ({ apiRequest, recurse }) => { - Complex predicates with multiple conditions - Logging shows polling progress in test reports -## Enhanced Error Types +## API Reference -The utility categorizes errors for easier debugging: +### RecurseOptions -```typescript -// TimeoutError - Predicate never returned true -Error: Polling timed out after 30000ms: Job never completed +| Option | Type | Default | Description | +| ---------- | ------------------ | ----------- | ------------------------------------ | +| `timeout` | `number` | `30000` | Maximum time to wait (ms) | +| `interval` | `number` | `1000` | Time between polls (ms) | +| `log` | `string` | `undefined` | Message logged on each poll | +| `error` | `string` | `undefined` | Custom error message for timeout | +| `post` | `(result: T) => R` | `undefined` | Callback after successful poll | +| `delay` | `number` | `0` | Initial delay before first poll (ms) | -// CommandError - Command function threw -Error: Command failed: Request failed with status 500 +### Error Types -// PredicateError - Predicate function threw (not from assertions) -Error: Predicate failed: Cannot read property 'status' of undefined -``` +| Error Type | When Thrown | Properties | +| ----------------------- | --------------------------------------- | ---------------------------------------- | +| `RecurseTimeoutError` | Predicate never passed within timeout | `lastCommandValue`, `lastPredicateError` | +| `RecurseCommandError` | Command function threw an error | `cause` (original error) | +| `RecursePredicateError` | Predicate threw (not assertion failure) | `cause` (original error) | ## Comparison with Vanilla Playwright @@ -236,11 +359,11 @@ Error: Predicate failed: Cannot read property 'status' of undefined **Use recurse for:** -- ✅ Background job completion -- ✅ Webhook/event processing -- ✅ Database eventual consistency -- ✅ Cache propagation -- ✅ State machine transitions +- Background job completion +- Webhook/event processing +- Database eventual consistency +- Cache propagation +- State machine transitions **Stick with vanilla expect.poll for:** @@ -250,13 +373,15 @@ Error: Predicate failed: Cannot read property 'status' of undefined ## Related Fragments +- `api-testing-patterns.md` - Comprehensive pure API testing patterns - `api-request.md` - Combine for API endpoint polling - `overview.md` - Fixture composition patterns - `fixtures-composition.md` - Using with mergeTests +- `contract-testing.md` - Contract testing with async verification ## Anti-Patterns -**❌ Using hard waits instead of polling:** +**DON'T use hard waits instead of polling:** ```typescript await page.click('#export'); @@ -264,33 +389,33 @@ await page.waitForTimeout(5000); // Arbitrary wait expect(await page.textContent('#status')).toBe('Ready'); ``` -**✅ Poll for actual condition:** +**DO poll for actual condition:** ```typescript await page.click('#export'); await recurse( () => page.textContent('#status'), (status) => status === 'Ready', - { timeout: 10000 }, + { timeout: 10000 } ); ``` -**❌ Polling too frequently:** +**DON'T poll too frequently:** ```typescript await recurse( () => apiRequest({ method: 'GET', path: '/status' }), (res) => res.body.ready, - { interval: 100 }, // Hammers API every 100ms! + { interval: 100 } // Hammers API every 100ms! ); ``` -**✅ Reasonable interval for API calls:** +**DO use reasonable interval for API calls:** ```typescript await recurse( () => apiRequest({ method: 'GET', path: '/status' }), (res) => res.body.ready, - { interval: 2000 }, // Check every 2 seconds (reasonable) + { interval: 2000 } // Check every 2 seconds (reasonable) ); ``` diff --git a/src/modules/bmm/testarch/tea-index.csv b/src/modules/bmm/testarch/tea-index.csv index cf1efd67..4546d351 100644 --- a/src/modules/bmm/testarch/tea-index.csv +++ b/src/modules/bmm/testarch/tea-index.csv @@ -1,33 +1,34 @@ id,name,description,tags,fragment_file fixture-architecture,Fixture Architecture,"Composable fixture patterns (pure function → fixture → merge) and reuse rules","fixtures,architecture,playwright,cypress",knowledge/fixture-architecture.md -network-first,Network-First Safeguards,"Intercept-before-navigate workflow, HAR capture, deterministic waits, edge mocking","network,stability,playwright,cypress",knowledge/network-first.md -data-factories,Data Factories and API Setup,"Factories with overrides, API seeding, cleanup discipline","data,factories,setup,api",knowledge/data-factories.md +network-first,Network-First Safeguards,"Intercept-before-navigate workflow, HAR capture, deterministic waits, edge mocking","network,stability,playwright,cypress,ui",knowledge/network-first.md +data-factories,Data Factories and API Setup,"Factories with overrides, API seeding, cleanup discipline","data,factories,setup,api,backend,seeding",knowledge/data-factories.md component-tdd,Component TDD Loop,"Red→green→refactor workflow, provider isolation, accessibility assertions","component-testing,tdd,ui",knowledge/component-tdd.md playwright-config,Playwright Config Guardrails,"Environment switching, timeout standards, artifact outputs","playwright,config,env",knowledge/playwright-config.md ci-burn-in,CI and Burn-In Strategy,"Staged jobs, shard orchestration, burn-in loops, artifact policy","ci,automation,flakiness",knowledge/ci-burn-in.md selective-testing,Selective Test Execution,"Tag/grep usage, spec filters, diff-based runs, promotion rules","risk-based,selection,strategy",knowledge/selective-testing.md feature-flags,Feature Flag Governance,"Enum management, targeting helpers, cleanup, release checklists","feature-flags,governance,launchdarkly",knowledge/feature-flags.md -contract-testing,Contract Testing Essentials,"Pact publishing, provider verification, resilience coverage","contract-testing,pact,api",knowledge/contract-testing.md +contract-testing,Contract Testing Essentials,"Pact publishing, provider verification, resilience coverage","contract-testing,pact,api,backend,microservices,service-contract",knowledge/contract-testing.md email-auth,Email Authentication Testing,"Magic link extraction, state preservation, caching, negative flows","email-authentication,security,workflow",knowledge/email-auth.md -error-handling,Error Handling Checks,"Scoped exception handling, retry validation, telemetry logging","resilience,error-handling,stability",knowledge/error-handling.md -visual-debugging,Visual Debugging Toolkit,"Trace viewer usage, artifact expectations, accessibility integration","debugging,dx,tooling",knowledge/visual-debugging.md +error-handling,Error Handling Checks,"Scoped exception handling, retry validation, telemetry logging","resilience,error-handling,stability,api,backend",knowledge/error-handling.md +visual-debugging,Visual Debugging Toolkit,"Trace viewer usage, artifact expectations, accessibility integration","debugging,dx,tooling,ui",knowledge/visual-debugging.md risk-governance,Risk Governance,"Scoring matrix, category ownership, gate decision rules","risk,governance,gates",knowledge/risk-governance.md probability-impact,Probability and Impact Scale,"Shared definitions for scoring matrix and gate thresholds","risk,scoring,scale",knowledge/probability-impact.md test-quality,Test Quality Definition of Done,"Execution limits, isolation rules, green criteria","quality,definition-of-done,tests",knowledge/test-quality.md nfr-criteria,NFR Review Criteria,"Security, performance, reliability, maintainability status definitions","nfr,assessment,quality",knowledge/nfr-criteria.md -test-levels,Test Levels Framework,"Guidelines for choosing unit, integration, or end-to-end coverage","testing,levels,selection",knowledge/test-levels-framework.md +test-levels,Test Levels Framework,"Guidelines for choosing unit, integration, or end-to-end coverage","testing,levels,selection,api,backend,ui",knowledge/test-levels-framework.md test-priorities,Test Priorities Matrix,"P0–P3 criteria, coverage targets, execution ordering","testing,prioritization,risk",knowledge/test-priorities-matrix.md test-healing-patterns,Test Healing Patterns,"Common failure patterns and automated fixes","healing,debugging,patterns",knowledge/test-healing-patterns.md -selector-resilience,Selector Resilience,"Robust selector strategies and debugging techniques","selectors,locators,debugging",knowledge/selector-resilience.md +selector-resilience,Selector Resilience,"Robust selector strategies and debugging techniques","selectors,locators,debugging,ui",knowledge/selector-resilience.md timing-debugging,Timing Debugging,"Race condition identification and deterministic wait fixes","timing,async,debugging",knowledge/timing-debugging.md -overview,Playwright Utils Overview,"Installation, design principles, fixture patterns","playwright-utils,fixtures",knowledge/overview.md -api-request,API Request,"Typed HTTP client, schema validation","api,playwright-utils",knowledge/api-request.md -network-recorder,Network Recorder,"HAR record/playback, CRUD detection","network,playwright-utils",knowledge/network-recorder.md -auth-session,Auth Session,"Token persistence, multi-user","auth,playwright-utils",knowledge/auth-session.md -intercept-network-call,Intercept Network Call,"Network spy/stub, JSON parsing","network,playwright-utils",knowledge/intercept-network-call.md -recurse,Recurse Polling,"Async polling, condition waiting","polling,playwright-utils",knowledge/recurse.md -log,Log Utility,"Report logging, structured output","logging,playwright-utils",knowledge/log.md -file-utils,File Utilities,"CSV/XLSX/PDF/ZIP validation","files,playwright-utils",knowledge/file-utils.md -burn-in,Burn-in Runner,"Smart test selection, git diff","ci,playwright-utils",knowledge/burn-in.md -network-error-monitor,Network Error Monitor,"HTTP 4xx/5xx detection","monitoring,playwright-utils",knowledge/network-error-monitor.md -fixtures-composition,Fixtures Composition,"mergeTests composition patterns","fixtures,playwright-utils",knowledge/fixtures-composition.md +overview,Playwright Utils Overview,"Installation, design principles, fixture patterns for API and UI testing","playwright-utils,fixtures,api,backend,ui",knowledge/overview.md +api-request,API Request,"Typed HTTP client, schema validation, retry logic for API and service testing","api,backend,service-testing,api-testing,playwright-utils",knowledge/api-request.md +network-recorder,Network Recorder,"HAR record/playback, CRUD detection for offline UI testing","network,playwright-utils,ui,har",knowledge/network-recorder.md +auth-session,Auth Session,"Token persistence, multi-user, API and browser authentication","auth,playwright-utils,api,backend,jwt,token",knowledge/auth-session.md +intercept-network-call,Intercept Network Call,"Network spy/stub, JSON parsing for UI tests","network,playwright-utils,ui",knowledge/intercept-network-call.md +recurse,Recurse Polling,"Async polling for API responses, background jobs, eventual consistency","polling,playwright-utils,api,backend,async,eventual-consistency",knowledge/recurse.md +log,Log Utility,"Report logging, structured output for API and UI tests","logging,playwright-utils,api,ui",knowledge/log.md +file-utils,File Utilities,"CSV/XLSX/PDF/ZIP validation for API exports and UI downloads","files,playwright-utils,api,backend,ui",knowledge/file-utils.md +burn-in,Burn-in Runner,"Smart test selection, git diff for CI optimization","ci,playwright-utils",knowledge/burn-in.md +network-error-monitor,Network Error Monitor,"HTTP 4xx/5xx detection for UI tests","monitoring,playwright-utils,ui",knowledge/network-error-monitor.md +fixtures-composition,Fixtures Composition,"mergeTests composition patterns for combining utilities","fixtures,playwright-utils",knowledge/fixtures-composition.md +api-testing-patterns,API Testing Patterns,"Pure API test patterns without browser: service testing, microservices, GraphQL","api,backend,service-testing,api-testing,microservices,graphql,no-browser",knowledge/api-testing-patterns.md diff --git a/src/modules/bmm/workflows/1-analysis/create-product-brief/steps/step-01-init.md b/src/modules/bmm/workflows/1-analysis/create-product-brief/steps/step-01-init.md index 1db8ecad..a5535a42 100644 --- a/src/modules/bmm/workflows/1-analysis/create-product-brief/steps/step-01-init.md +++ b/src/modules/bmm/workflows/1-analysis/create-product-brief/steps/step-01-init.md @@ -2,17 +2,12 @@ name: 'step-01-init' description: 'Initialize the product brief workflow by detecting continuation state and setting up the document' -# Path Definitions -workflow_path: '{project-root}/_bmad/bmm/workflows/1-analysis/create-product-brief' - # File References -thisStepFile: '{workflow_path}/steps/step-01-init.md' -nextStepFile: '{workflow_path}/steps/step-02-vision.md' -workflowFile: '{workflow_path}/workflow.md' +nextStepFile: './step-02-vision.md' outputFile: '{planning_artifacts}/product-brief-{{project_name}}-{{date}}.md' # Template References -productBriefTemplate: '{workflow_path}/product-brief.template.md' +productBriefTemplate: '../product-brief.template.md' --- # Step 1: Product Brief Initialization @@ -29,6 +24,7 @@ Initialize the product brief workflow by detecting continuation state and settin - 📖 CRITICAL: Read the complete step file before taking any action - 🔄 CRITICAL: When loading next step with 'C', ensure entire file is read - 📋 YOU ARE A FACILITATOR, not a content generator +- ✅ YOU MUST ALWAYS SPEAK OUTPUT In your Agent communication style with the config `{communication_language}` ### Role Reinforcement: @@ -67,7 +63,7 @@ First, check if the output document already exists: **Workflow State Detection:** -- Look for file at `{output_folder}/analysis/*product-brief*.md` +- Look for file `{outputFile}` - If exists, read the complete file including frontmatter - If not exists, this is a fresh workflow @@ -77,7 +73,7 @@ If the document exists and has frontmatter with `stepsCompleted`: **Continuation Protocol:** -- **STOP immediately** and load `{workflow_path}/steps/step-01b-continue.md` +- **STOP immediately** and load `./step-01b-continue.md` - Do not proceed with any initialization tasks - Let step-01b handle all continuation logic - This is an auto-proceed situation - no user choice needed @@ -88,47 +84,35 @@ If no document exists or no `stepsCompleted` in frontmatter: #### A. Input Document Discovery -Discover and load context documents using smart discovery: +load context documents using smart discovery. Documents can be in the following locations: +- {planning_artifacts}/** +- {output_folder}/** +- {product_knowledge}/** +- docs/** -**Research Documents (Priority: Sharded → Whole):** +Also - when searching - documents can be a single markdown file, or a folder with an index and multiple files. For Example, if searching for `*foo*.md` and not found, also search for a folder called *foo*/index.md (which indicates sharded content) -1. Check for sharded research folder: `{output_folder}/analysis/research/**/*.md` -2. If folder exists: Load EVERY file in that folder completely -3. If no folder exists: Try whole file: `{output_folder}/analysis/research/*research*.md` -4. Add discovered files to `inputDocuments` frontmatter +Try to discover the following: +- Brainstorming Reports (`*brainstorming*.md`) +- Research Documents (`*research*.md`) +- Project Documentation (generally multiple documents might be found for this in the `{product_knowledge}` or `docs` folder.) +- Project Context (`**/project-context.md`) -**Brainstorming Documents (Priority: Sharded → Whole):** +Confirm what you have found with the user, along with asking if the user wants to provide anything else. Only after this confirmation will you proceed to follow the loading rules -1. Check for sharded brainstorming folder: `{output_folder}/analysis/*brainstorm*/**/*.md` -2. If folder exists: Load useful brainstorming files completely -3. If no folder exists: Try whole file: `{output_folder}/analysis/*brainstorm*.md` -4. Add discovered files to `inputDocuments` frontmatter +**Loading Rules:** -**Project Documentation (Existing Projects):** - -1. Look for index file: `{output_folder}/**/index.md` -2. Load index.md to understand what project files are available -3. Read available files from index to understand existing project context -4. Add discovered files to `inputDocuments` frontmatter +- Load ALL discovered files completely that the user confirmed or provided (no offset/limit) +- If there is a project context, whatever is relevant should try to be biased in the remainder of this whole workflow process +- For sharded folders, load ALL files to get complete picture, using the index first to potentially know the potential of each document +- index.md is a guide to what's relevant whenever available +- Track all successfully loaded files in frontmatter `inputDocuments` array #### B. Create Initial Document **Document Setup:** -- Copy the template from `{productBriefTemplate}` to `{outputFile}` -- Initialize frontmatter with proper structure: - -```yaml ---- -stepsCompleted: [] -inputDocuments: [] -workflowType: 'product-brief' -lastStep: 0 -project_name: '{{project_name}}' -user_name: '{{user_name}}' -date: '{{date}}' ---- -``` +- Copy the template from `{productBriefTemplate}` to `{outputFile}`, and update the frontmatter fields #### C. Present Initialization Results @@ -145,6 +129,7 @@ date: '{{date}}' - Research: {number of research files loaded or "None found"} - Brainstorming: {number of brainstorming files loaded or "None found"} - Project docs: {number of project files loaded or "None found"} +- Project Context: {number of project context files loaded or "None found"} **Files loaded:** {list of specific file names or "No additional documents found"} diff --git a/src/modules/bmm/workflows/1-analysis/create-product-brief/steps/step-01b-continue.md b/src/modules/bmm/workflows/1-analysis/create-product-brief/steps/step-01b-continue.md index 437ac5a5..0d541b40 100644 --- a/src/modules/bmm/workflows/1-analysis/create-product-brief/steps/step-01b-continue.md +++ b/src/modules/bmm/workflows/1-analysis/create-product-brief/steps/step-01b-continue.md @@ -2,12 +2,7 @@ name: 'step-01b-continue' description: 'Resume the product brief workflow from where it was left off, ensuring smooth continuation' -# Path Definitions -workflow_path: '{project-root}/_bmad/bmm/workflows/1-analysis/create-product-brief' - # File References -thisStepFile: '{workflow_path}/steps/step-01b-continue.md' -workflowFile: '{workflow_path}/workflow.md' outputFile: '{planning_artifacts}/product-brief-{{project_name}}-{{date}}.md' --- @@ -25,6 +20,7 @@ Resume the product brief workflow from where it was left off, ensuring smooth co - 📖 CRITICAL: Read the complete step file before taking any action - 🔄 CRITICAL: When loading next step with 'C', ensure entire file is read - 📋 YOU ARE A FACILITATOR, not a content generator +- ✅ YOU MUST ALWAYS SPEAK OUTPUT In your Agent communication style with the config `{communication_language}` ### Role Reinforcement: diff --git a/src/modules/bmm/workflows/1-analysis/create-product-brief/steps/step-02-vision.md b/src/modules/bmm/workflows/1-analysis/create-product-brief/steps/step-02-vision.md index c28fa920..1df56977 100644 --- a/src/modules/bmm/workflows/1-analysis/create-product-brief/steps/step-02-vision.md +++ b/src/modules/bmm/workflows/1-analysis/create-product-brief/steps/step-02-vision.md @@ -2,17 +2,12 @@ name: 'step-02-vision' description: 'Discover and define the core product vision, problem statement, and unique value proposition' -# Path Definitions -workflow_path: '{project-root}/_bmad/bmm/workflows/1-analysis/create-product-brief' - # File References -thisStepFile: '{workflow_path}/steps/step-02-vision.md' -nextStepFile: '{workflow_path}/steps/step-03-users.md' -workflowFile: '{workflow_path}/workflow.md' +nextStepFile: './step-03-users.md' outputFile: '{planning_artifacts}/product-brief-{{project_name}}-{{date}}.md' # Task References -advancedElicitationTask: '{project-root}/_bmad/core/tasks/advanced-elicitation.xml' +advancedElicitationTask: '{project-root}/_bmad/core/workflows/advanced-elicitation/workflow.xml' partyModeWorkflow: '{project-root}/_bmad/core/workflows/party-mode/workflow.md' --- @@ -30,6 +25,7 @@ Conduct comprehensive product vision discovery to define the core problem, solut - 📖 CRITICAL: Read the complete step file before taking any action - 🔄 CRITICAL: When loading next step with 'C', ensure entire file is read - 📋 YOU ARE A FACILITATOR, not a content generator +- ✅ YOU MUST ALWAYS SPEAK OUTPUT In your Agent communication style with the config `{communication_language}` ### Role Reinforcement: diff --git a/src/modules/bmm/workflows/1-analysis/create-product-brief/steps/step-03-users.md b/src/modules/bmm/workflows/1-analysis/create-product-brief/steps/step-03-users.md index 14072a36..8493e7d2 100644 --- a/src/modules/bmm/workflows/1-analysis/create-product-brief/steps/step-03-users.md +++ b/src/modules/bmm/workflows/1-analysis/create-product-brief/steps/step-03-users.md @@ -2,17 +2,12 @@ name: 'step-03-users' description: 'Define target users with rich personas and map their key interactions with the product' -# Path Definitions -workflow_path: '{project-root}/_bmad/bmm/workflows/1-analysis/create-product-brief' - # File References -thisStepFile: '{workflow_path}/steps/step-03-users.md' -nextStepFile: '{workflow_path}/steps/step-04-metrics.md' -workflowFile: '{workflow_path}/workflow.md' +nextStepFile: './step-04-metrics.md' outputFile: '{planning_artifacts}/product-brief-{{project_name}}-{{date}}.md' # Task References -advancedElicitationTask: '{project-root}/_bmad/core/tasks/advanced-elicitation.xml' +advancedElicitationTask: '{project-root}/_bmad/core/workflows/advanced-elicitation/workflow.xml' partyModeWorkflow: '{project-root}/_bmad/core/workflows/party-mode/workflow.md' --- @@ -30,6 +25,7 @@ Define target users with rich personas and map their key interactions with the p - 📖 CRITICAL: Read the complete step file before taking any action - 🔄 CRITICAL: When loading next step with 'C', ensure entire file is read - 📋 YOU ARE A FACILITATOR, not a content generator +- ✅ YOU MUST ALWAYS SPEAK OUTPUT In your Agent communication style with the config `{communication_language}` ### Role Reinforcement: diff --git a/src/modules/bmm/workflows/1-analysis/create-product-brief/steps/step-04-metrics.md b/src/modules/bmm/workflows/1-analysis/create-product-brief/steps/step-04-metrics.md index 9d6de6ea..6a3dde46 100644 --- a/src/modules/bmm/workflows/1-analysis/create-product-brief/steps/step-04-metrics.md +++ b/src/modules/bmm/workflows/1-analysis/create-product-brief/steps/step-04-metrics.md @@ -2,17 +2,12 @@ name: 'step-04-metrics' description: 'Define comprehensive success metrics that include user success, business objectives, and key performance indicators' -# Path Definitions -workflow_path: '{project-root}/_bmad/bmm/workflows/1-analysis/create-product-brief' - # File References -thisStepFile: '{workflow_path}/steps/step-04-metrics.md' -nextStepFile: '{workflow_path}/steps/step-05-scope.md' -workflowFile: '{workflow_path}/workflow.md' +nextStepFile: './step-05-scope.md' outputFile: '{planning_artifacts}/product-brief-{{project_name}}-{{date}}.md' # Task References -advancedElicitationTask: '{project-root}/_bmad/core/tasks/advanced-elicitation.xml' +advancedElicitationTask: '{project-root}/_bmad/core/workflows/advanced-elicitation/workflow.xml' partyModeWorkflow: '{project-root}/_bmad/core/workflows/party-mode/workflow.md' --- @@ -30,6 +25,7 @@ Define comprehensive success metrics that include user success, business objecti - 📖 CRITICAL: Read the complete step file before taking any action - 🔄 CRITICAL: When loading next step with 'C', ensure entire file is read - 📋 YOU ARE A FACILITATOR, not a content generator +- ✅ YOU MUST ALWAYS SPEAK OUTPUT In your Agent communication style with the config `{communication_language}` ### Role Reinforcement: diff --git a/src/modules/bmm/workflows/1-analysis/create-product-brief/steps/step-05-scope.md b/src/modules/bmm/workflows/1-analysis/create-product-brief/steps/step-05-scope.md index 5b3bc6a5..b494f2d8 100644 --- a/src/modules/bmm/workflows/1-analysis/create-product-brief/steps/step-05-scope.md +++ b/src/modules/bmm/workflows/1-analysis/create-product-brief/steps/step-05-scope.md @@ -2,17 +2,12 @@ name: 'step-05-scope' description: 'Define MVP scope with clear boundaries and outline future vision while managing scope creep' -# Path Definitions -workflow_path: '{project-root}/_bmad/bmm/workflows/1-analysis/create-product-brief' - # File References -thisStepFile: '{workflow_path}/steps/step-05-scope.md' -nextStepFile: '{workflow_path}/steps/step-06-complete.md' -workflowFile: '{workflow_path}/workflow.md' +nextStepFile: './step-06-complete.md' outputFile: '{planning_artifacts}/product-brief-{{project_name}}-{{date}}.md' # Task References -advancedElicitationTask: '{project-root}/_bmad/core/tasks/advanced-elicitation.xml' +advancedElicitationTask: '{project-root}/_bmad/core/workflows/advanced-elicitation/workflow.xml' partyModeWorkflow: '{project-root}/_bmad/core/workflows/party-mode/workflow.md' --- @@ -30,6 +25,7 @@ Define MVP scope with clear boundaries and outline future vision through collabo - 📖 CRITICAL: Read the complete step file before taking any action - 🔄 CRITICAL: When loading next step with 'C', ensure entire file is read - 📋 YOU ARE A FACILITATOR, not a content generator +- ✅ YOU MUST ALWAYS SPEAK OUTPUT In your Agent communication style with the config `{communication_language}` ### Role Reinforcement: diff --git a/src/modules/bmm/workflows/1-analysis/create-product-brief/steps/step-06-complete.md b/src/modules/bmm/workflows/1-analysis/create-product-brief/steps/step-06-complete.md index fa586c9e..0c49da1e 100644 --- a/src/modules/bmm/workflows/1-analysis/create-product-brief/steps/step-06-complete.md +++ b/src/modules/bmm/workflows/1-analysis/create-product-brief/steps/step-06-complete.md @@ -2,12 +2,7 @@ name: 'step-06-complete' description: 'Complete the product brief workflow, update status files, and suggest next steps for the project' -# Path Definitions -workflow_path: '{project-root}/_bmad/bmm/workflows/1-analysis/create-product-brief' - # File References -thisStepFile: '{workflow_path}/steps/step-06-complete.md' -workflowFile: '{workflow_path}/workflow.md' outputFile: '{planning_artifacts}/product-brief-{{project_name}}-{{date}}.md' --- @@ -25,6 +20,7 @@ Complete the product brief workflow, update status files, and provide guidance o - 📖 CRITICAL: Read the complete step file before taking any action - 🔄 CRITICAL: When loading next step with 'C', ensure entire file is read - 📋 YOU ARE A FACILITATOR, not a content generator +- ✅ YOU MUST ALWAYS SPEAK OUTPUT In your Agent communication style with the config `{communication_language}` ### Role Reinforcement: diff --git a/src/modules/bmm/workflows/1-analysis/research/domain-steps/step-01-init.md b/src/modules/bmm/workflows/1-analysis/research/domain-steps/step-01-init.md index e8743d5a..27d056b1 100644 --- a/src/modules/bmm/workflows/1-analysis/research/domain-steps/step-01-init.md +++ b/src/modules/bmm/workflows/1-analysis/research/domain-steps/step-01-init.md @@ -10,6 +10,7 @@ - 📋 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: diff --git a/src/modules/bmm/workflows/1-analysis/research/domain-steps/step-02-domain-analysis.md b/src/modules/bmm/workflows/1-analysis/research/domain-steps/step-02-domain-analysis.md index 941ed423..bb4cbb63 100644 --- a/src/modules/bmm/workflows/1-analysis/research/domain-steps/step-02-domain-analysis.md +++ b/src/modules/bmm/workflows/1-analysis/research/domain-steps/step-02-domain-analysis.md @@ -11,6 +11,7 @@ - 💬 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: diff --git a/src/modules/bmm/workflows/1-analysis/research/domain-steps/step-03-competitive-landscape.md b/src/modules/bmm/workflows/1-analysis/research/domain-steps/step-03-competitive-landscape.md index 4efc4a5b..0dc2de6e 100644 --- a/src/modules/bmm/workflows/1-analysis/research/domain-steps/step-03-competitive-landscape.md +++ b/src/modules/bmm/workflows/1-analysis/research/domain-steps/step-03-competitive-landscape.md @@ -11,6 +11,7 @@ - 💬 FOCUS on key players, market share, and competitive 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: diff --git a/src/modules/bmm/workflows/1-analysis/research/domain-steps/step-04-regulatory-focus.md b/src/modules/bmm/workflows/1-analysis/research/domain-steps/step-04-regulatory-focus.md index db7bcb71..e98010c7 100644 --- a/src/modules/bmm/workflows/1-analysis/research/domain-steps/step-04-regulatory-focus.md +++ b/src/modules/bmm/workflows/1-analysis/research/domain-steps/step-04-regulatory-focus.md @@ -11,6 +11,7 @@ - 💬 FOCUS on compliance requirements and regulatory landscape - 🔍 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: diff --git a/src/modules/bmm/workflows/1-analysis/research/domain-steps/step-05-technical-trends.md b/src/modules/bmm/workflows/1-analysis/research/domain-steps/step-05-technical-trends.md index ba46ebb8..55e834cd 100644 --- a/src/modules/bmm/workflows/1-analysis/research/domain-steps/step-05-technical-trends.md +++ b/src/modules/bmm/workflows/1-analysis/research/domain-steps/step-05-technical-trends.md @@ -11,6 +11,7 @@ - 💬 FOCUS on emerging technologies and innovation patterns - 🔍 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: diff --git a/src/modules/bmm/workflows/1-analysis/research/domain-steps/step-06-research-synthesis.md b/src/modules/bmm/workflows/1-analysis/research/domain-steps/step-06-research-synthesis.md index 8ce2eee5..1c7db8c0 100644 --- a/src/modules/bmm/workflows/1-analysis/research/domain-steps/step-06-research-synthesis.md +++ b/src/modules/bmm/workflows/1-analysis/research/domain-steps/step-06-research-synthesis.md @@ -11,6 +11,7 @@ - 💬 FOCUS on comprehensive synthesis and authoritative conclusions - 🔍 WEB SEARCH REQUIRED - verify current facts against live sources - 📄 PRODUCE COMPREHENSIVE DOCUMENT with narrative intro, TOC, and summary +- ✅ YOU MUST ALWAYS SPEAK OUTPUT In your Agent communication style with the config `{communication_language}` ## EXECUTION PROTOCOLS: diff --git a/src/modules/bmm/workflows/1-analysis/research/market-steps/step-01-init.md b/src/modules/bmm/workflows/1-analysis/research/market-steps/step-01-init.md index c1bf6262..a3772a9b 100644 --- a/src/modules/bmm/workflows/1-analysis/research/market-steps/step-01-init.md +++ b/src/modules/bmm/workflows/1-analysis/research/market-steps/step-01-init.md @@ -9,6 +9,7 @@ - 🔍 NO WEB RESEARCH in init - that's for later steps - 📖 CRITICAL: ALWAYS read the complete step file before taking any action - partial understanding leads to incomplete research - 🔄 CRITICAL: When loading next step with 'C', ensure the entire file is read and understood before proceeding +- ✅ YOU MUST ALWAYS SPEAK OUTPUT In your Agent communication style with the config `{communication_language}` ## EXECUTION PROTOCOLS: diff --git a/src/modules/bmm/workflows/1-analysis/research/market-steps/step-02-customer-behavior.md b/src/modules/bmm/workflows/1-analysis/research/market-steps/step-02-customer-behavior.md index 330dd2f0..f707a0a3 100644 --- a/src/modules/bmm/workflows/1-analysis/research/market-steps/step-02-customer-behavior.md +++ b/src/modules/bmm/workflows/1-analysis/research/market-steps/step-02-customer-behavior.md @@ -10,6 +10,7 @@ - 📝 WRITE CONTENT IMMEDIATELY TO DOCUMENT - 📖 CRITICAL: ALWAYS read the complete step file before taking any action - partial understanding leads to incomplete research - 🔄 CRITICAL: When loading next step with 'C', ensure the entire file is read and understood before proceeding +- ✅ YOU MUST ALWAYS SPEAK OUTPUT In your Agent communication style with the config `{communication_language}` ## EXECUTION PROTOCOLS: diff --git a/src/modules/bmm/workflows/1-analysis/research/market-steps/step-02-customer-insights.md b/src/modules/bmm/workflows/1-analysis/research/market-steps/step-02-customer-insights.md index 4a0e9633..c6d7ea32 100644 --- a/src/modules/bmm/workflows/1-analysis/research/market-steps/step-02-customer-insights.md +++ b/src/modules/bmm/workflows/1-analysis/research/market-steps/step-02-customer-insights.md @@ -10,6 +10,7 @@ - 📋 YOU ARE A CUSTOMER INSIGHTS ANALYST, not content generator - 💬 FOCUS on customer behavior and needs analysis - 🔍 WEB SEARCH REQUIRED - verify current facts against live sources +- ✅ YOU MUST ALWAYS SPEAK OUTPUT In your Agent communication style with the config `{communication_language}` ## EXECUTION PROTOCOLS: diff --git a/src/modules/bmm/workflows/1-analysis/research/market-steps/step-03-customer-pain-points.md b/src/modules/bmm/workflows/1-analysis/research/market-steps/step-03-customer-pain-points.md index a706f16d..f4d2ae6d 100644 --- a/src/modules/bmm/workflows/1-analysis/research/market-steps/step-03-customer-pain-points.md +++ b/src/modules/bmm/workflows/1-analysis/research/market-steps/step-03-customer-pain-points.md @@ -11,6 +11,7 @@ - 💬 FOCUS on customer pain points, challenges, and unmet needs - 🔍 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: diff --git a/src/modules/bmm/workflows/1-analysis/research/market-steps/step-04-customer-decisions.md b/src/modules/bmm/workflows/1-analysis/research/market-steps/step-04-customer-decisions.md index a8ee8335..21544335 100644 --- a/src/modules/bmm/workflows/1-analysis/research/market-steps/step-04-customer-decisions.md +++ b/src/modules/bmm/workflows/1-analysis/research/market-steps/step-04-customer-decisions.md @@ -11,6 +11,7 @@ - 💬 FOCUS on customer decision processes and journey mapping - 🔍 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: diff --git a/src/modules/bmm/workflows/1-analysis/research/market-steps/step-05-competitive-analysis.md b/src/modules/bmm/workflows/1-analysis/research/market-steps/step-05-competitive-analysis.md index ff265e20..d7387a4f 100644 --- a/src/modules/bmm/workflows/1-analysis/research/market-steps/step-05-competitive-analysis.md +++ b/src/modules/bmm/workflows/1-analysis/research/market-steps/step-05-competitive-analysis.md @@ -10,6 +10,7 @@ - 📋 YOU ARE A COMPETITIVE ANALYST, not content generator - 💬 FOCUS on competitive landscape and market positioning - 🔍 WEB SEARCH REQUIRED - verify current facts against live sources +- ✅ YOU MUST ALWAYS SPEAK OUTPUT In your Agent communication style with the config `{communication_language}` ## EXECUTION PROTOCOLS: diff --git a/src/modules/bmm/workflows/1-analysis/research/market-steps/step-06-research-completion.md b/src/modules/bmm/workflows/1-analysis/research/market-steps/step-06-research-completion.md index 53b03f77..42d7d7d9 100644 --- a/src/modules/bmm/workflows/1-analysis/research/market-steps/step-06-research-completion.md +++ b/src/modules/bmm/workflows/1-analysis/research/market-steps/step-06-research-completion.md @@ -10,6 +10,7 @@ - 📋 YOU ARE A MARKET RESEARCH STRATEGIST, not content generator - 💬 FOCUS on strategic recommendations and actionable insights - 🔍 WEB SEARCH REQUIRED - verify current facts against live sources +- ✅ YOU MUST ALWAYS SPEAK OUTPUT In your Agent communication style with the config `{communication_language}` ## EXECUTION PROTOCOLS: diff --git a/src/modules/bmm/workflows/1-analysis/research/technical-steps/step-01-init.md b/src/modules/bmm/workflows/1-analysis/research/technical-steps/step-01-init.md index 1bbf9238..b286822d 100644 --- a/src/modules/bmm/workflows/1-analysis/research/technical-steps/step-01-init.md +++ b/src/modules/bmm/workflows/1-analysis/research/technical-steps/step-01-init.md @@ -10,6 +10,7 @@ - 📋 YOU ARE A TECHNICAL RESEARCH PLANNER, not content generator - 💬 ACKNOWLEDGE and CONFIRM understanding of technical 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: diff --git a/src/modules/bmm/workflows/1-analysis/research/technical-steps/step-02-technical-overview.md b/src/modules/bmm/workflows/1-analysis/research/technical-steps/step-02-technical-overview.md index 631bf1f1..78151eb0 100644 --- a/src/modules/bmm/workflows/1-analysis/research/technical-steps/step-02-technical-overview.md +++ b/src/modules/bmm/workflows/1-analysis/research/technical-steps/step-02-technical-overview.md @@ -11,6 +11,7 @@ - 💬 FOCUS on languages, frameworks, tools, and platforms - 🔍 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: diff --git a/src/modules/bmm/workflows/1-analysis/research/technical-steps/step-03-integration-patterns.md b/src/modules/bmm/workflows/1-analysis/research/technical-steps/step-03-integration-patterns.md index 185c0881..68e2b70f 100644 --- a/src/modules/bmm/workflows/1-analysis/research/technical-steps/step-03-integration-patterns.md +++ b/src/modules/bmm/workflows/1-analysis/research/technical-steps/step-03-integration-patterns.md @@ -11,6 +11,7 @@ - 💬 FOCUS on APIs, protocols, and system interoperability - 🔍 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: diff --git a/src/modules/bmm/workflows/1-analysis/research/technical-steps/step-04-architectural-patterns.md b/src/modules/bmm/workflows/1-analysis/research/technical-steps/step-04-architectural-patterns.md index 6567285a..426cc662 100644 --- a/src/modules/bmm/workflows/1-analysis/research/technical-steps/step-04-architectural-patterns.md +++ b/src/modules/bmm/workflows/1-analysis/research/technical-steps/step-04-architectural-patterns.md @@ -11,6 +11,7 @@ - 💬 FOCUS on architectural patterns and design decisions - 🔍 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: diff --git a/src/modules/bmm/workflows/1-analysis/research/technical-steps/step-05-implementation-research.md b/src/modules/bmm/workflows/1-analysis/research/technical-steps/step-05-implementation-research.md index 219b231b..7117d525 100644 --- a/src/modules/bmm/workflows/1-analysis/research/technical-steps/step-05-implementation-research.md +++ b/src/modules/bmm/workflows/1-analysis/research/technical-steps/step-05-implementation-research.md @@ -10,6 +10,7 @@ - 📋 YOU ARE AN IMPLEMENTATION ENGINEER, not content generator - 💬 FOCUS on implementation approaches and technology adoption - 🔍 WEB SEARCH REQUIRED - verify current facts against live sources +- ✅ YOU MUST ALWAYS SPEAK OUTPUT In your Agent communication style with the config `{communication_language}` ## EXECUTION PROTOCOLS: diff --git a/src/modules/bmm/workflows/1-analysis/research/technical-steps/step-06-research-synthesis.md b/src/modules/bmm/workflows/1-analysis/research/technical-steps/step-06-research-synthesis.md index 6e83cc86..7dc28a2d 100644 --- a/src/modules/bmm/workflows/1-analysis/research/technical-steps/step-06-research-synthesis.md +++ b/src/modules/bmm/workflows/1-analysis/research/technical-steps/step-06-research-synthesis.md @@ -11,6 +11,7 @@ - 💬 FOCUS on comprehensive technical synthesis and authoritative conclusions - 🔍 WEB SEARCH REQUIRED - verify current facts against live sources - 📄 PRODUCE COMPREHENSIVE DOCUMENT with narrative intro, TOC, and summary +- ✅ YOU MUST ALWAYS SPEAK OUTPUT In your Agent communication style with the config `{communication_language}` ## EXECUTION PROTOCOLS: diff --git a/src/modules/bmm/workflows/1-analysis/research/workflow.md b/src/modules/bmm/workflows/1-analysis/research/workflow.md index 9af85058..64f62bef 100644 --- a/src/modules/bmm/workflows/1-analysis/research/workflow.md +++ b/src/modules/bmm/workflows/1-analysis/research/workflow.md @@ -145,7 +145,7 @@ After understanding the research topic and goals, identify the most appropriate ### Research Type Routing -Based on user selection, route to appropriate sub-workflow with the discovered topic using the following IF block sets of instructions. +Based on user selection, route to appropriate sub-workflow with the discovered topic using the following IF block sets of instructions. YOU MUST ALWAYS SPEAK OUTPUT In your Agent communication style with the config `{communication_language}` #### If Market Research: diff --git a/src/modules/bmm/workflows/2-plan-workflows/create-ux-design/steps/step-01-init.md b/src/modules/bmm/workflows/2-plan-workflows/create-ux-design/steps/step-01-init.md index 86896990..62969baf 100644 --- a/src/modules/bmm/workflows/2-plan-workflows/create-ux-design/steps/step-01-init.md +++ b/src/modules/bmm/workflows/2-plan-workflows/create-ux-design/steps/step-01-init.md @@ -10,6 +10,7 @@ - 📋 YOU ARE A UX FACILITATOR, not a content generator - 💬 FOCUS on initialization and setup only - don't look ahead to future steps - 🚪 DETECT existing workflow state and handle continuation properly +- ✅ YOU MUST ALWAYS SPEAK OUTPUT In your Agent communication style with the config `{communication_language}` ## EXECUTION PROTOCOLS: @@ -35,7 +36,7 @@ Initialize the UX design workflow by detecting continuation state and setting up First, check if the output document already exists: -- Look for file at `{planning_artifacts}/ux-design-specification.md` +- Look for file at `{planning_artifacts}/*ux-design-specification*.md` - If exists, read the complete file including frontmatter - If not exists, this is a fresh workflow @@ -53,59 +54,34 @@ If no document exists or no `stepsCompleted` in frontmatter: #### A. Input Document Discovery -Discover and load context documents using smart discovery: +Discover and load context documents using smart discovery. Documents can be in the following locations: +- {planning_artifacts}/** +- {output_folder}/** +- {product_knowledge}/** +- docs/** -**PRD (Priority: Analysis → Main → Sharded → Whole):** +Also - when searching - documents can be a single markdown file, or a folder with an index and multiple files. For Example, if searching for `*foo*.md` and not found, also search for a folder called *foo*/index.md (which indicates sharded content) -1. Check analysis folder: `{planning_artifacts}/*prd*.md` -2. If no files: Try main folder: `{output_folder}/*prd*.md` -3. If no main files: Check for sharded PRD folder: `**/*prd*/**/*.md` -4. If sharded folder exists: Load EVERY file in that folder completely for UX context -5. Add discovered files to `inputDocuments` frontmatter +Try to discover the following: +- Product Brief (`*brief*.md`) +- Research Documents (`*prd*.md`) +- Project Documentation (generally multiple documents might be found for this in the `{product_knowledge}` or `docs` folder.) +- Project Context (`**/project-context.md`) -**Product Brief (Priority: Analysis → Main → Sharded → Whole):** - -1. Check analysis folder: `{planning_artifacts}/*brief*.md` -2. If no analysis files: Try main folder: `{output_folder}/*brief*.md` -3. If no main files: Check for sharded brief folder: `**/*brief*/**/*.md` -4. If sharded folder exists: Load EVERY file in that folder completely -5. Add discovered files to `inputDocuments` frontmatter - -**Research Documents (Priority: Analysis → Main → Sharded → Whole):** - -1. Check analysis folder: `{planning_artifacts}/research/*research*.md` -2. If no analysis files: Try main folder: `{output_folder}/*research*.md` -3. If no main files: Check for sharded research folder: `{output_folder}/*research*/**/*.md` -4. Load useful research files completely -5. Add discovered files to `inputDocuments` frontmatter - -**Other Context (Priority: Analysis → Main → Sharded):** - -- Epics: `{output_folder}/analysis/*epic*.md` or `{output_folder}/*epic*.md` or `{output_folder}/*epic*/**/*.md` -- Brainstorming: `{output_folder}/analysis/brainstorming/*brainstorming*.md` or `{output_folder}/*brainstorming*.md` +Confirm what you have found with the user, along with asking if the user wants to provide anything else. Only after this confirmation will you proceed to follow the loading rules **Loading Rules:** -- Load ALL discovered files completely (no offset/limit) -- For sharded folders, load ALL files to get complete picture +- Load ALL discovered files completely that the user confirmed or provided (no offset/limit) +- If there is a project context, whatever is relevant should try to be biased in the remainder of this whole workflow process +- For sharded folders, load ALL files to get complete picture, using the index first to potentially know the potential of each document +- index.md is a guide to what's relevant whenever available - Track all successfully loaded files in frontmatter `inputDocuments` array #### B. Create Initial Document Copy the template from `{installed_path}/ux-design-template.md` to `{planning_artifacts}/ux-design-specification.md` -Initialize frontmatter with: - -```yaml ---- -stepsCompleted: [] -inputDocuments: [] -workflowType: 'ux-design' -lastStep: 0 -project_name: '{{project_name}}' -user_name: '{{user_name}}' -date: '{{date}}' ---- -``` +Initialize frontmatter in the template. #### C. Complete Initialization and Report @@ -134,7 +110,7 @@ Do you have any other documents you'd like me to include, or shall we continue t ## NEXT STEP: -After user selects [C] to continue, load `./step-02-discovery.md` to begin the UX discovery phase. +After user selects [C] to continue, ensure the file `{planning_artifacts}/ux-design-specification.md` has been created and saved, and then load `./step-02-discovery.md` to begin the UX discovery phase. Remember: Do NOT proceed to step-02 until output file has been updated and user explicitly selects [C] to continue! diff --git a/src/modules/bmm/workflows/2-plan-workflows/create-ux-design/steps/step-01b-continue.md b/src/modules/bmm/workflows/2-plan-workflows/create-ux-design/steps/step-01b-continue.md index 84933913..3d0f647e 100644 --- a/src/modules/bmm/workflows/2-plan-workflows/create-ux-design/steps/step-01b-continue.md +++ b/src/modules/bmm/workflows/2-plan-workflows/create-ux-design/steps/step-01b-continue.md @@ -10,6 +10,7 @@ - 📋 YOU ARE A UX FACILITATOR, not a content generator - 💬 FOCUS on understanding where we left off and continuing appropriately - 🚪 RESUME workflow from exact point where it was interrupted +- ✅ YOU MUST ALWAYS SPEAK OUTPUT In your Agent communication style with the config `{communication_language}` ## EXECUTION PROTOCOLS: diff --git a/src/modules/bmm/workflows/2-plan-workflows/create-ux-design/steps/step-02-discovery.md b/src/modules/bmm/workflows/2-plan-workflows/create-ux-design/steps/step-02-discovery.md index ce6f8ea8..7acc5f84 100644 --- a/src/modules/bmm/workflows/2-plan-workflows/create-ux-design/steps/step-02-discovery.md +++ b/src/modules/bmm/workflows/2-plan-workflows/create-ux-design/steps/step-02-discovery.md @@ -10,13 +10,14 @@ - 📋 YOU ARE A UX FACILITATOR, not a content generator - 💬 FOCUS on understanding project context and user needs - 🎯 COLLABORATIVE discovery, not assumption-based design +- ✅ 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 A/P/C menu after generating project understanding content - 💾 ONLY save when user chooses C (Continue) -- 📖 Update frontmatter `stepsCompleted: [1, 2]` before loading next step +- 📖 Update output file frontmatter, adding this step to the end of the list of stepsCompleted. - 🚫 FORBIDDEN to load next step until C is selected ## COLLABORATION MENUS (A/P/C): @@ -29,7 +30,7 @@ This step will generate content and present choices: ## PROTOCOL INTEGRATION: -- When 'A' selected: Execute {project-root}/_bmad/core/tasks/advanced-elicitation.xml +- When 'A' selected: Execute {project-root}/_bmad/core/workflows/advanced-elicitation/workflow.xml - When 'P' selected: Execute {project-root}/_bmad/core/workflows/party-mode/workflow.md - PROTOCOLS always return to this step's A/P/C menu - User accepts/rejects protocol changes before proceeding diff --git a/src/modules/bmm/workflows/2-plan-workflows/create-ux-design/steps/step-03-core-experience.md b/src/modules/bmm/workflows/2-plan-workflows/create-ux-design/steps/step-03-core-experience.md index ac4bc45e..593ca02a 100644 --- a/src/modules/bmm/workflows/2-plan-workflows/create-ux-design/steps/step-03-core-experience.md +++ b/src/modules/bmm/workflows/2-plan-workflows/create-ux-design/steps/step-03-core-experience.md @@ -10,13 +10,14 @@ - 📋 YOU ARE A UX FACILITATOR, not a content generator - 💬 FOCUS on defining the core user experience and platform - 🎯 COLLABORATIVE discovery, not assumption-based design +- ✅ 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 A/P/C menu after generating core experience content - 💾 ONLY save when user chooses C (Continue) -- 📖 Update frontmatter `stepsCompleted: [1, 2, 3]` before loading next step +- 📖 Update output file frontmatter, adding this step to the end of the list of stepsCompleted. - 🚫 FORBIDDEN to load next step until C is selected ## COLLABORATION MENUS (A/P/C): @@ -29,7 +30,7 @@ This step will generate content and present choices: ## PROTOCOL INTEGRATION: -- When 'A' selected: Execute {project-root}/_bmad/core/tasks/advanced-elicitation.xml +- When 'A' selected: Execute {project-root}/_bmad/core/workflows/advanced-elicitation/workflow.xml - When 'P' selected: Execute {project-root}/_bmad/core/workflows/party-mode/workflow.md - PROTOCOLS always return to this step's A/P/C menu - User accepts/rejects protocol changes before proceeding @@ -160,7 +161,7 @@ Show the generated core experience content and present choices: #### If 'A' (Advanced Elicitation): -- Execute {project-root}/_bmad/core/tasks/advanced-elicitation.xml with the current core experience content +- Execute {project-root}/_bmad/core/workflows/advanced-elicitation/workflow.xml with the current core experience content - Process the enhanced experience insights that come back - Ask user: "Accept these improvements to the core experience definition? (y/n)" - If yes: Update content with improvements, then return to A/P/C menu @@ -177,7 +178,7 @@ Show the generated core experience content and present choices: #### If 'C' (Continue): - Append the final content to `{planning_artifacts}/ux-design-specification.md` -- Update frontmatter: `stepsCompleted: [1, 2, 3]` +- Update frontmatter: append step to end of stepsCompleted array - Load `./step-04-emotional-response.md` ## APPEND TO DOCUMENT: diff --git a/src/modules/bmm/workflows/2-plan-workflows/create-ux-design/steps/step-04-emotional-response.md b/src/modules/bmm/workflows/2-plan-workflows/create-ux-design/steps/step-04-emotional-response.md index 165b20ba..97a5c1a2 100644 --- a/src/modules/bmm/workflows/2-plan-workflows/create-ux-design/steps/step-04-emotional-response.md +++ b/src/modules/bmm/workflows/2-plan-workflows/create-ux-design/steps/step-04-emotional-response.md @@ -10,13 +10,14 @@ - 📋 YOU ARE A UX FACILITATOR, not a content generator - 💬 FOCUS on defining desired emotional responses and user feelings - 🎯 COLLABORATIVE discovery, not assumption-based design +- ✅ 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 A/P/C menu after generating emotional response content - 💾 ONLY save when user chooses C (Continue) -- 📖 Update frontmatter `stepsCompleted: [1, 2, 3, 4]` before loading next step +- 📖 Update output file frontmatter, adding this step to the end of the list of stepsCompleted. - 🚫 FORBIDDEN to load next step until C is selected ## COLLABORATION MENUS (A/P/C): @@ -29,7 +30,7 @@ This step will generate content and present choices: ## PROTOCOL INTEGRATION: -- When 'A' selected: Execute {project-root}/_bmad/core/tasks/advanced-elicitation.xml +- When 'A' selected: Execute {project-root}/_bmad/core/workflows/advanced-elicitation/workflow.xml - When 'P' selected: Execute {project-root}/_bmad/core/workflows/party-mode/workflow.md - PROTOCOLS always return to this step's A/P/C menu - User accepts/rejects protocol changes before proceeding @@ -163,7 +164,7 @@ Show the generated emotional response content and present choices: #### If 'A' (Advanced Elicitation): -- Execute {project-root}/_bmad/core/tasks/advanced-elicitation.xml with the current emotional response content +- Execute {project-root}/_bmad/core/workflows/advanced-elicitation/workflow.xml with the current emotional response content - Process the enhanced emotional insights that come back - Ask user: "Accept these improvements to the emotional response definition? (y/n)" - If yes: Update content with improvements, then return to A/P/C menu @@ -180,7 +181,7 @@ Show the generated emotional response content and present choices: #### If 'C' (Continue): - Append the final content to `{planning_artifacts}/ux-design-specification.md` -- Update frontmatter: `stepsCompleted: [1, 2, 3, 4]` +- Update frontmatter: append step to end of stepsCompleted array - Load `./step-05-inspiration.md` ## APPEND TO DOCUMENT: diff --git a/src/modules/bmm/workflows/2-plan-workflows/create-ux-design/steps/step-05-inspiration.md b/src/modules/bmm/workflows/2-plan-workflows/create-ux-design/steps/step-05-inspiration.md index a98b0bbc..2307fbdb 100644 --- a/src/modules/bmm/workflows/2-plan-workflows/create-ux-design/steps/step-05-inspiration.md +++ b/src/modules/bmm/workflows/2-plan-workflows/create-ux-design/steps/step-05-inspiration.md @@ -10,13 +10,14 @@ - 📋 YOU ARE A UX FACILITATOR, not a content generator - 💬 FOCUS on analyzing existing UX patterns and extracting inspiration - 🎯 COLLABORATIVE discovery, not assumption-based design +- ✅ 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 A/P/C menu after generating inspiration analysis content - 💾 ONLY save when user chooses C (Continue) -- 📖 Update frontmatter `stepsCompleted: [1, 2, 3, 4, 5]` before loading next step +- 📖 Update output file frontmatter, adding this step to the end of the list of stepsCompleted. - 🚫 FORBIDDEN to load next step until C is selected ## COLLABORATION MENUS (A/P/C): @@ -29,7 +30,7 @@ This step will generate content and present choices: ## PROTOCOL INTEGRATION: -- When 'A' selected: Execute {project-root}/_bmad/core/tasks/advanced-elicitation.xml +- When 'A' selected: Execute {project-root}/_bmad/core/workflows/advanced-elicitation/workflow.xml - When 'P' selected: Execute {project-root}/_bmad/core/workflows/party-mode/workflow.md - PROTOCOLS always return to this step's A/P/C menu - User accepts/rejects protocol changes before proceeding @@ -178,7 +179,7 @@ Show the generated inspiration analysis content and present choices: #### If 'A' (Advanced Elicitation): -- Execute {project-root}/_bmad/core/tasks/advanced-elicitation.xml with the current inspiration analysis content +- Execute {project-root}/_bmad/core/workflows/advanced-elicitation/workflow.xml with the current inspiration analysis content - Process the enhanced pattern insights that come back - Ask user: "Accept these improvements to the inspiration analysis? (y/n)" - If yes: Update content with improvements, then return to A/P/C menu @@ -195,7 +196,7 @@ Show the generated inspiration analysis content and present choices: #### If 'C' (Continue): - Append the final content to `{planning_artifacts}/ux-design-specification.md` -- Update frontmatter: `stepsCompleted: [1, 2, 3, 4, 5]` +- Update frontmatter: append step to end of stepsCompleted array - Load and execute`./step-06-design-system.md` ## APPEND TO DOCUMENT: diff --git a/src/modules/bmm/workflows/2-plan-workflows/create-ux-design/steps/step-06-design-system.md b/src/modules/bmm/workflows/2-plan-workflows/create-ux-design/steps/step-06-design-system.md index e0f0741d..f9375d19 100644 --- a/src/modules/bmm/workflows/2-plan-workflows/create-ux-design/steps/step-06-design-system.md +++ b/src/modules/bmm/workflows/2-plan-workflows/create-ux-design/steps/step-06-design-system.md @@ -10,13 +10,14 @@ - 📋 YOU ARE A UX FACILITATOR, not a content generator - 💬 FOCUS on choosing appropriate design system approach - 🎯 COLLABORATIVE decision-making, not recommendation-only +- ✅ 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 A/P/C menu after generating design system decision content - 💾 ONLY save when user chooses C (Continue) -- 📖 Update frontmatter `stepsCompleted: [1, 2, 3, 4, 5, 6]` before loading next step +- 📖 Update output file frontmatter, adding this step to the end of the list of stepsCompleted. - 🚫 FORBIDDEN to load next step until C is selected ## COLLABORATION MENUS (A/P/C): @@ -29,7 +30,7 @@ This step will generate content and present choices: ## PROTOCOL INTEGRATION: -- When 'A' selected: Execute {project-root}/_bmad/core/tasks/advanced-elicitation.xml +- When 'A' selected: Execute {project-root}/_bmad/core/workflows/advanced-elicitation/workflow.xml - When 'P' selected: Execute {project-root}/_bmad/core/workflows/party-mode/workflow.md - PROTOCOLS always return to this step's A/P/C menu - User accepts/rejects protocol changes before proceeding @@ -196,7 +197,7 @@ Show the generated design system content and present choices: #### If 'A' (Advanced Elicitation): -- Execute {project-root}/_bmad/core/tasks/advanced-elicitation.xml with the current design system content +- Execute {project-root}/_bmad/core/workflows/advanced-elicitation/workflow.xml with the current design system content - Process the enhanced design system insights that come back - Ask user: "Accept these improvements to the design system decision? (y/n)" - If yes: Update content with improvements, then return to A/P/C menu @@ -213,7 +214,7 @@ Show the generated design system content and present choices: #### If 'C' (Continue): - Append the final content to `{planning_artifacts}/ux-design-specification.md` -- Update frontmatter: `stepsCompleted: [1, 2, 3, 4, 5, 6]` +- Update frontmatter: append step to end of stepsCompleted array - Load `./step-07-defining-experience.md` ## APPEND TO DOCUMENT: diff --git a/src/modules/bmm/workflows/2-plan-workflows/create-ux-design/steps/step-07-defining-experience.md b/src/modules/bmm/workflows/2-plan-workflows/create-ux-design/steps/step-07-defining-experience.md index d2afb46c..c67f2126 100644 --- a/src/modules/bmm/workflows/2-plan-workflows/create-ux-design/steps/step-07-defining-experience.md +++ b/src/modules/bmm/workflows/2-plan-workflows/create-ux-design/steps/step-07-defining-experience.md @@ -10,13 +10,14 @@ - 📋 YOU ARE A UX FACILITATOR, not a content generator - 💬 FOCUS on defining the core interaction that defines the product - 🎯 COLLABORATIVE discovery, not assumption-based design +- ✅ 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 A/P/C menu after generating defining experience content - 💾 ONLY save when user chooses C (Continue) -- 📖 Update frontmatter `stepsCompleted: [1, 2, 3, 4, 5, 6, 7]` before loading next step +- 📖 Update output file frontmatter, adding this step to the end of the list of stepsCompleted. - 🚫 FORBIDDEN to load next step until C is selected ## COLLABORATION MENUS (A/P/C): @@ -29,7 +30,7 @@ This step will generate content and present choices: ## PROTOCOL INTEGRATION: -- When 'A' selected: Execute {project-root}/_bmad/core/tasks/advanced-elicitation.xml +- When 'A' selected: Execute {project-root}/_bmad/core/workflows/advanced-elicitation/workflow.xml - When 'P' selected: Execute {project-root}/_bmad/core/workflows/party-mode/workflow.md - PROTOCOLS always return to this step's A/P/C menu - User accepts/rejects protocol changes before proceeding @@ -198,7 +199,7 @@ Show the generated defining experience content and present choices: #### If 'A' (Advanced Elicitation): -- Execute {project-root}/_bmad/core/tasks/advanced-elicitation.xml with the current defining experience content +- Execute {project-root}/_bmad/core/workflows/advanced-elicitation/workflow.xml with the current defining experience content - Process the enhanced experience insights that come back - Ask user: "Accept these improvements to the defining experience? (y/n)" - If yes: Update content with improvements, then return to A/P/C menu @@ -215,7 +216,7 @@ Show the generated defining experience content and present choices: #### If 'C' (Continue): - Append the final content to `{planning_artifacts}/ux-design-specification.md` -- Update frontmatter: `stepsCompleted: [1, 2, 3, 4, 5, 6, 7]` +- Update frontmatter: append step to end of stepsCompleted array - Load `./step-08-visual-foundation.md` ## APPEND TO DOCUMENT: diff --git a/src/modules/bmm/workflows/2-plan-workflows/create-ux-design/steps/step-08-visual-foundation.md b/src/modules/bmm/workflows/2-plan-workflows/create-ux-design/steps/step-08-visual-foundation.md index d9445771..aa930104 100644 --- a/src/modules/bmm/workflows/2-plan-workflows/create-ux-design/steps/step-08-visual-foundation.md +++ b/src/modules/bmm/workflows/2-plan-workflows/create-ux-design/steps/step-08-visual-foundation.md @@ -10,13 +10,14 @@ - 📋 YOU ARE A UX FACILITATOR, not a content generator - 💬 FOCUS on establishing visual design foundation (colors, typography, spacing) - 🎯 COLLABORATIVE discovery, not assumption-based design +- ✅ 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 A/P/C menu after generating visual foundation content - 💾 ONLY save when user chooses C (Continue) -- 📖 Update frontmatter `stepsCompleted: [1, 2, 3, 4, 5, 6, 7, 8]` before loading next step +- 📖 Update output file frontmatter, adding this step to the end of the list of stepsCompleted. - 🚫 FORBIDDEN to load next step until C is selected ## COLLABORATION MENUS (A/P/C): @@ -29,7 +30,7 @@ This step will generate content and present choices: ## PROTOCOL INTEGRATION: -- When 'A' selected: Execute {project-root}/_bmad/core/tasks/advanced-elicitation.xml +- When 'A' selected: Execute {project-root}/_bmad/core/workflows/advanced-elicitation/workflow.xml - When 'P' selected: Execute {project-root}/_bmad/core/workflows/party-mode/workflow.md - PROTOCOLS always return to this step's A/P/C menu - User accepts/rejects protocol changes before proceeding @@ -168,7 +169,7 @@ Show the generated visual foundation content and present choices: #### If 'A' (Advanced Elicitation): -- Execute {project-root}/_bmad/core/tasks/advanced-elicitation.xml with the current visual foundation content +- Execute {project-root}/_bmad/core/workflows/advanced-elicitation/workflow.xml with the current visual foundation content - Process the enhanced visual insights that come back - Ask user: "Accept these improvements to the visual foundation? (y/n)" - If yes: Update content with improvements, then return to A/P/C menu @@ -185,7 +186,7 @@ Show the generated visual foundation content and present choices: #### If 'C' (Continue): - Append the final content to `{planning_artifacts}/ux-design-specification.md` -- Update frontmatter: `stepsCompleted: [1, 2, 3, 4, 5, 6, 7, 8]` +- Update frontmatter: append step to end of stepsCompleted array - Load `./step-09-design-directions.md` ## APPEND TO DOCUMENT: diff --git a/src/modules/bmm/workflows/2-plan-workflows/create-ux-design/steps/step-09-design-directions.md b/src/modules/bmm/workflows/2-plan-workflows/create-ux-design/steps/step-09-design-directions.md index 188a31ed..f1cfceee 100644 --- a/src/modules/bmm/workflows/2-plan-workflows/create-ux-design/steps/step-09-design-directions.md +++ b/src/modules/bmm/workflows/2-plan-workflows/create-ux-design/steps/step-09-design-directions.md @@ -10,13 +10,14 @@ - 📋 YOU ARE A UX FACILITATOR, not a content generator - 💬 FOCUS on generating and evaluating design direction variations - 🎯 COLLABORATIVE exploration, not assumption-based design +- ✅ 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 A/P/C menu after generating design direction content - 💾 Generate HTML visualizer for design directions -- 📖 Update frontmatter `stepsCompleted: [1, 2, 3, 4, 5, 6, 7, 8, 9]` before loading next step +- 📖 Update output file frontmatter, adding this step to the end of the list of stepsCompleted. - 🚫 FORBIDDEN to load next step until C is selected ## COLLABORATION MENUS (A/P/C): @@ -29,7 +30,7 @@ This step will generate content and present choices: ## PROTOCOL INTEGRATION: -- When 'A' selected: Execute {project-root}/_bmad/core/tasks/advanced-elicitation.xml +- When 'A' selected: Execute {project-root}/_bmad/core/workflows/advanced-elicitation/workflow.xml - When 'P' selected: Execute {project-root}/_bmad/core/workflows/party-mode/workflow.md - PROTOCOLS always return to this step's A/P/C menu - User accepts/rejects protocol changes before proceeding @@ -65,7 +66,7 @@ Each mockup will show a complete vision for {{project_name}} with all our design Generate interactive visual exploration: "🎨 Design Direction Mockups Generated! -I'm creating a comprehensive HTML design direction showcase at `{output_folder}/ux-design-directions.html` +I'm creating a comprehensive HTML design direction showcase at `{planning_artifacts}/ux-design-directions.html` **What you'll see:** @@ -168,7 +169,7 @@ Show the generated design direction content and present choices: #### If 'A' (Advanced Elicitation): -- Execute {project-root}/_bmad/core/tasks/advanced-elicitation.xml with the current design direction content +- Execute {project-root}/_bmad/core/workflows/advanced-elicitation/workflow.xml with the current design direction content - Process the enhanced design insights that come back - Ask user: "Accept these improvements to the design direction? (y/n)" - If yes: Update content with improvements, then return to A/P/C menu @@ -185,7 +186,7 @@ Show the generated design direction content and present choices: #### If 'C' (Continue): - Append the final content to `{planning_artifacts}/ux-design-specification.md` -- Update frontmatter: `stepsCompleted: [1, 2, 3, 4, 5, 6, 7, 8, 9]` +- Update frontmatter: append step to end of stepsCompleted array - Load `./step-10-user-journeys.md` ## APPEND TO DOCUMENT: diff --git a/src/modules/bmm/workflows/2-plan-workflows/create-ux-design/steps/step-10-user-journeys.md b/src/modules/bmm/workflows/2-plan-workflows/create-ux-design/steps/step-10-user-journeys.md index 81816ec0..6bc9b55c 100644 --- a/src/modules/bmm/workflows/2-plan-workflows/create-ux-design/steps/step-10-user-journeys.md +++ b/src/modules/bmm/workflows/2-plan-workflows/create-ux-design/steps/step-10-user-journeys.md @@ -10,13 +10,14 @@ - 📋 YOU ARE A UX FACILITATOR, not a content generator - 💬 FOCUS on designing user flows and journey interactions - 🎯 COLLABORATIVE flow design, not assumption-based layouts +- ✅ 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 A/P/C menu after generating user journey content - 💾 ONLY save when user chooses C (Continue) -- 📖 Update frontmatter `stepsCompleted: [1, 2, 3, 4, 5, 6, 7, 8, 9, 10]` before loading next step +- 📖 Update output file frontmatter, adding this step to the end of the list of stepsCompleted. - 🚫 FORBIDDEN to load next step until C is selected ## COLLABORATION MENUS (A/P/C): @@ -29,7 +30,7 @@ This step will generate content and present choices: ## PROTOCOL INTEGRATION: -- When 'A' selected: Execute {project-root}/_bmad/core/tasks/advanced-elicitation.xml +- When 'A' selected: Execute {project-root}/_bmad/core/workflows/advanced-elicitation/workflow.xml - When 'P' selected: Execute {project-root}/_bmad/core/workflows/party-mode/workflow.md - PROTOCOLS always return to this step's A/P/C menu - User accepts/rejects protocol changes before proceeding @@ -186,7 +187,7 @@ Show the generated user journey content and present choices: #### If 'A' (Advanced Elicitation): -- Execute {project-root}/_bmad/core/tasks/advanced-elicitation.xml with the current user journey content +- Execute {project-root}/_bmad/core/workflows/advanced-elicitation/workflow.xml with the current user journey content - Process the enhanced journey insights that come back - Ask user: "Accept these improvements to the user journeys? (y/n)" - If yes: Update content with improvements, then return to A/P/C menu @@ -203,7 +204,7 @@ Show the generated user journey content and present choices: #### If 'C' (Continue): - Append the final content to `{planning_artifacts}/ux-design-specification.md` -- Update frontmatter: `stepsCompleted: [1, 2, 3, 4, 5, 6, 7, 8, 9, 10]` +- Update frontmatter: append step to end of stepsCompleted array - Load `./step-11-component-strategy.md` ## APPEND TO DOCUMENT: diff --git a/src/modules/bmm/workflows/2-plan-workflows/create-ux-design/steps/step-11-component-strategy.md b/src/modules/bmm/workflows/2-plan-workflows/create-ux-design/steps/step-11-component-strategy.md index d84059e2..410bb5fe 100644 --- a/src/modules/bmm/workflows/2-plan-workflows/create-ux-design/steps/step-11-component-strategy.md +++ b/src/modules/bmm/workflows/2-plan-workflows/create-ux-design/steps/step-11-component-strategy.md @@ -10,13 +10,14 @@ - 📋 YOU ARE A UX FACILITATOR, not a content generator - 💬 FOCUS on defining component library strategy and custom components - 🎯 COLLABORATIVE component planning, not assumption-based design +- ✅ 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 A/P/C menu after generating component strategy content - 💾 ONLY save when user chooses C (Continue) -- 📖 Update frontmatter `stepsCompleted: [1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11]` before loading next step +- 📖 Update output file frontmatter, adding this step to the end of the list of stepsCompleted. - 🚫 FORBIDDEN to load next step until C is selected ## COLLABORATION MENUS (A/P/C): @@ -29,7 +30,7 @@ This step will generate content and present choices: ## PROTOCOL INTEGRATION: -- When 'A' selected: Execute {project-root}/_bmad/core/tasks/advanced-elicitation.xml +- When 'A' selected: Execute {project-root}/_bmad/core/workflows/advanced-elicitation/workflow.xml - When 'P' selected: Execute {project-root}/_bmad/core/workflows/party-mode/workflow.md - PROTOCOLS always return to this step's A/P/C menu - User accepts/rejects protocol changes before proceeding @@ -192,7 +193,7 @@ Show the generated component strategy content and present choices: #### If 'A' (Advanced Elicitation): -- Execute {project-root}/_bmad/core/tasks/advanced-elicitation.xml with the current component strategy content +- Execute {project-root}/_bmad/core/workflows/advanced-elicitation/workflow.xml with the current component strategy content - Process the enhanced component insights that come back - Ask user: "Accept these improvements to the component strategy? (y/n)" - If yes: Update content with improvements, then return to A/P/C menu @@ -209,7 +210,7 @@ Show the generated component strategy content and present choices: #### If 'C' (Continue): - Append the final content to `{planning_artifacts}/ux-design-specification.md` -- Update frontmatter: `stepsCompleted: [1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11]` +- Update frontmatter: append step to end of stepsCompleted array - Load `./step-12-ux-patterns.md` ## APPEND TO DOCUMENT: diff --git a/src/modules/bmm/workflows/2-plan-workflows/create-ux-design/steps/step-12-ux-patterns.md b/src/modules/bmm/workflows/2-plan-workflows/create-ux-design/steps/step-12-ux-patterns.md index cabea2bb..19fc6484 100644 --- a/src/modules/bmm/workflows/2-plan-workflows/create-ux-design/steps/step-12-ux-patterns.md +++ b/src/modules/bmm/workflows/2-plan-workflows/create-ux-design/steps/step-12-ux-patterns.md @@ -10,13 +10,14 @@ - 📋 YOU ARE A UX FACILITATOR, not a content generator - 💬 FOCUS on establishing consistency patterns for common UX situations - 🎯 COLLABORATIVE pattern definition, not assumption-based design +- ✅ 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 A/P/C menu after generating UX patterns content - 💾 ONLY save when user chooses C (Continue) -- 📖 Update frontmatter `stepsCompleted: [1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12]` before loading next step +- 📖 Update output file frontmatter, adding this step to the end of the list of stepsCompleted. - 🚫 FORBIDDEN to load next step until C is selected ## COLLABORATION MENUS (A/P/C): @@ -29,7 +30,7 @@ This step will generate content and present choices: ## PROTOCOL INTEGRATION: -- When 'A' selected: Execute {project-root}/_bmad/core/tasks/advanced-elicitation.xml +- When 'A' selected: Execute {project-root}/_bmad/core/workflows/advanced-elicitation/workflow.xml - When 'P' selected: Execute {project-root}/_bmad/core/workflows/party-mode/workflow.md - PROTOCOLS always return to this step's A/P/C menu - User accepts/rejects protocol changes before proceeding @@ -181,7 +182,7 @@ Show the generated UX patterns content and present choices: #### If 'A' (Advanced Elicitation): -- Execute {project-root}/_bmad/core/tasks/advanced-elicitation.xml with the current UX patterns content +- Execute {project-root}/_bmad/core/workflows/advanced-elicitation/workflow.xml with the current UX patterns content - Process the enhanced pattern insights that come back - Ask user: "Accept these improvements to the UX patterns? (y/n)" - If yes: Update content with improvements, then return to A/P/C menu @@ -198,7 +199,7 @@ Show the generated UX patterns content and present choices: #### If 'C' (Continue): - Append the final content to `{planning_artifacts}/ux-design-specification.md` -- Update frontmatter: `stepsCompleted: [1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12]` +- Update frontmatter: append step to end of stepsCompleted array - Load `./step-13-responsive-accessibility.md` ## APPEND TO DOCUMENT: diff --git a/src/modules/bmm/workflows/2-plan-workflows/create-ux-design/steps/step-13-responsive-accessibility.md b/src/modules/bmm/workflows/2-plan-workflows/create-ux-design/steps/step-13-responsive-accessibility.md index 9f3a0c70..8c2e55bd 100644 --- a/src/modules/bmm/workflows/2-plan-workflows/create-ux-design/steps/step-13-responsive-accessibility.md +++ b/src/modules/bmm/workflows/2-plan-workflows/create-ux-design/steps/step-13-responsive-accessibility.md @@ -10,13 +10,14 @@ - 📋 YOU ARE A UX FACILITATOR, not a content generator - 💬 FOCUS on responsive design strategy and accessibility compliance - 🎯 COLLABORATIVE strategy definition, not assumption-based design +- ✅ 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 A/P/C menu after generating responsive/accessibility content - 💾 ONLY save when user chooses C (Continue) -- 📖 Update frontmatter `stepsCompleted: [1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13]` before loading next step +- 📖 Update output file frontmatter, adding this step to the end of the list of stepsCompleted. - 🚫 FORBIDDEN to load next step until C is selected ## COLLABORATION MENUS (A/P/C): @@ -29,7 +30,7 @@ This step will generate content and present choices: ## PROTOCOL INTEGRATION: -- When 'A' selected: Execute {project-root}/_bmad/core/tasks/advanced-elicitation.xml +- When 'A' selected: Execute {project-root}/_bmad/core/workflows/advanced-elicitation/workflow.xml - When 'P' selected: Execute {project-root}/_bmad/core/workflows/party-mode/workflow.md - PROTOCOLS always return to this step's A/P/C menu - User accepts/rejects protocol changes before proceeding @@ -208,7 +209,7 @@ Show the generated responsive and accessibility content and present choices: #### If 'A' (Advanced Elicitation): -- Execute {project-root}/_bmad/core/tasks/advanced-elicitation.xml with the current responsive/accessibility content +- Execute {project-root}/_bmad/core/workflows/advanced-elicitation/workflow.xml with the current responsive/accessibility content - Process the enhanced insights that come back - Ask user: "Accept these improvements to the responsive/accessibility strategy? (y/n)" - If yes: Update content with improvements, then return to A/P/C menu @@ -225,7 +226,7 @@ Show the generated responsive and accessibility content and present choices: #### If 'C' (Continue): - Append the final content to `{planning_artifacts}/ux-design-specification.md` -- Update frontmatter: `stepsCompleted: [1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13]` +- Update frontmatter: append step to end of stepsCompleted array - Load `./step-14-complete.md` ## APPEND TO DOCUMENT: diff --git a/src/modules/bmm/workflows/2-plan-workflows/create-ux-design/steps/step-14-complete.md b/src/modules/bmm/workflows/2-plan-workflows/create-ux-design/steps/step-14-complete.md index d41f9406..aa6e96b2 100644 --- a/src/modules/bmm/workflows/2-plan-workflows/create-ux-design/steps/step-14-complete.md +++ b/src/modules/bmm/workflows/2-plan-workflows/create-ux-design/steps/step-14-complete.md @@ -10,6 +10,7 @@ - 📋 FINALIZE document and update workflow status - 💬 FOCUS on completion, validation, and next steps - 🎯 UPDATE workflow status files with completion information +- ✅ YOU MUST ALWAYS SPEAK OUTPUT In your Agent communication style with the config `{communication_language}` ## EXECUTION PROTOCOLS: @@ -21,6 +22,7 @@ ## TERMINATION STEP PROTOCOLS: - This is a FINAL step - workflow completion required +- 📖 Update output file frontmatter, adding this step to the end of the list of stepsCompleted to indicate all is finished.. - Output completion summary and next step guidance - Update the main workflow status file with finalized document - Suggest potential next workflow steps for the user @@ -64,8 +66,8 @@ I've successfully collaborated with you to create a comprehensive UX design spec **Supporting Visual Assets:** -- Color themes visualizer: `{output_folder}/ux-color-themes.html` -- Design directions mockups: `{output_folder}/ux-design-directions.html` +- Color themes visualizer: `{planning_artifacts}/ux-color-themes.html` +- Design directions mockups: `{planning_artifacts}/ux-design-directions.html` This specification is now ready to guide visual design, implementation, and development." @@ -222,5 +224,5 @@ This UX design workflow is now complete. The specification serves as the foundat **Core Deliverables:** - ✅ UX Design Specification: `{planning_artifacts}/ux-design-specification.md` -- ✅ Color Themes Visualizer: `{output_folder}/ux-color-themes.html` -- ✅ Design Directions: `{output_folder}/ux-design-directions.html` +- ✅ Color Themes Visualizer: `{planning_artifacts}/ux-color-themes.html` +- ✅ Design Directions: `{planning_artifacts}/ux-design-directions.html` diff --git a/src/modules/bmm/workflows/2-plan-workflows/create-ux-design/workflow.md b/src/modules/bmm/workflows/2-plan-workflows/create-ux-design/workflow.md index b30852a6..2ad717de 100644 --- a/src/modules/bmm/workflows/2-plan-workflows/create-ux-design/workflow.md +++ b/src/modules/bmm/workflows/2-plan-workflows/create-ux-design/workflow.md @@ -37,21 +37,7 @@ Load config from `{project-root}/_bmad/bmm/config.yaml` and resolve: - `template_path` = `{installed_path}/ux-design-template.md` - `default_output_file` = `{planning_artifacts}/ux-design-specification.md` -### Output Files - -- Color themes: `{output_folder}/ux-color-themes.html` -- Design directions: `{output_folder}/ux-design-directions.html` - -### Input Document Discovery - -Discover context documents for UX context (Priority: Analysis folder first, then main folder, then sharded): - -- PRD: `{planning_artifacts}/*prd*.md` or `{output_folder}/*prd*.md` or `{output_folder}/*prd*/**/*.md` -- Product brief: `{output_folder}/analysis/*brief*.md` or `{output_folder}/*brief*.md` or `{output_folder}/*brief*/**/*.md` -- Epics: `{output_folder}/analysis/*epic*.md` or `{output_folder}/*epic*.md` or `{output_folder}/*epic*/**/*.md` -- Research: `{output_folder}/analysis/research/*research*.md` or `{output_folder}/*research*.md` or `{output_folder}/*research*/**/*.md` -- Brainstorming: `{output_folder}/analysis/brainstorming/*brainstorming*.md` or `{output_folder}/*brainstorming*.md` - ## EXECUTION -Load and execute `steps/step-01-init.md` to begin the UX design workflow. +- ✅ YOU MUST ALWAYS SPEAK OUTPUT In your Agent communication style with the config `{communication_language}` +- Load and execute `steps/step-01-init.md` to begin the UX design workflow. diff --git a/src/modules/bmm/workflows/2-plan-workflows/prd/domain-complexity.csv b/src/modules/bmm/workflows/2-plan-workflows/prd/data/domain-complexity.csv similarity index 100% rename from src/modules/bmm/workflows/2-plan-workflows/prd/domain-complexity.csv rename to src/modules/bmm/workflows/2-plan-workflows/prd/data/domain-complexity.csv diff --git a/src/modules/bmm/workflows/2-plan-workflows/prd/data/prd-purpose.md b/src/modules/bmm/workflows/2-plan-workflows/prd/data/prd-purpose.md new file mode 100644 index 00000000..755230be --- /dev/null +++ b/src/modules/bmm/workflows/2-plan-workflows/prd/data/prd-purpose.md @@ -0,0 +1,197 @@ +# BMAD PRD Purpose + +**The PRD is the top of the required funnel that feeds all subsequent product development work in rhw BMad Method.** + +--- + +## What is a BMAD PRD? + +A dual-audience document serving: +1. **Human Product Managers and builders** - Vision, strategy, stakeholder communication +2. **LLM Downstream Consumption** - UX Design → Architecture → Epics → Development AI Agents + +Each successive document becomes more AI-tailored and granular. + +--- + +## Core Philosophy: Information Density + +**High Signal-to-Noise Ratio** + +Every sentence must carry information weight. LLMs consume precise, dense content efficiently. + +**Anti-Patterns (Eliminate These):** +- ❌ "The system will allow users to..." → ✅ "Users can..." +- ❌ "It is important to note that..." → ✅ State the fact directly +- ❌ "In order to..." → ✅ "To..." +- ❌ Conversational filler and padding → ✅ Direct, concise statements + +**Goal:** Maximum information per word. Zero fluff. + +--- + +## The Traceability Chain + +**PRD starts the chain:** +``` +Vision → Success Criteria → User Journeys → Functional Requirements → (future: User Stories) +``` + +**In the PRD, establish:** +- Vision → Success Criteria alignment +- Success Criteria → User Journey coverage +- User Journey → Functional Requirement mapping +- All requirements traceable to user needs + +**Why:** Each downstream artifact (UX, Architecture, Epics, Stories) must trace back to documented user needs and business objectives. This chain ensures we build the right thing. + +--- + +## What Makes Great Functional Requirements? + +### FRs are Capabilities, Not Implementation + +**Good FR:** "Users can reset their password via email link" +**Bad FR:** "System sends JWT via email and validates with database" (implementation leakage) + +**Good FR:** "Dashboard loads in under 2 seconds for 95th percentile" +**Bad FR:** "Fast loading time" (subjective, unmeasurable) + +### SMART Quality Criteria + +**Specific:** Clear, precisely defined capability +**Measurable:** Quantifiable with test criteria +**Attainable:** Realistic within constraints +**Relevant:** Aligns with business objectives +**Traceable:** Links to source (executive summary or user journey) + +### FR Anti-Patterns + +**Subjective Adjectives:** +- ❌ "easy to use", "intuitive", "user-friendly", "fast", "responsive" +- ✅ Use metrics: "completes task in under 3 clicks", "loads in under 2 seconds" + +**Implementation Leakage:** +- ❌ Technology names, specific libraries, implementation details +- ✅ Focus on capability and measurable outcomes + +**Vague Quantifiers:** +- ❌ "multiple users", "several options", "various formats" +- ✅ "up to 100 concurrent users", "3-5 options", "PDF, DOCX, TXT formats" + +**Missing Test Criteria:** +- ❌ "The system shall provide notifications" +- ✅ "The system shall send email notifications within 30 seconds of trigger event" + +--- + +## What Makes Great Non-Functional Requirements? + +### NFRs Must Be Measurable + +**Template:** +``` +"The system shall [metric] [condition] [measurement method]" +``` + +**Examples:** +- ✅ "The system shall respond to API requests in under 200ms for 95th percentile as measured by APM monitoring" +- ✅ "The system shall maintain 99.9% uptime during business hours as measured by cloud provider SLA" +- ✅ "The system shall support 10,000 concurrent users as measured by load testing" + +### NFR Anti-Patterns + +**Unmeasurable Claims:** +- ❌ "The system shall be scalable" → ✅ "The system shall handle 10x load growth through horizontal scaling" +- ❌ "High availability required" → ✅ "99.9% uptime as measured by cloud provider SLA" + +**Missing Context:** +- ❌ "Response time under 1 second" → ✅ "API response time under 1 second for 95th percentile under normal load" + +--- + +## Domain-Specific Requirements + +**Auto-Detect and Enforce Based on Project Context** + +Certain industries have mandatory requirements that must be present: + +- **Healthcare:** HIPAA Privacy & Security Rules, PHI encryption, audit logging, MFA +- **Fintech:** PCI-DSS Level 1, AML/KYC compliance, SOX controls, financial audit trails +- **GovTech:** NIST framework, Section 508 accessibility (WCAG 2.1 AA), FedRAMP, data residency +- **E-Commerce:** PCI-DSS for payments, inventory accuracy, tax calculation by jurisdiction + +**Why:** Missing these requirements in the PRD means they'll be missed in architecture and implementation, creating expensive rework. During PRD creation there is a step to cover this - during validation we want to make sure it was covered. For this purpose steps will utilize a domain-complexity.csv and project-types.csv. + +--- + +## Document Structure (Markdown, Human-Readable) + +### Required Sections +1. **Executive Summary** - Vision, differentiator, target users +2. **Success Criteria** - Measurable outcomes (SMART) +3. **Product Scope** - MVP, Growth, Vision phases +4. **User Journeys** - Comprehensive coverage +5. **Domain Requirements** - Industry-specific compliance (if applicable) +6. **Innovation Analysis** - Competitive differentiation (if applicable) +7. **Project-Type Requirements** - Platform-specific needs +8. **Functional Requirements** - Capability contract (FRs) +9. **Non-Functional Requirements** - Quality attributes (NFRs) + +### Formatting for Dual Consumption + +**For Humans:** +- Clear, professional language +- Logical flow from vision to requirements +- Easy for stakeholders to review and approve + +**For LLMs:** +- ## Level 2 headers for all main sections (enables extraction) +- Consistent structure and patterns +- Precise, testable language +- High information density + +--- + +## Downstream Impact + +**How the PRD Feeds Next Artifacts:** + +**UX Design:** +- User journeys → interaction flows +- FRs → design requirements +- Success criteria → UX metrics + +**Architecture:** +- FRs → system capabilities +- NFRs → architecture decisions +- Domain requirements → compliance architecture +- Project-type requirements → platform choices + +**Epics & Stories (created after architecture):** +- FRs → user stories (1 FR could map to 1-3 stories potentially) +- Acceptance criteria → story acceptance tests +- Priority → sprint sequencing +- Traceability → stories map back to vision + +**Development AI Agents:** +- Precise requirements → implementation clarity +- Test criteria → automated test generation +- Domain requirements → compliance enforcement +- Measurable NFRs → performance targets + +--- + +## Summary: What Makes a Great BMAD PRD? + +✅ **High Information Density** - Every sentence carries weight, zero fluff +✅ **Measurable Requirements** - All FRs and NFRs are testable with specific criteria +✅ **Clear Traceability** - Each requirement links to user need and business objective +✅ **Domain Awareness** - Industry-specific requirements auto-detected and included +✅ **Zero Anti-Patterns** - No subjective adjectives, implementation leakage, or vague quantifiers +✅ **Dual Audience Optimized** - Human-readable AND LLM-consumable +✅ **Markdown Format** - Professional, clean, accessible to all stakeholders + +--- + +**Remember:** The PRD is the foundation. Quality here ripples through every subsequent phase. A dense, precise, well-traced PRD makes UX design, architecture, epic breakdown, and AI development dramatically more effective. diff --git a/src/modules/bmm/workflows/2-plan-workflows/prd/project-types.csv b/src/modules/bmm/workflows/2-plan-workflows/prd/data/project-types.csv similarity index 100% rename from src/modules/bmm/workflows/2-plan-workflows/prd/project-types.csv rename to src/modules/bmm/workflows/2-plan-workflows/prd/data/project-types.csv diff --git a/src/modules/bmm/workflows/2-plan-workflows/prd/steps/step-01-init.md b/src/modules/bmm/workflows/2-plan-workflows/prd/steps-c/step-01-init.md similarity index 62% rename from src/modules/bmm/workflows/2-plan-workflows/prd/steps/step-01-init.md rename to src/modules/bmm/workflows/2-plan-workflows/prd/steps-c/step-01-init.md index 11dcd880..63a8e7ae 100644 --- a/src/modules/bmm/workflows/2-plan-workflows/prd/steps/step-01-init.md +++ b/src/modules/bmm/workflows/2-plan-workflows/prd/steps-c/step-01-init.md @@ -2,18 +2,13 @@ name: 'step-01-init' description: 'Initialize the PRD workflow by detecting continuation state and setting up the document' -# Path Definitions -workflow_path: '{project-root}/_bmad/bmm/workflows/2-plan-workflows/prd' - # File References -thisStepFile: '{workflow_path}/steps/step-01-init.md' -nextStepFile: '{workflow_path}/steps/step-02-discovery.md' -continueStepFile: '{workflow_path}/steps/step-01b-continue.md' -workflowFile: '{workflow_path}/workflow.md' -outputFile: '{output_folder}/prd.md' +nextStepFile: './step-02-discovery.md' +continueStepFile: './step-01b-continue.md' +outputFile: '{planning_artifacts}/prd.md' -# Template References -prdTemplate: '{workflow_path}/prd-template.md' +# Template Reference +prdTemplate: '../templates/prd-template.md' --- # Step 1: Workflow Initialization @@ -32,6 +27,7 @@ Initialize the PRD workflow by detecting continuation state, discovering input d - 📖 CRITICAL: Read the complete step file before taking any action - 🔄 CRITICAL: When loading next step with 'C', ensure entire file is read - 📋 YOU ARE A FACILITATOR, not a content generator +- ✅ YOU MUST ALWAYS SPEAK OUTPUT In your Agent communication style with the config `{communication_language}` ### Role Reinforcement: @@ -51,7 +47,7 @@ Initialize the PRD workflow by detecting continuation state, discovering input d - 🎯 Show your analysis of current state before taking any action - 💾 Initialize document structure and update frontmatter appropriately -- 📖 Set up frontmatter `stepsCompleted: [1]` before loading next step +- Update frontmatter: add this step name to the end of the steps completed array (it should be the first entry in the steps array since this is step 1) - 🚫 FORBIDDEN to load next step until user selects 'C' (Continue) ## CONTEXT BOUNDARIES: @@ -75,7 +71,7 @@ First, check if the output document already exists: ### 2. Handle Continuation (If Document Exists) -If the document exists and has frontmatter with `stepsCompleted`: +If the document exists and has frontmatter with `stepsCompleted` BUT `step-11-complete` is NOT in the list, follow the Continuation Protocol since the document is incomplete: **Continuation Protocol:** @@ -90,58 +86,28 @@ If no document exists or no `stepsCompleted` in frontmatter: #### A. Input Document Discovery -Discover and load context documents using smart discovery. +Discover and load context documents using smart discovery. Documents can be in the following locations: +- {planning_artifacts}/** +- {output_folder}/** +- {product_knowledge}/** +- docs/** -**IMPORTANT: Track document counts as you discover files.** +Also - when searching - documents can be a single markdown file, or a folder with an index and multiple files. For Example, if searching for `*foo*.md` and not found, also search for a folder called *foo*/index.md (which indicates sharded content) -Initialize counters: +Try to discover the following: +- Product Brief (`*brief*.md`) +- Research Documents (`/*research*.md`) +- Project Documentation (generally multiple documents might be found for this in the `{product_knowledge}` or `docs` folder.) +- Project Context (`**/project-context.md`) -``` -briefCount = 0 -researchCount = 0 -brainstormingCount = 0 -projectDocsCount = 0 -``` - -**Product Brief (Priority: Analysis → Main → Sharded → Whole):** - -1. Check analysis folder: `{output_folder}/analysis/*brief*.md` -2. If no analysis files: Try main folder: `{output_folder}/*brief*.md` -3. If no main files: Check for sharded brief folder: `{output_folder}/*brief*/**/*.md` -4. If sharded folder exists: Load EVERY file in that folder completely -5. Add discovered files to `inputDocuments` frontmatter -6. **Update briefCount with number of files found** - -**Research Documents (Priority: Analysis → Main → Sharded → Whole):** - -1. Check analysis folder: `{output_folder}/analysis/research/*research*.md` -2. If no analysis files: Try main folder: `{output_folder}/*research*.md` -3. If no main files: Check for sharded research folder: `{output_folder}/*research*/**/*.md` -4. Load useful research files completely -5. Add discovered files to `inputDocuments` frontmatter -6. **Update researchCount with number of files found** - -**Brainstorming Documents (Priority: Analysis → Main):** - -1. Check analysis folder: `{output_folder}/analysis/brainstorming/*brainstorming*.md` -2. If no analysis files: Try main folder: `{output_folder}/*brainstorming*.md` -3. Add discovered files to `inputDocuments` frontmatter -4. **Update brainstormingCount with number of files found** - -**Project Documentation (Existing Projects - Brownfield):** - -1. Look for index file: `{output_folder}/index.md` -2. CRITICAL: Load index.md to understand what project files are available -3. Read available files from index to understand existing project context -4. This provides essential context for extending existing project with new PRD -5. Add discovered files to `inputDocuments` frontmatter -6. **Update projectDocsCount with number of files found (including index.md)** +Confirm what you have found with the user, along with asking if the user wants to provide anything else. Only after this confirmation will you proceed to follow the loading rules **Loading Rules:** -- Load ALL discovered files completely (no offset/limit) -- For sharded folders, load ALL files to get complete picture -- For existing projects, use index.md as guide to what's relevant +- Load ALL discovered files completely that the user confirmed or provided (no offset/limit) +- If there is a project context, whatever is relevant should try to be biased in the remainder of this whole workflow process +- For sharded folders, load ALL files to get complete picture, using the index first to potentially know the potential of each document +- index.md is a guide to what's relevant whenever available - Track all successfully loaded files in frontmatter `inputDocuments` array #### B. Create Initial Document @@ -149,24 +115,7 @@ projectDocsCount = 0 **Document Setup:** - Copy the template from `{prdTemplate}` to `{outputFile}` -- Initialize frontmatter with proper structure including document counts: - -```yaml ---- -stepsCompleted: [] -inputDocuments: [] -documentCounts: - briefs: { { briefCount } } - research: { { researchCount } } - brainstorming: { { brainstormingCount } } - projectDocs: { { projectDocsCount } } -workflowType: 'prd' -lastStep: 0 -project_name: '{{project_name}}' -user_name: '{{user_name}}' -date: '{{date}}' ---- -``` +- Initialize frontmatter with proper structure including inputDocuments array. #### C. Present Initialization Results @@ -202,7 +151,7 @@ Display menu after setup report: #### Menu Handling Logic: -- IF C: Update frontmatter with `stepsCompleted: [1]`, then load, read entire file, then execute {nextStepFile} +- IF C: Update output file frontmatter, adding this step name to the end of the list of stepsCompleted, then load, read entire {nextStepFile}, then execute {nextStepFile} - IF user provides additional files: Load them, update inputDocuments and documentCounts, redisplay report - IF user asks questions: Answer and redisplay menu @@ -213,7 +162,7 @@ Display menu after setup report: ## CRITICAL STEP COMPLETION NOTE -ONLY WHEN [C continue option] is selected and [frontmatter properly updated with stepsCompleted: [1] and documentCounts], will you then load and read fully `{nextStepFile}` to execute and begin project discovery. +ONLY WHEN [C continue option] is selected and [frontmatter properly updated with this step added to stepsCompleted and documentCounts], will you then load and read fully `{nextStepFile}` to execute and begin project discovery. --- @@ -225,10 +174,9 @@ ONLY WHEN [C continue option] is selected and [frontmatter properly updated with - Fresh workflow initialized with template and proper frontmatter - Input documents discovered and loaded using sharded-first logic - All discovered files tracked in frontmatter `inputDocuments` -- **Document counts stored in frontmatter `documentCounts`** - User clearly informed of brownfield vs greenfield status - Menu presented and user input handled correctly -- Frontmatter updated with `stepsCompleted: [1]` before proceeding +- Frontmatter updated with this step name added to stepsCompleted before proceeding ### ❌ SYSTEM FAILURE: diff --git a/src/modules/bmm/workflows/2-plan-workflows/prd/steps/step-01b-continue.md b/src/modules/bmm/workflows/2-plan-workflows/prd/steps-c/step-01b-continue.md similarity index 68% rename from src/modules/bmm/workflows/2-plan-workflows/prd/steps/step-01b-continue.md rename to src/modules/bmm/workflows/2-plan-workflows/prd/steps-c/step-01b-continue.md index bd4dfec6..5f3999bf 100644 --- a/src/modules/bmm/workflows/2-plan-workflows/prd/steps/step-01b-continue.md +++ b/src/modules/bmm/workflows/2-plan-workflows/prd/steps-c/step-01b-continue.md @@ -2,13 +2,8 @@ name: 'step-01b-continue' description: 'Resume an interrupted PRD workflow from the last completed step' -# Path Definitions -workflow_path: '{project-root}/_bmad/bmm/workflows/2-plan-workflows/prd' - # File References -thisStepFile: '{workflow_path}/steps/step-01b-continue.md' -workflowFile: '{workflow_path}/workflow.md' -outputFile: '{output_folder}/prd.md' +outputFile: '{planning_artifacts}/prd.md' --- # Step 1B: Workflow Continuation @@ -25,6 +20,7 @@ Resume the PRD workflow from where it was left off, ensuring smooth continuation - 📖 CRITICAL: Read the complete step file before taking any action - 🔄 CRITICAL: When loading next step with 'C', ensure entire file is read - 📋 YOU ARE A FACILITATOR, not a content generator +- ✅ YOU MUST ALWAYS SPEAK OUTPUT In your Agent communication style with the config `{communication_language}` ### Role Reinforcement: @@ -41,7 +37,7 @@ Resume the PRD workflow from where it was left off, ensuring smooth continuation ## EXECUTION PROTOCOLS: - 🎯 Show your analysis of current state before taking action -- 💾 Keep existing frontmatter `stepsCompleted` values +- Update frontmatter: add this step name to the end of the steps completed array - 📖 Only load documents that were already tracked in `inputDocuments` - 🚫 FORBIDDEN to discover new input documents during continuation @@ -59,10 +55,9 @@ Resume the PRD workflow from where it was left off, ensuring smooth continuation **State Assessment:** Review the frontmatter to understand: -- `stepsCompleted`: Which steps are already done -- `lastStep`: The most recently completed step number +- `stepsCompleted`: Array of completed step filenames +- Last element of `stepsCompleted` array: The most recently completed step - `inputDocuments`: What context was already loaded -- `documentCounts`: briefs, research, brainstorming, projectDocs counts - All other frontmatter variables ### 2. Restore Context Documents @@ -73,47 +68,27 @@ Review the frontmatter to understand: - This ensures you have full context for continuation - Don't discover new documents - only reload what was previously processed -### 3. Present Current Progress +### 3. Determine Next Step -**Progress Report to User:** -"Welcome back {{user_name}}! I'm resuming our PRD collaboration for {{project_name}}. +**Simplified Next Step Logic:** +1. Get the last element from the `stepsCompleted` array (this is the filename of the last completed step, e.g., "step-03-success.md") +2. Load that step file and read its frontmatter +3. Extract the `nextStepFile` value from the frontmatter +4. That's the next step to load! -**Current Progress:** +**Example:** +- If `stepsCompleted = ["step-01-init.md", "step-02-discovery.md", "step-03-success.md"]` +- Last element is `"step-03-success.md"` +- Load `step-03-success.md`, read its frontmatter +- Find `nextStepFile: './step-04-journeys.md'` +- Next step to load is `./step-04-journeys.md` -- Steps completed: {stepsCompleted} -- Last worked on: Step {lastStep} -- Context documents available: {len(inputDocuments)} files +### 4. Handle Workflow Completion -**Document Status:** - -- Current PRD document is ready with all completed sections -- Ready to continue from where we left off - -Does this look right, or do you want to make any adjustments before we proceed?" - -### 4. Determine Continuation Path - -**Next Step Logic:** -Based on `lastStep` value, determine which step to load next: - -- If `lastStep = 1` → Load `./step-02-discovery.md` -- If `lastStep = 2` → Load `./step-03-success.md` -- If `lastStep = 3` → Load `./step-04-journeys.md` -- If `lastStep = 4` → Load `./step-05-domain.md` -- If `lastStep = 5` → Load `./step-06-innovation.md` -- If `lastStep = 6` → Load `./step-07-project-type.md` -- If `lastStep = 7` → Load `./step-08-scoping.md` -- If `lastStep = 8` → Load `./step-09-functional.md` -- If `lastStep = 9` → Load `./step-10-nonfunctional.md` -- If `lastStep = 10` → Load `./step-11-complete.md` -- If `lastStep = 11` → Workflow already complete - -### 5. Handle Workflow Completion - -**If workflow already complete (`lastStep = 11`):** +**If `stepsCompleted` array contains `"step-11-complete.md"`:** "Great news! It looks like we've already completed the PRD workflow for {{project_name}}. -The final document is ready at `{outputFile}` with all sections completed through step 11. +The final document is ready at `{outputFile}` with all sections completed. Would you like me to: @@ -123,16 +98,29 @@ Would you like me to: What would be most helpful?" -### 6. Present MENU OPTIONS +### 5. Present Current Progress **If workflow not complete:** -Display: "Ready to continue with Step {nextStepNumber}? +"Welcome back {{user_name}}! I'm resuming our PRD collaboration for {{project_name}}. -**Select an Option:** [C] Continue to next step" +**Current Progress:** +- Last completed: {last step filename from stepsCompleted array} +- Next up: {nextStepFile determined from that step's frontmatter} +- Context documents available: {len(inputDocuments)} files + +**Document Status:** +- Current PRD document is ready with all completed sections +- Ready to continue from where we left off + +Does this look right, or do you want to make any adjustments before we proceed?" + +### 6. Present MENU OPTIONS + +Display: "**Select an Option:** [C] Continue to {next step name}" #### Menu Handling Logic: -- IF C: Load, read entire file, then execute the appropriate next step file based on `lastStep` +- IF C: Load, read entire file, then execute the {nextStepFile} determined in step 3 - IF Any other comments or queries: respond and redisplay menu #### EXECUTION RULES: @@ -142,7 +130,7 @@ Display: "Ready to continue with Step {nextStepNumber}? ## CRITICAL STEP COMPLETION NOTE -ONLY WHEN [C continue option] is selected and [current state confirmed], will you then load and read fully the appropriate next step file to resume the workflow. +ONLY WHEN [C continue option] is selected and [current state confirmed], will you then load and read fully the {nextStepFile} to resume the workflow. --- @@ -159,7 +147,7 @@ ONLY WHEN [C continue option] is selected and [current state confirmed], will yo - Discovering new input documents instead of reloading existing ones - Modifying content from already completed steps -- Loading wrong next step based on `lastStep` value +- Failing to extract nextStepFile from the last completed step's frontmatter - Proceeding without user confirmation of current state **Master Rule:** Skipping steps, optimizing sequences, or not following exact instructions is FORBIDDEN and constitutes SYSTEM FAILURE. diff --git a/src/modules/bmm/workflows/2-plan-workflows/prd/steps-c/step-02-discovery.md b/src/modules/bmm/workflows/2-plan-workflows/prd/steps-c/step-02-discovery.md new file mode 100644 index 00000000..49f2557e --- /dev/null +++ b/src/modules/bmm/workflows/2-plan-workflows/prd/steps-c/step-02-discovery.md @@ -0,0 +1,224 @@ +--- +name: 'step-02-discovery' +description: 'Discover project type, domain, and context through collaborative dialogue' + +# File References +nextStepFile: './step-03-success.md' +outputFile: '{planning_artifacts}/prd.md' + +# Data Files +projectTypesCSV: '../data/project-types.csv' +domainComplexityCSV: '../data/domain-complexity.csv' + +# Task References +advancedElicitationTask: '{project-root}/_bmad/core/workflows/advanced-elicitation/workflow.xml' +partyModeWorkflow: '{project-root}/_bmad/core/workflows/party-mode/workflow.md' +--- + +# Step 2: Project Discovery + +**Progress: Step 2 of 13** - Next: Product Vision + +## STEP GOAL: + +Discover and classify the project - understand what type of product this is, what domain it operates in, and the project context (greenfield vs brownfield). + +## MANDATORY EXECUTION RULES (READ FIRST): + +### Universal Rules: + +- 🛑 NEVER generate content without user input +- 📖 CRITICAL: Read the complete step file before taking any action +- 🔄 CRITICAL: When loading next step with 'C', ensure the entire file is read +- ✅ ALWAYS treat this as collaborative discovery between PM peers +- 📋 YOU ARE A FACILITATOR, not a content generator +- ✅ YOU MUST ALWAYS SPEAK OUTPUT In your Agent communication style with the config `{communication_language}` + +### Role Reinforcement: + +- ✅ You are a product-focused PM facilitator collaborating with an expert peer +- ✅ We engage in collaborative dialogue, not command-response +- ✅ You bring structured thinking and facilitation skills, while the user brings domain expertise and product vision + +### Step-Specific Rules: + +- 🎯 Focus on classification and understanding - no content generation yet +- 🚫 FORBIDDEN to generate executive summary or vision statements (that's next steps) +- 💬 APPROACH: Natural conversation to understand the project +- 🎯 LOAD classification data BEFORE starting discovery conversation + +## EXECUTION PROTOCOLS: + +- 🎯 Show your analysis before taking any action +- ⚠️ Present A/P/C menu after classification complete +- 💾 ONLY save classification to frontmatter when user chooses C (Continue) +- 📖 Update frontmatter, adding this step to the end of the list of stepsCompleted +- 🚫 FORBIDDEN to load next step until C is selected + +## CONTEXT BOUNDARIES: + +- Current document and frontmatter from step 1 are available +- Input documents already loaded are in memory (product briefs, research, brainstorming, project docs) +- **Document counts available in frontmatter `documentCounts`** +- Classification CSV data will be loaded in this step only +- No executive summary or vision content yet (that's steps 2b and 2c) + +## YOUR TASK: + +Discover and classify the project through natural conversation: +- What type of product is this? (web app, API, mobile, etc.) +- What domain does it operate in? (healthcare, fintech, e-commerce, etc.) +- What's the project context? (greenfield new product vs brownfield existing system) +- How complex is this domain? (low, medium, high) + +## DISCOVERY SEQUENCE: + +### 1. Check Document State + +Read the frontmatter from `{outputFile}` to get document counts: +- `briefCount` - Product briefs available +- `researchCount` - Research documents available +- `brainstormingCount` - Brainstorming docs available +- `projectDocsCount` - Existing project documentation + +**Announce your understanding:** + +"From step 1, I have loaded: +- Product briefs: {{briefCount}} +- Research: {{researchCount}} +- Brainstorming: {{brainstormingCount}} +- Project docs: {{projectDocsCount}} + +{{if projectDocsCount > 0}}This is a brownfield project - I'll focus on understanding what you want to add or change.{{else}}This is a greenfield project - I'll help you define the full product vision.{{/if}}" + +### 2. Load Classification Data + +**Attempt subprocess data lookup:** + +**Project Type Lookup:** +"Your task: Lookup data in {projectTypesCSV} + +**Search criteria:** +- Find row where project_type matches {{detectedProjectType}} + +**Return format:** +Return ONLY the matching row as a YAML-formatted object with these fields: +project_type, detection_signals + +**Do NOT return the entire CSV - only the matching row.**" + +**Domain Complexity Lookup:** +"Your task: Lookup data in {domainComplexityCSV} + +**Search criteria:** +- Find row where domain matches {{detectedDomain}} + +**Return format:** +Return ONLY the matching row as a YAML-formatted object with these fields: +domain, complexity, typical_concerns, compliance_requirements + +**Do NOT return the entire CSV - only the matching row.**" + +**Graceful degradation (if Task tool unavailable):** +- Load the CSV files directly +- Find the matching rows manually +- Extract required fields +- Keep in memory for intelligent classification + +### 3. Begin Discovery Conversation + +**Start with what you know:** + +If the user has a product brief or project docs, acknowledge them and share your understanding. Then ask clarifying questions to deepen your understanding. + +If this is a greenfield project with no docs, start with open-ended discovery: +- What problem does this solve? +- Who's it for? +- What excites you about building this? + +**Listen for classification signals:** + +As the user describes their product, match against: +- **Project type signals** (API, mobile, SaaS, etc.) +- **Domain signals** (healthcare, fintech, education, etc.) +- **Complexity indicators** (regulated industries, novel technology, etc.) + +### 4. Confirm Classification + +Once you have enough understanding, share your classification: + +"I'm hearing this as: +- **Project Type:** {{detectedType}} +- **Domain:** {{detectedDomain}} +- **Complexity:** {{complexityLevel}} + +Does this sound right to you?" + +Let the user confirm or refine your classification. + +### 5. Save Classification to Frontmatter + +When user selects 'C', update frontmatter with classification: +```yaml +classification: + projectType: {{projectType}} + domain: {{domain}} + complexity: {{complexityLevel}} + projectContext: {{greenfield|brownfield}} +``` + +### N. Present MENU OPTIONS + +Present the project classification for review, then display menu: + +"Based on our conversation, I've discovered and classified your project. + +**Here's the classification:** + +**Project Type:** {{detectedType}} +**Domain:** {{detectedDomain}} +**Complexity:** {{complexityLevel}} +**Project Context:** {{greenfield|brownfield}} + +**What would you like to do?**" + +Display: "**Select:** [A] Advanced Elicitation [P] Party Mode [C] Continue to Product Vision (Step 2b of 13)" + +#### Menu Handling Logic: +- IF A: Execute {advancedElicitationTask} with the current classification, process the enhanced insights that come back, ask user if they accept the improvements, if yes update classification then redisplay menu, if no keep original classification then redisplay menu +- IF P: Execute {partyModeWorkflow} with the current classification, process the collaborative insights, ask user if they accept the changes, if yes update classification then redisplay menu, if no keep original classification then redisplay menu +- IF C: Save classification to {outputFile} frontmatter, add this step name to the end of stepsCompleted array, then load, read entire file, then execute {nextStepFile} +- IF Any other: help user respond, then redisplay menu + +#### EXECUTION RULES: +- ALWAYS halt and wait for user input after presenting menu +- ONLY proceed to next step when user selects 'C' +- After other menu items execution, return to this menu + +## CRITICAL STEP COMPLETION NOTE + +ONLY WHEN [C continue option] is selected and [classification saved to frontmatter], will you then load and read fully `{nextStepFile}` to explore product vision. + +--- + +## 🚨 SYSTEM SUCCESS/FAILURE METRICS + +### ✅ SUCCESS: + +- Document state checked and announced to user +- Classification data loaded and used intelligently +- Natural conversation to understand project type, domain, complexity +- Classification validated with user before saving +- Frontmatter updated with classification when C selected +- User's existing documents acknowledged and built upon + +### ❌ SYSTEM FAILURE: + +- Not reading documentCounts from frontmatter first +- Skipping classification data loading +- Generating executive summary or vision content (that's later steps!) +- Not validating classification with user +- Being prescriptive instead of having natural conversation +- Proceeding without user selecting 'C' + +**Master Rule:** This is classification and understanding only. No content generation yet. Build on what the user already has. Have natural conversations, don't follow scripts. diff --git a/src/modules/bmm/workflows/2-plan-workflows/prd/steps/step-03-success.md b/src/modules/bmm/workflows/2-plan-workflows/prd/steps-c/step-03-success.md similarity index 54% rename from src/modules/bmm/workflows/2-plan-workflows/prd/steps/step-03-success.md rename to src/modules/bmm/workflows/2-plan-workflows/prd/steps-c/step-03-success.md index 29ea708c..90906981 100644 --- a/src/modules/bmm/workflows/2-plan-workflows/prd/steps/step-03-success.md +++ b/src/modules/bmm/workflows/2-plan-workflows/prd/steps-c/step-03-success.md @@ -2,17 +2,12 @@ name: 'step-03-success' description: 'Define comprehensive success criteria covering user, business, and technical success' -# Path Definitions -workflow_path: '{project-root}/_bmad/bmm/workflows/2-plan-workflows/prd' - # File References -thisStepFile: '{workflow_path}/steps/step-03-success.md' -nextStepFile: '{workflow_path}/steps/step-04-journeys.md' -workflowFile: '{workflow_path}/workflow.md' -outputFile: '{output_folder}/prd.md' +nextStepFile: './step-04-journeys.md' +outputFile: '{planning_artifacts}/prd.md' # Task References -advancedElicitationTask: '{project-root}/_bmad/core/tasks/advanced-elicitation.xml' +advancedElicitationTask: '{project-root}/_bmad/core/workflows/advanced-elicitation/workflow.xml' partyModeWorkflow: '{project-root}/_bmad/core/workflows/party-mode/workflow.md' --- @@ -30,30 +25,16 @@ partyModeWorkflow: '{project-root}/_bmad/core/workflows/party-mode/workflow.md' - 📋 YOU ARE A FACILITATOR, not a content generator - 💬 FOCUS on defining what winning looks like for this product - 🎯 COLLABORATIVE discovery, not assumption-based goal setting +- ✅ 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 A/P/C menu after generating success criteria content - 💾 ONLY save when user chooses C (Continue) -- 📖 Update frontmatter `stepsCompleted: [1, 2, 3]` before loading next step +- 📖 Update output file frontmatter, adding this step name to the end of the list of stepsCompleted - 🚫 FORBIDDEN to load next step until C is selected -## COLLABORATION MENUS (A/P/C): - -This step will generate content and present choices: - -- **A (Advanced Elicitation)**: Use discovery protocols to develop deeper insights about success metrics -- **P (Party Mode)**: Bring multiple perspectives to define comprehensive success criteria -- **C (Continue)**: Save the content to the document and proceed to next step - -## PROTOCOL INTEGRATION: - -- When 'A' selected: Execute {project-root}/_bmad/core/tasks/advanced-elicitation.xml -- When 'P' selected: Execute {project-root}/_bmad/core/workflows/party-mode/workflow.md -- PROTOCOLS always return to this step's A/P/C menu -- User accepts/rejects protocol changes before proceeding - ## CONTEXT BOUNDARIES: - Current document and frontmatter from previous steps are available @@ -75,38 +56,21 @@ Define comprehensive success criteria that cover user success, business success, Analyze product brief, research, and brainstorming documents for success criteria already mentioned. **If Input Documents Contain Success Criteria:** -"Looking at your product brief and research, I see some initial success criteria already defined: - -**From your brief:** -{{extracted_success_criteria_from_brief}} - -**From research:** -{{extracted_success_criteria_from_research}} - -**From brainstorming:** -{{extracted_success_criteria_from_brainstorming}} - -This gives us a great foundation. Let's refine and expand on these initial thoughts: - -**User Success First:** -Based on what we have, how would you refine these user success indicators: - -- {{refined_user_success_from_documents}} -- Are there other user success metrics we should consider? - -**What would make a user say 'this was worth it'** beyond what's already captured?" +Guide user to refine existing success criteria: +- Acknowledge what's already documented in their materials +- Extract key success themes from brief, research, and brainstorming +- Help user identify gaps and areas for expansion +- Probe for specific, measurable outcomes: When do users feel delighted/relieved/empowered? +- Ask about emotional success moments and completion scenarios +- Explore what "worth it" means beyond what's already captured **If No Success Criteria in Input Documents:** -Start with user-centered success: -"Now that we understand what makes {{project_name}} special, let's define what success looks like. - -**User Success First:** - -- What would make a user say 'this was worth it'? -- What's the moment where they realize this solved their problem? -- After using {{project_name}}, what outcome are they walking away with? - -Let's start with the user experience of success." +Start with user-centered success exploration: +- Guide conversation toward defining what "worth it" means for users +- Ask about the moment users realize their problem is solved +- Explore specific user outcomes and emotional states +- Identify success "aha!" moments and completion scenarios +- Focus on user experience of success first ### 2. Explore User Success Metrics @@ -120,15 +84,11 @@ Listen for specific user outcomes and help make them measurable: ### 3. Define Business Success Transition to business metrics: -"Now let's look at success from the business perspective. - -**Business Success:** - -- What does success look like at 3 months? 12 months? -- Are we measuring revenue, user growth, engagement, something else? -- What metric would make you say 'this is working'? - -Help me understand what success means for your business." +- Guide conversation to business perspective on success +- Explore timelines: What does 3-month success look like? 12-month success? +- Identify key business metrics: revenue, user growth, engagement, or other measures? +- Ask what specific metric would indicate "this is working" +- Understand business success from their perspective ### 4. Challenge Vague Metrics @@ -142,31 +102,25 @@ Push for specificity on business metrics: ### 5. Connect to Product Differentiator Tie success metrics back to what makes the product special: -"So success means users experience [differentiator] and achieve [outcome]. Does that capture it?" - -Adapt success criteria to context: - -- Consumer: User love, engagement, retention -- B2B: ROI, efficiency, adoption -- Developer tools: Developer experience, community -- Regulated: Compliance, safety, validation -- GovTech: Government compliance, accessibility, procurement +- Connect success criteria to the product's unique differentiator +- Ensure metrics reflect the specific value proposition +- Adapt success criteria to domain context: + - Consumer: User love, engagement, retention + - B2B: ROI, efficiency, adoption + - Developer tools: Developer experience, community + - Regulated: Compliance, safety, validation + - GovTech: Government compliance, accessibility, procurement ### 6. Smart Scope Negotiation Guide scope definition through success lens: -"The Scoping Game: - -1. What must work for this to be useful? → MVP -2. What makes it competitive? → Growth -3. What's the dream version? → Vision - -Challenge scope creep conversationally: - -- Could that wait until after launch? -- Is that essential for proving the concept? - -For complex domains, include compliance minimums in MVP." +- Help user distinguish MVP (must work to be useful) from growth (competitive) and vision (dream) +- Guide conversation through three scope levels: + 1. MVP: What's essential for proving the concept? + 2. Growth: What makes it competitive? + 3. Vision: What's the dream version? +- Challenge scope creep conversationally: Could this wait until after launch? Is this essential for MVP? +- For complex domains: Ensure compliance minimums are included in MVP ### 7. Generate Success Criteria Content @@ -210,43 +164,26 @@ When saving to document, append these Level 2 and Level 3 sections: [Content about future vision based on conversation] ``` -### 8. Present Content and Menu +### 8. Present MENU OPTIONS -Show the generated content and present choices: -"I've drafted our success criteria and scope definition based on our conversation. +Present the success criteria content for user review, then display menu: -**Here's what I'll add to the document:** +- Show the drafted success criteria and scope definition (using structure from section 7) +- Ask if they'd like to refine further, get other perspectives, or proceed +- Present menu options naturally as part of the conversation -[Show the complete markdown content from step 7] +Display: "**Select:** [A] Advanced Elicitation [P] Party Mode [C] Continue to User Journey Mapping (Step 4 of 11)" -**What would you like to do?** -[A] Advanced Elicitation - Let's dive deeper and refine these success metrics -[P] Party Mode - Bring in different perspectives on success criteria -[C] Continue - Save success criteria and move to User Journey Mapping (Step 4 of 11)" +#### Menu Handling Logic: +- IF A: Execute {advancedElicitationTask} with the current success criteria content, process the enhanced success metrics that come back, ask user "Accept these improvements to the success criteria? (y/n)", if yes update content with improvements then redisplay menu, if no keep original content then redisplay menu +- IF P: Execute {partyModeWorkflow} with the current success criteria, process the collaborative improvements to metrics and scope, ask user "Accept these changes to the success criteria? (y/n)", if yes update content with improvements then redisplay menu, if no keep original content then redisplay menu +- IF C: Append the final content to {outputFile}, update frontmatter by adding this step name to the end of the stepsCompleted array, then load, read entire file, then execute {nextStepFile} +- IF Any other: help user respond, then redisplay menu -### 9. Handle Menu Selection - -#### If 'A' (Advanced Elicitation): - -- Execute {project-root}/_bmad/core/tasks/advanced-elicitation.xml with the current success criteria content -- Process the enhanced success metrics that come back -- Ask user: "Accept these improvements to the success criteria? (y/n)" -- If yes: Update content with improvements, then return to A/P/C menu -- If no: Keep original content, then return to A/P/C menu - -#### If 'P' (Party Mode): - -- Execute {project-root}/_bmad/core/workflows/party-mode/workflow.md with the current success criteria -- Process the collaborative improvements to metrics and scope -- Ask user: "Accept these changes to the success criteria? (y/n)" -- If yes: Update content with improvements, then return to A/P/C menu -- If no: Keep original content, then return to A/P/C menu - -#### If 'C' (Continue): - -- Append the final content to `{output_folder}/prd.md` -- Update frontmatter: `stepsCompleted: [1, 2, 3]` -- Load `./step-04-journeys.md` +#### EXECUTION RULES: +- ALWAYS halt and wait for user input after presenting menu +- ONLY proceed to next step when user selects 'C' +- After other menu items execution, return to this menu ## APPEND TO DOCUMENT: diff --git a/src/modules/bmm/workflows/2-plan-workflows/prd/steps-c/step-04-journeys.md b/src/modules/bmm/workflows/2-plan-workflows/prd/steps-c/step-04-journeys.md new file mode 100644 index 00000000..765eb8b3 --- /dev/null +++ b/src/modules/bmm/workflows/2-plan-workflows/prd/steps-c/step-04-journeys.md @@ -0,0 +1,213 @@ +--- +name: 'step-04-journeys' +description: 'Map ALL user types that interact with the system with narrative story-based journeys' + +# File References +nextStepFile: './step-05-domain.md' +outputFile: '{planning_artifacts}/prd.md' + +# Task References +advancedElicitationTask: '{project-root}/_bmad/core/workflows/advanced-elicitation/workflow.xml' +partyModeWorkflow: '{project-root}/_bmad/core/workflows/party-mode/workflow.md' +--- + +# Step 4: User Journey Mapping + +**Progress: Step 4 of 11** - Next: Domain Requirements + +## MANDATORY EXECUTION RULES (READ FIRST): + +- 🛑 NEVER generate content without user input + +- 📖 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 +- ✅ ALWAYS treat this as collaborative discovery between PM peers +- 📋 YOU ARE A FACILITATOR, not a content generator +- 💬 FOCUS on mapping ALL user types that interact with the system +- 🎯 CRITICAL: No journey = no functional requirements = product doesn't exist +- ✅ 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 A/P/C menu after generating journey content +- 💾 ONLY save when user chooses C (Continue) +- 📖 Update output file frontmatter, adding this step name to the end of the list of stepsCompleted +- 🚫 FORBIDDEN to load next step until C is selected + +## CONTEXT BOUNDARIES: + +- Current document and frontmatter from previous steps are available +- Success criteria and scope already defined +- Input documents from step-01 are available (product briefs with user personas) +- Every human interaction with the system needs a journey + +## YOUR TASK: + +Create compelling narrative user journeys that leverage existing personas from product briefs and identify additional user types needed for comprehensive coverage. + +## JOURNEY MAPPING SEQUENCE: + +### 1. Leverage Existing Users & Identify Additional Types + +**Check Input Documents for Existing Personas:** +Analyze product brief, research, and brainstorming documents for user personas already defined. + +**If User Personas Exist in Input Documents:** +Guide user to build on existing personas: +- Acknowledge personas found in their product brief +- Extract key persona details and backstories +- Leverage existing insights about their needs +- Prompt to identify additional user types beyond those documented +- Suggest additional user types based on product context (admins, moderators, support, API consumers, internal ops) +- Ask what additional user types should be considered + +**If No Personas in Input Documents:** +Start with comprehensive user type discovery: +- Guide exploration of ALL people who interact with the system +- Consider beyond primary users: admins, moderators, support staff, API consumers, internal ops +- Ask what user types should be mapped for this specific product +- Ensure comprehensive coverage of all system interactions + +### 2. Create Narrative Story-Based Journeys + +For each user type, create compelling narrative journeys that tell their story: + +#### Narrative Journey Creation Process: + +**If Using Existing Persona from Input Documents:** +Guide narrative journey creation: +- Use persona's existing backstory from brief +- Explore how the product changes their life/situation +- Craft journey narrative: where do we meet them, how does product help them write their next chapter? + +**If Creating New Persona:** +Guide persona creation with story framework: +- Name: realistic name and personality +- Situation: What's happening in their life/work that creates need? +- Goal: What do they desperately want to achieve? +- Obstacle: What's standing in their way? +- Solution: How does the product solve their story? + +**Story-Based Journey Mapping:** + +Guide narrative journey creation using story structure: +- **Opening Scene**: Where/how do we meet them? What's their current pain? +- **Rising Action**: What steps do they take? What do they discover? +- **Climax**: Critical moment where product delivers real value +- **Resolution**: How does their situation improve? What's their new reality? + +Encourage narrative format with specific user details, emotional journey, and clear before/after contrast + +### 3. Guide Journey Exploration + +For each journey, facilitate detailed exploration: +- What happens at each step specifically? +- What could go wrong? What's the recovery path? +- What information do they need to see/hear? +- What's their emotional state at each point? +- Where does this journey succeed or fail? + +### 4. Connect Journeys to Requirements + +After each journey, explicitly state: +- This journey reveals requirements for specific capability areas +- Help user see how different journeys create different feature sets +- Connect journey needs to concrete capabilities (onboarding, dashboards, notifications, etc.) + +### 5. Aim for Comprehensive Coverage + +Guide toward complete journey set: + +- **Primary user** - happy path (core experience) +- **Primary user** - edge case (different goal, error recovery) +- **Secondary user** (admin, moderator, support, etc.) +- **API consumer** (if applicable) + +Ask if additional journeys are needed to cover uncovered user types + +### 6. Generate User Journey Content + +Prepare the content to append to the document: + +#### Content Structure: + +When saving to document, append these Level 2 and Level 3 sections: + +```markdown +## User Journeys + +[All journey narratives based on conversation] + +### Journey Requirements Summary + +[Summary of capabilities revealed by journeys based on conversation] +``` + +### 7. Present MENU OPTIONS + +Present the user journey content for review, then display menu: +- Show the mapped user journeys (using structure from section 6) +- Highlight how each journey reveals different capabilities +- Ask if they'd like to refine further, get other perspectives, or proceed +- Present menu options naturally as part of conversation + +Display: "**Select:** [A] Advanced Elicitation [P] Party Mode [C] Continue to Domain Requirements (Step 5 of 11)" + +#### Menu Handling Logic: +- IF A: Execute {advancedElicitationTask} with the current journey content, process the enhanced journey insights that come back, ask user "Accept these improvements to the user journeys? (y/n)", if yes update content with improvements then redisplay menu, if no keep original content then redisplay menu +- IF P: Execute {partyModeWorkflow} with the current journeys, process the collaborative journey improvements and additions, ask user "Accept these changes to the user journeys? (y/n)", if yes update content with improvements then redisplay menu, if no keep original content then redisplay menu +- IF C: Append the final content to {outputFile}, update frontmatter by adding this step name to the end of the stepsCompleted array, then load, read entire file, then execute {nextStepFile} +- IF Any other: help user respond, then redisplay menu + +#### EXECUTION RULES: +- ALWAYS halt and wait for user input after presenting menu +- ONLY proceed to next step when user selects 'C' +- After other menu items execution, return to this menu + +## APPEND TO DOCUMENT: + +When user selects 'C', append the content directly to the document using the structure from step 6. + +## SUCCESS METRICS: + +✅ Existing personas from product briefs leveraged when available +✅ All user types identified (not just primary users) +✅ Rich narrative storytelling for each persona and journey +✅ Complete story-based journey mapping with emotional arc +✅ Journey requirements clearly connected to capabilities needed +✅ Minimum 3-4 compelling narrative journeys covering different user types +✅ A/P/C menu presented and handled correctly +✅ Content properly appended to document when C selected + +## FAILURE MODES: + +❌ Ignoring existing personas from product briefs +❌ Only mapping primary user journeys and missing secondary users +❌ Creating generic journeys without rich persona details and narrative +❌ Missing emotional storytelling elements that make journeys compelling +❌ Missing critical decision points and failure scenarios +❌ Not connecting journeys to required capabilities +❌ Not having enough journey diversity (admin, support, API, etc.) +❌ Not presenting A/P/C menu after content generation +❌ Appending content without user selecting 'C' + +❌ **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 + +## JOURNEY TYPES TO ENSURE: + +**Minimum Coverage:** + +1. **Primary User - Success Path**: Core experience journey +2. **Primary User - Edge Case**: Error recovery, alternative goals +3. **Admin/Operations User**: Management, configuration, monitoring +4. **Support/Troubleshooting**: Help, investigation, issue resolution +5. **API/Integration** (if applicable): Developer/technical user journey + +## NEXT STEP: + +After user selects 'C' and content is saved to document, load `./step-05-domain.md`. + +Remember: Do NOT proceed to step-05 until user explicitly selects 'C' from the A/P/C menu and content is saved! diff --git a/src/modules/bmm/workflows/2-plan-workflows/prd/steps-c/step-05-domain.md b/src/modules/bmm/workflows/2-plan-workflows/prd/steps-c/step-05-domain.md new file mode 100644 index 00000000..36351c64 --- /dev/null +++ b/src/modules/bmm/workflows/2-plan-workflows/prd/steps-c/step-05-domain.md @@ -0,0 +1,207 @@ +--- +name: 'step-05-domain' +description: 'Explore domain-specific requirements for complex domains (optional step)' + +# File References +nextStepFile: './step-06-innovation.md' +outputFile: '{planning_artifacts}/prd.md' +domainComplexityCSV: '../data/domain-complexity.csv' + +# Task References +advancedElicitationTask: '{project-root}/_bmad/core/workflows/advanced-elicitation/workflow.xml' +partyModeWorkflow: '{project-root}/_bmad/core/workflows/party-mode/workflow.md' +--- + +# Step 5: Domain-Specific Requirements (Optional) + +**Progress: Step 5 of 13** - Next: Innovation Focus + +## STEP GOAL: + +For complex domains only that have a mapping in {domainComplexityCSV}, explore domain-specific constraints, compliance requirements, and technical considerations that shape the product. + +## MANDATORY EXECUTION RULES (READ FIRST): + +### Universal Rules: + +- 🛑 NEVER generate content without user input +- 📖 CRITICAL: Read the complete step file before taking any action +- 🔄 CRITICAL: When loading next step with 'C', ensure the entire file is read +- ✅ ALWAYS treat this as collaborative discovery between PM peers +- 📋 YOU ARE A FACILITATOR, not a content generator +- ✅ YOU MUST ALWAYS SPEAK OUTPUT In your Agent communication style with the config `{communication_language}` + +### Role Reinforcement: + +- ✅ You are a product-focused PM facilitator collaborating with an expert peer +- ✅ We engage in collaborative dialogue, not command-response +- ✅ You bring structured thinking and facilitation skills, while the user brings domain expertise + +### Step-Specific Rules: + +- 🎯 This step is OPTIONAL - only needed for complex domains +- 🚫 SKIP if domain complexity is "low" from step-02 +- 💬 APPROACH: Natural conversation to discover domain-specific needs +- 🎯 Focus on constraints, compliance, and domain patterns + +## EXECUTION PROTOCOLS: + +- 🎯 Check domain complexity from step-02 classification first +- ⚠️ If complexity is "low", offer to skip this step +- ⚠️ Present A/P/C menu after domain requirements defined (or skipped) +- 💾 ONLY save when user chooses C (Continue) +- 📖 Update output file frontmatter, adding this step name to the end of the list of stepsCompleted +- 🚫 FORBIDDEN to load next step until C is selected + +## CONTEXT BOUNDARIES: + +- Domain classification from step-02 is available +- If complexity is low, this step may be skipped +- Domain CSV data provides complexity reference +- Focus on domain-specific constraints, not general requirements + +## YOUR TASK: + +For complex domains, explore what makes this domain special: +- **Compliance requirements** - regulations, standards, certifications +- **Technical constraints** - security, privacy, integration requirements +- **Domain patterns** - common patterns, best practices, anti-patterns +- **Risks and mitigations** - what could go wrong, how to prevent it + +## DOMAIN DISCOVERY SEQUENCE: + +### 1. Check Domain Complexity + +**Review classification from step-02:** + +- What's the domain complexity level? (low/medium/high) +- What's the specific domain? (healthcare, fintech, education, etc.) + +**If complexity is LOW:** + +Offer to skip: +"The domain complexity from our discovery is low. We may not need deep domain-specific requirements. Would you like to: +- [C] Skip this step and move to Innovation +- [D] Do domain exploration anyway" + +**If complexity is MEDIUM or HIGH:** + +Proceed with domain exploration. + +### 2. Load Domain Reference Data + +**Attempt subprocess data lookup:** + +"Your task: Lookup data in {domainComplexityCSV} + +**Search criteria:** +- Find row where domain matches {{domainFromStep02}} + +**Return format:** +Return ONLY the matching row as a YAML-formatted object with these fields: +domain, complexity, typical_concerns, compliance_requirements + +**Do NOT return the entire CSV - only the matching row.**" + +**Graceful degradation (if Task tool unavailable):** +- Load the CSV file directly +- Find the matching row manually +- Extract required fields +- Understand typical concerns and compliance requirements + +### 3. Explore Domain-Specific Concerns + +**Start with what you know:** + +Acknowledge the domain and explore what makes it complex: +- What regulations apply? (HIPAA, PCI-DSS, GDPR, SOX, etc.) +- What standards matter? (ISO, NIST, domain-specific standards) +- What certifications are needed? (security, privacy, domain-specific) +- What integrations are required? (EMR systems, payment processors, etc.) + +**Explore technical constraints:** +- Security requirements (encryption, audit logs, access control) +- Privacy requirements (data handling, consent, retention) +- Performance requirements (real-time, batch, latency) +- Availability requirements (uptime, disaster recovery) + +### 4. Document Domain Requirements + +**Structure the requirements around key concerns:** + +```markdown +### Compliance & Regulatory +- [Specific requirements] + +### Technical Constraints +- [Security, privacy, performance needs] + +### Integration Requirements +- [Required systems and data flows] + +### Risk Mitigations +- [Domain-specific risks and how to address them] +``` + +### 5. Validate Completeness + +**Check with the user:** + +"Are there other domain-specific concerns we should consider? For [this domain], what typically gets overlooked?" + +### N. Present MENU OPTIONS + +Display: "**Select:** [A] Advanced Elicitation [P] Party Mode [C] Continue - Save and Proceed to Innovation (Step 6 of 13)" + +#### Menu Handling Logic: +- IF A: Execute {advancedElicitationTask}, and when finished redisplay the menu +- IF P: Execute {partyModeWorkflow}, and when finished redisplay the menu +- IF C: Save content to {outputFile}, update frontmatter, then load, read entire file, then execute {nextStepFile} +- IF Any other comments or queries: help user respond then [Redisplay Menu Options](#n-present-menu-options) + +#### EXECUTION RULES: +- ALWAYS halt and wait for user input after presenting menu +- ONLY proceed to next step when user selects 'C' +- After other menu items execution, return to this menu + +## APPEND TO DOCUMENT + +When user selects 'C', append to `{outputFile}`: + +```markdown +## Domain-Specific Requirements + +{{discovered domain requirements}} +``` + +If step was skipped, append nothing and proceed. + +## CRITICAL STEP COMPLETION NOTE + +ONLY WHEN [C continue option] is selected and [content saved or skipped], will you then load and read fully `{nextStepFile}` to explore innovation. + +--- + +## 🚨 SYSTEM SUCCESS/FAILURE METRICS + +### ✅ SUCCESS: + +- Domain complexity checked before proceeding +- Offered to skip if complexity is low +- Natural conversation exploring domain concerns +- Compliance, technical, and integration requirements identified +- Domain-specific risks documented with mitigations +- User validated completeness +- Content properly saved (or step skipped) when C selected + +### ❌ SYSTEM FAILURE: + +- Not checking domain complexity first +- Not offering to skip for low-complexity domains +- Missing critical compliance requirements +- Not exploring technical constraints +- Not asking about domain-specific risks +- Being generic instead of domain-specific +- Proceeding without user validation + +**Master Rule:** This step is OPTIONAL for simple domains. For complex domains, focus on compliance, constraints, and domain patterns. Natural conversation, not checklists. diff --git a/src/modules/bmm/workflows/2-plan-workflows/prd/steps/step-06-innovation.md b/src/modules/bmm/workflows/2-plan-workflows/prd/steps-c/step-06-innovation.md similarity index 57% rename from src/modules/bmm/workflows/2-plan-workflows/prd/steps/step-06-innovation.md rename to src/modules/bmm/workflows/2-plan-workflows/prd/steps-c/step-06-innovation.md index 709edad2..85e3d473 100644 --- a/src/modules/bmm/workflows/2-plan-workflows/prd/steps/step-06-innovation.md +++ b/src/modules/bmm/workflows/2-plan-workflows/prd/steps-c/step-06-innovation.md @@ -2,20 +2,15 @@ name: 'step-06-innovation' description: 'Detect and explore innovative aspects of the product (optional step)' -# Path Definitions -workflow_path: '{project-root}/_bmad/bmm/workflows/2-plan-workflows/prd' - # File References -thisStepFile: '{workflow_path}/steps/step-06-innovation.md' -nextStepFile: '{workflow_path}/steps/step-07-project-type.md' -workflowFile: '{workflow_path}/workflow.md' -outputFile: '{output_folder}/prd.md' +nextStepFile: './step-07-project-type.md' +outputFile: '{planning_artifacts}/prd.md' # Data Files -projectTypesCSV: '{workflow_path}/project-types.csv' +projectTypesCSV: '../data/project-types.csv' # Task References -advancedElicitationTask: '{project-root}/_bmad/core/tasks/advanced-elicitation.xml' +advancedElicitationTask: '{project-root}/_bmad/core/workflows/advanced-elicitation/workflow.xml' partyModeWorkflow: '{project-root}/_bmad/core/workflows/party-mode/workflow.md' --- @@ -33,30 +28,16 @@ partyModeWorkflow: '{project-root}/_bmad/core/workflows/party-mode/workflow.md' - 📋 YOU ARE A FACILITATOR, not a content generator - 💬 FOCUS on detecting and exploring innovative aspects of the product - 🎯 OPTIONAL STEP: Only proceed if innovation signals are detected +- ✅ 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 A/P/C menu after generating innovation content - 💾 ONLY save when user chooses C (Continue) -- 📖 Update frontmatter `stepsCompleted: [1, 2, 3, 4, 5, 6]` before loading next step +- 📖 Update output file frontmatter, adding this step name to the end of the list of stepsCompleted - 🚫 FORBIDDEN to load next step until C is selected -## COLLABORATION MENUS (A/P/C): - -This step will generate content and present choices: - -- **A (Advanced Elicitation)**: Use discovery protocols to develop deeper innovation insights -- **P (Party Mode)**: Bring creative perspectives to explore innovation opportunities -- **C (Continue)**: Save the content to the document and proceed to next step - -## PROTOCOL INTEGRATION: - -- When 'A' selected: Execute {project-root}/_bmad/core/tasks/advanced-elicitation.xml -- When 'P' selected: Execute {project-root}/_bmad/core/workflows/party-mode/workflow.md -- PROTOCOLS always return to this step's A/P/C menu -- User accepts/rejects protocol changes before proceeding - ## CONTEXT BOUNDARIES: - Current document and frontmatter from previous steps are available @@ -83,7 +64,7 @@ Detect and explore innovation patterns in the product, focusing on what makes it Load innovation signals specific to this project type: -- Load `{project-root}/_bmad/bmm/workflows/2-plan-workflows/prd/project-types.csv` completely +- Load `{projectTypesCSV}` completely - Find the row where `project_type` matches detected type from step-02 - Extract `innovation_signals` (semicolon-separated list) - Extract `web_search_triggers` for potential innovation research @@ -112,27 +93,22 @@ Match user descriptions against innovation_signals for their project_type: ### 3. Initial Innovation Screening Ask targeted innovation discovery questions: -"As we explore {{project_name}}, I'm listening for what makes it innovative. - -**Innovation Indicators:** - -- Are you challenging any existing assumptions about how things work? -- Are you combining technologies or approaches in new ways? -- Is there something about this that hasn't been done before? - -What aspects of {{project_name}} feel most innovative to you?" +- Guide exploration of what makes the product innovative +- Explore if they're challenging existing assumptions +- Ask about novel combinations of technologies/approaches +- Identify what hasn't been done before +- Understand which aspects feel most innovative ### 4. Deep Innovation Exploration (If Detected) If innovation signals are found, explore deeply: #### Innovation Discovery Questions: - -- "What makes it unique compared to existing solutions?" -- "What assumption are you challenging?" -- "How do we validate it works?" -- "What's the fallback if it doesn't?" -- "Has anyone tried this before?" +- What makes it unique compared to existing solutions? +- What assumption are you challenging? +- How do we validate it works? +- What's the fallback if it doesn't? +- Has anyone tried this before? #### Market Context Research: @@ -168,54 +144,43 @@ When saving to document, append these Level 2 and Level 3 sections: [Innovation risks and fallbacks based on conversation] ``` -### 6. Present Content and Menu (Only if Innovation Detected) +### 6. Present MENU OPTIONS (Only if Innovation Detected) -Show the generated innovation content and present choices: -"I've identified some innovative aspects of {{project_name}} that differentiate it from existing solutions. +Present the innovation content for review, then display menu: +- Show identified innovative aspects (using structure from section 5) +- Highlight differentiation from existing solutions +- Ask if they'd like to refine further, get other perspectives, or proceed +- Present menu options naturally as part of conversation -**Here's what I'll add to the document:** +Display: "**Select:** [A] Advanced Elicitation [P] Party Mode [C] Continue to Project Type Analysis (Step 7 of 11)" -[Show the complete markdown content from step 5] +#### Menu Handling Logic: +- IF A: Execute {advancedElicitationTask} with the current innovation content, process the enhanced innovation insights that come back, ask user "Accept these improvements to the innovation analysis? (y/n)", if yes update content with improvements then redisplay menu, if no keep original content then redisplay menu +- IF P: Execute {partyModeWorkflow} with the current innovation content, process the collaborative innovation exploration and ideation, ask user "Accept these changes to the innovation analysis? (y/n)", if yes update content with improvements then redisplay menu, if no keep original content then redisplay menu +- IF C: Append the final content to {outputFile}, update frontmatter by adding this step name to the end of the stepsCompleted array, then load, read entire file, then execute {nextStepFile} +- IF Any other: help user respond, then redisplay menu -**What would you like to do?** -[A] Advanced Elicitation - Let's dive deeper into these innovation opportunities -[P] Party Mode - Bring creative perspectives to explore innovation further -[C] Continue - Save this and move to Project Type Analysis (Step 7 of 11)" - -### 7. Handle Menu Selection - -#### If 'A' (Advanced Elicitation): - -- Execute {project-root}/_bmad/core/tasks/advanced-elicitation.xml with the current innovation content -- Process the enhanced innovation insights that come back -- Ask user: "Accept these improvements to the innovation analysis? (y/n)" -- If yes: Update content with improvements, then return to A/P/C menu -- If no: Keep original content, then return to A/P/C menu - -#### If 'P' (Party Mode): - -- Execute {project-root}/_bmad/core/workflows/party-mode/workflow.md with the current innovation content -- Process the collaborative innovation exploration and ideation -- Ask user: "Accept these changes to the innovation analysis? (y/n)" -- If yes: Update content with improvements, then return to A/P/C menu -- If no: Keep original content, then return to A/P/C menu - -#### If 'C' (Continue): - -- Append the final content to `{output_folder}/prd.md` -- Update frontmatter: `stepsCompleted: [1, 2, 3, 4, 5, 6]` -- Load `{project-root}/_bmad/bmm/workflows/2-plan-workflows/prd/steps/step-07-project-type.md` +#### EXECUTION RULES: +- ALWAYS halt and wait for user input after presenting menu +- ONLY proceed to next step when user selects 'C' +- After other menu items execution, return to this menu ## NO INNOVATION DETECTED: If no genuine innovation signals are found after exploration: -"After exploring {{project_name}}, I don't see clear innovation signals that warrant a dedicated innovation section. This is perfectly fine - many successful products are excellent executions of existing concepts rather than breakthrough innovations. +- Acknowledge that no clear innovation signals were found +- Note this is fine - many successful products are excellent executions of existing concepts +- Ask if they'd like to try finding innovative angles or proceed -**Options:** -[A] Force innovation exploration - Let's try to find innovative angles -[C] Continue - Skip innovation section and move to Project Type Analysis (Step 7 of 11)" +Display: "**Select:** [A] Advanced Elicitation - Let's try to find innovative angles [C] Continue - Skip innovation section and move to Project Type Analysis (Step 7 of 11)" -If user selects 'A', proceed with content generation anyway. If 'C', skip this step and load `{project-root}/_bmad/bmm/workflows/2-plan-workflows/prd/steps/step-07-project-type.md`. +### Menu Handling Logic: +- IF A: Proceed with content generation anyway, then return to menu +- IF C: Skip this step, then load, read entire file, then execute {nextStepFile} + +### EXECUTION RULES: +- ALWAYS halt and wait for user input after presenting menu +- ONLY proceed to next step when user selects 'C' ## APPEND TO DOCUMENT: @@ -247,7 +212,7 @@ When user selects 'C', append the content directly to the document using the str ## SKIP CONDITIONS: -Skip this step and load `{project-root}/_bmad/bmm/workflows/2-plan-workflows/prd/steps/step-07-project-type.md` if: +Skip this step and load `{nextStepFile}` if: - No innovation signals detected in conversation - Product is incremental improvement rather than breakthrough @@ -256,6 +221,6 @@ Skip this step and load `{project-root}/_bmad/bmm/workflows/2-plan-workflows/prd ## NEXT STEP: -After user selects 'C' and content is saved to document (or step is skipped), load `{project-root}/_bmad/bmm/workflows/2-plan-workflows/prd/steps/step-07-project-type.md`. +After user selects 'C' and content is saved to document (or step is skipped), load `{nextStepFile}`. Remember: Do NOT proceed to step-07 until user explicitly selects 'C' from the A/P/C menu (or confirms step skip)! diff --git a/src/modules/bmm/workflows/2-plan-workflows/prd/steps/step-07-project-type.md b/src/modules/bmm/workflows/2-plan-workflows/prd/steps-c/step-07-project-type.md similarity index 67% rename from src/modules/bmm/workflows/2-plan-workflows/prd/steps/step-07-project-type.md rename to src/modules/bmm/workflows/2-plan-workflows/prd/steps-c/step-07-project-type.md index adca0967..27650819 100644 --- a/src/modules/bmm/workflows/2-plan-workflows/prd/steps/step-07-project-type.md +++ b/src/modules/bmm/workflows/2-plan-workflows/prd/steps-c/step-07-project-type.md @@ -2,20 +2,15 @@ name: 'step-07-project-type' description: 'Conduct project-type specific discovery using CSV-driven guidance' -# Path Definitions -workflow_path: '{project-root}/_bmad/bmm/workflows/2-plan-workflows/prd' - # File References -thisStepFile: '{workflow_path}/steps/step-07-project-type.md' -nextStepFile: '{workflow_path}/steps/step-08-scoping.md' -workflowFile: '{workflow_path}/workflow.md' -outputFile: '{output_folder}/prd.md' +nextStepFile: './step-08-scoping.md' +outputFile: '{planning_artifacts}/prd.md' # Data Files -projectTypesCSV: '{workflow_path}/project-types.csv' +projectTypesCSV: '../data/project-types.csv' # Task References -advancedElicitationTask: '{project-root}/_bmad/core/tasks/advanced-elicitation.xml' +advancedElicitationTask: '{project-root}/_bmad/core/workflows/advanced-elicitation/workflow.xml' partyModeWorkflow: '{project-root}/_bmad/core/workflows/party-mode/workflow.md' --- @@ -33,30 +28,16 @@ partyModeWorkflow: '{project-root}/_bmad/core/workflows/party-mode/workflow.md' - 📋 YOU ARE A FACILITATOR, not a content generator - 💬 FOCUS on project-type specific requirements and technical considerations - 🎯 DATA-DRIVEN: Use CSV configuration to guide discovery +- ✅ 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 A/P/C menu after generating project-type content - 💾 ONLY save when user chooses C (Continue) -- 📖 Update frontmatter `stepsCompleted: [1, 2, 3, 4, 5, 6, 7]` before loading next step +- 📖 Update output file frontmatter, adding this step name to the end of the list of stepsCompleted - 🚫 FORBIDDEN to load next step until C is selected -## COLLABORATION MENUS (A/P/C): - -This step will generate content and present choices: - -- **A (Advanced Elicitation)**: Use discovery protocols to develop deeper project-type insights -- **P (Party Mode)**: Bring technical perspectives to explore project-specific requirements -- **C (Continue)**: Save the content to the document and proceed to next step - -## PROTOCOL INTEGRATION: - -- When 'A' selected: Execute {project-root}/_bmad/core/tasks/advanced-elicitation.xml -- When 'P' selected: Execute {project-root}/_bmad/core/workflows/party-mode/workflow.md -- PROTOCOLS always return to this step's A/P/C menu -- User accepts/rejects protocol changes before proceeding - ## CONTEXT BOUNDARIES: - Current document and frontmatter from previous steps are available @@ -72,11 +53,23 @@ Conduct project-type specific discovery using CSV-driven guidance to define tech ### 1. Load Project-Type Configuration Data -Load project-type specific configuration: +**Attempt subprocess data lookup:** -- Load `{project-root}/_bmad/bmm/workflows/2-plan-workflows/prd/project-types.csv` completely -- Find the row where `project_type` matches detected type from step-02 -- Extract these columns: +"Your task: Lookup data in {projectTypesCSV} + +**Search criteria:** +- Find row where project_type matches {{projectTypeFromStep02}} + +**Return format:** +Return ONLY the matching row as a YAML-formatted object with these fields: +project_type, key_questions, required_sections, skip_sections, innovation_signals + +**Do NOT return the entire CSV - only the matching row.**" + +**Graceful degradation (if Task tool unavailable):** +- Load the CSV file directly +- Find the matching row manually +- Extract required fields: - `key_questions` (semicolon-separated list of discovery questions) - `required_sections` (semicolon-separated list of sections to document) - `skip_sections` (semicolon-separated list of sections to skip) @@ -164,47 +157,34 @@ When saving to document, append these Level 2 and Level 3 sections: [Implementation specific requirements based on conversation] ``` -### 6. Present Content and Menu +### 6. Present MENU OPTIONS -Show the generated project-type content and present choices: -"I've documented the {project_type}-specific requirements for {{project_name}} based on our conversation and best practices for this type of product. +Present the project-type content for review, then display menu: + +"Based on our conversation and best practices for this product type, I've documented the {project_type}-specific requirements for {{project_name}}. **Here's what I'll add to the document:** -[Show the complete markdown content from step 5] +[Show the complete markdown content from section 5] -**What would you like to do?** -[A] Advanced Elicitation - Let's dive deeper into these technical requirements -[P] Party Mode - Bring technical expertise perspectives to validate requirements -[C] Continue - Save this and move to Scoping (Step 8 of 11)" +**What would you like to do?**" -### 7. Handle Menu Selection +Display: "**Select:** [A] Advanced Elicitation [P] Party Mode [C] Continue to Scoping (Step 8 of 11)" -#### If 'A' (Advanced Elicitation): +#### Menu Handling Logic: +- IF A: Execute {advancedElicitationTask} with the current project-type content, process the enhanced technical insights that come back, ask user "Accept these improvements to the technical requirements? (y/n)", if yes update content with improvements then redisplay menu, if no keep original content then redisplay menu +- IF P: Execute {partyModeWorkflow} with the current project-type requirements, process the collaborative technical expertise and validation, ask user "Accept these changes to the technical requirements? (y/n)", if yes update content with improvements then redisplay menu, if no keep original content then redisplay menu +- IF C: Append the final content to {outputFile}, update frontmatter by adding this step name to the end of the stepsCompleted array, then load, read entire file, then execute {nextStepFile} +- IF Any other: help user respond, then redisplay menu -- Execute {project-root}/_bmad/core/tasks/advanced-elicitation.xml with the current project-type content -- Process the enhanced technical insights that come back -- Ask user: "Accept these improvements to the technical requirements? (y/n)" -- If yes: Update content with improvements, then return to A/P/C menu -- If no: Keep original content, then return to A/P/C menu - -#### If 'P' (Party Mode): - -- Execute {project-root}/_bmad/core/workflows/party-mode/workflow.md with the current project-type requirements -- Process the collaborative technical expertise and validation -- Ask user: "Accept these changes to the technical requirements? (y/n)" -- If yes: Update content with improvements, then return to A/P/C menu -- If no: Keep original content, then return to A/P/C menu - -#### If 'C' (Continue): - -- Append the final content to `{output_folder}/prd.md` -- Update frontmatter: `stepsCompleted: [1, 2, 3, 4, 5, 6, 7]` -- Load `{project-root}/_bmad/bmm/workflows/2-plan-workflows/prd/steps/step-08-scoping.md` +#### EXECUTION RULES: +- ALWAYS halt and wait for user input after presenting menu +- ONLY proceed to next step when user selects 'C' +- After other menu items execution, return to this menu ## APPEND TO DOCUMENT: -When user selects 'C', append the content directly to the document using the structure from step 5. +When user selects 'C', append the content directly to the document using the structure from previous steps. ## SUCCESS METRICS: @@ -252,6 +232,6 @@ When user selects 'C', append the content directly to the document using the str ## NEXT STEP: -After user selects 'C' and content is saved to document, load `{project-root}/_bmad/bmm/workflows/2-plan-workflows/prd/steps/step-08-scoping.md` to define project scope. +After user selects 'C' and content is saved to document, load `{nextStepFile}` to define project scope. Remember: Do NOT proceed to step-08 (Scoping) until user explicitly selects 'C' from the A/P/C menu and content is saved! diff --git a/src/modules/bmm/workflows/2-plan-workflows/prd/steps/step-08-scoping.md b/src/modules/bmm/workflows/2-plan-workflows/prd/steps-c/step-08-scoping.md similarity index 51% rename from src/modules/bmm/workflows/2-plan-workflows/prd/steps/step-08-scoping.md rename to src/modules/bmm/workflows/2-plan-workflows/prd/steps-c/step-08-scoping.md index ca03d214..c26ad663 100644 --- a/src/modules/bmm/workflows/2-plan-workflows/prd/steps/step-08-scoping.md +++ b/src/modules/bmm/workflows/2-plan-workflows/prd/steps-c/step-08-scoping.md @@ -2,17 +2,12 @@ name: 'step-08-scoping' description: 'Define MVP boundaries and prioritize features across development phases' -# Path Definitions -workflow_path: '{project-root}/_bmad/bmm/workflows/2-plan-workflows/prd' - # File References -thisStepFile: '{workflow_path}/steps/step-08-scoping.md' -nextStepFile: '{workflow_path}/steps/step-09-functional.md' -workflowFile: '{workflow_path}/workflow.md' -outputFile: '{output_folder}/prd.md' +nextStepFile: './step-09-functional.md' +outputFile: '{planning_artifacts}/prd.md' # Task References -advancedElicitationTask: '{project-root}/_bmad/core/tasks/advanced-elicitation.xml' +advancedElicitationTask: '{project-root}/_bmad/core/workflows/advanced-elicitation/workflow.xml' partyModeWorkflow: '{project-root}/_bmad/core/workflows/party-mode/workflow.md' --- @@ -30,6 +25,7 @@ partyModeWorkflow: '{project-root}/_bmad/core/workflows/party-mode/workflow.md' - 📋 YOU ARE A FACILITATOR, not a content generator - 💬 FOCUS on strategic scope decisions that keep projects viable - 🎯 EMPHASIZE lean MVP thinking while preserving long-term vision +- ✅ YOU MUST ALWAYS SPEAK OUTPUT In your Agent communication style with the config `{communication_language}` ## EXECUTION PROTOCOLS: @@ -37,23 +33,9 @@ partyModeWorkflow: '{project-root}/_bmad/core/workflows/party-mode/workflow.md' - 📚 Review the complete PRD document built so far - ⚠️ Present A/P/C menu after generating scoping decisions - 💾 ONLY save when user chooses C (Continue) -- 📖 Update frontmatter `stepsCompleted: [1, 2, 3, 4, 5, 6, 7, 8]` before loading next step +- 📖 Update output file frontmatter, adding this step name to the end of the list of stepsCompleted - 🚫 FORBIDDEN to load next step until C is selected -## COLLABORATION MENUS (A/P/C): - -This step will generate content and present choices: - -- **A (Advanced Elicitation)**: Use discovery protocols to explore innovative scoping approaches -- **P (Party Mode)**: Bring multiple perspectives to ensure comprehensive scope decisions -- **C (Continue)**: Save the scoping decisions and proceed to functional requirements - -## PROTOCOL INTEGRATION: - -- When 'A' selected: Execute {project-root}/_bmad/core/tasks/advanced-elicitation.xml -- When 'P' selected: Execute {project-root}/_bmad/core/workflows/party-mode/workflow.md -- PROTOCOLS always return to display this step's A/P/C menu after the A or P have completed -- User accepts/rejects protocol changes before proceeding ## CONTEXT BOUNDARIES: @@ -71,80 +53,46 @@ Conduct comprehensive scoping exercise to define MVP boundaries and prioritize f ### 1. Review Current PRD State Analyze everything documented so far: -"I've reviewed your complete PRD so far. Here's what we've established: - -**Product Vision & Success:** -{{summary_of_vision_and_success_criteria}} - -**User Journeys:** {{number_of_journeys}} mapped with rich narratives - -**Domain & Innovation Focus:** -{{summary_of_domain_requirements_and_innovation}} - -**Current Scope Implications:** -Based on everything we've documented, this looks like it could be: - -- [ ] Simple MVP (small team, lean scope) -- [ ] Medium scope (moderate team, balanced features) -- [ ] Complex project (large team, comprehensive scope) - -Does this initial assessment feel right, or do you see this differently?" +- Present synthesis of established vision, success criteria, journeys +- Assess domain and innovation focus +- Evaluate scope implications: simple MVP, medium, or complex project +- Ask if initial assessment feels right or if they see it differently ### 2. Define MVP Strategy Facilitate strategic MVP decisions: - -"Let's think strategically about your launch strategy: - -**MVP Philosophy Options:** - -1. **Problem-Solving MVP**: Solve the core problem with minimal features -2. **Experience MVP**: Deliver the key user experience with basic functionality -3. **Platform MVP**: Build the foundation for future expansion -4. **Revenue MVP**: Generate early revenue with essential features - -**Critical Questions:** - -- What's the minimum that would make users say 'this is useful'? -- What would make investors/partners say 'this has potential'? -- What's the fastest path to validated learning? - -**Which MVP approach feels right for {{project_name}}?**" +- Explore MVP philosophy options: problem-solving, experience, platform, or revenue MVP +- Ask critical questions: + - What's the minimum that would make users say 'this is useful'? + - What would make investors/partners say 'this has potential'? + - What's the fastest path to validated learning? +- Guide toward appropriate MVP approach for their product ### 3. Scoping Decision Framework Use structured decision-making for scope: **Must-Have Analysis:** -"Let's identify absolute MVP necessities. For each journey and success criterion, ask: - -- **Without this, does the product fail?** (Y/N) -- **Can this be manual initially?** (Y/N) -- **Is this a deal-breaker for early adopters?** (Y/N) - -**Current Document Review:** -Looking at your user journeys, what are the absolute core experiences that must work? - -{{analyze_journeys_for_mvp_essentials}}" +- Guide identification of absolute MVP necessities +- For each journey and success criterion, ask: + - Without this, does the product fail? + - Can this be manual initially? + - Is this a deal-breaker for early adopters? +- Analyze journeys for MVP essentials **Nice-to-Have Analysis:** -"Let's also identify what could be added later: - -**Post-MVP Enhancements:** - -- Features that enhance but aren't essential -- User types that can be added later -- Advanced functionality that builds on MVP - -**What features could we add in versions 2, 3, etc.?**" +- Identify what could be added later: + - Features that enhance but aren't essential + - User types that can be added later + - Advanced functionality that builds on MVP +- Ask what features could be added in versions 2, 3, etc. ### 4. Progressive Feature Roadmap Create phased development approach: - -"Let's map your features across development phases: - -**Phase 1: MVP** +- Guide mapping of features across development phases +- Structure as Phase 1 (MVP), Phase 2 (Growth), Phase 3 (Vision) +- Ensure clear progression and dependencies - Core user value delivery - Essential user journeys @@ -224,44 +172,26 @@ Prepare comprehensive scoping section: **Resource Risks:** {{contingency_approach}} ``` -### 7. Present Content and Menu +### 7. Present MENU OPTIONS -Show the scoping decisions and present choices: +Present the scoping decisions for review, then display menu: +- Show strategic scoping plan (using structure from step 6) +- Highlight MVP boundaries and phased roadmap +- Ask if they'd like to refine further, get other perspectives, or proceed +- Present menu options naturally as part of conversation -"I've analyzed your complete PRD and created a strategic scoping plan for {{project_name}}. +Display: "**Select:** [A] Advanced Elicitation [P] Party Mode [C] Continue to Functional Requirements (Step 9 of 11)" -**Here's what I'll add to the document:** +#### Menu Handling Logic: +- IF A: Execute {advancedElicitationTask} with the current scoping analysis, process the enhanced insights that come back, ask user if they accept the improvements, if yes update content then redisplay menu, if no keep original content then redisplay menu +- IF P: Execute {partyModeWorkflow} with the scoping context, process the collaborative insights on MVP and roadmap decisions, ask user if they accept the changes, if yes update content then redisplay menu, if no keep original content then redisplay menu +- IF C: Append the final content to {outputFile}, update frontmatter by adding this step name to the end of the stepsCompleted array, then load, read entire file, then execute {nextStepFile} +- IF Any other: help user respond, then redisplay menu -[Show the complete markdown content from step 6] - -**What would you like to do?** -[A] Advanced Elicitation - Explore alternative scoping strategies -[P] Party Mode - Bring different perspectives on MVP and roadmap decisions -[C] Continue - Save scoping decisions and move to Functional Requirements (Step 9 of 11)" - -### 8. Handle Menu Selection - -#### If 'A' (Advanced Elicitation): - -- Execute {project-root}/_bmad/core/tasks/advanced-elicitation.xml with current scoping analysis -- Process enhanced scoping insights that come back -- Ask user: "Accept these improvements to the scoping decisions? (y/n)" -- If yes: Update content, then return to A/P/C menu -- If no: Keep original content, then return to A/P/C menu - -#### If 'P' (Party Mode): - -- Execute {project-root}/_bmad/core/workflows/party-mode/workflow.md with scoping context -- Process collaborative insights on MVP and roadmap decisions -- Ask user: "Accept these changes to the scoping decisions? (y/n)" -- If yes: Update content, then return to A/P/C menu -- If no: Keep original content, then return to A/P/C menu - -#### If 'C' (Continue): - -- Append the final content to `{output_folder}/prd.md` -- Update frontmatter: `stepsCompleted: [1, 2, 3, 4, 5, 6, 7, 8]` -- Load `./step-09-functional.md` +#### EXECUTION RULES: +- ALWAYS halt and wait for user input after presenting menu +- ONLY proceed to next step when user selects 'C' +- After other menu items execution, return to this menu ## APPEND TO DOCUMENT: @@ -293,6 +223,6 @@ When user selects 'C', append the content directly to the document using the str ## NEXT STEP: -After user selects 'C' and content is saved to document, load `./step-09-functional.md`. +After user selects 'C' and content is saved to document, load {nextStepFile}. Remember: Do NOT proceed to step-09 until user explicitly selects 'C' from the A/P/C menu and content is saved! diff --git a/src/modules/bmm/workflows/2-plan-workflows/prd/steps/step-09-functional.md b/src/modules/bmm/workflows/2-plan-workflows/prd/steps-c/step-09-functional.md similarity index 69% rename from src/modules/bmm/workflows/2-plan-workflows/prd/steps/step-09-functional.md rename to src/modules/bmm/workflows/2-plan-workflows/prd/steps-c/step-09-functional.md index 5d8df8bd..36fb71b4 100644 --- a/src/modules/bmm/workflows/2-plan-workflows/prd/steps/step-09-functional.md +++ b/src/modules/bmm/workflows/2-plan-workflows/prd/steps-c/step-09-functional.md @@ -2,17 +2,12 @@ name: 'step-09-functional' description: 'Synthesize all discovery into comprehensive functional requirements' -# Path Definitions -workflow_path: '{project-root}/_bmad/bmm/workflows/2-plan-workflows/prd' - # File References -thisStepFile: '{workflow_path}/steps/step-09-functional.md' -nextStepFile: '{workflow_path}/steps/step-10-nonfunctional.md' -workflowFile: '{workflow_path}/workflow.md' -outputFile: '{output_folder}/prd.md' +nextStepFile: './step-10-nonfunctional.md' +outputFile: '{planning_artifacts}/prd.md' # Task References -advancedElicitationTask: '{project-root}/_bmad/core/tasks/advanced-elicitation.xml' +advancedElicitationTask: '{project-root}/_bmad/core/workflows/advanced-elicitation/workflow.xml' partyModeWorkflow: '{project-root}/_bmad/core/workflows/party-mode/workflow.md' --- @@ -30,29 +25,16 @@ partyModeWorkflow: '{project-root}/_bmad/core/workflows/party-mode/workflow.md' - 📋 YOU ARE A FACILITATOR, not a content generator - 💬 FOCUS on creating comprehensive capability inventory for the product - 🎯 CRITICAL: This is THE CAPABILITY CONTRACT for all downstream work +- ✅ 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 A/P/C menu after generating functional requirements - 💾 ONLY save when user chooses C (Continue) -- 📖 Update frontmatter `stepsCompleted: [1, 2, 3, 4, 5, 6, 7, 8]` before loading next step +- 📖 Update output file frontmatter, adding this step name to the end of the list of stepsCompleted - 🚫 FORBIDDEN to load next step until C is selected -## COLLABORATION MENUS (A/P/C): - -This step will generate content and present choices: - -- **A (Advanced Elicitation)**: Use discovery protocols to ensure comprehensive requirement coverage -- **P (Party Mode)**: Bring multiple perspectives to validate complete requirement set -- **C (Continue)**: Save the content to the document and proceed to next step - -## PROTOCOL INTEGRATION: - -- When 'A' selected: Execute {project-root}/_bmad/core/tasks/advanced-elicitation.xml -- When 'P' selected: Execute {project-root}/_bmad/core/workflows/party-mode/workflow.md -- PROTOCOLS always return to this step's A/P/C menu -- User accepts/rejects protocol changes before proceeding ## CONTEXT BOUNDARIES: @@ -185,49 +167,29 @@ When saving to document, append these Level 2 and Level 3 sections: [Continue for all capability areas discovered in conversation] ``` -### 7. Present Content and Menu +### 7. Present MENU OPTIONS -Show the generated functional requirements and present choices: -"I've synthesized all our discussions into comprehensive functional requirements. This becomes the capability contract that UX designers, architects, and developers will all work from. +Present the functional requirements for review, then display menu: +- Show synthesized functional requirements (using structure from step 6) +- Emphasize this is the capability contract for all downstream work +- Highlight that every feature must trace back to these requirements +- Ask if they'd like to refine further, get other perspectives, or proceed +- Present menu options naturally as part of conversation -**Here's what I'll add to the document:** +**What would you like to do?**" -[Show the complete FR list from step 6] +Display: "**Select:** [A] Advanced Elicitation [P] Party Mode [C] Continue to Non-Functional Requirements (Step 10 of 11)" -**This is critical because:** +#### Menu Handling Logic: +- IF A: Execute {advancedElicitationTask} with the current FR list, process the enhanced capability coverage that comes back, ask user if they accept the additions, if yes update content then redisplay menu, if no keep original content then redisplay menu +- IF P: Execute {partyModeWorkflow} with the current FR list, process the collaborative capability validation and additions, ask user if they accept the changes, if yes update content then redisplay menu, if no keep original content then redisplay menu +- IF C: Append the final content to {outputFile}, update frontmatter by adding this step name to the end of the stepsCompleted array, then load, read entire file, then execute {nextStepFile} +- IF Any other: help user respond, then redisplay menu -- Every feature we build must trace back to one of these requirements -- UX designers will ONLY design interactions for these capabilities -- Architects will ONLY build systems to support these capabilities - -**What would you like to do?** -[A] Advanced Elicitation - Let's ensure we haven't missed any capabilities -[P] Party Mode - Bring different perspectives to validate complete coverage -[C] Continue - Save this and move to Non-Functional Requirements (Step 10 of 11)" - -### 8. Handle Menu Selection - -#### If 'A' (Advanced Elicitation): - -- Execute {project-root}/_bmad/core/tasks/advanced-elicitation.xml with the current FR list -- Process the enhanced capability coverage that comes back -- Ask user: "Accept these additions to the functional requirements? (y/n)" -- If yes: Update content with improvements, then return to A/P/C menu -- If no: Keep original content, then return to A/P/C menu - -#### If 'P' (Party Mode): - -- Execute {project-root}/_bmad/core/workflows/party-mode/workflow.md with the current FR list -- Process the collaborative capability validation and additions -- Ask user: "Accept these changes to the functional requirements? (y/n)" -- If yes: Update content with improvements, then return to A/P/C menu -- If no: Keep original content, then return to A/P/C menu - -#### If 'C' (Continue): - -- Append the final content to `{output_folder}/prd.md` -- Update frontmatter: `stepsCompleted: [1, 2, 3, 4, 5, 6, 7, 8, 9]` -- Load `{project-root}/_bmad/bmm/workflows/2-plan-workflows/prd/steps/step-10-nonfunctional.md` +#### EXECUTION RULES: +- ALWAYS halt and wait for user input after presenting menu +- ONLY proceed to next step when user selects 'C' +- After other menu items execution, return to this menu ## APPEND TO DOCUMENT: @@ -264,6 +226,6 @@ Emphasize to user: "This FR list is now binding. Any feature not listed here wil ## NEXT STEP: -After user selects 'C' and content is saved to document, load `{project-root}/_bmad/bmm/workflows/2-plan-workflows/prd/steps/step-10-nonfunctional.md` to define non-functional requirements. +After user selects 'C' and content is saved to document, load {nextStepFile} to define non-functional requirements. Remember: Do NOT proceed to step-10 until user explicitly selects 'C' from the A/P/C menu and content is saved! diff --git a/src/modules/bmm/workflows/2-plan-workflows/prd/steps/step-10-nonfunctional.md b/src/modules/bmm/workflows/2-plan-workflows/prd/steps-c/step-10-nonfunctional.md similarity index 63% rename from src/modules/bmm/workflows/2-plan-workflows/prd/steps/step-10-nonfunctional.md rename to src/modules/bmm/workflows/2-plan-workflows/prd/steps-c/step-10-nonfunctional.md index 4982519f..403a647e 100644 --- a/src/modules/bmm/workflows/2-plan-workflows/prd/steps/step-10-nonfunctional.md +++ b/src/modules/bmm/workflows/2-plan-workflows/prd/steps-c/step-10-nonfunctional.md @@ -2,23 +2,18 @@ name: 'step-10-nonfunctional' description: 'Define quality attributes that matter for this specific product' -# Path Definitions -workflow_path: '{project-root}/_bmad/bmm/workflows/2-plan-workflows/prd' - # File References -thisStepFile: '{workflow_path}/steps/step-10-nonfunctional.md' -nextStepFile: '{workflow_path}/steps/step-11-complete.md' -workflowFile: '{workflow_path}/workflow.md' -outputFile: '{output_folder}/prd.md' +nextStepFile: './step-11-polish.md' +outputFile: '{planning_artifacts}/prd.md' # Task References -advancedElicitationTask: '{project-root}/_bmad/core/tasks/advanced-elicitation.xml' +advancedElicitationTask: '{project-root}/_bmad/core/workflows/advanced-elicitation/workflow.xml' partyModeWorkflow: '{project-root}/_bmad/core/workflows/party-mode/workflow.md' --- # Step 10: Non-Functional Requirements -**Progress: Step 10 of 11** - Next: Complete PRD +**Progress: Step 10 of 12** - Next: Polish Document ## MANDATORY EXECUTION RULES (READ FIRST): @@ -30,29 +25,16 @@ partyModeWorkflow: '{project-root}/_bmad/core/workflows/party-mode/workflow.md' - 📋 YOU ARE A FACILITATOR, not a content generator - 💬 FOCUS on quality attributes that matter for THIS specific product - 🎯 SELECTIVE: Only document NFRs that actually apply to the product +- ✅ 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 A/P/C menu after generating NFR content - 💾 ONLY save when user chooses C (Continue) -- 📖 Update frontmatter `stepsCompleted: [1, 2, 3, 4, 5, 6, 7, 8, 9]` before loading next step +- 📖 Update output file frontmatter, adding this step name to the end of the list of stepsCompleted - 🚫 FORBIDDEN to load next step until C is selected -## COLLABORATION MENUS (A/P/C): - -This step will generate content and present choices: - -- **A (Advanced Elicitation)**: Use discovery protocols to ensure comprehensive quality attributes -- **P (Party Mode)**: Bring technical perspectives to validate NFR completeness -- **C (Continue)**: Save the content to the document and proceed to final step - -## PROTOCOL INTEGRATION: - -- When 'A' selected: Execute {project-root}/_bmad/core/tasks/advanced-elicitation.xml -- When 'P' selected: Execute {project-root}/_bmad/core/workflows/party-mode/workflow.md -- PROTOCOLS always return to this step's A/P/C menu -- User accepts/rejects protocol changes before proceeding ## CONTEXT BOUNDARIES: @@ -96,56 +78,41 @@ For each relevant category, conduct targeted discovery: #### Performance NFRs (If relevant): -"Let's talk about performance requirements for {{project_name}}. - -**Performance Questions:** - +Explore performance requirements: - What parts of the system need to be fast for users to be successful? - Are there specific response time expectations? - What happens if performance is slower than expected? -- Are there concurrent user scenarios we need to support?" +- Are there concurrent user scenarios we need to support? #### Security NFRs (If relevant): -"Security is critical for products that handle sensitive information. - -**Security Questions:** - +Explore security requirements: - What data needs to be protected? - Who should have access to what? - What are the security risks we need to mitigate? -- Are there compliance requirements (GDPR, HIPAA, PCI-DSS)?" +- Are there compliance requirements (GDPR, HIPAA, PCI-DSS)? #### Scalability NFRs (If relevant): -"Scalability matters if we expect growth or have variable demand. - -**Scalability Questions:** - +Explore scalability requirements: - How many users do we expect initially? Long-term? - Are there seasonal or event-based traffic spikes? -- What happens if we exceed our capacity?" -- What growth scenarios should we plan for?" +- What happens if we exceed our capacity? +- What growth scenarios should we plan for? #### Accessibility NFRs (If relevant): -"Accessibility ensures the product works for users with disabilities. - -**Accessibility Questions:** - +Explore accessibility requirements: - Are we serving users with visual, hearing, or motor impairments? - Are there legal accessibility requirements (WCAG, Section 508)? -- What accessibility features are most important for our users?" +- What accessibility features are most important for our users? #### Integration NFRs (If relevant): -"Integration requirements matter for products that connect to other systems. - -**Integration Questions:** - +Explore integration requirements: - What external systems do we need to connect with? - Are there APIs or data formats we must support? -- How reliable do these integrations need to be?" +- How reliable do these integrations need to be? ### 4. Make NFRs Specific and Measurable @@ -189,45 +156,27 @@ When saving to document, append these Level 2 and Level 3 sections (only include [Integration requirements based on conversation - only include if relevant] ``` -### 6. Present Content and Menu +### 6. Present MENU OPTIONS -Show the generated NFR content and present choices: -"I've defined the non-functional requirements that specify how well {{project_name}} needs to perform. I've only included categories that actually matter for this product. +Present the non-functional requirements for review, then display menu: +- Show defined NFRs (using structure from step 5) +- Note that only relevant categories were included +- Emphasize NFRs specify how well the system needs to perform +- Ask if they'd like to refine further, get other perspectives, or proceed +- Present menu options naturally as part of conversation -**Here's what I'll add to the document:** +Display: "**Select:** [A] Advanced Elicitation [P] Party Mode [C] Continue to Polish Document (Step 11 of 12)" -[Show the complete NFR content from step 5] +#### Menu Handling Logic: +- IF A: Execute {advancedElicitationTask} with the current NFR content, process the enhanced quality attribute insights that come back, ask user if they accept the improvements, if yes update content then redisplay menu, if no keep original content then redisplay menu +- IF P: Execute {partyModeWorkflow} with the current NFR list, process the collaborative technical validation and additions, ask user if they accept the changes, if yes update content then redisplay menu, if no keep original content then redisplay menu +- IF C: Append the final content to {outputFile}, update frontmatter by adding this step name to the end of the stepsCompleted array, then load, read entire file, then execute {nextStepFile} +- IF Any other: help user respond, then redisplay menu -**Note:** We've skipped categories that don't apply to avoid unnecessary requirements. - -**What would you like to do?** -[A] Advanced Elicitation - Let's ensure we haven't missed critical quality attributes -[P] Party Mode - Bring technical perspectives to validate NFR specifications -[C] Continue - Save this and move to Complete PRD (Step 11 of 11)" - -### 7. Handle Menu Selection - -#### If 'A' (Advanced Elicitation): - -- Execute {project-root}/_bmad/core/tasks/advanced-elicitation.xml with the current NFR content -- Process the enhanced quality attribute insights that come back -- Ask user: "Accept these improvements to the non-functional requirements? (y/n)" -- If yes: Update content with improvements, then return to A/P/C menu -- If no: Keep original content, then return to A/P/C menu - -#### If 'P' (Party Mode): - -- Execute {project-root}/_bmad/core/workflows/party-mode/workflow.md with the current NFR list -- Process the collaborative technical validation and additions -- Ask user: "Accept these changes to the non-functional requirements? (y/n)" -- If yes: Update content with improvements, then return to A/P/C menu -- If no: Keep original content, then return to A/P/C menu - -#### If 'C' (Continue): - -- Append the final content to `{output_folder}/prd.md` -- Update frontmatter: `stepsCompleted: [1, 2, 3, 4, 5, 6, 7, 8, 9, 10]` -- Load `{project-root}/_bmad/bmm/workflows/2-plan-workflows/prd/steps/step-11-complete.md` +#### EXECUTION RULES: +- ALWAYS halt and wait for user input after presenting menu +- ONLY proceed to next step when user selects 'C' +- After other menu items execution, return to this menu ## APPEND TO DOCUMENT: @@ -288,6 +237,6 @@ When user selects 'C', append the content directly to the document using the str ## NEXT STEP: -After user selects 'C' and content is saved to document, load `{project-root}/_bmad/bmm/workflows/2-plan-workflows/prd/steps/step-11-complete.md` to finalize the PRD and complete the workflow. +After user selects 'C' and content is saved to document, load {nextStepFile} to finalize the PRD and complete the workflow. Remember: Do NOT proceed to step-11 until user explicitly selects 'C' from the A/P/C menu and content is saved! diff --git a/src/modules/bmm/workflows/2-plan-workflows/prd/steps-c/step-11-polish.md b/src/modules/bmm/workflows/2-plan-workflows/prd/steps-c/step-11-polish.md new file mode 100644 index 00000000..1edbf0bf --- /dev/null +++ b/src/modules/bmm/workflows/2-plan-workflows/prd/steps-c/step-11-polish.md @@ -0,0 +1,217 @@ +--- +name: 'step-11-polish' +description: 'Optimize and polish the complete PRD document for flow, coherence, and readability' + +# File References +nextStepFile: './step-12-complete.md' +outputFile: '{planning_artifacts}/prd.md' +purposeFile: './data/prd-purpose.md' + +# Task References +advancedElicitationTask: '{project-root}/_bmad/core/workflows/advanced-elicitation/workflow.xml' +partyModeWorkflow: '{project-root}/_bmad/core/workflows/party-mode/workflow.md' +--- + +# Step 11: Document Polish + +**Progress: Step 11 of 12** - Next: Complete PRD + +## MANDATORY EXECUTION RULES (READ FIRST): + +- 🛑 CRITICAL: Load the ENTIRE document before making changes +- 📖 CRITICAL: Read complete step file before taking action +- 🔄 CRITICAL: When loading next step with 'C', ensure entire file is read +- ✅ This is a POLISH step - optimize existing content +- 📋 IMPROVE flow, coherence, and readability +- 💬 PRESERVE user's voice and intent +- 🎯 MAINTAIN all essential information while improving presentation +- ✅ YOU MUST ALWAYS SPEAK OUTPUT In your Agent communication style with the config `{communication_language}` + +## EXECUTION PROTOCOLS: + +- 🎯 Load complete document first +- 📝 Review for flow and coherence issues +- ✂️ Reduce duplication while preserving essential info +- 📖 Ensure proper ## Level 2 headers throughout +- 💾 Save optimized document +- ⚠️ Present A/P/C menu after polish +- 🚫 DO NOT skip review steps + +## CONTEXT BOUNDARIES: + +- Complete PRD document exists from all previous steps +- Document may have duplication from progressive append +- Sections may not flow smoothly together +- Level 2 headers ensure document can be split if needed +- Focus on readability and coherence + +## YOUR TASK: + +Optimize the complete PRD document for flow, coherence, and professional presentation while preserving all essential information. + +## DOCUMENT POLISH SEQUENCE: + +### 1. Load Context and Document + +**CRITICAL:** Load the PRD purpose document first: + +- Read `{purposeFile}` to understand what makes a great BMAD PRD +- Internalize the philosophy: information density, traceability, measurable requirements +- Keep the dual-audience nature (humans + LLMs) in mind + +**Then Load the PRD Document:** + +- Read `{outputFile}` completely from start to finish +- Understand the full document structure and content +- Identify all sections and their relationships +- Note areas that need attention + +### 2. Document Quality Review + +Review the entire document with PRD purpose principles in mind: + +**Information Density:** +- Are there wordy phrases that can be condensed? +- Is conversational padding present? +- Can sentences be more direct and concise? + +**Flow and Coherence:** +- Do sections transition smoothly? +- Are there jarring topic shifts? +- Does the document tell a cohesive story? +- Is the progression logical for readers? + +**Duplication Detection:** +- Are ideas repeated across sections? +- Is the same information stated multiple times? +- Can redundant content be consolidated? +- Are there contradictory statements? + +**Header Structure:** +- Are all main sections using ## Level 2 headers? +- Is the hierarchy consistent (##, ###, ####)? +- Can sections be easily extracted or referenced? +- Are headers descriptive and clear? + +**Readability:** +- Are sentences clear and concise? +- Is the language consistent throughout? +- Are technical terms used appropriately? +- Would stakeholders find this easy to understand? + +### 3. Optimization Actions + +Make targeted improvements: + +**Improve Flow:** +- Add transition sentences between sections +- Smooth out jarring topic shifts +- Ensure logical progression +- Connect related concepts across sections + +**Reduce Duplication:** +- Consolidate repeated information +- Keep content in the most appropriate section +- Use cross-references instead of repetition +- Remove redundant explanations + +**Enhance Coherence:** +- Ensure consistent terminology throughout +- Align all sections with product differentiator +- Maintain consistent voice and tone +- Verify scope consistency across sections + +**Optimize Headers:** +- Ensure all main sections use ## Level 2 +- Make headers descriptive and action-oriented +- Check that headers follow consistent patterns +- Verify headers support document navigation + +### 4. Preserve Critical Information + +**While optimizing, ensure NOTHING essential is lost:** + +**Must Preserve:** +- All user success criteria +- All functional requirements (capability contract) +- All user journey narratives +- All scope decisions (MVP, Growth, Vision) +- All non-functional requirements +- Product differentiator and vision +- Domain-specific requirements +- Innovation analysis (if present) + +**Can Consolidate:** +- Repeated explanations of the same concept +- Redundant background information +- Multiple versions of similar content +- Overlapping examples + +### 5. Generate Optimized Document + +Create the polished version: + +**Polishing Process:** +1. Start with original document +2. Apply all optimization actions +3. Review to ensure nothing essential was lost +4. Verify improvements enhance readability +5. Prepare optimized version for review + +### 6. Present MENU OPTIONS + +Present the polished document for review, then display menu: +- Show what changed in the polish +- Highlight improvements made (flow, duplication, headers) +- Ask if they'd like to refine further, get other perspectives, or proceed +- Present menu options naturally as part of conversation + +Display: "**Select:** [A] Advanced Elicitation [P] Party Mode [C] Continue to Complete PRD (Step 12 of 12)" + +#### Menu Handling Logic: +- IF A: Execute {advancedElicitationTask} with the polished document, process the enhanced refinements that come back, ask user "Accept these polish improvements? (y/n)", if yes update content with improvements then redisplay menu, if no keep original polish then redisplay menu +- IF P: Execute {partyModeWorkflow} with the polished document, process the collaborative refinements to flow and coherence, ask user "Accept these polish changes? (y/n)", if yes update content with improvements then redisplay menu, if no keep original polish then redisplay menu +- IF C: Save the polished document to {outputFile}, update frontmatter by adding this step name to the end of the stepsCompleted array, then load, read entire file, then execute {nextStepFile} +- IF Any other: help user respond, then redisplay menu + +#### EXECUTION RULES: +- ALWAYS halt and wait for user input after presenting menu +- ONLY proceed to next step when user selects 'C' +- After other menu items execution, return to this menu + +## APPEND TO DOCUMENT: + +When user selects 'C', replace the entire document content with the polished version. + +## SUCCESS METRICS: + +✅ Complete document loaded and reviewed +✅ Flow and coherence improved +✅ Duplication reduced while preserving essential information +✅ All main sections use ## Level 2 headers +✅ Transitions between sections are smooth +✅ User's voice and intent preserved +✅ Document is more readable and professional +✅ A/P/C menu presented and handled correctly +✅ Polished document saved when C selected + +## FAILURE MODES: + +❌ Loading only partial document (leads to incomplete polish) +❌ Removing essential information while reducing duplication +❌ Not preserving user's voice and intent +❌ Changing content instead of improving presentation +❌ Not ensuring ## Level 2 headers for main sections +❌ Making arbitrary style changes instead of coherence improvements +❌ Not presenting A/P/C menu for user approval +❌ Saving polished document without user selecting 'C' + +❌ **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 changes without complete understanding of document requirements + +## NEXT STEP: + +After user selects 'C' and polished document is saved, load `./step-12-complete.md` to complete the workflow. + +Remember: Do NOT proceed to step-12 until user explicitly selects 'C' from the A/P/C menu and polished document is saved! diff --git a/src/modules/bmm/workflows/2-plan-workflows/prd/steps-c/step-12-complete.md b/src/modules/bmm/workflows/2-plan-workflows/prd/steps-c/step-12-complete.md new file mode 100644 index 00000000..435c9084 --- /dev/null +++ b/src/modules/bmm/workflows/2-plan-workflows/prd/steps-c/step-12-complete.md @@ -0,0 +1,180 @@ +--- +name: 'step-12-complete' +description: 'Complete the PRD workflow, update status files, and suggest next steps including validation' + +# File References +outputFile: '{planning_artifacts}/prd.md' +validationFlow: '../steps-v/step-v-01-discovery.md' +--- + +# Step 12: Workflow Completion + +**Final Step - Complete the PRD** + +## MANDATORY EXECUTION RULES (READ FIRST): + +- ✅ THIS IS A FINAL STEP - Workflow completion required +- 📖 CRITICAL: ALWAYS read the complete step file before taking any action +- 🛑 NO content generation - this is a wrap-up step +- 📋 FINALIZE document and update workflow status +- 💬 FOCUS on completion, validation options, and next steps +- 🎯 UPDATE workflow status files with completion information +- ✅ YOU MUST ALWAYS SPEAK OUTPUT In your Agent communication style with the config `{communication_language}` + +## EXECUTION PROTOCOLS: + +- 🎯 Show your analysis before taking any action +- 💾 Update the main workflow status file with completion information (if exists) +- 📖 Offer validation workflow options to user +- 🚫 DO NOT load additional steps after this one + +## TERMINATION STEP PROTOCOLS: + +- This is a FINAL step - workflow completion required +- Update workflow status file with finalized document +- Suggest validation and next workflow steps +- Mark workflow as complete in status tracking + +## CONTEXT BOUNDARIES: + +- Complete and polished PRD document is available from all previous steps +- Workflow frontmatter shows all completed steps including polish +- All collaborative content has been generated, saved, and optimized +- Focus on completion, validation options, and next steps + +## YOUR TASK: + +Complete the PRD workflow, update status files, offer validation options, and suggest next steps for the project. + +## WORKFLOW COMPLETION SEQUENCE: + +### 1. Announce Workflow Completion + +Inform user that the PRD is complete and polished: +- Celebrate successful completion of comprehensive PRD +- Summarize all sections that were created +- Highlight that document has been polished for flow and coherence +- Emphasize document is ready for downstream work + +### 2. Workflow Status Update + +Update the main workflow status file if there is one: + +- Load `{status_file}` from workflow configuration (if exists) +- Update workflow_status["prd"] = "{default_output_file}" +- Save file, preserving all comments and structure +- Mark current timestamp as completion time + +### 3. Validation Workflow Options + +Offer validation workflows to ensure PRD is ready for implementation: + +**Available Validation Workflows:** + +**Option 1: Check Implementation Readiness** (`{checkImplementationReadinessWorkflow}`) +- Validates PRD has all information needed for development +- Checks epic coverage completeness +- Reviews UX alignment with requirements +- Assesses epic quality and readiness +- Identifies gaps before architecture/design work begins + +**When to use:** Before starting technical architecture or epic breakdown + +**Option 2: Skip for Now** +- Proceed directly to next workflows (architecture, UX, epics) +- Validation can be done later if needed +- Some teams prefer to validate during architecture reviews + +### 4. Suggest Next Workflows + +Provide guidance on logical next workflows - strongly suggesting any of these chosen are started in a fresh context with the appropriate agent: + +**Typical Next Workflows:** + +**Immediate Next Steps:** + +1. **PRD Quality Validation First (Recommended):** + - execute the `{validationFlow}` workflow if selected or start a new chat with me and select the validate PRD menu item + - Ensures PRD is complete and ready + - Identifies any gaps or issues + - Validates before committing to architecture/design + +2. **UX Design:** `workflow create-ux-design` with the UX-Designer Agent (if UI exists) + - User journey insights from step-04 inform interaction design + - Functional requirements from step-09 define design scope + - Polish-optimized document provides clear design requirements + +3. **Technical Architecture:** `workflow create-architecture` with the Architect Agent + - Project-type requirements from step-07 guide technical decisions + - Non-functional requirements from step-10 inform architecture choices + - Functional requirements define system capabilities + +4. **Epic Breakdown:** `workflow create-epics-and-stories` with me again - but really recommend first doing a UX if needed and an architecture! + - Functional requirements from step-09 become epics and stories + - Scope definition from step-03 guides sprint planning + - Richer when created after UX/architecture + +**Strategic Considerations:** + +- Validation adds confidence before architecture/design investment +- UX design and architecture can happen in parallel after validation +- Epics/stories are richer when created after UX/architecture +- Order depends on team preferences and project needs + +### 5. Final Completion Confirmation + +- Confirm completion with user and summarize what has been accomplished +- Document now contains: Executive Summary, Success Criteria, User Journeys, Domain Requirements (if applicable), Innovation Analysis (if applicable), Project-Type Requirements, Functional Requirements (capability contract), Non-Functional Requirements, and has been polished for flow and coherence +- Ask if they'd like to run validation workflow or proceed to next workflows + +## SUCCESS METRICS: + +✅ PRD document contains all required sections and has been polished +✅ All collaborative content properly saved and optimized +✅ Workflow status file updated with completion information (if exists) +✅ Validation workflow options clearly presented +✅ Clear next step guidance provided to user +✅ Document quality validation completed +✅ User acknowledges completion and understands next options + +## FAILURE MODES: + +❌ Not updating workflow status file with completion information (if exists) +❌ Not offering validation workflow options +❌ Missing clear next step guidance for user +❌ Not confirming document completeness with user +❌ Workflow not properly marked as complete in status tracking (if applicable) +❌ User unclear about what happens next or what validation options exist + +❌ **CRITICAL**: Reading only partial step file - leads to incomplete understanding and poor decisions +❌ **CRITICAL**: Making decisions without complete understanding of step requirements and protocols + +## WORKFLOW COMPLETION CHECKLIST: + +### Document Structure Complete: + +- [ ] Executive Summary with vision and differentiator +- [ ] Success Criteria with measurable outcomes +- [ ] Product Scope (MVP, Growth, Vision) +- [ ] User Journeys (comprehensive coverage) +- [ ] Domain Requirements (if applicable) +- [ ] Innovation Analysis (if applicable) +- [ ] Project-Type Requirements +- [ ] Functional Requirements (capability contract) +- [ ] Non-Functional Requirements +- [ ] Document polished for flow and coherence + +### Process Complete: + +- [ ] All steps (including polish) completed with user confirmation +- [ ] All content saved and optimized +- [ ] Frontmatter properly updated +- [ ] Workflow status file updated (if exists) +- [ ] Validation options presented +- [ ] Next steps clearly communicated + +## FINAL REMINDER to give the user: + +The polished PRD serves as the foundation for all subsequent product development activities. All design, architecture, and development work should trace back to the requirements and vision documented in this PRD - update it also as needed as you continue planning. + +**Congratulations on completing the Product Requirements Document for {{project_name}}!** 🎉 diff --git a/src/modules/bmm/workflows/2-plan-workflows/prd/steps-e/step-e-01-discovery.md b/src/modules/bmm/workflows/2-plan-workflows/prd/steps-e/step-e-01-discovery.md new file mode 100644 index 00000000..4b9e882a --- /dev/null +++ b/src/modules/bmm/workflows/2-plan-workflows/prd/steps-e/step-e-01-discovery.md @@ -0,0 +1,247 @@ +--- +name: 'step-e-01-discovery' +description: 'Discovery & Understanding - Understand what user wants to edit and detect PRD format' + +# File references (ONLY variables used in this step) +altStepFile: './step-e-01b-legacy-conversion.md' +prdPurpose: '{project-root}/src/modules/bmm/workflows/2-plan-workflows/prd/data/prd-purpose.md' +advancedElicitationTask: '{project-root}/_bmad/core/workflows/advanced-elicitation/workflow.xml' +partyModeWorkflow: '{project-root}/_bmad/core/workflows/party-mode/workflow.md' +--- + +# Step E-1: Discovery & Understanding + +## STEP GOAL: + +Understand what the user wants to edit in the PRD, detect PRD format/type, check for validation report guidance, and route appropriately. + +## MANDATORY EXECUTION RULES (READ FIRST): + +### Universal Rules: + +- 🛑 NEVER generate content without user input +- 📖 CRITICAL: Read the complete step file before taking any action +- 🔄 CRITICAL: When loading next step with 'C', ensure entire file is read +- 📋 YOU ARE A FACILITATOR, not a content generator +- ✅ YOU MUST ALWAYS SPEAK OUTPUT In your Agent communication style with the config `{communication_language}` + +### Role Reinforcement: + +- ✅ You are a Validation Architect and PRD Improvement Specialist +- ✅ If you already have been given communication or persona patterns, continue to use those while playing this new role +- ✅ We engage in collaborative dialogue, not command-response +- ✅ You bring analytical expertise and improvement guidance +- ✅ User brings domain knowledge and edit requirements + +### Step-Specific Rules: + +- 🎯 Focus ONLY on discovering user intent and PRD format +- 🚫 FORBIDDEN to make any edits yet +- 💬 Approach: Inquisitive and analytical, understanding before acting +- 🚪 This is a branch step - may route to legacy conversion + +## EXECUTION PROTOCOLS: + +- 🎯 Discover user's edit requirements +- 🎯 Auto-detect validation reports in PRD folder (use as guide) +- 🎯 Load validation report if provided (use as guide) +- 🎯 Detect PRD format (BMAD/legacy) +- 🎯 Route appropriately based on format +- 💾 Document discoveries for next step +- 🚫 FORBIDDEN to proceed without understanding requirements + +## CONTEXT BOUNDARIES: + +- Available context: PRD file to edit, optional validation report, auto-detected validation reports +- Focus: User intent discovery and format detection only +- Limits: Don't edit yet, don't validate yet +- Dependencies: None - this is first edit step + +## MANDATORY SEQUENCE + +**CRITICAL:** Follow this sequence exactly. Do not skip, reorder, or improvise unless user explicitly requests a change. + +### 1. Load PRD Purpose Standards + +Load and read the complete file at: +`{prdPurpose}` (data/prd-purpose.md) + +This file defines what makes a great BMAD PRD. Internalize this understanding - it will guide improvement recommendations. + +### 2. Discover PRD to Edit + +"**PRD Edit Workflow** + +Which PRD would you like to edit? + +Please provide the path to the PRD file you want to edit." + +**Wait for user to provide PRD path.** + +### 3. Validate PRD Exists and Load + +Once PRD path is provided: +- Check if PRD file exists at specified path +- If not found: "I cannot find a PRD at that path. Please check the path and try again." +- If found: Load the complete PRD file including frontmatter + +### 4. Check for Existing Validation Report + +**Check if validation report exists in the PRD folder:** + +```bash +# Look for most recent validation report in the PRD folder +ls -t {prd_folder_path}/validation-report-*.md 2>/dev/null | head -1 +``` + +**If validation report found:** + +Display: +"**📋 Found Validation Report** + +I found a validation report from {validation_date} in the PRD folder. + +This report contains findings from previous validation checks and can help guide our edits to fix known issues. + +**Would you like to:** +- **[U] Use validation report** - Load it to guide and prioritize edits +- **[S] Skip** - Proceed with manual edit discovery" + +**Wait for user input.** + +**IF U (Use validation report):** +- Load the validation report file +- Extract findings, issues, and improvement suggestions +- Note: "Validation report loaded - will use it to guide prioritized improvements" +- Continue to step 5 + +**IF S (Skip) or no validation report found:** +- Note: "Proceeding with manual edit discovery" +- Continue to step 5 + +**If no validation report found:** +- Note: "No validation report found in PRD folder" +- Continue to step 5 without asking user + +### 5. Ask About Validation Report + +"**Do you have a validation report to guide edits?** + +If you've run the validation workflow on this PRD, I can use that report to guide improvements and prioritize changes. + +Validation report path (or type 'none'):" + +**Wait for user input.** + +**If validation report path provided:** +- Load the validation report +- Extract findings, severity, improvement suggestions +- Note: "Validation report loaded - will use it to guide prioritized improvements" + +**If no validation report:** +- Note: "Proceeding with manual edit discovery" +- Continue to step 6 + +### 6. Discover Edit Requirements + +"**What would you like to edit in this PRD?** + +Please describe the changes you want to make. For example: +- Fix specific issues (information density, implementation leakage, etc.) +- Add missing sections or content +- Improve structure and flow +- Convert to BMAD format (if legacy PRD) +- General improvements +- Other changes + +**Describe your edit goals:**" + +**Wait for user to describe their requirements.** + +### 7. Detect PRD Format + +Analyze the loaded PRD: + +**Extract all ## Level 2 headers** from PRD + +**Check for BMAD PRD core sections:** +1. Executive Summary +2. Success Criteria +3. Product Scope +4. User Journeys +5. Functional Requirements +6. Non-Functional Requirements + +**Classify format:** +- **BMAD Standard:** 5-6 core sections present +- **BMAD Variant:** 3-4 core sections present, generally follows BMAD patterns +- **Legacy (Non-Standard):** Fewer than 3 core sections, does not follow BMAD structure + +### 8. Route Based on Format and Context + +**IF validation report provided OR PRD is BMAD Standard/Variant:** + +Display: "**Edit Requirements Understood** + +**PRD Format:** {classification} +{If validation report: "**Validation Guide:** Yes - will use validation report findings"} +**Edit Goals:** {summary of user's requirements} + +**Proceeding to deep review and analysis...**" + +Load and execute next step (step-e-02-review.md) + +**IF PRD is Legacy (Non-Standard) AND no validation report:** + +Display: "**Format Detected:** Legacy PRD + +This PRD does not follow BMAD standard structure (only {count}/6 core sections present). + +**Your edit goals:** {user's requirements} + +**How would you like to proceed?**" + +Present MENU OPTIONS below for user selection + +### 9. Present MENU OPTIONS (Legacy PRDs Only) + +**[C] Convert to BMAD Format** - Convert PRD to BMAD standard structure, then apply your edits +**[E] Edit As-Is** - Apply your edits without converting the format +**[X] Exit** - Exit and review conversion options + +#### EXECUTION RULES: + +- ALWAYS halt and wait for user input +- Only proceed based on user selection + +#### Menu Handling Logic: + +- IF C (Convert): Load, read entire file, then execute {altStepFile} (step-e-01b-legacy-conversion.md) +- IF E (Edit As-Is): Display "Proceeding with edits..." then load next step +- IF X (Exit): Display summary and exit +- IF Any other: help user, then redisplay menu + +--- + +## 🚨 SYSTEM SUCCESS/FAILURE METRICS + +### ✅ SUCCESS: + +- User's edit requirements clearly understood +- Auto-detected validation reports loaded and analyzed (when found) +- Manual validation report loaded and analyzed (if provided) +- PRD format detected correctly +- BMAD PRDs proceed directly to review step +- Legacy PRDs pause and present conversion options +- User can choose conversion path or edit as-is + +### ❌ SYSTEM FAILURE: + +- Not discovering user's edit requirements +- Not auto-detecting validation reports in PRD folder +- Not loading validation report when provided (auto or manual) +- Missing format detection +- Not pausing for legacy PRDs without guidance +- Auto-proceeding without understanding intent + +**Master Rule:** Understand before editing. Detect format early so we can guide users appropriately. Auto-detect and use validation reports for prioritized improvements. diff --git a/src/modules/bmm/workflows/2-plan-workflows/prd/steps-e/step-e-01b-legacy-conversion.md b/src/modules/bmm/workflows/2-plan-workflows/prd/steps-e/step-e-01b-legacy-conversion.md new file mode 100644 index 00000000..b8c67753 --- /dev/null +++ b/src/modules/bmm/workflows/2-plan-workflows/prd/steps-e/step-e-01b-legacy-conversion.md @@ -0,0 +1,208 @@ +--- +name: 'step-e-01b-legacy-conversion' +description: 'Legacy PRD Conversion Assessment - Analyze legacy PRD and propose conversion strategy' + +# File references (ONLY variables used in this step) +nextStepFile: './step-e-02-review.md' +prdFile: '{prd_file_path}' +prdPurpose: '{project-root}/src/modules/bmm/workflows/2-plan-workflows/prd/data/prd-purpose.md' +--- + +# Step E-1B: Legacy PRD Conversion Assessment + +## STEP GOAL: + +Analyze legacy PRD against BMAD standards, identify gaps, propose conversion strategy, and let user choose how to proceed. + +## MANDATORY EXECUTION RULES (READ FIRST): + +### Universal Rules: + +- 🛑 NEVER generate content without user input +- 📖 CRITICAL: Read the complete step file before taking any action +- 🔄 CRITICAL: When loading next step with 'C', ensure entire file is read +- 📋 YOU ARE A FACILITATOR, not a content generator +- ✅ YOU MUST ALWAYS SPEAK OUTPUT In your Agent communication style with the config `{communication_language}` + +### Role Reinforcement: + +- ✅ You are a Validation Architect and PRD Improvement Specialist +- ✅ If you already have been given communication or persona patterns, continue to use those while playing this new role +- ✅ We engage in collaborative dialogue, not command-response +- ✅ You bring BMAD standards expertise and conversion guidance +- ✅ User brings domain knowledge and edit requirements + +### Step-Specific Rules: + +- 🎯 Focus ONLY on conversion assessment and proposal +- 🚫 FORBIDDEN to perform conversion yet (that comes in edit step) +- 💬 Approach: Analytical gap analysis with clear recommendations +- 🚪 This is a branch step - user chooses conversion path + +## EXECUTION PROTOCOLS: + +- 🎯 Analyze legacy PRD against BMAD standard +- 💾 Identify gaps and estimate conversion effort +- 📖 Present conversion options with effort estimates +- 🚫 FORBIDDEN to proceed without user selection + +## CONTEXT BOUNDARIES: + +- Available context: Legacy PRD, user's edit requirements, prd-purpose standards +- Focus: Conversion assessment only (not actual conversion) +- Limits: Don't convert yet, don't validate yet +- Dependencies: Step e-01 detected legacy format and routed here + +## MANDATORY SEQUENCE + +**CRITICAL:** Follow this sequence exactly. Do not skip, reorder, or improvise unless user explicitly requests a change. + +### 1. Attempt Sub-Process Assessment + +**Try to use Task tool with sub-agent:** + +"Perform legacy PRD conversion assessment: + +**Load the PRD and prd-purpose.md** + +**For each BMAD PRD section, analyze:** +1. Does PRD have this section? (Executive Summary, Success Criteria, Product Scope, User Journeys, Functional Requirements, Non-Functional Requirements) +2. If present: Is it complete and well-structured? +3. If missing: What content exists that could migrate to this section? +4. Effort to create/complete: Minimal / Moderate / Significant + +**Identify:** +- Core sections present: {count}/6 +- Content gaps in each section +- Overall conversion effort: Quick / Moderate / Substantial +- Recommended approach: Full restructuring vs targeted improvements + +Return conversion assessment with gap analysis and effort estimate." + +**Graceful degradation (if no Task tool):** +- Manually check PRD for each BMAD section +- Note what's present and what's missing +- Estimate conversion effort +- Identify best conversion approach + +### 2. Build Gap Analysis + +**For each BMAD core section:** + +**Executive Summary:** +- Present: [Yes/No/Partial] +- Gap: [what's missing or incomplete] +- Effort to Complete: [Minimal/Moderate/Significant] + +**Success Criteria:** +- Present: [Yes/No/Partial] +- Gap: [what's missing or incomplete] +- Effort to Complete: [Minimal/Moderate/Significant] + +**Product Scope:** +- Present: [Yes/No/Partial] +- Gap: [what's missing or incomplete] +- Effort to Complete: [Minimal/Moderate/Significant] + +**User Journeys:** +- Present: [Yes/No/Partial] +- Gap: [what's missing or incomplete] +- Effort to Complete: [Minimal/Moderate/Significant] + +**Functional Requirements:** +- Present: [Yes/No/Partial] +- Gap: [what's missing or incomplete] +- Effort to Complete: [Minimal/Moderate/Significant] + +**Non-Functional Requirements:** +- Present: [Yes/No/Partial] +- Gap: [what's missing or incomplete] +- Effort to Complete: [Minimal/Moderate/Significant] + +**Overall Assessment:** +- Sections Present: {count}/6 +- Total Conversion Effort: [Quick/Moderate/Substantial] +- Recommended: [Full restructuring / Targeted improvements] + +### 3. Present Conversion Assessment + +Display: + +"**Legacy PRD Conversion Assessment** + +**Current PRD Structure:** +- Core sections present: {count}/6 +{List which sections are present/missing} + +**Gap Analysis:** + +{Present gap analysis table showing each section's status and effort} + +**Overall Conversion Effort:** {effort level} + +**Your Edit Goals:** +{Reiterate user's stated edit requirements} + +**Recommendation:** +{Based on effort and user goals, recommend best approach} + +**How would you like to proceed?**" + +### 4. Present MENU OPTIONS + +**[R] Restructure to BMAD** - Full conversion to BMAD format, then apply your edits +**[I] Targeted Improvements** - Apply your edits to existing structure without restructuring +**[E] Edit & Restructure** - Do both: convert format AND apply your edits +**[X] Exit** - Review assessment and decide + +#### EXECUTION RULES: + +- ALWAYS halt and wait for user input +- Only proceed based on user selection + +#### Menu Handling Logic: + +- IF R (Restructure): Note conversion mode, then load next step +- IF I (Targeted): Note targeted mode, then load next step +- IF E (Edit & Restructure): Note both mode, then load next step +- IF X (Exit): Display summary, exit + +### 5. Document Conversion Strategy + +Store conversion decision for next step: + +- **Conversion mode:** [Full restructuring / Targeted improvements / Both] +- **Edit requirements:** [user's requirements from step e-01] +- **Gap analysis:** [summary of gaps identified] + +Display: "**Conversion Strategy Documented** + +Mode: {conversion mode} +Edit goals: {summary} + +**Proceeding to deep review...**" + +Load and execute {nextStepFile} (step-e-02-review.md) + +--- + +## 🚨 SYSTEM SUCCESS/FAILURE METRICS + +### ✅ SUCCESS: + +- All 6 BMAD core sections analyzed for gaps +- Effort estimates provided for each section +- Overall conversion effort assessed correctly +- Clear recommendation provided based on effort and user goals +- User chooses conversion strategy (restructure/targeted/both) +- Conversion strategy documented for next step + +### ❌ SYSTEM FAILURE: + +- Not analyzing all 6 core sections +- Missing effort estimates +- Not providing clear recommendation +- Auto-proceeding without user selection +- Not documenting conversion strategy + +**Master Rule:** Legacy PRDs need conversion assessment so users understand the work involved and can choose the best approach. diff --git a/src/modules/bmm/workflows/2-plan-workflows/prd/steps-e/step-e-02-review.md b/src/modules/bmm/workflows/2-plan-workflows/prd/steps-e/step-e-02-review.md new file mode 100644 index 00000000..31c80971 --- /dev/null +++ b/src/modules/bmm/workflows/2-plan-workflows/prd/steps-e/step-e-02-review.md @@ -0,0 +1,249 @@ +--- +name: 'step-e-02-review' +description: 'Deep Review & Analysis - Thoroughly review existing PRD and prepare detailed change plan' + +# File references (ONLY variables used in this step) +nextStepFile: './step-e-03-edit.md' +prdFile: '{prd_file_path}' +validationReport: '{validation_report_path}' # If provided +prdPurpose: '{project-root}/src/modules/bmm/workflows/2-plan-workflows/prd/data/prd-purpose.md' +advancedElicitationTask: '{project-root}/_bmad/core/workflows/advanced-elicitation/workflow.xml' +--- + +# Step E-2: Deep Review & Analysis + +## STEP GOAL: + +Thoroughly review the existing PRD, analyze validation report findings (if provided), and prepare a detailed change plan before editing. + +## MANDATORY EXECUTION RULES (READ FIRST): + +### Universal Rules: + +- 🛑 NEVER generate content without user input +- 📖 CRITICAL: Read the complete step file before taking any action +- 🔄 CRITICAL: When loading next step with 'C', ensure entire file is read +- 📋 YOU ARE A FACILITATOR, not a content generator +- ✅ YOU MUST ALWAYS SPEAK OUTPUT In your Agent communication style with the config `{communication_language}` + +### Role Reinforcement: + +- ✅ You are a Validation Architect and PRD Improvement Specialist +- ✅ If you already have been given communication or persona patterns, continue to use those while playing this new role +- ✅ We engage in collaborative dialogue, not command-response +- ✅ You bring analytical expertise and improvement planning +- ✅ User brings domain knowledge and approval authority + +### Step-Specific Rules: + +- 🎯 Focus ONLY on review and analysis, not editing yet +- 🚫 FORBIDDEN to make changes to PRD in this step +- 💬 Approach: Thorough analysis with user confirmation on plan +- 🚪 This is a middle step - user confirms plan before proceeding + +## EXECUTION PROTOCOLS: + +- 🎯 Load and analyze validation report (if provided) +- 🎯 Deep review of entire PRD +- 🎯 Map validation findings to specific sections +- 🎯 Prepare detailed change plan +- 💬 Get user confirmation on plan +- 🚫 FORBIDDEN to proceed to edit without user approval + +## CONTEXT BOUNDARIES: + +- Available context: PRD file, validation report (if provided), user requirements from step e-01 +- Focus: Analysis and planning only (no editing) +- Limits: Don't change PRD yet, don't validate yet +- Dependencies: Step e-01 completed - requirements and format known + +## MANDATORY SEQUENCE + +**CRITICAL:** Follow this sequence exactly. Do not skip, reorder, or improvise unless user explicitly requests a change. + +### 1. Attempt Sub-Process Deep Review + +**Try to use Task tool with sub-agent:** + +"Perform deep PRD review and change planning: + +**Context from step e-01:** +- User's edit requirements: {user_requirements} +- PRD format: {BMAD/legacy} +- Validation report provided: {yes/no} +- Conversion mode: {restructure/targeted/both} (if legacy) + +**IF validation report provided:** +1. Extract all findings from validation report +2. Map findings to specific PRD sections +3. Prioritize by severity: Critical > Warning > Informational +4. For each critical issue: identify specific fix needed +5. For user's manual edit goals: identify where in PRD to apply + +**IF no validation report:** +1. Read entire PRD thoroughly +2. Analyze against BMAD standards (from prd-purpose.md) +3. Identify issues in: + - Information density (anti-patterns) + - Structure and flow + - Completeness (missing sections/content) + - Measurability (unmeasurable requirements) + - Traceability (broken chains) + - Implementation leakage +4. Map user's edit goals to specific sections + +**Output:** +- Section-by-section analysis +- Specific changes needed for each section +- Prioritized action list +- Recommended order for applying changes + +Return detailed change plan with section breakdown." + +**Graceful degradation (if no Task tool):** +- Manually read PRD sections +- Manually analyze validation report findings (if provided) +- Build section-by-section change plan +- Prioritize changes by severity/user goals + +### 2. Build Change Plan + +**Organize by PRD section:** + +**For each section (in order):** +- **Current State:** Brief description of what exists +- **Issues Identified:** [List from validation report or manual analysis] +- **Changes Needed:** [Specific changes required] +- **Priority:** [Critical/High/Medium/Low] +- **User Requirements Met:** [Which user edit goals address this section] + +**Include:** +- Sections to add (if missing) +- Sections to update (if present but needs work) +- Content to remove (if incorrect/leakage) +- Structure changes (if reformatting needed) + +### 3. Prepare Change Plan Summary + +**Summary sections:** + +**Changes by Type:** +- **Additions:** {count} sections to add +- **Updates:** {count} sections to update +- **Removals:** {count} items to remove +- **Restructuring:** {yes/no} if format conversion needed + +**Priority Distribution:** +- **Critical:** {count} changes (must fix) +- **High:** {count} changes (important) +- **Medium:** {count} changes (nice to have) +- **Low:** {count} changes (optional) + +**Estimated Effort:** +[Quick/Moderate/Substantial] based on scope and complexity + +### 4. Present Change Plan to User + +Display: + +"**Deep Review Complete - Change Plan** + +**PRD Analysis:** +{Brief summary of PRD current state} + +{If validation report provided:} +**Validation Findings:** +{count} issues identified: {critical} critical, {warning} warnings + +**Your Edit Requirements:** +{summary of what user wants to edit} + +**Proposed Change Plan:** + +**By Section:** +{Present section-by-section breakdown} + +**By Priority:** +- Critical: {count} items +- High: {count} items +- Medium: {count} items + +**Estimated Effort:** {effort level} + +**Questions:** +1. Does this change plan align with what you had in mind? +2. Any sections I should add/remove/reprioritize? +3. Any concerns before I proceed with edits? + +**Review the plan and let me know if you'd like any adjustments.**" + +### 5. Get User Confirmation + +Wait for user to review and provide feedback. + +**If user wants adjustments:** +- Discuss requested changes +- Revise change plan accordingly +- Represent for confirmation + +**If user approves:** +- Note: "Change plan approved. Proceeding to edit step." +- Continue to step 6 + +### 6. Document Approved Plan + +Store approved change plan for next step: + +- **Approved changes:** Section-by-section list +- **Priority order:** Sequence to apply changes +- **User confirmed:** Yes + +Display: "**Change Plan Approved** + +{Brief summary of approved plan} + +**Proceeding to edit step...**" + +Load and execute {nextStepFile} (step-e-03-edit.md) + +### 7. Present MENU OPTIONS (If User Wants Discussion) + +**[A] Advanced Elicitation** - Get additional perspectives on change plan +**[P] Party Mode** - Discuss with team for more ideas +**[C] Continue to Edit** - Proceed with approved plan + +#### EXECUTION RULES: + +- ALWAYS halt and wait for user input +- Only proceed to edit when user selects 'C' + +#### Menu Handling Logic: + +- IF A: Execute {advancedElicitationTask}, then return to discussion +- IF P: Execute {partyModeWorkflow}, then return to discussion +- IF C: Document approval, then load {nextStepFile} +- IF Any other: discuss, then redisplay menu + +--- + +## 🚨 SYSTEM SUCCESS/FAILURE METRICS + +### ✅ SUCCESS: + +- Validation report findings fully analyzed (if provided) +- Deep PRD review completed systematically +- Change plan built section-by-section +- Changes prioritized by severity/user goals +- User presented with clear plan +- User confirms or adjusts plan +- Approved plan documented for next step + +### ❌ SYSTEM FAILURE: + +- Not analyzing validation report findings (if provided) +- Superficial review instead of deep analysis +- Missing section-by-section breakdown +- Not prioritizing changes +- Proceeding without user approval + +**Master Rule:** Plan before editing. Thorough analysis ensures we make the right changes in the right order. User approval prevents misalignment. diff --git a/src/modules/bmm/workflows/2-plan-workflows/prd/steps-e/step-e-03-edit.md b/src/modules/bmm/workflows/2-plan-workflows/prd/steps-e/step-e-03-edit.md new file mode 100644 index 00000000..7c26891b --- /dev/null +++ b/src/modules/bmm/workflows/2-plan-workflows/prd/steps-e/step-e-03-edit.md @@ -0,0 +1,253 @@ +--- +name: 'step-e-03-edit' +description: 'Edit & Update - Apply changes to PRD following approved change plan' + +# File references (ONLY variables used in this step) +nextStepFile: './step-e-04-complete.md' +prdFile: '{prd_file_path}' +prdPurpose: '{project-root}/src/modules/bmm/workflows/2-plan-workflows/prd/data/prd-purpose.md' +--- + +# Step E-3: Edit & Update + +## STEP GOAL: + +Apply changes to the PRD following the approved change plan from step e-02, including content updates, structure improvements, and format conversion if needed. + +## MANDATORY EXECUTION RULES (READ FIRST): + +### Universal Rules: + +- 🛑 ALWAYS generate content WITH user input/approval +- 📖 CRITICAL: Read the complete step file before taking any action +- 🔄 CRITICAL: When loading next step with 'C', ensure entire file is read +- 📋 YOU ARE A FACILITATOR, not a content generator +- ✅ YOU MUST ALWAYS SPEAK OUTPUT In your Agent communication style with the config `{communication_language}` + +### Role Reinforcement: + +- ✅ You are a Validation Architect and PRD Improvement Specialist +- ✅ If you already have been given communication or persona patterns, continue to use those while playing this new role +- ✅ We engage in collaborative dialogue, not command-response +- ✅ You bring analytical expertise and precise editing skills +- ✅ User brings domain knowledge and approval authority + +### Step-Specific Rules: + +- 🎯 Focus ONLY on implementing approved changes from step e-02 +- 🚫 FORBIDDEN to make changes beyond the approved plan +- 💬 Approach: Methodical, section-by-section execution +- 🚪 This is a middle step - user can request adjustments + +## EXECUTION PROTOCOLS: + +- 🎯 Follow approved change plan systematically +- 💾 Edit PRD content according to plan +- 📖 Update frontmatter as needed +- 🚫 FORBIDDEN to proceed without completion + +## CONTEXT BOUNDARIES: + +- Available context: PRD file, approved change plan from step e-02, prd-purpose standards +- Focus: Implementing changes from approved plan only +- Limits: Don't add changes beyond plan, don't validate yet +- Dependencies: Step e-02 completed - plan approved by user + +## MANDATORY SEQUENCE + +**CRITICAL:** Follow this sequence exactly. Do not skip, reorder, or improvise unless user explicitly requests a change. + +### 1. Retrieve Approved Change Plan + +From step e-02, retrieve: +- **Approved changes:** Section-by-section list +- **Priority order:** Sequence to apply changes +- **User requirements:** Edit goals from step e-01 + +Display: "**Starting PRD Edits** + +**Change Plan:** {summary} +**Total Changes:** {count} +**Estimated Effort:** {effort level} + +**Proceeding with edits section by section...**" + +### 2. Attempt Sub-Process Edits (For Complex Changes) + +**Try to use Task tool with sub-agent for major sections:** + +"Execute PRD edits for {section_name}: + +**Context:** +- Section to edit: {section_name} +- Current content: {existing content} +- Changes needed: {specific changes from plan} +- BMAD PRD standards: Load from prd-purpose.md + +**Tasks:** +1. Read current PRD section +2. Apply specified changes +3. Ensure BMAD PRD principles compliance: + - High information density (no filler) + - Measurable requirements + - Clear structure + - Proper markdown formatting +4. Return updated section content + +Apply changes and return updated section." + +**Graceful degradation (if no Task tool):** +- Perform edits directly in current context +- Load PRD section, apply changes, save + +### 3. Execute Changes Section-by-Section + +**For each section in approved plan (in priority order):** + +**a) Load current section** +- Read the current PRD section content +- Note what exists + +**b) Apply changes per plan** +- Additions: Create new sections with proper content +- Updates: Modify existing content per plan +- Removals: Remove specified content +- Restructuring: Reformat content to BMAD standard + +**c) Update PRD file** +- Apply changes to PRD +- Save updated PRD +- Verify changes applied correctly + +**Display progress after each section:** +"**Section Updated:** {section_name} +Changes: {brief summary} +{More sections remaining...}" + +### 4. Handle Restructuring (If Needed) + +**If conversion mode is "Full restructuring" or "Both":** + +**For restructuring:** +- Reorganize PRD to BMAD standard structure +- Ensure proper ## Level 2 headers +- Reorder sections logically +- Update PRD frontmatter to match BMAD format + +**Follow BMAD PRD structure:** +1. Executive Summary +2. Success Criteria +3. Product Scope +4. User Journeys +5. Domain Requirements (if applicable) +6. Innovation Analysis (if applicable) +7. Project-Type Requirements +8. Functional Requirements +9. Non-Functional Requirements + +Display: "**PRD Restructured** +BMAD standard structure applied. +{Sections added/reordered}" + +### 5. Update PRD Frontmatter + +**Ensure frontmatter is complete and accurate:** + +```yaml +--- +workflowType: 'prd' +workflow: 'create' # or 'validate' or 'edit' +classification: + domain: '{domain}' + projectType: '{project_type}' + complexity: '{complexity}' +inputDocuments: [list of input documents] +stepsCompleted: ['step-e-01-discovery', 'step-e-02-review', 'step-e-03-edit'] +lastEdited: '{current_date}' +editHistory: + - date: '{current_date}' + changes: '{summary of changes}' +--- +``` + +**Update frontmatter accordingly.** + +### 6. Final Review of Changes + +**Load complete updated PRD** + +**Verify:** +- All approved changes applied correctly +- PRD structure is sound +- No unintended modifications +- Frontmatter is accurate + +**If issues found:** +- Fix them now +- Note corrections made + +**If user wants adjustments:** +- Accept feedback and make adjustments +- Re-verify after adjustments + +### 7. Confirm Completion + +Display: + +"**PRD Edits Complete** + +**Changes Applied:** {count} sections modified +**PRD Updated:** {prd_file_path} + +**Summary of Changes:** +{Brief bullet list of major changes} + +**PRD is ready for:** +- Use in downstream workflows (UX, Architecture) +- Validation (if not yet validated) + +**What would you like to do next?**" + +### 8. Present MENU OPTIONS + +**[V] Run Validation** - Execute full validation workflow (steps-v/step-v-01-discovery.md) +**[S] Summary Only** - End with summary of changes (no validation) +**[A] Adjust** - Make additional edits +**[X] Exit** - Exit edit workflow + +#### EXECUTION RULES: + +- ALWAYS halt and wait for user input +- Only proceed based on user selection + +#### Menu Handling Logic: + +- IF V (Validate): Display "Starting validation workflow..." then load and execute steps-v/step-v-01-discovery.md +- IF S (Summary): Present edit summary and exit +- IF A (Adjust): Accept additional requirements, loop back to editing +- IF X (Exit): Display summary and exit + +--- + +## 🚨 SYSTEM SUCCESS/FAILURE METRICS + +### ✅ SUCCESS: + +- All approved changes from step e-02 applied correctly +- Changes executed in planned priority order +- Restructuring completed (if needed) +- Frontmatter updated accurately +- Final verification confirms changes +- User can proceed to validation or exit with summary +- Option to run validation seamlessly integrates edit and validate modes + +### ❌ SYSTEM FAILURE: + +- Making changes beyond approved plan +- Not following priority order +- Missing restructuring (if conversion mode) +- Not updating frontmatter +- No final verification +- Not saving updated PRD + +**Master Rule:** Execute the plan exactly as approved. PRD is now ready for validation or downstream use. Validation integration ensures quality. diff --git a/src/modules/bmm/workflows/2-plan-workflows/prd/steps-e/step-e-04-complete.md b/src/modules/bmm/workflows/2-plan-workflows/prd/steps-e/step-e-04-complete.md new file mode 100644 index 00000000..780f2694 --- /dev/null +++ b/src/modules/bmm/workflows/2-plan-workflows/prd/steps-e/step-e-04-complete.md @@ -0,0 +1,168 @@ +--- +name: 'step-e-04-complete' +description: 'Complete & Validate - Present options for next steps including full validation' + +# File references (ONLY variables used in this step) +prdFile: '{prd_file_path}' +validationWorkflow: './steps-v/step-v-01-discovery.md' +--- + +# Step E-4: Complete & Validate + +## STEP GOAL: + +Present summary of completed edits and offer next steps including seamless integration with validation workflow. + +## MANDATORY EXECUTION RULES (READ FIRST): + +### Universal Rules: + +- 🛑 ALWAYS generate content WITH user input/approval +- 📖 CRITICAL: Read the complete step file before taking any action +- 🔄 CRITICAL: When loading next step with 'C', ensure entire file is read +- 📋 YOU ARE A FACILITATOR, not a content generator +- ✅ YOU MUST ALWAYS SPEAK OUTPUT In your Agent communication style with the config `{communication_language}` + +### Role Reinforcement: + +- ✅ You are a Validation Architect and PRD Improvement Specialist +- ✅ If you already have been given communication or persona patterns, continue to use those while playing this new role +- ✅ We engage in collaborative dialogue, not command-response +- ✅ You bring synthesis and summary expertise +- ✅ User chooses next actions + +### Step-Specific Rules: + +- 🎯 Focus ONLY on presenting summary and options +- 🚫 FORBIDDEN to make additional changes +- 💬 Approach: Clear, concise summary with actionable options +- 🚪 This is the final edit step - no more edits + +## EXECUTION PROTOCOLS: + +- 🎯 Compile summary of all changes made +- 🎯 Present options clearly with expected outcomes +- 📖 Route to validation if user chooses +- 🚫 FORBIDDEN to proceed without user selection + +## CONTEXT BOUNDARIES: + +- Available context: Updated PRD file, edit history from step e-03 +- Focus: Summary and options only (no more editing) +- Limits: Don't make changes, just present options +- Dependencies: Step e-03 completed - all edits applied + +## MANDATORY SEQUENCE + +**CRITICAL:** Follow this sequence exactly. Do not skip, reorder, or improvise unless user explicitly requests a change. + +### 1. Compile Edit Summary + +From step e-03 change execution, compile: + +**Changes Made:** +- Sections added: {list with names} +- Sections updated: {list with names} +- Content removed: {list} +- Structure changes: {description} + +**Edit Details:** +- Total sections affected: {count} +- Mode: {restructure/targeted/both} +- Priority addressed: {Critical/High/Medium/Low} + +**PRD Status:** +- Format: {BMAD Standard / BMAD Variant / Legacy (converted)} +- Completeness: {assessment} +- Ready for: {downstream use cases} + +### 2. Present Completion Summary + +Display: + +"**✓ PRD Edit Complete** + +**Updated PRD:** {prd_file_path} + +**Changes Summary:** +{Present bulleted list of major changes} + +**Edit Mode:** {mode} +**Sections Modified:** {count} + +**PRD Format:** {format} + +**PRD is now ready for:** +- Downstream workflows (UX Design, Architecture) +- Validation to ensure quality +- Production use + +**What would you like to do next?**" + +### 3. Present MENU OPTIONS + +Display: + +**[V] Run Full Validation** - Execute complete validation workflow (steps-v) to verify PRD quality +**[E] Edit More** - Make additional edits to the PRD +**[S] Summary** - End with detailed summary of changes +**[X] Exit** - Exit edit workflow + +#### EXECUTION RULES: + +- ALWAYS halt and wait for user input +- Only proceed based on user selection + +#### Menu Handling Logic: + +- **IF V (Run Full Validation):** + - Display: "**Starting Validation Workflow**" + - Display: "This will run all 13 validation checks on the updated PRD." + - Display: "Preparing to validate: {prd_file_path}" + - Display: "**Proceeding to validation...**" + - Load, read entire file, then execute {validationWorkflow} (steps-v/step-v-01-discovery.md) + - Note: This hands off to the validation workflow which will run its complete 13-step process + +- **IF E (Edit More):** + - Display: "**Additional Edits**" + - Ask: "What additional edits would you like to make?" + - Accept input, then display: "**Returning to edit step...**" + - Load and execute step-e-03-edit.md again + +- **IF S (Summary):** + - Display detailed summary including: + - Complete list of all changes made + - Before/after comparison (key improvements) + - Recommendations for next steps + - Display: "**Edit Workflow Complete**" + - Exit + +- **IF X (Exit):** + - Display summary + - Display: "**Edit Workflow Complete**" + - Exit + +- **IF Any other:** Help user, then redisplay menu + +--- + +## 🚨 SYSTEM SUCCESS/FAILURE METRICS + +### ✅ SUCCESS: + +- Complete edit summary compiled accurately +- All changes clearly documented +- Options presented with clear expectations +- Validation option seamlessly integrates with steps-v workflow +- User can validate, edit more, or exit +- Clean handoff to validation workflow (if chosen) +- Edit workflow completes properly + +### ❌ SYSTEM FAILURE: + +- Missing changes in summary +- Not offering validation option +- Not documenting completion properly +- No clear handoff to validation workflow + +**Master Rule:** Edit workflow seamlessly integrates with validation. User can edit → validate → edit again → validate again in iterative improvement cycle. diff --git a/src/modules/bmm/workflows/2-plan-workflows/prd/steps-v/step-v-01-discovery.md b/src/modules/bmm/workflows/2-plan-workflows/prd/steps-v/step-v-01-discovery.md new file mode 100644 index 00000000..0d198495 --- /dev/null +++ b/src/modules/bmm/workflows/2-plan-workflows/prd/steps-v/step-v-01-discovery.md @@ -0,0 +1,218 @@ +--- +name: 'step-v-01-discovery' +description: 'Document Discovery & Confirmation - Handle fresh context validation, confirm PRD path, discover input documents' + +# File references (ONLY variables used in this step) +nextStepFile: './step-v-02-format-detection.md' +advancedElicitationTask: '{project-root}/_bmad/core/workflows/advanced-elicitation/workflow.xml' +partyModeWorkflow: '{project-root}/_bmad/core/workflows/party-mode/workflow.md' +prdPurpose: '../data/prd-purpose.md' +--- + +# Step 1: Document Discovery & Confirmation + +## STEP GOAL: + +Handle fresh context validation by confirming PRD path, discovering and loading input documents from frontmatter, and initializing the validation report. + +## MANDATORY EXECUTION RULES (READ FIRST): + +### Universal Rules: + +- 🛑 NEVER generate content without user input +- 📖 CRITICAL: Read the complete step file before taking any action +- 🔄 CRITICAL: When loading next step with 'C', ensure entire file is read +- 📋 YOU ARE A FACILITATOR, not a content generator +- ✅ YOU MUST ALWAYS SPEAK OUTPUT In your Agent communication style with the config `{communication_language}` + +### Role Reinforcement: + +- ✅ You are a Validation Architect and Quality Assurance Specialist +- ✅ If you already have been given communication or persona patterns, continue to use those while playing this new role +- ✅ We engage in collaborative dialogue, not command-response +- ✅ You bring systematic validation expertise and analytical rigor +- ✅ User brings domain knowledge and specific PRD context + +### Step-Specific Rules: + +- 🎯 Focus ONLY on discovering PRD and input documents, not validating yet +- 🚫 FORBIDDEN to perform any validation checks in this step +- 💬 Approach: Systematic discovery with clear reporting to user +- 🚪 This is the setup step - get everything ready for validation + +## EXECUTION PROTOCOLS: + +- 🎯 Discover and confirm PRD to validate +- 💾 Load PRD and all input documents from frontmatter +- 📖 Initialize validation report next to PRD +- 🚫 FORBIDDEN to load next step until user confirms setup + +## CONTEXT BOUNDARIES: + +- Available context: PRD path (user-specified or discovered), workflow configuration +- Focus: Document discovery and setup only +- Limits: Don't perform validation, don't skip discovery +- Dependencies: Configuration loaded from PRD workflow.md initialization + +## MANDATORY SEQUENCE + +**CRITICAL:** Follow this sequence exactly. Do not skip, reorder, or improvise unless user explicitly requests a change. + +### 1. Load PRD Purpose and Standards + +Load and read the complete file at: +`{prdPurpose}` + +This file contains the BMAD PRD philosophy, standards, and validation criteria that will guide all validation checks. Internalize this understanding - it defines what makes a great BMAD PRD. + +### 2. Discover PRD to Validate + +**If PRD path provided as invocation parameter:** +- Use provided path + +**If no PRD path provided:** +"**PRD Validation Workflow** + +Which PRD would you like to validate? + +Please provide the path to the PRD file you want to validate." + +**Wait for user to provide PRD path.** + +### 3. Validate PRD Exists and Load + +Once PRD path is provided: + +- Check if PRD file exists at specified path +- If not found: "I cannot find a PRD at that path. Please check the path and try again." +- If found: Load the complete PRD file including frontmatter + +### 4. Extract Frontmatter and Input Documents + +From the loaded PRD frontmatter, extract: + +- `inputDocuments: []` array (if present) +- Any other relevant metadata (classification, date, etc.) + +**If no inputDocuments array exists:** +Note this and proceed with PRD-only validation + +### 5. Load Input Documents + +For each document listed in `inputDocuments`: + +- Attempt to load the document +- Track successfully loaded documents +- Note any documents that fail to load + +**Build list of loaded input documents:** +- Product Brief (if present) +- Research documents (if present) +- Other reference materials (if present) + +### 6. Ask About Additional Reference Documents + +"**I've loaded the following documents from your PRD frontmatter:** + +{list loaded documents with file names} + +**Are there any additional reference documents you'd like me to include in this validation?** + +These could include: +- Additional research or context documents +- Project documentation not tracked in frontmatter +- Standards or compliance documents +- Competitive analysis or benchmarks + +Please provide paths to any additional documents, or type 'none' to proceed." + +**Load any additional documents provided by user.** + +### 7. Initialize Validation Report + +Create validation report at: `{validationReportPath}` + +**Initialize with frontmatter:** +```yaml +--- +validationTarget: '{prd_path}' +validationDate: '{current_date}' +inputDocuments: [list of all loaded documents] +validationStepsCompleted: [] +validationStatus: IN_PROGRESS +--- +``` + +**Initial content:** +```markdown +# PRD Validation Report + +**PRD Being Validated:** {prd_path} +**Validation Date:** {current_date} + +## Input Documents + +{list all documents loaded for validation} + +## Validation Findings + +[Findings will be appended as validation progresses] +``` + +### 8. Present Discovery Summary + +"**Setup Complete!** + +**PRD to Validate:** {prd_path} + +**Input Documents Loaded:** +- PRD: {prd_name} ✓ +- Product Brief: {count} {if count > 0}✓{else}(none found){/if} +- Research: {count} {if count > 0}✓{else}(none found){/if} +- Additional References: {count} {if count > 0}✓{else}(none){/if} + +**Validation Report:** {validationReportPath} + +**Ready to begin validation.**" + +### 9. Present MENU OPTIONS + +Display: **Select an Option:** [A] Advanced Elicitation [P] Party Mode [C] Continue to Format Detection + +#### EXECUTION RULES: + +- ALWAYS halt and wait for user input after presenting menu +- ONLY proceed to next step when user selects 'C' +- User can ask questions or add more documents - always respond and redisplay menu + +#### Menu Handling Logic: + +- IF A: Execute {advancedElicitationTask}, and when finished redisplay the menu +- IF P: Execute {partyModeWorkflow}, and when finished redisplay the menu +- IF C: Load, read entire file, then execute {nextStepFile} to begin format detection +- IF user provides additional document: Load it, update report, redisplay summary +- IF Any other: help user, then redisplay menu + +--- + +## 🚨 SYSTEM SUCCESS/FAILURE METRICS + +### ✅ SUCCESS: + +- PRD path discovered and confirmed +- PRD file exists and loads successfully +- All input documents from frontmatter loaded +- Additional reference documents (if any) loaded +- Validation report initialized next to PRD +- User clearly informed of setup status +- Menu presented and user input handled correctly + +### ❌ SYSTEM FAILURE: + +- Proceeding with non-existent PRD file +- Not loading input documents from frontmatter +- Creating validation report in wrong location +- Proceeding without user confirming setup +- Not handling missing input documents gracefully + +**Master Rule:** Complete discovery and setup BEFORE validation. This step ensures everything is in place for systematic validation checks. diff --git a/src/modules/bmm/workflows/2-plan-workflows/prd/steps-v/step-v-02-format-detection.md b/src/modules/bmm/workflows/2-plan-workflows/prd/steps-v/step-v-02-format-detection.md new file mode 100644 index 00000000..97566603 --- /dev/null +++ b/src/modules/bmm/workflows/2-plan-workflows/prd/steps-v/step-v-02-format-detection.md @@ -0,0 +1,191 @@ +--- +name: 'step-v-02-format-detection' +description: 'Format Detection & Structure Analysis - Classify PRD format and route appropriately' + +# File references (ONLY variables used in this step) +nextStepFile: './step-v-03-density-validation.md' +altStepFile: './step-v-02b-parity-check.md' +prdFile: '{prd_file_path}' +validationReportPath: '{validation_report_path}' +--- + +# Step 2: Format Detection & Structure Analysis + +## STEP GOAL: + +Detect if PRD follows BMAD format and route appropriately - classify as BMAD Standard / BMAD Variant / Non-Standard, with optional parity check for non-standard formats. + +## MANDATORY EXECUTION RULES (READ FIRST): + +### Universal Rules: + +- 🛑 NEVER generate content without user input +- 📖 CRITICAL: Read the complete step file before taking any action +- 🔄 CRITICAL: When loading next step with 'C', ensure entire file is read +- 📋 YOU ARE A FACILITATOR, not a content generator +- ✅ YOU MUST ALWAYS SPEAK OUTPUT In your Agent communication style with the config `{communication_language}` + +### Role Reinforcement: + +- ✅ You are a Validation Architect and Quality Assurance Specialist +- ✅ If you already have been given communication or persona patterns, continue to use those while playing this new role +- ✅ We engage in collaborative dialogue, not command-response +- ✅ You bring systematic validation expertise and pattern recognition +- ✅ User brings domain knowledge and PRD context + +### Step-Specific Rules: + +- 🎯 Focus ONLY on detecting format and classifying structure +- 🚫 FORBIDDEN to perform other validation checks in this step +- 💬 Approach: Analytical and systematic, clear reporting of findings +- 🚪 This is a branch step - may route to parity check for non-standard PRDs + +## EXECUTION PROTOCOLS: + +- 🎯 Analyze PRD structure systematically +- 💾 Append format findings to validation report +- 📖 Route appropriately based on format classification +- 🚫 FORBIDDEN to skip format detection or proceed without classification + +## CONTEXT BOUNDARIES: + +- Available context: PRD file loaded in step 1, validation report initialized +- Focus: Format detection and classification only +- Limits: Don't perform other validation, don't skip classification +- Dependencies: Step 1 completed - PRD loaded and report initialized + +## MANDATORY SEQUENCE + +**CRITICAL:** Follow this sequence exactly. Do not skip, reorder, or improvise unless user explicitly requests a change. + +### 1. Extract PRD Structure + +Load the complete PRD file and extract: + +**All Level 2 (##) headers:** +- Scan through entire PRD document +- Extract all ## section headers +- List them in order + +**PRD frontmatter:** +- Extract classification.domain if present +- Extract classification.projectType if present +- Note any other relevant metadata + +### 2. Check for BMAD PRD Core Sections + +Check if the PRD contains the following BMAD PRD core sections: + +1. **Executive Summary** (or variations: ## Executive Summary, ## Overview, ## Introduction) +2. **Success Criteria** (or: ## Success Criteria, ## Goals, ## Objectives) +3. **Product Scope** (or: ## Product Scope, ## Scope, ## In Scope, ## Out of Scope) +4. **User Journeys** (or: ## User Journeys, ## User Stories, ## User Flows) +5. **Functional Requirements** (or: ## Functional Requirements, ## Features, ## Capabilities) +6. **Non-Functional Requirements** (or: ## Non-Functional Requirements, ## NFRs, ## Quality Attributes) + +**Count matches:** +- How many of these 6 core sections are present? +- Which specific sections are present? +- Which are missing? + +### 3. Classify PRD Format + +Based on core section count, classify: + +**BMAD Standard:** +- 5-6 core sections present +- Follows BMAD PRD structure closely + +**BMAD Variant:** +- 3-4 core sections present +- Generally follows BMAD patterns but may have structural differences +- Missing some sections but recognizable as BMAD-style + +**Non-Standard:** +- Fewer than 3 core sections present +- Does not follow BMAD PRD structure +- May be completely custom format, legacy format, or from another framework + +### 4. Report Format Findings to Validation Report + +Append to validation report: + +```markdown +## Format Detection + +**PRD Structure:** +[List all ## Level 2 headers found] + +**BMAD Core Sections Present:** +- Executive Summary: [Present/Missing] +- Success Criteria: [Present/Missing] +- Product Scope: [Present/Missing] +- User Journeys: [Present/Missing] +- Functional Requirements: [Present/Missing] +- Non-Functional Requirements: [Present/Missing] + +**Format Classification:** [BMAD Standard / BMAD Variant / Non-Standard] +**Core Sections Present:** [count]/6 +``` + +### 5. Route Based on Format Classification + +**IF format is BMAD Standard or BMAD Variant:** + +Display: "**Format Detected:** {classification} + +Proceeding to systematic validation checks..." + +Immediately load and execute {nextStepFile} (step-v-03-density-validation.md) + +**IF format is Non-Standard (< 3 core sections):** + +Display: "**Format Detected:** Non-Standard PRD + +This PRD does not follow BMAD standard structure (only {count}/6 core sections present). + +You have options:" + +Present MENU OPTIONS below for user selection + +### 6. Present MENU OPTIONS (Non-Standard PRDs Only) + +**[A] Parity Check** - Analyze gaps and estimate effort to reach BMAD PRD parity +**[B] Validate As-Is** - Proceed with validation using current structure +**[C] Exit** - Exit validation and review format findings + +#### EXECUTION RULES: + +- ALWAYS halt and wait for user input +- Only proceed based on user selection + +#### Menu Handling Logic: + +- IF A (Parity Check): Load, read entire file, then execute {altStepFile} (step-v-02b-parity-check.md) +- IF B (Validate As-Is): Display "Proceeding with validation..." then load, read entire file, then execute {nextStepFile} +- IF C (Exit): Display format findings summary and exit validation +- IF Any other: help user respond, then redisplay menu + +--- + +## 🚨 SYSTEM SUCCESS/FAILURE METRICS + +### ✅ SUCCESS: + +- All ## Level 2 headers extracted successfully +- BMAD core sections checked systematically +- Format classified correctly based on section count +- Findings reported to validation report +- BMAD Standard/Variant PRDs proceed directly to next validation step +- Non-Standard PRDs pause and present options to user +- User can choose parity check, validate as-is, or exit + +### ❌ SYSTEM FAILURE: + +- Not extracting all headers before classification +- Incorrect format classification +- Not reporting findings to validation report +- Not pausing for non-standard PRDs +- Proceeding without user decision for non-standard formats + +**Master Rule:** Format detection determines validation path. Non-standard PRDs require user choice before proceeding. diff --git a/src/modules/bmm/workflows/2-plan-workflows/prd/steps-v/step-v-02b-parity-check.md b/src/modules/bmm/workflows/2-plan-workflows/prd/steps-v/step-v-02b-parity-check.md new file mode 100644 index 00000000..3c1cc273 --- /dev/null +++ b/src/modules/bmm/workflows/2-plan-workflows/prd/steps-v/step-v-02b-parity-check.md @@ -0,0 +1,209 @@ +--- +name: 'step-v-02b-parity-check' +description: 'Document Parity Check - Analyze non-standard PRD and identify gaps to achieve BMAD PRD parity' + +# File references (ONLY variables used in this step) +nextStepFile: './step-v-03-density-validation.md' +prdFile: '{prd_file_path}' +validationReportPath: '{validation_report_path}' +--- + +# Step 2B: Document Parity Check + +## STEP GOAL: + +Analyze non-standard PRD and identify gaps to achieve BMAD PRD parity, presenting user with options for how to proceed. + +## MANDATORY EXECUTION RULES (READ FIRST): + +### Universal Rules: + +- 🛑 NEVER generate content without user input +- 📖 CRITICAL: Read the complete step file before taking any action +- 🔄 CRITICAL: When loading next step with 'C', ensure entire file is read +- 📋 YOU ARE A FACILITATOR, not a content generator +- ✅ YOU MUST ALWAYS SPEAK OUTPUT In your Agent communication style with the config `{communication_language}` + +### Role Reinforcement: + +- ✅ You are a Validation Architect and Quality Assurance Specialist +- ✅ If you already have been given communication or persona patterns, continue to use those while playing this new role +- ✅ We engage in collaborative dialogue, not command-response +- ✅ You bring BMAD PRD standards expertise and gap analysis +- ✅ User brings domain knowledge and PRD context + +### Step-Specific Rules: + +- 🎯 Focus ONLY on analyzing gaps and estimating parity effort +- 🚫 FORBIDDEN to perform other validation checks in this step +- 💬 Approach: Systematic gap analysis with clear recommendations +- 🚪 This is an optional branch step - user chooses next action + +## EXECUTION PROTOCOLS: + +- 🎯 Analyze each BMAD PRD section for gaps +- 💾 Append parity analysis to validation report +- 📖 Present options and await user decision +- 🚫 FORBIDDEN to proceed without user selection + +## CONTEXT BOUNDARIES: + +- Available context: Non-standard PRD from step 2, validation report in progress +- Focus: Parity analysis only - what's missing, what's needed +- Limits: Don't perform validation checks, don't auto-proceed +- Dependencies: Step 2 classified PRD as non-standard and user chose parity check + +## MANDATORY SEQUENCE + +**CRITICAL:** Follow this sequence exactly. Do not skip, reorder, or improvise unless user explicitly requests a change. + +### 1. Analyze Each BMAD PRD Section + +For each of the 6 BMAD PRD core sections, analyze: + +**Executive Summary:** +- Does PRD have vision/overview? +- Is problem statement clear? +- Are target users identified? +- Gap: [What's missing or incomplete] + +**Success Criteria:** +- Are measurable goals defined? +- Is success clearly defined? +- Gap: [What's missing or incomplete] + +**Product Scope:** +- Is scope clearly defined? +- Are in-scope items listed? +- Are out-of-scope items listed? +- Gap: [What's missing or incomplete] + +**User Journeys:** +- Are user types/personas identified? +- Are user flows documented? +- Gap: [What's missing or incomplete] + +**Functional Requirements:** +- Are features/capabilities listed? +- Are requirements structured? +- Gap: [What's missing or incomplete] + +**Non-Functional Requirements:** +- Are quality attributes defined? +- Are performance/security/etc. requirements documented? +- Gap: [What's missing or incomplete] + +### 2. Estimate Effort to Reach Parity + +For each missing or incomplete section, estimate: + +**Effort Level:** +- Minimal - Section exists but needs minor enhancements +- Moderate - Section missing but content exists elsewhere in PRD +- Significant - Section missing, requires new content creation + +**Total Parity Effort:** +- Based on individual section estimates +- Classify overall: Quick / Moderate / Substantial effort + +### 3. Report Parity Analysis to Validation Report + +Append to validation report: + +```markdown +## Parity Analysis (Non-Standard PRD) + +### Section-by-Section Gap Analysis + +**Executive Summary:** +- Status: [Present/Missing/Incomplete] +- Gap: [specific gap description] +- Effort to Complete: [Minimal/Moderate/Significant] + +**Success Criteria:** +- Status: [Present/Missing/Incomplete] +- Gap: [specific gap description] +- Effort to Complete: [Minimal/Moderate/Significant] + +**Product Scope:** +- Status: [Present/Missing/Incomplete] +- Gap: [specific gap description] +- Effort to Complete: [Minimal/Moderate/Significant] + +**User Journeys:** +- Status: [Present/Missing/Incomplete] +- Gap: [specific gap description] +- Effort to Complete: [Minimal/Moderate/Significant] + +**Functional Requirements:** +- Status: [Present/Missing/Incomplete] +- Gap: [specific gap description] +- Effort to Complete: [Minimal/Moderate/Significant] + +**Non-Functional Requirements:** +- Status: [Present/Missing/Incomplete] +- Gap: [specific gap description] +- Effort to Complete: [Minimal/Moderate/Significant] + +### Overall Parity Assessment + +**Overall Effort to Reach BMAD Standard:** [Quick/Moderate/Substantial] +**Recommendation:** [Brief recommendation based on analysis] +``` + +### 4. Present Parity Analysis and Options + +Display: + +"**Parity Analysis Complete** + +Your PRD is missing {count} of 6 core BMAD PRD sections. The overall effort to reach BMAD standard is: **{effort level}** + +**Quick Summary:** +[2-3 sentence summary of key gaps] + +**Recommendation:** +{recommendation from analysis} + +**How would you like to proceed?**" + +### 5. Present MENU OPTIONS + +**[C] Continue Validation** - Proceed with validation using current structure +**[E] Exit & Review** - Exit validation and review parity report +**[S] Save & Exit** - Save parity report and exit + +#### EXECUTION RULES: + +- ALWAYS halt and wait for user input +- Only proceed based on user selection + +#### Menu Handling Logic: + +- IF C (Continue): Display "Proceeding with validation..." then load, read entire file, then execute {nextStepFile} +- IF E (Exit): Display parity summary and exit validation +- IF S (Save): Confirm saved, display summary, exit +- IF Any other: help user respond, then redisplay menu + +--- + +## 🚨 SYSTEM SUCCESS/FAILURE METRICS + +### ✅ SUCCESS: + +- All 6 BMAD PRD sections analyzed for gaps +- Effort estimates provided for each gap +- Overall parity effort assessed correctly +- Parity analysis reported to validation report +- Clear summary presented to user +- User can choose to continue validation, exit, or save report + +### ❌ SYSTEM FAILURE: + +- Not analyzing all 6 sections systematically +- Missing effort estimates +- Not reporting parity analysis to validation report +- Auto-proceeding without user decision +- Unclear recommendations + +**Master Rule:** Parity check informs user of gaps and effort, but user decides whether to proceed with validation or address gaps first. diff --git a/src/modules/bmm/workflows/2-plan-workflows/prd/steps-v/step-v-03-density-validation.md b/src/modules/bmm/workflows/2-plan-workflows/prd/steps-v/step-v-03-density-validation.md new file mode 100644 index 00000000..b7d4f330 --- /dev/null +++ b/src/modules/bmm/workflows/2-plan-workflows/prd/steps-v/step-v-03-density-validation.md @@ -0,0 +1,174 @@ +--- +name: 'step-v-03-density-validation' +description: 'Information Density Check - Scan for anti-patterns that violate information density principles' + +# File references (ONLY variables used in this step) +nextStepFile: './step-v-04-brief-coverage-validation.md' +prdFile: '{prd_file_path}' +validationReportPath: '{validation_report_path}' +--- + +# Step 3: Information Density Validation + +## STEP GOAL: + +Validate PRD meets BMAD information density standards by scanning for conversational filler, wordy phrases, and redundant expressions that violate conciseness principles. + +## MANDATORY EXECUTION RULES (READ FIRST): + +### Universal Rules: + +- 🛑 NEVER generate content without user input +- 📖 CRITICAL: Read the complete step file before taking any action +- 🔄 CRITICAL: When loading next step with 'C', ensure entire file is read +- 📋 YOU ARE A FACILITATOR, not a content generator +- ✅ YOU MUST ALWAYS SPEAK OUTPUT In your Agent communication style with the config `{communication_language}` + +### Role Reinforcement: + +- ✅ You are a Validation Architect and Quality Assurance Specialist +- ✅ If you already have been given communication or persona patterns, continue to use those while playing this new role +- ✅ We engage in systematic validation, not collaborative dialogue +- ✅ You bring analytical rigor and attention to detail +- ✅ This step runs autonomously - no user input needed + +### Step-Specific Rules: + +- 🎯 Focus ONLY on information density anti-patterns +- 🚫 FORBIDDEN to validate other aspects in this step +- 💬 Approach: Systematic scanning and categorization +- 🚪 This is a validation sequence step - auto-proceeds when complete + +## EXECUTION PROTOCOLS: + +- 🎯 Scan PRD for density anti-patterns systematically +- 💾 Append density findings to validation report +- 📖 Display "Proceeding to next check..." and load next step +- 🚫 FORBIDDEN to pause or request user input + +## CONTEXT BOUNDARIES: + +- Available context: PRD file, validation report with format findings +- Focus: Information density validation only +- Limits: Don't validate other aspects, don't pause for user input +- Dependencies: Step 2 completed - format classification done + +## MANDATORY SEQUENCE + +**CRITICAL:** Follow this sequence exactly. Do not skip, reorder, or improvise unless user explicitly requests a change. + +### 1. Attempt Sub-Process Validation + +**Try to use Task tool to spawn a subprocess:** + +"Perform information density validation on this PRD: + +1. Load the PRD file +2. Scan for the following anti-patterns: + - Conversational filler phrases (examples: 'The system will allow users to...', 'It is important to note that...', 'In order to') + - Wordy phrases (examples: 'Due to the fact that', 'In the event of', 'For the purpose of') + - Redundant phrases (examples: 'Future plans', 'Absolutely essential', 'Past history') +3. Count violations by category with line numbers +4. Classify severity: Critical (>10 violations), Warning (5-10), Pass (<5) + +Return structured findings with counts and examples." + +### 2. Graceful Degradation (if Task tool unavailable) + +If Task tool unavailable, perform analysis directly: + +**Scan for conversational filler patterns:** +- "The system will allow users to..." +- "It is important to note that..." +- "In order to" +- "For the purpose of" +- "With regard to" +- Count occurrences and note line numbers + +**Scan for wordy phrases:** +- "Due to the fact that" (use "because") +- "In the event of" (use "if") +- "At this point in time" (use "now") +- "In a manner that" (use "how") +- Count occurrences and note line numbers + +**Scan for redundant phrases:** +- "Future plans" (just "plans") +- "Past history" (just "history") +- "Absolutely essential" (just "essential") +- "Completely finish" (just "finish") +- Count occurrences and note line numbers + +### 3. Classify Severity + +**Calculate total violations:** +- Conversational filler count +- Wordy phrases count +- Redundant phrases count +- Total = sum of all categories + +**Determine severity:** +- **Critical:** Total > 10 violations +- **Warning:** Total 5-10 violations +- **Pass:** Total < 5 violations + +### 4. Report Density Findings to Validation Report + +Append to validation report: + +```markdown +## Information Density Validation + +**Anti-Pattern Violations:** + +**Conversational Filler:** {count} occurrences +[If count > 0, list examples with line numbers] + +**Wordy Phrases:** {count} occurrences +[If count > 0, list examples with line numbers] + +**Redundant Phrases:** {count} occurrences +[If count > 0, list examples with line numbers] + +**Total Violations:** {total} + +**Severity Assessment:** [Critical/Warning/Pass] + +**Recommendation:** +[If Critical] "PRD requires significant revision to improve information density. Every sentence should carry weight without filler." +[If Warning] "PRD would benefit from reducing wordiness and eliminating filler phrases." +[If Pass] "PRD demonstrates good information density with minimal violations." +``` + +### 5. Display Progress and Auto-Proceed + +Display: "**Information Density Validation Complete** + +Severity: {Critical/Warning/Pass} + +**Proceeding to next validation check...**" + +Immediately load and execute {nextStepFile} (step-v-04-brief-coverage-validation.md) + +--- + +## 🚨 SYSTEM SUCCESS/FAILURE METRICS + +### ✅ SUCCESS: + +- PRD scanned for all three anti-pattern categories +- Violations counted with line numbers +- Severity classified correctly +- Findings reported to validation report +- Auto-proceeds to next validation step +- Subprocess attempted with graceful degradation + +### ❌ SYSTEM FAILURE: + +- Not scanning all anti-pattern categories +- Missing severity classification +- Not reporting findings to validation report +- Pausing for user input (should auto-proceed) +- Not attempting subprocess architecture + +**Master Rule:** Information density validation runs autonomously. Scan, classify, report, auto-proceed. No user interaction needed. diff --git a/src/modules/bmm/workflows/2-plan-workflows/prd/steps-v/step-v-04-brief-coverage-validation.md b/src/modules/bmm/workflows/2-plan-workflows/prd/steps-v/step-v-04-brief-coverage-validation.md new file mode 100644 index 00000000..909114fe --- /dev/null +++ b/src/modules/bmm/workflows/2-plan-workflows/prd/steps-v/step-v-04-brief-coverage-validation.md @@ -0,0 +1,214 @@ +--- +name: 'step-v-04-brief-coverage-validation' +description: 'Product Brief Coverage Check - Validate PRD covers all content from Product Brief (if used as input)' + +# File references (ONLY variables used in this step) +nextStepFile: './step-v-05-measurability-validation.md' +prdFile: '{prd_file_path}' +productBrief: '{product_brief_path}' +validationReportPath: '{validation_report_path}' +--- + +# Step 4: Product Brief Coverage Validation + +## STEP GOAL: + +Validate that PRD covers all content from Product Brief (if brief was used as input), mapping brief content to PRD sections and identifying gaps. + +## MANDATORY EXECUTION RULES (READ FIRST): + +### Universal Rules: + +- 🛑 NEVER generate content without user input +- 📖 CRITICAL: Read the complete step file before taking any action +- 🔄 CRITICAL: When loading next step with 'C', ensure entire file is read +- 📋 YOU ARE A FACILITATOR, not a content generator +- ✅ YOU MUST ALWAYS SPEAK OUTPUT In your Agent communication style with the config `{communication_language}` + +### Role Reinforcement: + +- ✅ You are a Validation Architect and Quality Assurance Specialist +- ✅ If you already have been given communication or persona patterns, continue to use those while playing this new role +- ✅ We engage in systematic validation, not collaborative dialogue +- ✅ You bring analytical rigor and traceability expertise +- ✅ This step runs autonomously - no user input needed + +### Step-Specific Rules: + +- 🎯 Focus ONLY on Product Brief coverage (conditional on brief existence) +- 🚫 FORBIDDEN to validate other aspects in this step +- 💬 Approach: Systematic mapping and gap analysis +- 🚪 This is a validation sequence step - auto-proceeds when complete + +## EXECUTION PROTOCOLS: + +- 🎯 Check if Product Brief exists in input documents +- 💬 If no brief: Skip this check and report "N/A - No Product Brief" +- 🎯 If brief exists: Map brief content to PRD sections +- 💾 Append coverage findings to validation report +- 📖 Display "Proceeding to next check..." and load next step +- 🚫 FORBIDDEN to pause or request user input + +## CONTEXT BOUNDARIES: + +- Available context: PRD file, input documents from step 1, validation report +- Focus: Product Brief coverage only (conditional) +- Limits: Don't validate other aspects, conditional execution +- Dependencies: Step 1 completed - input documents loaded + +## MANDATORY SEQUENCE + +**CRITICAL:** Follow this sequence exactly. Do not skip, reorder, or improvise unless user explicitly requests a change. + +### 1. Check for Product Brief + +Check if Product Brief was loaded in step 1's inputDocuments: + +**IF no Product Brief found:** +Append to validation report: +```markdown +## Product Brief Coverage + +**Status:** N/A - No Product Brief was provided as input +``` + +Display: "**Product Brief Coverage: Skipped** (No Product Brief provided) + +**Proceeding to next validation check...**" + +Immediately load and execute {nextStepFile} + +**IF Product Brief exists:** Continue to step 2 below + +### 2. Attempt Sub-Process Validation + +**Try to use Task tool to spawn a subprocess:** + +"Perform Product Brief coverage validation: + +1. Load the Product Brief +2. Extract key content: + - Vision statement + - Target users/personas + - Problem statement + - Key features + - Goals/objectives + - Differentiators + - Constraints +3. For each item, search PRD for corresponding coverage +4. Classify coverage: Fully Covered / Partially Covered / Not Found / Intentionally Excluded +5. Note any gaps with severity: Critical / Moderate / Informational + +Return structured coverage map with classifications." + +### 3. Graceful Degradation (if Task tool unavailable) + +If Task tool unavailable, perform analysis directly: + +**Extract from Product Brief:** +- Vision: What is this product? +- Users: Who is it for? +- Problem: What problem does it solve? +- Features: What are the key capabilities? +- Goals: What are the success criteria? +- Differentiators: What makes it unique? + +**For each item, search PRD:** +- Scan Executive Summary for vision +- Check User Journeys or user personas +- Look for problem statement +- Review Functional Requirements for features +- Check Success Criteria section +- Search for differentiators + +**Classify coverage:** +- **Fully Covered:** Content present and complete +- **Partially Covered:** Content present but incomplete +- **Not Found:** Content missing from PRD +- **Intentionally Excluded:** Content explicitly out of scope + +### 4. Assess Coverage and Severity + +**For each gap (Partially Covered or Not Found):** +- Is this Critical? (Core vision, primary users, main features) +- Is this Moderate? (Secondary features, some goals) +- Is this Informational? (Nice-to-have features, minor details) + +**Note:** Some exclusions may be intentional (valid scoping decisions) + +### 5. Report Coverage Findings to Validation Report + +Append to validation report: + +```markdown +## Product Brief Coverage + +**Product Brief:** {brief_file_name} + +### Coverage Map + +**Vision Statement:** [Fully/Partially/Not Found/Intentionally Excluded] +[If gap: Note severity and specific missing content] + +**Target Users:** [Fully/Partially/Not Found/Intentionally Excluded] +[If gap: Note severity and specific missing content] + +**Problem Statement:** [Fully/Partially/Not Found/Intentionally Excluded] +[If gap: Note severity and specific missing content] + +**Key Features:** [Fully/Partially/Not Found/Intentionally Excluded] +[If gap: List specific features with severity] + +**Goals/Objectives:** [Fully/Partially/Not Found/Intentionally Excluded] +[If gap: Note severity and specific missing content] + +**Differentiators:** [Fully/Partially/Not Found/Intentionally Excluded] +[If gap: Note severity and specific missing content] + +### Coverage Summary + +**Overall Coverage:** [percentage or qualitative assessment] +**Critical Gaps:** [count] [list if any] +**Moderate Gaps:** [count] [list if any] +**Informational Gaps:** [count] [list if any] + +**Recommendation:** +[If critical gaps exist] "PRD should be revised to cover critical Product Brief content." +[If moderate gaps] "Consider addressing moderate gaps for complete coverage." +[If minimal gaps] "PRD provides good coverage of Product Brief content." +``` + +### 6. Display Progress and Auto-Proceed + +Display: "**Product Brief Coverage Validation Complete** + +Overall Coverage: {assessment} + +**Proceeding to next validation check...**" + +Immediately load and execute {nextStepFile} (step-v-05-measurability-validation.md) + +--- + +## 🚨 SYSTEM SUCCESS/FAILURE METRICS + +### ✅ SUCCESS: + +- Checked for Product Brief existence correctly +- If no brief: Reported "N/A" and skipped gracefully +- If brief exists: Mapped all key brief content to PRD sections +- Coverage classified appropriately (Fully/Partially/Not Found/Intentionally Excluded) +- Severity assessed for gaps (Critical/Moderate/Informational) +- Findings reported to validation report +- Auto-proceeds to next validation step +- Subprocess attempted with graceful degradation + +### ❌ SYSTEM FAILURE: + +- Not checking for brief existence before attempting validation +- If brief exists: not mapping all key content areas +- Missing coverage classifications +- Not reporting findings to validation report +- Not auto-proceeding + +**Master Rule:** Product Brief coverage is conditional - skip if no brief, validate thoroughly if brief exists. Always auto-proceed. diff --git a/src/modules/bmm/workflows/2-plan-workflows/prd/steps-v/step-v-05-measurability-validation.md b/src/modules/bmm/workflows/2-plan-workflows/prd/steps-v/step-v-05-measurability-validation.md new file mode 100644 index 00000000..18442e8a --- /dev/null +++ b/src/modules/bmm/workflows/2-plan-workflows/prd/steps-v/step-v-05-measurability-validation.md @@ -0,0 +1,228 @@ +--- +name: 'step-v-05-measurability-validation' +description: 'Measurability Validation - Validate that all requirements (FRs and NFRs) are measurable and testable' + +# File references (ONLY variables used in this step) +nextStepFile: './step-v-06-traceability-validation.md' +prdFile: '{prd_file_path}' +validationReportPath: '{validation_report_path}' +--- + +# Step 5: Measurability Validation + +## STEP GOAL: + +Validate that all Functional Requirements (FRs) and Non-Functional Requirements (NFRs) are measurable, testable, and follow proper format without implementation details. + +## MANDATORY EXECUTION RULES (READ FIRST): + +### Universal Rules: + +- 🛑 NEVER generate content without user input +- 📖 CRITICAL: Read the complete step file before taking any action +- 🔄 CRITICAL: When loading next step with 'C', ensure entire file is read +- 📋 YOU ARE A FACILITATOR, not a content generator +- ✅ YOU MUST ALWAYS SPEAK OUTPUT In your Agent communication style with the config `{communication_language}` + +### Role Reinforcement: + +- ✅ You are a Validation Architect and Quality Assurance Specialist +- ✅ If you already have been given communication or persona patterns, continue to use those while playing this new role +- ✅ We engage in systematic validation, not collaborative dialogue +- ✅ You bring analytical rigor and requirements engineering expertise +- ✅ This step runs autonomously - no user input needed + +### Step-Specific Rules: + +- 🎯 Focus ONLY on FR and NFR measurability +- 🚫 FORBIDDEN to validate other aspects in this step +- 💬 Approach: Systematic requirement-by-requirement analysis +- 🚪 This is a validation sequence step - auto-proceeds when complete + +## EXECUTION PROTOCOLS: + +- 🎯 Extract all FRs and NFRs from PRD +- 💾 Validate each for measurability and format +- 📖 Append findings to validation report +- 📖 Display "Proceeding to next check..." and load next step +- 🚫 FORBIDDEN to pause or request user input + +## CONTEXT BOUNDARIES: + +- Available context: PRD file, validation report +- Focus: FR and NFR measurability only +- Limits: Don't validate other aspects, don't pause for user input +- Dependencies: Steps 2-4 completed - initial validation checks done + +## MANDATORY SEQUENCE + +**CRITICAL:** Follow this sequence exactly. Do not skip, reorder, or improvise unless user explicitly requests a change. + +### 1. Attempt Sub-Process Validation + +**Try to use Task tool to spawn a subprocess:** + +"Perform measurability validation on this PRD: + +**Functional Requirements (FRs):** +1. Extract all FRs from Functional Requirements section +2. Check each FR for: + - '[Actor] can [capability]' format compliance + - No subjective adjectives (easy, fast, simple, intuitive, etc.) + - No vague quantifiers (multiple, several, some, many, etc.) + - No implementation details (technology names, library names, data structures unless capability-relevant) +3. Document violations with line numbers + +**Non-Functional Requirements (NFRs):** +1. Extract all NFRs from Non-Functional Requirements section +2. Check each NFR for: + - Specific metrics with measurement methods + - Template compliance (criterion, metric, measurement method, context) + - Context included (why this matters, who it affects) +3. Document violations with line numbers + +Return structured findings with violation counts and examples." + +### 2. Graceful Degradation (if Task tool unavailable) + +If Task tool unavailable, perform analysis directly: + +**Functional Requirements Analysis:** + +Extract all FRs and check each for: + +**Format compliance:** +- Does it follow "[Actor] can [capability]" pattern? +- Is actor clearly defined? +- Is capability actionable and testable? + +**No subjective adjectives:** +- Scan for: easy, fast, simple, intuitive, user-friendly, responsive, quick, efficient (without metrics) +- Note line numbers + +**No vague quantifiers:** +- Scan for: multiple, several, some, many, few, various, number of +- Note line numbers + +**No implementation details:** +- Scan for: React, Vue, Angular, PostgreSQL, MongoDB, AWS, Docker, Kubernetes, Redux, etc. +- Unless capability-relevant (e.g., "API consumers can access...") +- Note line numbers + +**Non-Functional Requirements Analysis:** + +Extract all NFRs and check each for: + +**Specific metrics:** +- Is there a measurable criterion? (e.g., "response time < 200ms", not "fast response") +- Can this be measured or tested? + +**Template compliance:** +- Criterion defined? +- Metric specified? +- Measurement method included? +- Context provided? + +### 3. Tally Violations + +**FR Violations:** +- Format violations: count +- Subjective adjectives: count +- Vague quantifiers: count +- Implementation leakage: count +- Total FR violations: sum + +**NFR Violations:** +- Missing metrics: count +- Incomplete template: count +- Missing context: count +- Total NFR violations: sum + +**Total violations:** FR violations + NFR violations + +### 4. Report Measurability Findings to Validation Report + +Append to validation report: + +```markdown +## Measurability Validation + +### Functional Requirements + +**Total FRs Analyzed:** {count} + +**Format Violations:** {count} +[If violations exist, list examples with line numbers] + +**Subjective Adjectives Found:** {count} +[If found, list examples with line numbers] + +**Vague Quantifiers Found:** {count} +[If found, list examples with line numbers] + +**Implementation Leakage:** {count} +[If found, list examples with line numbers] + +**FR Violations Total:** {total} + +### Non-Functional Requirements + +**Total NFRs Analyzed:** {count} + +**Missing Metrics:** {count} +[If missing, list examples with line numbers] + +**Incomplete Template:** {count} +[If incomplete, list examples with line numbers] + +**Missing Context:** {count} +[If missing, list examples with line numbers] + +**NFR Violations Total:** {total} + +### Overall Assessment + +**Total Requirements:** {FRs + NFRs} +**Total Violations:** {FR violations + NFR violations} + +**Severity:** [Critical if >10 violations, Warning if 5-10, Pass if <5] + +**Recommendation:** +[If Critical] "Many requirements are not measurable or testable. Requirements must be revised to be testable for downstream work." +[If Warning] "Some requirements need refinement for measurability. Focus on violating requirements above." +[If Pass] "Requirements demonstrate good measurability with minimal issues." +``` + +### 5. Display Progress and Auto-Proceed + +Display: "**Measurability Validation Complete** + +Total Violations: {count} ({severity}) + +**Proceeding to next validation check...**" + +Immediately load and execute {nextStepFile} (step-v-06-traceability-validation.md) + +--- + +## 🚨 SYSTEM SUCCESS/FAILURE METRICS + +### ✅ SUCCESS: + +- All FRs extracted and analyzed for measurability +- All NFRs extracted and analyzed for measurability +- Violations documented with line numbers +- Severity assessed correctly +- Findings reported to validation report +- Auto-proceeds to next validation step +- Subprocess attempted with graceful degradation + +### ❌ SYSTEM FAILURE: + +- Not analyzing all FRs and NFRs +- Missing line numbers for violations +- Not reporting findings to validation report +- Not assessing severity +- Not auto-proceeding + +**Master Rule:** Requirements must be testable to be useful. Validate every requirement for measurability, document violations, auto-proceed. diff --git a/src/modules/bmm/workflows/2-plan-workflows/prd/steps-v/step-v-06-traceability-validation.md b/src/modules/bmm/workflows/2-plan-workflows/prd/steps-v/step-v-06-traceability-validation.md new file mode 100644 index 00000000..2a2dcc76 --- /dev/null +++ b/src/modules/bmm/workflows/2-plan-workflows/prd/steps-v/step-v-06-traceability-validation.md @@ -0,0 +1,217 @@ +--- +name: 'step-v-06-traceability-validation' +description: 'Traceability Validation - Validate the traceability chain from vision → success → journeys → FRs is intact' + +# File references (ONLY variables used in this step) +nextStepFile: './step-v-07-implementation-leakage-validation.md' +prdFile: '{prd_file_path}' +validationReportPath: '{validation_report_path}' +--- + +# Step 6: Traceability Validation + +## STEP GOAL: + +Validate the traceability chain from Executive Summary → Success Criteria → User Journeys → Functional Requirements is intact, ensuring every requirement traces back to a user need or business objective. + +## MANDATORY EXECUTION RULES (READ FIRST): + +### Universal Rules: + +- 🛑 NEVER generate content without user input +- 📖 CRITICAL: Read the complete step file before taking any action +- 🔄 CRITICAL: When loading next step with 'C', ensure entire file is read +- 📋 YOU ARE A FACILITATOR, not a content generator +- ✅ YOU MUST ALWAYS SPEAK OUTPUT In your Agent communication style with the config `{communication_language}` + +### Role Reinforcement: + +- ✅ You are a Validation Architect and Quality Assurance Specialist +- ✅ If you already have been given communication or persona patterns, continue to use those while playing this new role +- ✅ We engage in systematic validation, not collaborative dialogue +- ✅ You bring analytical rigor and traceability matrix expertise +- ✅ This step runs autonomously - no user input needed + +### Step-Specific Rules: + +- 🎯 Focus ONLY on traceability chain validation +- 🚫 FORBIDDEN to validate other aspects in this step +- 💬 Approach: Systematic chain validation and orphan detection +- 🚪 This is a validation sequence step - auto-proceeds when complete + +## EXECUTION PROTOCOLS: + +- 🎯 Build and validate traceability matrix +- 💾 Identify broken chains and orphan requirements +- 📖 Append findings to validation report +- 📖 Display "Proceeding to next check..." and load next step +- 🚫 FORBIDDEN to pause or request user input + +## CONTEXT BOUNDARIES: + +- Available context: PRD file, validation report +- Focus: Traceability chain validation only +- Limits: Don't validate other aspects, don't pause for user input +- Dependencies: Steps 2-5 completed - initial validations done + +## MANDATORY SEQUENCE + +**CRITICAL:** Follow this sequence exactly. Do not skip, reorder, or improvise unless user explicitly requests a change. + +### 1. Attempt Sub-Process Validation + +**Try to use Task tool to spawn a subprocess:** + +"Perform traceability validation on this PRD: + +1. Extract content from Executive Summary (vision, goals) +2. Extract Success Criteria +3. Extract User Journeys (user types, flows, outcomes) +4. Extract Functional Requirements (FRs) +5. Extract Product Scope (in-scope items) + +**Validate chains:** +- Executive Summary → Success Criteria: Does vision align with defined success? +- Success Criteria → User Journeys: Are success criteria supported by user journeys? +- User Journeys → Functional Requirements: Does each FR trace back to a user journey? +- Scope → FRs: Do MVP scope FRs align with in-scope items? + +**Identify orphans:** +- FRs not traceable to any user journey or business objective +- Success criteria not supported by user journeys +- User journeys without supporting FRs + +Build traceability matrix and identify broken chains and orphan FRs. + +Return structured findings with chain status and orphan list." + +### 2. Graceful Degradation (if Task tool unavailable) + +If Task tool unavailable, perform analysis directly: + +**Step 1: Extract key elements** +- Executive Summary: Note vision, goals, objectives +- Success Criteria: List all criteria +- User Journeys: List user types and their flows +- Functional Requirements: List all FRs +- Product Scope: List in-scope items + +**Step 2: Validate Executive Summary → Success Criteria** +- Does Executive Summary mention the success dimensions? +- Are Success Criteria aligned with vision? +- Note any misalignment + +**Step 3: Validate Success Criteria → User Journeys** +- For each success criterion, is there a user journey that achieves it? +- Note success criteria without supporting journeys + +**Step 4: Validate User Journeys → FRs** +- For each user journey/flow, are there FRs that enable it? +- List FRs with no clear user journey origin +- Note orphan FRs (requirements without traceable source) + +**Step 5: Validate Scope → FR Alignment** +- Does MVP scope align with essential FRs? +- Are in-scope items supported by FRs? +- Note misalignments + +**Step 6: Build traceability matrix** +- Map each FR to its source (journey or business objective) +- Note orphan FRs +- Identify broken chains + +### 3. Tally Traceability Issues + +**Broken chains:** +- Executive Summary → Success Criteria gaps: count +- Success Criteria → User Journeys gaps: count +- User Journeys → FRs gaps: count +- Scope → FR misalignments: count + +**Orphan elements:** +- Orphan FRs (no traceable source): count +- Unsupported success criteria: count +- User journeys without FRs: count + +**Total issues:** Sum of all broken chains and orphans + +### 4. Report Traceability Findings to Validation Report + +Append to validation report: + +```markdown +## Traceability Validation + +### Chain Validation + +**Executive Summary → Success Criteria:** [Intact/Gaps Identified] +{If gaps: List specific misalignments} + +**Success Criteria → User Journeys:** [Intact/Gaps Identified] +{If gaps: List unsupported success criteria} + +**User Journeys → Functional Requirements:** [Intact/Gaps Identified] +{If gaps: List journeys without supporting FRs} + +**Scope → FR Alignment:** [Intact/Misaligned] +{If misaligned: List specific issues} + +### Orphan Elements + +**Orphan Functional Requirements:** {count} +{List orphan FRs with numbers} + +**Unsupported Success Criteria:** {count} +{List unsupported criteria} + +**User Journeys Without FRs:** {count} +{List journeys without FRs} + +### Traceability Matrix + +{Summary table showing traceability coverage} + +**Total Traceability Issues:** {total} + +**Severity:** [Critical if orphan FRs exist, Warning if gaps, Pass if intact] + +**Recommendation:** +[If Critical] "Orphan requirements exist - every FR must trace back to a user need or business objective." +[If Warning] "Traceability gaps identified - strengthen chains to ensure all requirements are justified." +[If Pass] "Traceability chain is intact - all requirements trace to user needs or business objectives." +``` + +### 5. Display Progress and Auto-Proceed + +Display: "**Traceability Validation Complete** + +Total Issues: {count} ({severity}) + +**Proceeding to next validation check...**" + +Immediately load and execute {nextStepFile} (step-v-07-implementation-leakage-validation.md) + +--- + +## 🚨 SYSTEM SUCCESS/FAILURE METRICS + +### ✅ SUCCESS: + +- All traceability chains validated systematically +- Orphan FRs identified with numbers +- Broken chains documented +- Traceability matrix built +- Severity assessed correctly +- Findings reported to validation report +- Auto-proceeds to next validation step +- Subprocess attempted with graceful degradation + +### ❌ SYSTEM FAILURE: + +- Not validating all traceability chains +- Missing orphan FR detection +- Not building traceability matrix +- Not reporting findings to validation report +- Not auto-proceeding + +**Master Rule:** Every requirement should trace to a user need or business objective. Orphan FRs indicate broken traceability that must be fixed. diff --git a/src/modules/bmm/workflows/2-plan-workflows/prd/steps-v/step-v-07-implementation-leakage-validation.md b/src/modules/bmm/workflows/2-plan-workflows/prd/steps-v/step-v-07-implementation-leakage-validation.md new file mode 100644 index 00000000..7d2839b5 --- /dev/null +++ b/src/modules/bmm/workflows/2-plan-workflows/prd/steps-v/step-v-07-implementation-leakage-validation.md @@ -0,0 +1,205 @@ +--- +name: 'step-v-07-implementation-leakage-validation' +description: 'Implementation Leakage Check - Ensure FRs and NFRs don\'t include implementation details' + +# File references (ONLY variables used in this step) +nextStepFile: './step-v-08-domain-compliance-validation.md' +prdFile: '{prd_file_path}' +validationReportPath: '{validation_report_path}' +--- + +# Step 7: Implementation Leakage Validation + +## STEP GOAL: + +Ensure Functional Requirements and Non-Functional Requirements don't include implementation details - they should specify WHAT, not HOW. + +## MANDATORY EXECUTION RULES (READ FIRST): + +### Universal Rules: + +- 🛑 NEVER generate content without user input +- 📖 CRITICAL: Read the complete step file before taking any action +- 🔄 CRITICAL: When loading next step with 'C', ensure entire file is read +- 📋 YOU ARE A FACILITATOR, not a content generator +- ✅ YOU MUST ALWAYS SPEAK OUTPUT In your Agent communication style with the config `{communication_language}` + +### Role Reinforcement: + +- ✅ You are a Validation Architect and Quality Assurance Specialist +- ✅ If you already have been given communication or persona patterns, continue to use those while playing this new role +- ✅ We engage in systematic validation, not collaborative dialogue +- ✅ You bring analytical rigor and separation of concerns expertise +- ✅ This step runs autonomously - no user input needed + +### Step-Specific Rules: + +- 🎯 Focus ONLY on implementation leakage detection +- 🚫 FORBIDDEN to validate other aspects in this step +- 💬 Approach: Systematic scanning for technology and implementation terms +- 🚪 This is a validation sequence step - auto-proceeds when complete + +## EXECUTION PROTOCOLS: + +- 🎯 Scan FRs and NFRs for implementation terms +- 💾 Distinguish capability-relevant vs leakage +- 📖 Append findings to validation report +- 📖 Display "Proceeding to next check..." and load next step +- 🚫 FORBIDDEN to pause or request user input + +## CONTEXT BOUNDARIES: + +- Available context: PRD file, validation report +- Focus: Implementation leakage detection only +- Limits: Don't validate other aspects, don't pause for user input +- Dependencies: Steps 2-6 completed - initial validations done + +## MANDATORY SEQUENCE + +**CRITICAL:** Follow this sequence exactly. Do not skip, reorder, or improvise unless user explicitly requests a change. + +### 1. Attempt Sub-Process Validation + +**Try to use Task tool to spawn a subprocess:** + +"Perform implementation leakage validation on this PRD: + +**Scan for:** +1. Technology names (React, Vue, Angular, PostgreSQL, MongoDB, AWS, GCP, Azure, Docker, Kubernetes, etc.) +2. Library names (Redux, axios, lodash, Express, Django, Rails, Spring, etc.) +3. Data structures (JSON, XML, CSV) unless relevant to capability +4. Architecture patterns (MVC, microservices, serverless) unless business requirement +5. Protocol names (HTTP, REST, GraphQL, WebSockets) - check if capability-relevant + +**For each term found:** +- Is this capability-relevant? (e.g., 'API consumers can access...' - API is capability) +- Or is this implementation detail? (e.g., 'React component for...' - implementation) + +Document violations with line numbers and explanation. + +Return structured findings with leakage counts and examples." + +### 2. Graceful Degradation (if Task tool unavailable) + +If Task tool unavailable, perform analysis directly: + +**Implementation leakage terms to scan for:** + +**Frontend Frameworks:** +React, Vue, Angular, Svelte, Solid, Next.js, Nuxt, etc. + +**Backend Frameworks:** +Express, Django, Rails, Spring, Laravel, FastAPI, etc. + +**Databases:** +PostgreSQL, MySQL, MongoDB, Redis, DynamoDB, Cassandra, etc. + +**Cloud Platforms:** +AWS, GCP, Azure, Cloudflare, Vercel, Netlify, etc. + +**Infrastructure:** +Docker, Kubernetes, Terraform, Ansible, etc. + +**Libraries:** +Redux, Zustand, axios, fetch, lodash, jQuery, etc. + +**Data Formats:** +JSON, XML, YAML, CSV (unless capability-relevant) + +**For each term found in FRs/NFRs:** +- Determine if it's capability-relevant or implementation leakage +- Example: "API consumers can access data via REST endpoints" - API/REST is capability +- Example: "React components fetch data using Redux" - implementation leakage + +**Count violations and note line numbers** + +### 3. Tally Implementation Leakage + +**By category:** +- Frontend framework leakage: count +- Backend framework leakage: count +- Database leakage: count +- Cloud platform leakage: count +- Infrastructure leakage: count +- Library leakage: count +- Other implementation details: count + +**Total implementation leakage violations:** sum + +### 4. Report Implementation Leakage Findings to Validation Report + +Append to validation report: + +```markdown +## Implementation Leakage Validation + +### Leakage by Category + +**Frontend Frameworks:** {count} violations +{If violations, list examples with line numbers} + +**Backend Frameworks:** {count} violations +{If violations, list examples with line numbers} + +**Databases:** {count} violations +{If violations, list examples with line numbers} + +**Cloud Platforms:** {count} violations +{If violations, list examples with line numbers} + +**Infrastructure:** {count} violations +{If violations, list examples with line numbers} + +**Libraries:** {count} violations +{If violations, list examples with line numbers} + +**Other Implementation Details:** {count} violations +{If violations, list examples with line numbers} + +### Summary + +**Total Implementation Leakage Violations:** {total} + +**Severity:** [Critical if >5 violations, Warning if 2-5, Pass if <2] + +**Recommendation:** +[If Critical] "Extensive implementation leakage found. Requirements specify HOW instead of WHAT. Remove all implementation details - these belong in architecture, not PRD." +[If Warning] "Some implementation leakage detected. Review violations and remove implementation details from requirements." +[If Pass] "No significant implementation leakage found. Requirements properly specify WHAT without HOW." + +**Note:** API consumers, GraphQL (when required), and other capability-relevant terms are acceptable when they describe WHAT the system must do, not HOW to build it. +``` + +### 5. Display Progress and Auto-Proceed + +Display: "**Implementation Leakage Validation Complete** + +Total Violations: {count} ({severity}) + +**Proceeding to next validation check...**" + +Immediately load and execute {nextStepFile} (step-v-08-domain-compliance-validation.md) + +--- + +## 🚨 SYSTEM SUCCESS/FAILURE METRICS + +### ✅ SUCCESS: + +- Scanned FRs and NFRs for all implementation term categories +- Distinguished capability-relevant from implementation leakage +- Violations documented with line numbers and explanations +- Severity assessed correctly +- Findings reported to validation report +- Auto-proceeds to next validation step +- Subprocess attempted with graceful degradation + +### ❌ SYSTEM FAILURE: + +- Not scanning all implementation term categories +- Not distinguishing capability-relevant from leakage +- Missing line numbers for violations +- Not reporting findings to validation report +- Not auto-proceeding + +**Master Rule:** Requirements specify WHAT, not HOW. Implementation details belong in architecture documents, not PRDs. diff --git a/src/modules/bmm/workflows/2-plan-workflows/prd/steps-v/step-v-08-domain-compliance-validation.md b/src/modules/bmm/workflows/2-plan-workflows/prd/steps-v/step-v-08-domain-compliance-validation.md new file mode 100644 index 00000000..6bc473e7 --- /dev/null +++ b/src/modules/bmm/workflows/2-plan-workflows/prd/steps-v/step-v-08-domain-compliance-validation.md @@ -0,0 +1,243 @@ +--- +name: 'step-v-08-domain-compliance-validation' +description: 'Domain Compliance Validation - Validate domain-specific requirements are present for high-complexity domains' + +# File references (ONLY variables used in this step) +nextStepFile: './step-v-09-project-type-validation.md' +prdFile: '{prd_file_path}' +prdFrontmatter: '{prd_frontmatter}' +validationReportPath: '{validation_report_path}' +domainComplexityData: '../data/domain-complexity.csv' +--- + +# Step 8: Domain Compliance Validation + +## STEP GOAL: + +Validate domain-specific requirements are present for high-complexity domains (Healthcare, Fintech, GovTech, etc.), ensuring regulatory and compliance requirements are properly documented. + +## MANDATORY EXECUTION RULES (READ FIRST): + +### Universal Rules: + +- 🛑 NEVER generate content without user input +- 📖 CRITICAL: Read the complete step file before taking any action +- 🔄 CRITICAL: When loading next step with 'C', ensure entire file is read +- 📋 YOU ARE A FACILITATOR, not a content generator +- ✅ YOU MUST ALWAYS SPEAK OUTPUT In your Agent communication style with the config `{communication_language}` + +### Role Reinforcement: + +- ✅ You are a Validation Architect and Quality Assurance Specialist +- ✅ If you already have been given communication or persona patterns, continue to use those while playing this new role +- ✅ We engage in systematic validation, not collaborative dialogue +- ✅ You bring domain expertise and compliance knowledge +- ✅ This step runs autonomously - no user input needed + +### Step-Specific Rules: + +- 🎯 Focus ONLY on domain-specific compliance requirements +- 🚫 FORBIDDEN to validate other aspects in this step +- 💬 Approach: Conditional validation based on domain classification +- 🚪 This is a validation sequence step - auto-proceeds when complete + +## EXECUTION PROTOCOLS: + +- 🎯 Check classification.domain from PRD frontmatter +- 💬 If low complexity (general): Skip detailed checks +- 🎯 If high complexity: Validate required special sections +- 💾 Append compliance findings to validation report +- 📖 Display "Proceeding to next check..." and load next step +- 🚫 FORBIDDEN to pause or request user input + +## CONTEXT BOUNDARIES: + +- Available context: PRD file with frontmatter classification, validation report +- Focus: Domain compliance only (conditional on domain complexity) +- Limits: Don't validate other aspects, conditional execution +- Dependencies: Steps 2-7 completed - format and requirements validation done + +## MANDATORY SEQUENCE + +**CRITICAL:** Follow this sequence exactly. Do not skip, reorder, or improvise unless user explicitly requests a change. + +### 1. Load Domain Complexity Data + +Load and read the complete file at: +`{domainComplexityData}` (../data/domain-complexity.csv) + +This CSV contains: +- Domain classifications and complexity levels (high/medium/low) +- Required special sections for each domain +- Key concerns and requirements for regulated industries + +Internalize this data - it drives which domains require special compliance sections. + +### 2. Extract Domain Classification + +From PRD frontmatter, extract: +- `classification.domain` - what domain is this PRD for? + +**If no domain classification found:** +Treat as "general" (low complexity) and proceed to step 4 + +### 2. Determine Domain Complexity + +**Low complexity domains (skip detailed checks):** +- General +- Consumer apps (standard e-commerce, social, productivity) +- Content websites +- Business tools (standard) + +**High complexity domains (require special sections):** +- Healthcare / Healthtech +- Fintech / Financial services +- GovTech / Public sector +- EdTech (educational records, accredited courses) +- Legal tech +- Other regulated domains + +### 3. For High-Complexity Domains: Validate Required Special Sections + +**Attempt subprocess validation:** + +"Perform domain compliance validation for {domain}: + +Based on {domain} requirements, check PRD for: + +**Healthcare:** +- Clinical Requirements section +- Regulatory Pathway (FDA, HIPAA, etc.) +- Safety Measures +- HIPAA Compliance (data privacy, security) +- Patient safety considerations + +**Fintech:** +- Compliance Matrix (SOC2, PCI-DSS, GDPR, etc.) +- Security Architecture +- Audit Requirements +- Fraud Prevention measures +- Financial transaction handling + +**GovTech:** +- Accessibility Standards (WCAG 2.1 AA, Section 508) +- Procurement Compliance +- Security Clearance requirements +- Data residency requirements + +**Other regulated domains:** +- Check for domain-specific regulatory sections +- Compliance requirements +- Special considerations + +For each required section: +- Is it present in PRD? +- Is it adequately documented? +- Note any gaps + +Return compliance matrix with presence/adequacy assessment." + +**Graceful degradation (if no Task tool):** +- Manually check for required sections based on domain +- List present sections and missing sections +- Assess adequacy of documentation + +### 5. For Low-Complexity Domains: Skip Detailed Checks + +Append to validation report: +```markdown +## Domain Compliance Validation + +**Domain:** {domain} +**Complexity:** Low (general/standard) +**Assessment:** N/A - No special domain compliance requirements + +**Note:** This PRD is for a standard domain without regulatory compliance requirements. +``` + +Display: "**Domain Compliance Validation Skipped** + +Domain: {domain} (low complexity) + +**Proceeding to next validation check...**" + +Immediately load and execute {nextStepFile} + +### 6. Report Compliance Findings (High-Complexity Domains) + +Append to validation report: + +```markdown +## Domain Compliance Validation + +**Domain:** {domain} +**Complexity:** High (regulated) + +### Required Special Sections + +**{Section 1 Name}:** [Present/Missing/Adequate] +{If missing or inadequate: Note specific gaps} + +**{Section 2 Name}:** [Present/Missing/Adequate] +{If missing or inadequate: Note specific gaps} + +[Continue for all required sections] + +### Compliance Matrix + +| Requirement | Status | Notes | +|-------------|--------|-------| +| {Requirement 1} | [Met/Partial/Missing] | {Notes} | +| {Requirement 2} | [Met/Partial/Missing] | {Notes} | +[... continue for all requirements] + +### Summary + +**Required Sections Present:** {count}/{total} +**Compliance Gaps:** {count} + +**Severity:** [Critical if missing regulatory sections, Warning if incomplete, Pass if complete] + +**Recommendation:** +[If Critical] "PRD is missing required domain-specific compliance sections. These are essential for {domain} products." +[If Warning] "Some domain compliance sections are incomplete. Strengthen documentation for full compliance." +[If Pass] "All required domain compliance sections are present and adequately documented." +``` + +### 7. Display Progress and Auto-Proceed + +Display: "**Domain Compliance Validation Complete** + +Domain: {domain} ({complexity}) +Compliance Status: {status} + +**Proceeding to next validation check...**" + +Immediately load and execute {nextStepFile} (step-v-09-project-type-validation.md) + +--- + +## 🚨 SYSTEM SUCCESS/FAILURE METRICS + +### ✅ SUCCESS: + +- Domain classification extracted correctly +- Complexity assessed appropriately +- Low complexity domains: Skipped with clear "N/A" documentation +- High complexity domains: All required sections checked +- Compliance matrix built with status for each requirement +- Severity assessed correctly +- Findings reported to validation report +- Auto-proceeds to next validation step +- Subprocess attempted with graceful degradation + +### ❌ SYSTEM FAILURE: + +- Not checking domain classification before proceeding +- Performing detailed checks on low complexity domains +- For high complexity: missing required section checks +- Not building compliance matrix +- Not reporting findings to validation report +- Not auto-proceeding + +**Master Rule:** Domain compliance is conditional. High-complexity domains require special sections - low complexity domains skip these checks. diff --git a/src/modules/bmm/workflows/2-plan-workflows/prd/steps-v/step-v-09-project-type-validation.md b/src/modules/bmm/workflows/2-plan-workflows/prd/steps-v/step-v-09-project-type-validation.md new file mode 100644 index 00000000..0aa4a2fb --- /dev/null +++ b/src/modules/bmm/workflows/2-plan-workflows/prd/steps-v/step-v-09-project-type-validation.md @@ -0,0 +1,263 @@ +--- +name: 'step-v-09-project-type-validation' +description: 'Project-Type Compliance Validation - Validate project-type specific requirements are properly documented' + +# File references (ONLY variables used in this step) +nextStepFile: './step-v-10-smart-validation.md' +prdFile: '{prd_file_path}' +prdFrontmatter: '{prd_frontmatter}' +validationReportPath: '{validation_report_path}' +projectTypesData: '../data/project-types.csv' +--- + +# Step 9: Project-Type Compliance Validation + +## STEP GOAL: + +Validate project-type specific requirements are properly documented - different project types (api_backend, web_app, mobile_app, etc.) have different required and excluded sections. + +## MANDATORY EXECUTION RULES (READ FIRST): + +### Universal Rules: + +- 🛑 NEVER generate content without user input +- 📖 CRITICAL: Read the complete step file before taking any action +- 🔄 CRITICAL: When loading next step with 'C', ensure entire file is read +- 📋 YOU ARE A FACILITATOR, not a content generator +- ✅ YOU MUST ALWAYS SPEAK OUTPUT In your Agent communication style with the config `{communication_language}` + +### Role Reinforcement: + +- ✅ You are a Validation Architect and Quality Assurance Specialist +- ✅ If you already have been given communication or persona patterns, continue to use those while playing this new role +- ✅ We engage in systematic validation, not collaborative dialogue +- ✅ You bring project type expertise and architectural knowledge +- ✅ This step runs autonomously - no user input needed + +### Step-Specific Rules: + +- 🎯 Focus ONLY on project-type compliance +- 🚫 FORBIDDEN to validate other aspects in this step +- 💬 Approach: Validate required sections present, excluded sections absent +- 🚪 This is a validation sequence step - auto-proceeds when complete + +## EXECUTION PROTOCOLS: + +- 🎯 Check classification.projectType from PRD frontmatter +- 🎯 Validate required sections for that project type are present +- 🎯 Validate excluded sections for that project type are absent +- 💾 Append compliance findings to validation report +- 📖 Display "Proceeding to next check..." and load next step +- 🚫 FORBIDDEN to pause or request user input + +## CONTEXT BOUNDARIES: + +- Available context: PRD file with frontmatter classification, validation report +- Focus: Project-type compliance only +- Limits: Don't validate other aspects, don't pause for user input +- Dependencies: Steps 2-8 completed - domain and requirements validation done + +## MANDATORY SEQUENCE + +**CRITICAL:** Follow this sequence exactly. Do not skip, reorder, or improvise unless user explicitly requests a change. + +### 1. Load Project Types Data + +Load and read the complete file at: +`{projectTypesData}` (../data/project-types.csv) + +This CSV contains: +- Detection signals for each project type +- Required sections for each project type +- Skip/excluded sections for each project type +- Innovation signals + +Internalize this data - it drives what sections must be present or absent for each project type. + +### 2. Extract Project Type Classification + +From PRD frontmatter, extract: +- `classification.projectType` - what type of project is this? + +**Common project types:** +- api_backend +- web_app +- mobile_app +- desktop_app +- data_pipeline +- ml_system +- library_sdk +- infrastructure +- other + +**If no projectType classification found:** +Assume "web_app" (most common) and note in findings + +### 3. Determine Required and Excluded Sections from CSV Data + +**From loaded project-types.csv data, for this project type:** + +**Required sections:** (from required_sections column) +These MUST be present in the PRD + +**Skip sections:** (from skip_sections column) +These MUST NOT be present in the PRD + +**Example mappings from CSV:** +- api_backend: Required=[endpoint_specs, auth_model, data_schemas], Skip=[ux_ui, visual_design] +- mobile_app: Required=[platform_reqs, device_permissions, offline_mode], Skip=[desktop_features, cli_commands] +- cli_tool: Required=[command_structure, output_formats, config_schema], Skip=[visual_design, ux_principles, touch_interactions] +- etc. + +### 4. Validate Against CSV-Based Requirements + +**Based on project type, determine:** + +**api_backend:** +- Required: Endpoint Specs, Auth Model, Data Schemas, API Versioning +- Excluded: UX/UI sections, mobile-specific sections + +**web_app:** +- Required: User Journeys, UX/UI Requirements, Responsive Design +- Excluded: None typically + +**mobile_app:** +- Required: Mobile UX, Platform specifics (iOS/Android), Offline mode +- Excluded: Desktop-specific sections + +**desktop_app:** +- Required: Desktop UX, Platform specifics (Windows/Mac/Linux) +- Excluded: Mobile-specific sections + +**data_pipeline:** +- Required: Data Sources, Data Transformation, Data Sinks, Error Handling +- Excluded: UX/UI sections + +**ml_system:** +- Required: Model Requirements, Training Data, Inference Requirements, Model Performance +- Excluded: UX/UI sections (unless ML UI) + +**library_sdk:** +- Required: API Surface, Usage Examples, Integration Guide +- Excluded: UX/UI sections, deployment sections + +**infrastructure:** +- Required: Infrastructure Components, Deployment, Monitoring, Scaling +- Excluded: Feature requirements (this is infrastructure, not product) + +### 4. Attempt Sub-Process Validation + +"Perform project-type compliance validation for {projectType}: + +**Check that required sections are present:** +{List required sections for this project type} +For each: Is it present in PRD? Is it adequately documented? + +**Check that excluded sections are absent:** +{List excluded sections for this project type} +For each: Is it absent from PRD? (Should not be present) + +Build compliance table showing: +- Required sections: [Present/Missing/Incomplete] +- Excluded sections: [Absent/Present] (Present = violation) + +Return compliance table with findings." + +**Graceful degradation (if no Task tool):** +- Manually check PRD for required sections +- Manually check PRD for excluded sections +- Build compliance table + +### 5. Build Compliance Table + +**Required sections check:** +- For each required section: Present / Missing / Incomplete +- Count: Required sections present vs total required + +**Excluded sections check:** +- For each excluded section: Absent / Present (violation) +- Count: Excluded sections present (violations) + +**Total compliance score:** +- Required: {present}/{total} +- Excluded violations: {count} + +### 6. Report Project-Type Compliance Findings to Validation Report + +Append to validation report: + +```markdown +## Project-Type Compliance Validation + +**Project Type:** {projectType} + +### Required Sections + +**{Section 1}:** [Present/Missing/Incomplete] +{If missing or incomplete: Note specific gaps} + +**{Section 2}:** [Present/Missing/Incomplete] +{If missing or incomplete: Note specific gaps} + +[Continue for all required sections] + +### Excluded Sections (Should Not Be Present) + +**{Section 1}:** [Absent/Present] ✓ +{If present: This section should not be present for {projectType}} + +**{Section 2}:** [Absent/Present] ✓ +{If present: This section should not be present for {projectType}} + +[Continue for all excluded sections] + +### Compliance Summary + +**Required Sections:** {present}/{total} present +**Excluded Sections Present:** {violations} (should be 0) +**Compliance Score:** {percentage}% + +**Severity:** [Critical if required sections missing, Warning if incomplete, Pass if complete] + +**Recommendation:** +[If Critical] "PRD is missing required sections for {projectType}. Add missing sections to properly specify this type of project." +[If Warning] "Some required sections for {projectType} are incomplete. Strengthen documentation." +[If Pass] "All required sections for {projectType} are present. No excluded sections found." +``` + +### 7. Display Progress and Auto-Proceed + +Display: "**Project-Type Compliance Validation Complete** + +Project Type: {projectType} +Compliance: {score}% + +**Proceeding to next validation check...**" + +Immediately load and execute {nextStepFile} (step-v-10-smart-validation.md) + +--- + +## 🚨 SYSTEM SUCCESS/FAILURE METRICS + +### ✅ SUCCESS: + +- Project type extracted correctly (or default assumed) +- Required sections validated for presence and completeness +- Excluded sections validated for absence +- Compliance table built with status for all sections +- Severity assessed correctly +- Findings reported to validation report +- Auto-proceeds to next validation step +- Subprocess attempted with graceful degradation + +### ❌ SYSTEM FAILURE: + +- Not checking project type before proceeding +- Missing required section checks +- Missing excluded section checks +- Not building compliance table +- Not reporting findings to validation report +- Not auto-proceeding + +**Master Rule:** Different project types have different requirements. API PRDs don't need UX sections - validate accordingly. diff --git a/src/modules/bmm/workflows/2-plan-workflows/prd/steps-v/step-v-10-smart-validation.md b/src/modules/bmm/workflows/2-plan-workflows/prd/steps-v/step-v-10-smart-validation.md new file mode 100644 index 00000000..94918c91 --- /dev/null +++ b/src/modules/bmm/workflows/2-plan-workflows/prd/steps-v/step-v-10-smart-validation.md @@ -0,0 +1,209 @@ +--- +name: 'step-v-10-smart-validation' +description: 'SMART Requirements Validation - Validate Functional Requirements meet SMART quality criteria' + +# File references (ONLY variables used in this step) +nextStepFile: './step-v-11-holistic-quality-validation.md' +prdFile: '{prd_file_path}' +validationReportPath: '{validation_report_path}' +advancedElicitationTask: '{project-root}/_bmad/core/workflows/advanced-elicitation/workflow.xml' +--- + +# Step 10: SMART Requirements Validation + +## STEP GOAL: + +Validate Functional Requirements meet SMART quality criteria (Specific, Measurable, Attainable, Relevant, Traceable), ensuring high-quality requirements. + +## MANDATORY EXECUTION RULES (READ FIRST): + +### Universal Rules: + +- 🛑 NEVER generate content without user input +- 📖 CRITICAL: Read the complete step file before taking any action +- 🔄 CRITICAL: When loading next step with 'C', ensure entire file is read +- 📋 YOU ARE A FACILITATOR, not a content generator +- ✅ YOU MUST ALWAYS SPEAK OUTPUT In your Agent communication style with the config `{communication_language}` + +### Role Reinforcement: + +- ✅ You are a Validation Architect and Quality Assurance Specialist +- ✅ If you already have been given communication or persona patterns, continue to use those while playing this new role +- ✅ We engage in systematic validation, not collaborative dialogue +- ✅ You bring requirements engineering expertise and quality assessment +- ✅ This step runs autonomously - no user input needed + +### Step-Specific Rules: + +- 🎯 Focus ONLY on FR quality assessment using SMART framework +- 🚫 FORBIDDEN to validate other aspects in this step +- 💬 Approach: Score each FR on SMART criteria (1-5 scale) +- 🚪 This is a validation sequence step - auto-proceeds when complete + +## EXECUTION PROTOCOLS: + +- 🎯 Extract all FRs from PRD +- 🎯 Score each FR on SMART criteria (Specific, Measurable, Attainable, Relevant, Traceable) +- 💾 Flag FRs with score < 3 in any category +- 📖 Append scoring table and suggestions to validation report +- 📖 Display "Proceeding to next check..." and load next step +- 🚫 FORBIDDEN to pause or request user input + +## CONTEXT BOUNDARIES: + +- Available context: PRD file, validation report +- Focus: FR quality assessment only using SMART framework +- Limits: Don't validate NFRs or other aspects, don't pause for user input +- Dependencies: Steps 2-9 completed - comprehensive validation checks done + +## MANDATORY SEQUENCE + +**CRITICAL:** Follow this sequence exactly. Do not skip, reorder, or improvise unless user explicitly requests a change. + +### 1. Extract All Functional Requirements + +From the PRD's Functional Requirements section, extract: +- All FRs with their FR numbers (FR-001, FR-002, etc.) +- Count total FRs + +### 2. Attempt Sub-Process Validation + +**Try to use Task tool to spawn a subprocess:** + +"Perform SMART requirements validation on these Functional Requirements: + +{List all FRs} + +**For each FR, score on SMART criteria (1-5 scale):** + +**Specific (1-5):** +- 5: Clear, unambiguous, well-defined +- 3: Somewhat clear but could be more specific +- 1: Vague, ambiguous, unclear + +**Measurable (1-5):** +- 5: Quantifiable metrics, testable +- 3: Partially measurable +- 1: Not measurable, subjective + +**Attainable (1-5):** +- 5: Realistic, achievable with constraints +- 3: Probably achievable but uncertain +- 1: Unrealistic, technically infeasible + +**Relevant (1-5):** +- 5: Clearly aligned with user needs and business objectives +- 3: Somewhat relevant but connection unclear +- 1: Not relevant, doesn't align with goals + +**Traceable (1-5):** +- 5: Clearly traces to user journey or business objective +- 3: Partially traceable +- 1: Orphan requirement, no clear source + +**For each FR with score < 3 in any category:** +- Provide specific improvement suggestions + +Return scoring table with all FR scores and improvement suggestions for low-scoring FRs." + +**Graceful degradation (if no Task tool):** +- Manually score each FR on SMART criteria +- Note FRs with low scores +- Provide improvement suggestions + +### 3. Build Scoring Table + +For each FR: +- FR number +- Specific score (1-5) +- Measurable score (1-5) +- Attainable score (1-5) +- Relevant score (1-5) +- Traceable score (1-5) +- Average score +- Flag if any category < 3 + +**Calculate overall FR quality:** +- Percentage of FRs with all scores ≥ 3 +- Percentage of FRs with all scores ≥ 4 +- Average score across all FRs and categories + +### 4. Report SMART Findings to Validation Report + +Append to validation report: + +```markdown +## SMART Requirements Validation + +**Total Functional Requirements:** {count} + +### Scoring Summary + +**All scores ≥ 3:** {percentage}% ({count}/{total}) +**All scores ≥ 4:** {percentage}% ({count}/{total}) +**Overall Average Score:** {average}/5.0 + +### Scoring Table + +| FR # | Specific | Measurable | Attainable | Relevant | Traceable | Average | Flag | +|------|----------|------------|------------|----------|-----------|--------|------| +| FR-001 | {s1} | {m1} | {a1} | {r1} | {t1} | {avg1} | {X if any <3} | +| FR-002 | {s2} | {m2} | {a2} | {r2} | {t2} | {avg2} | {X if any <3} | +[Continue for all FRs] + +**Legend:** 1=Poor, 3=Acceptable, 5=Excellent +**Flag:** X = Score < 3 in one or more categories + +### Improvement Suggestions + +**Low-Scoring FRs:** + +**FR-{number}:** {specific suggestion for improvement} +[For each FR with score < 3 in any category] + +### Overall Assessment + +**Severity:** [Critical if >30% flagged FRs, Warning if 10-30%, Pass if <10%] + +**Recommendation:** +[If Critical] "Many FRs have quality issues. Revise flagged FRs using SMART framework to improve clarity and testability." +[If Warning] "Some FRs would benefit from SMART refinement. Focus on flagged requirements above." +[If Pass] "Functional Requirements demonstrate good SMART quality overall." +``` + +### 5. Display Progress and Auto-Proceed + +Display: "**SMART Requirements Validation Complete** + +FR Quality: {percentage}% with acceptable scores ({severity}) + +**Proceeding to next validation check...**" + +Immediately load and execute {nextStepFile} (step-v-11-holistic-quality-validation.md) + +--- + +## 🚨 SYSTEM SUCCESS/FAILURE METRICS + +### ✅ SUCCESS: + +- All FRs extracted from PRD +- Each FR scored on all 5 SMART criteria (1-5 scale) +- FRs with scores < 3 flagged for improvement +- Improvement suggestions provided for low-scoring FRs +- Scoring table built with all FR scores +- Overall quality assessment calculated +- Findings reported to validation report +- Auto-proceeds to next validation step +- Subprocess attempted with graceful degradation + +### ❌ SYSTEM FAILURE: + +- Not scoring all FRs on all SMART criteria +- Missing improvement suggestions for low-scoring FRs +- Not building scoring table +- Not calculating overall quality metrics +- Not reporting findings to validation report +- Not auto-proceeding + +**Master Rule:** FRs should be high-quality, not just present. SMART framework provides objective quality measure. diff --git a/src/modules/bmm/workflows/2-plan-workflows/prd/steps-v/step-v-11-holistic-quality-validation.md b/src/modules/bmm/workflows/2-plan-workflows/prd/steps-v/step-v-11-holistic-quality-validation.md new file mode 100644 index 00000000..65d41ea1 --- /dev/null +++ b/src/modules/bmm/workflows/2-plan-workflows/prd/steps-v/step-v-11-holistic-quality-validation.md @@ -0,0 +1,264 @@ +--- +name: 'step-v-11-holistic-quality-validation' +description: 'Holistic Quality Assessment - Assess PRD as cohesive, compelling document - is it a good PRD?' + +# File references (ONLY variables used in this step) +nextStepFile: './step-v-12-completeness-validation.md' +prdFile: '{prd_file_path}' +validationReportPath: '{validation_report_path}' +advancedElicitationTask: '{project-root}/_bmad/core/workflows/advanced-elicitation/workflow.xml' +--- + +# Step 11: Holistic Quality Assessment + +## STEP GOAL: + +Assess the PRD as a cohesive, compelling document - evaluating document flow, dual audience effectiveness (humans and LLMs), BMAD PRD principles compliance, and overall quality rating. + +## MANDATORY EXECUTION RULES (READ FIRST): + +### Universal Rules: + +- 🛑 NEVER generate content without user input +- 📖 CRITICAL: Read the complete step file before taking any action +- 🔄 CRITICAL: When loading next step with 'C', ensure entire file is read +- 📋 YOU ARE A FACILITATOR, not a content generator +- ✅ YOU MUST ALWAYS SPEAK OUTPUT In your Agent communication style with the config `{communication_language}` + +### Role Reinforcement: + +- ✅ You are a Validation Architect and Quality Assurance Specialist +- ✅ If you already have been given communication or persona patterns, continue to use those while playing this new role +- ✅ We engage in systematic validation, not collaborative dialogue +- ✅ You bring analytical rigor and document quality expertise +- ✅ This step runs autonomously - no user input needed +- ✅ Uses Advanced Elicitation for multi-perspective evaluation + +### Step-Specific Rules: + +- 🎯 Focus ONLY on holistic document quality assessment +- 🚫 FORBIDDEN to validate individual components (done in previous steps) +- 💬 Approach: Multi-perspective evaluation using Advanced Elicitation +- 🚪 This is a validation sequence step - auto-proceeds when complete + +## EXECUTION PROTOCOLS: + +- 🎯 Use Advanced Elicitation for multi-perspective assessment +- 🎯 Evaluate document flow, dual audience, BMAD principles +- 💾 Append comprehensive assessment to validation report +- 📖 Display "Proceeding to next check..." and load next step +- 🚫 FORBIDDEN to pause or request user input + +## CONTEXT BOUNDARIES: + +- Available context: Complete PRD file, validation report with findings from steps 1-10 +- Focus: Holistic quality - the WHOLE document +- Limits: Don't re-validate individual components, don't pause for user input +- Dependencies: Steps 1-10 completed - all systematic checks done + +## MANDATORY SEQUENCE + +**CRITICAL:** Follow this sequence exactly. Do not skip, reorder, or improvise unless user explicitly requests a change. + +### 1. Attempt Sub-Process with Advanced Elicitation + +**Try to use Task tool to spawn a subprocess using Advanced Elicitation:** + +"Perform holistic quality assessment on this PRD using multi-perspective evaluation: + +**Load and execute Advanced Elicitation workflow:** +{advancedElicitationTask} + +**Evaluate the PRD from these perspectives:** + +**1. Document Flow & Coherence:** +- Read entire PRD +- Evaluate narrative flow - does it tell a cohesive story? +- Check transitions between sections +- Assess consistency - is it coherent throughout? +- Evaluate readability - is it clear and well-organized? + +**2. Dual Audience Effectiveness:** + +**For Humans:** +- Executive-friendly: Can executives understand vision and goals quickly? +- Developer clarity: Do developers have clear requirements to build from? +- Designer clarity: Do designers understand user needs and flows? +- Stakeholder decision-making: Can stakeholders make informed decisions? + +**For LLMs:** +- Machine-readable structure: Is the PRD structured for LLM consumption? +- UX readiness: Can an LLM generate UX designs from this? +- Architecture readiness: Can an LLM generate architecture from this? +- Epic/Story readiness: Can an LLM break down into epics and stories? + +**3. BMAD PRD Principles Compliance:** +- Information density: Every sentence carries weight? +- Measurability: Requirements testable? +- Traceability: Requirements trace to sources? +- Domain awareness: Domain-specific considerations included? +- Zero anti-patterns: No filler or wordiness? +- Dual audience: Works for both humans and LLMs? +- Markdown format: Proper structure and formatting? + +**4. Overall Quality Rating:** +Rate the PRD on 5-point scale: +- Excellent (5/5): Exemplary, ready for production use +- Good (4/5): Strong with minor improvements needed +- Adequate (3/5): Acceptable but needs refinement +- Needs Work (2/5): Significant gaps or issues +- Problematic (1/5): Major flaws, needs substantial revision + +**5. Top 3 Improvements:** +Identify the 3 most impactful improvements to make this a great PRD + +Return comprehensive assessment with all perspectives, rating, and top 3 improvements." + +**Graceful degradation (if no Task tool or Advanced Elicitation unavailable):** +- Perform holistic assessment directly in current context +- Read complete PRD +- Evaluate document flow, coherence, transitions +- Assess dual audience effectiveness +- Check BMAD principles compliance +- Assign overall quality rating +- Identify top 3 improvements + +### 2. Synthesize Assessment + +**Compile findings from multi-perspective evaluation:** + +**Document Flow & Coherence:** +- Overall assessment: [Excellent/Good/Adequate/Needs Work/Problematic] +- Key strengths: [list] +- Key weaknesses: [list] + +**Dual Audience Effectiveness:** +- For Humans: [assessment] +- For LLMs: [assessment] +- Overall dual audience score: [1-5] + +**BMAD Principles Compliance:** +- Principles met: [count]/7 +- Principles with issues: [list] + +**Overall Quality Rating:** [1-5 with label] + +**Top 3 Improvements:** +1. [Improvement 1] +2. [Improvement 2] +3. [Improvement 3] + +### 3. Report Holistic Quality Findings to Validation Report + +Append to validation report: + +```markdown +## Holistic Quality Assessment + +### Document Flow & Coherence + +**Assessment:** [Excellent/Good/Adequate/Needs Work/Problematic] + +**Strengths:** +{List key strengths} + +**Areas for Improvement:** +{List key weaknesses} + +### Dual Audience Effectiveness + +**For Humans:** +- Executive-friendly: [assessment] +- Developer clarity: [assessment] +- Designer clarity: [assessment] +- Stakeholder decision-making: [assessment] + +**For LLMs:** +- Machine-readable structure: [assessment] +- UX readiness: [assessment] +- Architecture readiness: [assessment] +- Epic/Story readiness: [assessment] + +**Dual Audience Score:** {score}/5 + +### BMAD PRD Principles Compliance + +| Principle | Status | Notes | +|-----------|--------|-------| +| Information Density | [Met/Partial/Not Met] | {notes} | +| Measurability | [Met/Partial/Not Met] | {notes} | +| Traceability | [Met/Partial/Not Met] | {notes} | +| Domain Awareness | [Met/Partial/Not Met] | {notes} | +| Zero Anti-Patterns | [Met/Partial/Not Met] | {notes} | +| Dual Audience | [Met/Partial/Not Met] | {notes} | +| Markdown Format | [Met/Partial/Not Met] | {notes} | + +**Principles Met:** {count}/7 + +### Overall Quality Rating + +**Rating:** {rating}/5 - {label} + +**Scale:** +- 5/5 - Excellent: Exemplary, ready for production use +- 4/5 - Good: Strong with minor improvements needed +- 3/5 - Adequate: Acceptable but needs refinement +- 2/5 - Needs Work: Significant gaps or issues +- 1/5 - Problematic: Major flaws, needs substantial revision + +### Top 3 Improvements + +1. **{Improvement 1}** + {Brief explanation of why and how} + +2. **{Improvement 2}** + {Brief explanation of why and how} + +3. **{Improvement 3}** + {Brief explanation of why and how} + +### Summary + +**This PRD is:** {one-sentence overall assessment} + +**To make it great:** Focus on the top 3 improvements above. +``` + +### 4. Display Progress and Auto-Proceed + +Display: "**Holistic Quality Assessment Complete** + +Overall Rating: {rating}/5 - {label} + +**Proceeding to final validation checks...**" + +Immediately load and execute {nextStepFile} (step-v-12-completeness-validation.md) + +--- + +## 🚨 SYSTEM SUCCESS/FAILURE METRICS + +### ✅ SUCCESS: + +- Advanced Elicitation used for multi-perspective evaluation (or graceful degradation) +- Document flow & coherence assessed +- Dual audience effectiveness evaluated (humans and LLMs) +- BMAD PRD principles compliance checked +- Overall quality rating assigned (1-5 scale) +- Top 3 improvements identified +- Comprehensive assessment reported to validation report +- Auto-proceeds to next validation step +- Subprocess attempted with graceful degradation + +### ❌ SYSTEM FAILURE: + +- Not using Advanced Elicitation for multi-perspective evaluation +- Missing document flow assessment +- Missing dual audience evaluation +- Not checking all BMAD principles +- Not assigning overall quality rating +- Missing top 3 improvements +- Not reporting comprehensive assessment to validation report +- Not auto-proceeding + +**Master Rule:** This evaluates the WHOLE document, not just components. Answers "Is this a good PRD?" and "What would make it great?" diff --git a/src/modules/bmm/workflows/2-plan-workflows/prd/steps-v/step-v-12-completeness-validation.md b/src/modules/bmm/workflows/2-plan-workflows/prd/steps-v/step-v-12-completeness-validation.md new file mode 100644 index 00000000..825fbfe8 --- /dev/null +++ b/src/modules/bmm/workflows/2-plan-workflows/prd/steps-v/step-v-12-completeness-validation.md @@ -0,0 +1,242 @@ +--- +name: 'step-v-12-completeness-validation' +description: 'Completeness Check - Final comprehensive completeness check before report generation' + +# File references (ONLY variables used in this step) +nextStepFile: './step-v-13-report-complete.md' +prdFile: '{prd_file_path}' +prdFrontmatter: '{prd_frontmatter}' +validationReportPath: '{validation_report_path}' +--- + +# Step 12: Completeness Validation + +## STEP GOAL: + +Final comprehensive completeness check - validate no template variables remain, each section has required content, section-specific completeness, and frontmatter is properly populated. + +## MANDATORY EXECUTION RULES (READ FIRST): + +### Universal Rules: + +- 🛑 NEVER generate content without user input +- 📖 CRITICAL: Read the complete step file before taking any action +- 🔄 CRITICAL: When loading next step with 'C', ensure entire file is read +- 📋 YOU ARE A FACILITATOR, not a content generator +- ✅ YOU MUST ALWAYS SPEAK OUTPUT In your Agent communication style with the config `{communication_language}` + +### Role Reinforcement: + +- ✅ You are a Validation Architect and Quality Assurance Specialist +- ✅ If you already have been given communication or persona patterns, continue to use those while playing this new role +- ✅ We engage in systematic validation, not collaborative dialogue +- ✅ You bring attention to detail and completeness verification +- ✅ This step runs autonomously - no user input needed + +### Step-Specific Rules: + +- 🎯 Focus ONLY on completeness verification +- 🚫 FORBIDDEN to validate quality (done in step 11) or other aspects +- 💬 Approach: Systematic checklist-style verification +- 🚪 This is a validation sequence step - auto-proceeds when complete + +## EXECUTION PROTOCOLS: + +- 🎯 Check template completeness (no variables remaining) +- 🎯 Validate content completeness (each section has required content) +- 🎯 Validate section-specific completeness +- 🎯 Validate frontmatter completeness +- 💾 Append completeness matrix to validation report +- 📖 Display "Proceeding to final step..." and load next step +- 🚫 FORBIDDEN to pause or request user input + +## CONTEXT BOUNDARIES: + +- Available context: Complete PRD file, frontmatter, validation report +- Focus: Completeness verification only (final gate) +- Limits: Don't assess quality, don't pause for user input +- Dependencies: Steps 1-11 completed - all validation checks done + +## MANDATORY SEQUENCE + +**CRITICAL:** Follow this sequence exactly. Do not skip, reorder, or improvise unless user explicitly requests a change. + +### 1. Attempt Sub-Process Validation + +**Try to use Task tool to spawn a subprocess:** + +"Perform completeness validation on this PRD - final gate check: + +**1. Template Completeness:** +- Scan PRD for any remaining template variables +- Look for: {variable}, {{variable}}, {placeholder}, [placeholder], etc. +- List any found with line numbers + +**2. Content Completeness:** +- Executive Summary: Has vision statement? ({key content}) +- Success Criteria: All criteria measurable? ({metrics present}) +- Product Scope: In-scope and out-of-scope defined? ({both present}) +- User Journeys: User types identified? ({users listed}) +- Functional Requirements: FRs listed with proper format? ({FRs present}) +- Non-Functional Requirements: NFRs with metrics? ({NFRs present}) + +For each section: Is required content present? (Yes/No/Partial) + +**3. Section-Specific Completeness:** +- Success Criteria: Each has specific measurement method? +- User Journeys: Cover all user types? +- Functional Requirements: Cover MVP scope? +- Non-Functional Requirements: Each has specific criteria? + +**4. Frontmatter Completeness:** +- stepsCompleted: Populated? +- classification: Present (domain, projectType)? +- inputDocuments: Tracked? +- date: Present? + +Return completeness matrix with status for each check." + +**Graceful degradation (if no Task tool):** +- Manually scan for template variables +- Manually check each section for required content +- Manually verify frontmatter fields +- Build completeness matrix + +### 2. Build Completeness Matrix + +**Template Completeness:** +- Template variables found: count +- List if any found + +**Content Completeness by Section:** +- Executive Summary: Complete / Incomplete / Missing +- Success Criteria: Complete / Incomplete / Missing +- Product Scope: Complete / Incomplete / Missing +- User Journeys: Complete / Incomplete / Missing +- Functional Requirements: Complete / Incomplete / Missing +- Non-Functional Requirements: Complete / Incomplete / Missing +- Other sections: [List completeness] + +**Section-Specific Completeness:** +- Success criteria measurable: All / Some / None +- Journeys cover all users: Yes / Partial / No +- FRs cover MVP scope: Yes / Partial / No +- NFRs have specific criteria: All / Some / None + +**Frontmatter Completeness:** +- stepsCompleted: Present / Missing +- classification: Present / Missing +- inputDocuments: Present / Missing +- date: Present / Missing + +**Overall completeness:** +- Sections complete: X/Y +- Critical gaps: [list if any] + +### 3. Report Completeness Findings to Validation Report + +Append to validation report: + +```markdown +## Completeness Validation + +### Template Completeness + +**Template Variables Found:** {count} +{If count > 0, list variables with line numbers} +{If count = 0, note: No template variables remaining ✓} + +### Content Completeness by Section + +**Executive Summary:** [Complete/Incomplete/Missing] +{If incomplete or missing, note specific gaps} + +**Success Criteria:** [Complete/Incomplete/Missing] +{If incomplete or missing, note specific gaps} + +**Product Scope:** [Complete/Incomplete/Missing] +{If incomplete or missing, note specific gaps} + +**User Journeys:** [Complete/Incomplete/Missing] +{If incomplete or missing, note specific gaps} + +**Functional Requirements:** [Complete/Incomplete/Missing] +{If incomplete or missing, note specific gaps} + +**Non-Functional Requirements:** [Complete/Incomplete/Missing] +{If incomplete or missing, note specific gaps} + +### Section-Specific Completeness + +**Success Criteria Measurability:** [All/Some/None] measurable +{If Some or None, note which criteria lack metrics} + +**User Journeys Coverage:** [Yes/Partial/No] - covers all user types +{If Partial or No, note missing user types} + +**FRs Cover MVP Scope:** [Yes/Partial/No] +{If Partial or No, note scope gaps} + +**NFRs Have Specific Criteria:** [All/Some/None] +{If Some or None, note which NFRs lack specificity} + +### Frontmatter Completeness + +**stepsCompleted:** [Present/Missing] +**classification:** [Present/Missing] +**inputDocuments:** [Present/Missing] +**date:** [Present/Missing] + +**Frontmatter Completeness:** {complete_fields}/4 + +### Completeness Summary + +**Overall Completeness:** {percentage}% ({complete_sections}/{total_sections}) + +**Critical Gaps:** [count] [list if any] +**Minor Gaps:** [count] [list if any] + +**Severity:** [Critical if template variables exist or critical sections missing, Warning if minor gaps, Pass if complete] + +**Recommendation:** +[If Critical] "PRD has completeness gaps that must be addressed before use. Fix template variables and complete missing sections." +[If Warning] "PRD has minor completeness gaps. Address minor gaps for complete documentation." +[If Pass] "PRD is complete with all required sections and content present." +``` + +### 4. Display Progress and Auto-Proceed + +Display: "**Completeness Validation Complete** + +Overall Completeness: {percentage}% ({severity}) + +**Proceeding to final step...**" + +Immediately load and execute {nextStepFile} (step-v-13-report-complete.md) + +--- + +## 🚨 SYSTEM SUCCESS/FAILURE METRICS + +### ✅ SUCCESS: + +- Scanned for template variables systematically +- Validated each section for required content +- Validated section-specific completeness (measurability, coverage, scope) +- Validated frontmatter completeness +- Completeness matrix built with all checks +- Severity assessed correctly +- Findings reported to validation report +- Auto-proceeds to final step +- Subprocess attempted with graceful degradation + +### ❌ SYSTEM FAILURE: + +- Not scanning for template variables +- Missing section-specific completeness checks +- Not validating frontmatter +- Not building completeness matrix +- Not reporting findings to validation report +- Not auto-proceeding + +**Master Rule:** Final gate to ensure document is complete before presenting findings. Template variables or critical gaps must be fixed. diff --git a/src/modules/bmm/workflows/2-plan-workflows/prd/steps-v/step-v-13-report-complete.md b/src/modules/bmm/workflows/2-plan-workflows/prd/steps-v/step-v-13-report-complete.md new file mode 100644 index 00000000..8b138cfb --- /dev/null +++ b/src/modules/bmm/workflows/2-plan-workflows/prd/steps-v/step-v-13-report-complete.md @@ -0,0 +1,232 @@ +--- +name: 'step-v-13-report-complete' +description: 'Validation Report Complete - Finalize report, summarize findings, present to user, offer next steps' + +# File references (ONLY variables used in this step) +validationReportPath: '{validation_report_path}' +prdFile: '{prd_file_path}' +--- + +# Step 13: Validation Report Complete + +## STEP GOAL: + +Finalize validation report, summarize all findings from steps 1-12, present summary to user conversationally, and offer actionable next steps. + +## MANDATORY EXECUTION RULES (READ FIRST): + +### Universal Rules: + +- 🛑 NEVER generate content without user input +- 📖 CRITICAL: Read the complete step file before taking any action +- 🔄 CRITICAL: When loading next step with 'C', ensure entire file is read +- 📋 YOU ARE A FACILITATOR, not a content generator +- ✅ YOU MUST ALWAYS SPEAK OUTPUT In your Agent communication style with the config `{communication_language}` + +### Role Reinforcement: + +- ✅ You are a Validation Architect and Quality Assurance Specialist +- ✅ If you already have been given communication or persona patterns, continue to use those while playing this new role +- ✅ We engage in collaborative dialogue, not command-response +- ✅ You bring synthesis and summary expertise +- ✅ This is the FINAL step - requires user interaction + +### Step-Specific Rules: + +- 🎯 Focus ONLY on summarizing findings and presenting options +- 🚫 FORBIDDEN to perform additional validation +- 💬 Approach: Conversational summary with clear next steps +- 🚪 This is the final step - no next step after this + +## EXECUTION PROTOCOLS: + +- 🎯 Load complete validation report +- 🎯 Summarize all findings from steps 1-12 +- 🎯 Update report frontmatter with final status +- 💬 Present summary to user conversationally +- 💬 Offer menu options for next actions +- 🚫 FORBIDDEN to proceed without user selection + +## CONTEXT BOUNDARIES: + +- Available context: Complete validation report with findings from all validation steps +- Focus: Summary and presentation only (no new validation) +- Limits: Don't add new findings, just synthesize existing +- Dependencies: Steps 1-12 completed - all validation checks done + +## MANDATORY SEQUENCE + +**CRITICAL:** Follow this sequence exactly. Do not skip, reorder, or improvise unless user explicitly requests a change. + +### 1. Load Complete Validation Report + +Read the entire validation report from {validationReportPath} + +Extract all findings from: +- Format Detection (Step 2) +- Parity Analysis (Step 2B, if applicable) +- Information Density (Step 3) +- Product Brief Coverage (Step 4) +- Measurability (Step 5) +- Traceability (Step 6) +- Implementation Leakage (Step 7) +- Domain Compliance (Step 8) +- Project-Type Compliance (Step 9) +- SMART Requirements (Step 10) +- Holistic Quality (Step 11) +- Completeness (Step 12) + +### 2. Update Report Frontmatter with Final Status + +Update validation report frontmatter: + +```yaml +--- +validationTarget: '{prd_path}' +validationDate: '{current_date}' +inputDocuments: [list of documents] +validationStepsCompleted: ['step-v-01-discovery', 'step-v-02-format-detection', 'step-v-03-density-validation', 'step-v-04-brief-coverage-validation', 'step-v-05-measurability-validation', 'step-v-06-traceability-validation', 'step-v-07-implementation-leakage-validation', 'step-v-08-domain-compliance-validation', 'step-v-09-project-type-validation', 'step-v-10-smart-validation', 'step-v-11-holistic-quality-validation', 'step-v-12-completeness-validation'] +validationStatus: COMPLETE +holisticQualityRating: '{rating from step 11}' +overallStatus: '{Pass/Warning/Critical based on all findings}' +--- +``` + +### 3. Create Summary of Findings + +**Overall Status:** +- Determine from all validation findings +- **Pass:** All critical checks pass, minor warnings acceptable +- **Warning:** Some issues found but PRD is usable +- **Critical:** Major issues that prevent PRD from being fit for purpose + +**Quick Results Table:** +- Format: [classification] +- Information Density: [severity] +- Measurability: [severity] +- Traceability: [severity] +- Implementation Leakage: [severity] +- Domain Compliance: [status] +- Project-Type Compliance: [compliance score] +- SMART Quality: [percentage] +- Holistic Quality: [rating/5] +- Completeness: [percentage] + +**Critical Issues:** List from all validation steps +**Warnings:** List from all validation steps +**Strengths:** List positives from all validation steps + +**Holistic Quality Rating:** From step 11 +**Top 3 Improvements:** From step 11 + +**Recommendation:** Based on overall status + +### 4. Present Summary to User Conversationally + +Display: + +"**✓ PRD Validation Complete** + +**Overall Status:** {Pass/Warning/Critical} + +**Quick Results:** +{Present quick results table with key findings} + +**Critical Issues:** {count or "None"} +{If any, list briefly} + +**Warnings:** {count or "None"} +{If any, list briefly} + +**Strengths:** +{List key strengths} + +**Holistic Quality:** {rating}/5 - {label} + +**Top 3 Improvements:** +1. {Improvement 1} +2. {Improvement 2} +3. {Improvement 3} + +**Recommendation:** +{Based on overall status: +- Pass: "PRD is in good shape. Address minor improvements to make it great." +- Warning: "PRD is usable but has issues that should be addressed. Review warnings and improve where needed." +- Critical: "PRD has significant issues that should be fixed before use. Focus on critical issues above."} + +**What would you like to do next?**" + +### 5. Present MENU OPTIONS + +Display: + +**[R] Review Detailed Findings** - Walk through validation report section by section +**[E] Use Edit Workflow** - Use validation report with Edit workflow for systematic improvements +**[F] Fix Simpler Items** - Immediate fixes for simple issues (anti-patterns, leakage, missing headers) +**[X] Exit** - Exit and review validation report + +#### EXECUTION RULES: + +- ALWAYS halt and wait for user input after presenting menu +- Only proceed based on user selection + +#### Menu Handling Logic: + +- **IF R (Review Detailed Findings):** + - Walk through validation report section by section + - Present findings from each validation step + - Allow user to ask questions + - After review, return to menu + +- **IF E (Use Edit Workflow):** + - Explain: "The Edit workflow (steps-e/) can use this validation report to systematically address issues. Edit mode will guide you through discovering what to edit, reviewing the PRD, and applying targeted improvements." + - Offer: "Would you like to launch Edit mode now? It will help you fix validation findings systematically." + - If yes: Load and execute steps-e/step-e-01-discovery.md + - If no: Return to menu + +- **IF F (Fix Simpler Items):** + - Offer immediate fixes for: + - Template variables (fill in with appropriate content) + - Conversational filler (remove wordy phrases) + - Implementation leakage (remove technology names from FRs/NFRs) + - Missing section headers (add ## headers) + - Ask: "Which simple fixes would you like me to make?" + - If user specifies fixes, make them and update validation report + - Return to menu + +- **IF X (Exit):** + - Display: "**Validation Report Saved:** {validationReportPath}" + - Display: "**Summary:** {overall status} - {recommendation}" + - Display: "**Next Steps:** Review the validation report and address findings. For systematic improvements, consider using Edit workflow when available, or manually fix issues identified in this report." + - Exit validation + +- **IF Any other:** Help user, then redisplay menu + +--- + +## 🚨 SYSTEM SUCCESS/FAILURE METRICS + +### ✅ SUCCESS: + +- Complete validation report loaded successfully +- All findings from steps 1-12 summarized +- Report frontmatter updated with final status +- Overall status determined correctly (Pass/Warning/Critical) +- Quick results table presented +- Critical issues, warnings, and strengths listed +- Holistic quality rating included +- Top 3 improvements presented +- Clear recommendation provided +- Menu options presented with clear explanations +- User can review findings, get help, or exit + +### ❌ SYSTEM FAILURE: + +- Not loading complete validation report +- Missing summary of findings +- Not updating report frontmatter +- Not determining overall status +- Missing menu options +- Unclear next steps + +**Master Rule:** User needs clear summary and actionable next steps. Edit workflow is best for complex issues; immediate fixes available for simpler ones. diff --git a/src/modules/bmm/workflows/2-plan-workflows/prd/steps/step-02-discovery.md b/src/modules/bmm/workflows/2-plan-workflows/prd/steps/step-02-discovery.md deleted file mode 100644 index ed16913e..00000000 --- a/src/modules/bmm/workflows/2-plan-workflows/prd/steps/step-02-discovery.md +++ /dev/null @@ -1,420 +0,0 @@ ---- -name: 'step-02-discovery' -description: 'Conduct project and domain discovery with data-driven classification' - -# Path Definitions -workflow_path: '{project-root}/_bmad/bmm/workflows/2-plan-workflows/prd' - -# File References -thisStepFile: '{workflow_path}/steps/step-02-discovery.md' -nextStepFile: '{workflow_path}/steps/step-03-success.md' -workflowFile: '{workflow_path}/workflow.md' -outputFile: '{output_folder}/prd.md' - -# Data Files -projectTypesCSV: '{workflow_path}/project-types.csv' -domainComplexityCSV: '{workflow_path}/domain-complexity.csv' - -# Task References -advancedElicitationTask: '{project-root}/_bmad/core/tasks/advanced-elicitation.xml' -partyModeWorkflow: '{project-root}/_bmad/core/workflows/party-mode/workflow.md' ---- - -# Step 2: Project & Domain Discovery - -**Progress: Step 2 of 11** - Next: Success Criteria Definition - -## STEP GOAL: - -Conduct comprehensive project discovery that leverages existing input documents while allowing user refinement, with data-driven classification, and generate the Executive Summary content. - -## MANDATORY EXECUTION RULES (READ FIRST): - -### Universal Rules: - -- 🛑 NEVER generate content without user input -- 📖 CRITICAL: Read the complete step file before taking any action -- 🔄 CRITICAL: When loading next step with 'C', ensure entire file is read -- 📋 YOU ARE A FACILITATOR, not a content generator - -### Role Reinforcement: - -- ✅ You are a product-focused PM facilitator collaborating with an expert peer -- ✅ We engage in collaborative dialogue, not command-response -- ✅ You bring structured thinking and facilitation skills, while the user brings domain expertise and product vision - -### Step-Specific Rules: - -- 🎯 Focus on project classification and vision alignment only -- 🚫 FORBIDDEN to generate content without real user input -- 💬 APPROACH: Adapt questions based on document context (brownfield vs greenfield) -- 🎯 LOAD classification data BEFORE starting discovery conversation - -## EXECUTION PROTOCOLS: - -- 🎯 Show your analysis before taking any action -- ⚠️ Present A/P/C menu after generating executive summary content -- 💾 ONLY save when user chooses C (Continue) -- 📖 Update frontmatter `stepsCompleted: [1, 2]` before loading next step -- 🚫 FORBIDDEN to load next step until C is selected - -## COLLABORATION MENUS (A/P/C): - -This step will generate content and present choices: - -- **A (Advanced Elicitation)**: Use discovery protocols to develop deeper insights about the generated content -- **P (Party Mode)**: Bring multiple perspectives to discuss and improve the generated content -- **C (Continue)**: Save the content to the document and proceed to next step - -## PROTOCOL INTEGRATION: - -- When 'A' selected: Execute {advancedElicitationTask} -- When 'P' selected: Execute {partyModeWorkflow} -- PROTOCOLS always return to this step's A/P/C menu -- User accepts/rejects protocol changes before proceeding - -## CONTEXT BOUNDARIES: - -- Current document and frontmatter from step 1 are available -- Input documents already loaded are in memory (product briefs, research, brainstorming, project docs) -- **Document counts available in frontmatter `documentCounts`** -- Classification CSV data will be loaded in this step only -- This will be the first content section appended to the document - -## Sequence of Instructions (Do not deviate, skip, or optimize) - -### 1. Read Document State from Frontmatter - -**CRITICAL FIRST ACTION:** Read the frontmatter from `{outputFile}` to get document counts. - -``` -Read documentCounts from prd.md frontmatter: -- briefCount = documentCounts.briefs -- researchCount = documentCounts.research -- brainstormingCount = documentCounts.brainstorming -- projectDocsCount = documentCounts.projectDocs -``` - -**ANNOUNCE your understanding:** - -"From step 1, I have loaded: - -- Product briefs: {{briefCount}} files -- Research: {{researchCount}} files -- Brainstorming: {{brainstormingCount}} files -- Project docs: {{projectDocsCount}} files - -{if projectDocsCount > 0}This is a **brownfield project** - I'll focus on understanding what you want to add or change.{else}This is a **greenfield project** - I'll help you define the full product vision.{/if}" - -### 2. Load Classification Data - -Load and prepare CSV data for intelligent classification: - -- Load `{projectTypesCSV}` completely -- Load `{domainComplexityCSV}` completely -- Parse column structures and store in memory for this step only - -### 3. Begin Discovery Conversation - -**SELECT EXACTLY ONE DISCOVERY PATH based on document state:** - ---- - -#### PATH A: Has Product Brief (briefCount > 0) - -**Use this path when:** `briefCount > 0` - -"As your PM peer, I've reviewed your product brief and have a great starting point for our discovery. Let me share what I understand and you can refine or correct as needed. - -**Based on your product brief:** - -**What you're building:** -{{extracted_vision_from_brief}} - -**Problem it solves:** -{{extracted_problem_from_brief}} - -**Target users:** -{{extracted_users_from_brief}} - -**What makes it special:** -{{extracted_differentiator_from_brief}} - -{if projectDocsCount > 0}I also see you have existing project documentation. This PRD will define how new features integrate with your existing system architecture.{/if} - -**How does this align with your vision?** Should we refine any of these points or are there important aspects I'm missing?" - -**AFTER this message, SKIP to Section 4.** - ---- - -#### PATH B: No Brief but Has Project Docs - Brownfield (briefCount == 0 AND projectDocsCount > 0) - -**Use this path when:** `briefCount == 0 AND projectDocsCount > 0` - -**NOTE:** Extract the following from loaded project documentation (index.md, architecture.md, project-overview.md, etc.): - -"As your PM peer, I've reviewed your existing project documentation from document-project. - -**Your existing system includes:** - -- **Tech Stack:** {analyze index.md and architecture.md for technologies used} -- **Architecture:** {summarize architecture patterns from architecture.md} -- **Key Components:** {list main components from source-tree-analysis.md or project-overview.md} - -This PRD will define **new features or changes** to add to this existing codebase. - -**Tell me about what you want to add or change:** - -- What new capability or feature do you want to build? -- What problem will this solve for your users? -- How should it integrate with the existing system? -- Is this adding new functionality, improving existing features, or fixing issues? - -I'll help you create a PRD focused on these additions while respecting your existing patterns and architecture." - -**AFTER this message, SKIP to Section 4.** - ---- - -#### PATH C: No Documents - Greenfield (briefCount == 0 AND projectDocsCount == 0) - -**Use this path when:** `briefCount == 0 AND projectDocsCount == 0` - -"As your PM peer, I'm excited to help you shape {{project_name}}. Let me start by understanding what you want to build. - -**Tell me about what you want to create:** - -- What problem does it solve? -- Who are you building this for? -- What excites you most about this product? - -I'll be listening for signals to help us classify the project and domain so we can ask the right questions throughout our process." - -**AFTER this message, continue to Section 4.** - ---- - -### 4. Listen for Classification Signals - -As the user describes their product/feature, listen for and match against: - -#### Project Type Signals - -Compare user description against `detection_signals` from `project-types.csv`: - -- Look for keyword matches from semicolon-separated signals -- Examples: "API,REST,GraphQL" → api_backend -- Examples: "iOS,Android,app,mobile" → mobile_app -- Store the best matching `project_type` - -#### Domain Signals - -Compare user description against `signals` from `domain-complexity.csv`: - -- Look for domain keyword matches -- Examples: "medical,diagnostic,clinical" → healthcare -- Examples: "payment,banking,trading" → fintech -- Store the matched `domain` and `complexity_level` - -### 5. Present Classification for Validation - -**SELECT EXACTLY ONE CLASSIFICATION PRESENTATION based on document state:** - ---- - -#### IF PATH A was used (briefCount > 0): - -"Based on your product brief and our discussion, I'm classifying this as: - -- **Project Type:** {project_type_from_brief_or_conversation} -- **Domain:** {domain_from_brief_or_conversation} -- **Complexity:** {complexity_from_brief_or_conversation} - -From your brief, I detected these classification signals: -{{classification_signals_from_brief}} - -{if projectDocsCount > 0}Your existing project documentation also indicates: - -- **Existing Tech Stack:** {from architecture.md or index.md} -- **Architecture Pattern:** {from architecture.md} - -I'll ensure the new features align with your existing system.{/if} - -Combined with our conversation, this suggests the above classification. Does this sound right?" - ---- - -#### IF PATH B was used (briefCount == 0 AND projectDocsCount > 0): - -"Based on your existing project documentation and our discussion about new features: - -- **Existing Project Type:** {detected from project docs - e.g., web_app, api_backend} -- **Tech Stack:** {from architecture.md or index.md} -- **New Feature Type:** {from user's description of what they want to add} -- **Domain:** {detected_domain} -- **Complexity:** {complexity_level} - -I'll ensure the PRD aligns with your existing architecture patterns. Does this classification sound right?" - ---- - -#### IF PATH C was used (briefCount == 0 AND projectDocsCount == 0): - -"Based on our conversation, I'm hearing this as: - -- **Project Type:** {detected_project_type} -- **Domain:** {detected_domain} -- **Complexity:** {complexity_level} - -Does this sound right to you? I want to make sure we're on the same page before diving deeper." - ---- - -### 6. Identify What Makes It Special - -**SELECT EXACTLY ONE DIFFERENTIATOR DISCOVERY based on document state:** - ---- - -#### IF PATH A was used (briefCount > 0): - -"From your product brief, I understand that what makes this special is: -{{extracted_differentiator_from_brief}} - -Let's explore this deeper: - -- **Refinement needed:** Does this capture the essence correctly, or should we adjust it? -- **Missing aspects:** Are there other differentiators that aren't captured in your brief? -- **Evolution:** How has your thinking on this evolved since you wrote the brief?" - ---- - -#### IF PATH B was used (briefCount == 0 AND projectDocsCount > 0): - -"Your existing system already provides certain capabilities. Now let's define what makes these **new additions** special: - -- What gap in your current system will this fill? -- How will this improve the experience for your existing users? -- What's the key insight that led you to prioritize this addition? -- What would make users say 'finally, this is what we needed'?" - ---- - -#### IF PATH C was used (briefCount == 0 AND projectDocsCount == 0): - -Ask focused questions to capture the product's unique value: - -- "What would make users say 'this is exactly what I needed'?" -- "What's the moment where users realize this is different/better?" -- "What assumption about [problem space] are you challenging?" -- "If this succeeds wildly, what changed for your users?" - ---- - -### 7. Generate Executive Summary Content - -Based on the conversation, prepare the content to append to the document: - -#### Content Structure: - -```markdown -## Executive Summary - -{vision_alignment_content} - -### What Makes This Special - -{product_differentiator_content} - -## Project Classification - -**Technical Type:** {project_type} -**Domain:** {domain} -**Complexity:** {complexity_level} -{if projectDocsCount > 0}**Project Context:** Brownfield - extending existing system{else}**Project Context:** Greenfield - new project{/if} - -{project_classification_content} -``` - -### 8. Present Content and Menu - -Show the generated content to the user and present: - -"I've drafted our Executive Summary based on our conversation. This will be the first section of your PRD. - -**Here's what I'll add to the document:** - -[Show the complete markdown content from step 7] - -**Select an Option:** -[A] Advanced Elicitation - Let's dive deeper and refine this content -[P] Party Mode - Bring in different perspectives to improve this -[C] Continue - Save this and move to Success Criteria Definition (Step 3 of 11)" - -### 9. Handle Menu Selection - -#### IF A (Advanced Elicitation): - -- Execute {advancedElicitationTask} with the current content -- Process the enhanced content that comes back -- Ask user: "Accept these changes to the Executive Summary? (y/n)" -- If yes: Update the content with improvements, then return to A/P/C menu -- If no: Keep original content, then return to A/P/C menu - -#### IF P (Party Mode): - -- Execute {partyModeWorkflow} with the current content -- Process the collaborative improvements that come back -- Ask user: "Accept these changes to the Executive Summary? (y/n)" -- If yes: Update the content with improvements, then return to A/P/C menu -- If no: Keep original content, then return to A/P/C menu - -#### IF C (Continue): - -- Append the final content to `{outputFile}` -- Update frontmatter: `stepsCompleted: [1, 2]` -- Load `{nextStepFile}` - -## CRITICAL STEP COMPLETION NOTE - -ONLY WHEN [C continue option] is selected and [executive summary content finalized and saved to document with frontmatter updated], will you then load and read fully `{nextStepFile}` to execute and begin success criteria definition. - ---- - -## 🚨 SYSTEM SUCCESS/FAILURE METRICS - -### ✅ SUCCESS: - -- Document counts read from frontmatter and announced -- Classification data loaded and used effectively -- **Correct discovery path selected based on document counts** -- Input documents analyzed and leveraged for head start -- User classifications validated and confirmed -- Product differentiator clearly identified and refined -- Executive summary content generated collaboratively with document context -- A/P/C menu presented and handled correctly -- Content properly appended to document when C selected -- Frontmatter updated with stepsCompleted: [1, 2] - -### ❌ SYSTEM FAILURE: - -- **Not reading documentCounts from frontmatter first** -- **Executing multiple discovery paths instead of exactly one** -- Skipping classification data loading and guessing classifications -- Not leveraging existing input documents to accelerate discovery -- Not validating classifications with user before proceeding -- Generating executive summary without real user input -- Missing the "what makes it special" discovery and refinement -- Not presenting A/P/C menu after content generation -- Appending content without user selecting 'C' - -**Master Rule:** Skipping steps, optimizing sequences, or not following exact instructions is FORBIDDEN and constitutes SYSTEM FAILURE. - -## COMPLEXITY HANDLING: - -If `complexity_level = "high"`: - -- Note the `suggested_workflow` and `web_searches` from domain CSV -- Consider mentioning domain research needs in classification section -- Document complexity implications in project classification diff --git a/src/modules/bmm/workflows/2-plan-workflows/prd/steps/step-04-journeys.md b/src/modules/bmm/workflows/2-plan-workflows/prd/steps/step-04-journeys.md deleted file mode 100644 index 095480d1..00000000 --- a/src/modules/bmm/workflows/2-plan-workflows/prd/steps/step-04-journeys.md +++ /dev/null @@ -1,290 +0,0 @@ ---- -name: 'step-04-journeys' -description: 'Map ALL user types that interact with the system with narrative story-based journeys' - -# Path Definitions -workflow_path: '{project-root}/_bmad/bmm/workflows/2-plan-workflows/prd' - -# File References -thisStepFile: '{workflow_path}/steps/step-04-journeys.md' -nextStepFile: '{workflow_path}/steps/step-05-domain.md' -workflowFile: '{workflow_path}/workflow.md' -outputFile: '{output_folder}/prd.md' - -# Task References -advancedElicitationTask: '{project-root}/_bmad/core/tasks/advanced-elicitation.xml' -partyModeWorkflow: '{project-root}/_bmad/core/workflows/party-mode/workflow.md' ---- - -# Step 4: User Journey Mapping - -**Progress: Step 4 of 11** - Next: Domain Requirements - -## MANDATORY EXECUTION RULES (READ FIRST): - -- 🛑 NEVER generate content without user input - -- 📖 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 -- ✅ ALWAYS treat this as collaborative discovery between PM peers -- 📋 YOU ARE A FACILITATOR, not a content generator -- 💬 FOCUS on mapping ALL user types that interact with the system -- 🎯 CRITICAL: No journey = no functional requirements = product doesn't exist - -## EXECUTION PROTOCOLS: - -- 🎯 Show your analysis before taking any action -- ⚠️ Present A/P/C menu after generating journey content -- 💾 ONLY save when user chooses C (Continue) -- 📖 Update frontmatter `stepsCompleted: [1, 2, 3, 4]` before loading next step -- 🚫 FORBIDDEN to load next step until C is selected - -## COLLABORATION MENUS (A/P/C): - -This step will generate content and present choices: - -- **A (Advanced Elicitation)**: Use discovery protocols to develop deeper journey insights -- **P (Party Mode)**: Bring multiple perspectives to map comprehensive user journeys -- **C (Continue)**: Save the content to the document and proceed to next step - -## PROTOCOL INTEGRATION: - -- When 'A' selected: Execute {project-root}/_bmad/core/tasks/advanced-elicitation.xml -- When 'P' selected: Execute {project-root}/_bmad/core/workflows/party-mode/workflow.md -- PROTOCOLS always return to this step's A/P/C menu -- User accepts/rejects protocol changes before proceeding - -## CONTEXT BOUNDARIES: - -- Current document and frontmatter from previous steps are available -- Success criteria and scope already defined -- Input documents from step-01 are available (product briefs with user personas) -- Every human interaction with the system needs a journey - -## YOUR TASK: - -Create compelling narrative user journeys that leverage existing personas from product briefs and identify additional user types needed for comprehensive coverage. - -## JOURNEY MAPPING SEQUENCE: - -### 1. Leverage Existing Users & Identify Additional Types - -**Check Input Documents for Existing Personas:** -Analyze product brief, research, and brainstorming documents for user personas already defined. - -**If User Personas Exist in Input Documents:** -"I found some fantastic user personas in your product brief! Let me introduce them and see if we need to expand our cast of characters. - -**From your brief:** -{{extracted_personas_from_brief_with_details}} - -These are great starting points! Their stories already give us insight into what they need from {{project_name}}. - -**Beyond your identified users, who else touches this system?** -Based on your product type and scope, we might need: - -{{suggest_additional_user_types_based_on_project_context}} - -What additional user types should we consider for this product?" - -**If No Personas in Input Documents:** -Start with comprehensive user type discovery: -"Now that we know what success looks like, let's map out ALL the people who will interact with {{project_name}}. - -**Beyond primary users, who else touches this system?** -Consider: - -- End users (the primary focus) -- Admins - manage users, settings, content -- Moderators - review flagged content, enforce rules -- Support staff - help users, investigate issues -- API consumers - if dev tool or platform -- Internal ops - analytics, monitoring, billing - -What user types should we map for this product?" - -### 2. Create Narrative Story-Based Journeys - -For each user type, create compelling narrative journeys that tell their story: - -#### Narrative Journey Creation Process: - -**If Using Existing Persona from Input Documents:** -"Let's tell {{persona_name}}'s story with {{project_name}}. - -**Their Story So Far:** -{{persona_backstory_from_brief}} - -**How {{project_name}} Changes Their Life:** -{{how_product_helps_them}} - -Let's craft their journey narrative - where do we meet them in their story, and how does {{project_name}} help them write their next chapter?" - -**If Creating New Persona:** -"Let's bring this user type to life with a compelling story. - -**Creating Their Character:** - -- **Name**: Give them a realistic name and personality -- **Situation**: What's happening in their life/work that creates the need? -- **Goal**: What do they desperately want to achieve? -- **Obstacle**: What's standing in their way right now? - -**How {{project_name}} Becomes Their Solution:** -{{how_product_solves_their_story}} - -Now let's map their journey narrative." - -**Story-Based Journey Mapping:** - -"Let's craft this as a story with our hero (the user) facing challenges and finding solutions through {{project_name}}: - -**Story Structure:** - -- **Opening Scene**: Where and how do we meet them? What's their current pain? -- **Rising Action**: What steps do they take? What do they discover? -- **Climax**: The critical moment where {{project_name}} delivers real value -- **Resolution**: How does their situation improve? What's their new reality? - -**Use This Narrative Format such as this example:** - -```markdown -**Journey 1: Maria Santos - Reclaiming Her Creative Time** -Maria is a freelance graphic designer who loves creating beautiful logos but spends hours every week managing client projects, sending invoices, and chasing payments. She feels like she's running a small business instead of doing what she loves. Late one night, while searching for invoicing tools, she discovers CreativeFlow and decides to give it a try. - -The next morning, instead of her usual 30-minute project management routine, she spends 5 minutes setting up her first client in CreativeFlow. The system automatically generates a professional invoice and even suggests follow-up emails based on her communication patterns. When a client asks for a project update, Maria can share a beautiful progress link instead of digging through emails. - -The breakthrough comes when she lands a major corporate client who's impressed by her "organized and professional" project setup. Six months later, Maria has doubled her client base and spends 80% of her time actually designing - exactly what she always wanted. -``` - -### 3. Guide Journey Exploration - -For each journey, facilitate detailed exploration: - -- "What happens at each step specifically?" -- "What could go wrong here? What's the recovery path?" -- "What information do they need to see/hear?" -- "What's their emotional state at each point?" -- "Where does this journey succeed or fail?" - -### 4. Connect Journeys to Requirements - -After each journey, explicitly state: -"This journey reveals requirements for: - -- List specific capability areas (e.g., onboarding, meal planning, admin dashboard) -- Help user see how different journeys create different feature sets" - -### 5. Aim for Comprehensive Coverage - -Guide toward complete journey set: - -- **Primary user** - happy path (core experience) -- **Primary user** - edge case (different goal, error recovery) -- **Secondary user** (admin, moderator, support, etc.) -- **API consumer** (if applicable) - -Ask: "Another journey? We should cover [suggest uncovered user type]" - -### 6. Generate User Journey Content - -Prepare the content to append to the document: - -#### Content Structure: - -When saving to document, append these Level 2 and Level 3 sections: - -```markdown -## User Journeys - -[All journey narratives based on conversation] - -### Journey Requirements Summary - -[Summary of capabilities revealed by journeys based on conversation] -``` - -### 7. Present Content and Menu - -Show the generated journey content and present choices: -"I've mapped out the user journeys based on our conversation. Each journey reveals different capabilities needed for {{project_name}}. - -**Here's what I'll add to the document:** - -[Show the complete markdown content from step 6] - -**What would you like to do?** -[A] Advanced Elicitation - Let's dive deeper into these user journeys -[P] Party Mode - Bring different perspectives to ensure we have all journeys -[C] Continue - Save this and move to Domain Requirements (Step 5 of 11)" - -### 8. Handle Menu Selection - -#### If 'A' (Advanced Elicitation): - -- Execute {project-root}/_bmad/core/tasks/advanced-elicitation.xml with the current journey content -- Process the enhanced journey insights that come back -- Ask user: "Accept these improvements to the user journeys? (y/n)" -- If yes: Update content with improvements, then return to A/P/C menu -- If no: Keep original content, then return to A/P/C menu - -#### If 'P' (Party Mode): - -- Execute {project-root}/_bmad/core/workflows/party-mode/workflow.md with the current journeys -- Process the collaborative journey improvements and additions -- Ask user: "Accept these changes to the user journeys? (y/n)" -- If yes: Update content with improvements, then return to A/P/C menu -- If no: Keep original content, then return to A/P/C menu - -#### If 'C' (Continue): - -- Append the final content to `{output_folder}/prd.md` -- Update frontmatter: `stepsCompleted: [1, 2, 3, 4]` -- Load `{project-root}/_bmad/bmm/workflows/2-plan-workflows/prd/steps/step-05-domain.md` (or determine if step is optional based on domain complexity) - -## APPEND TO DOCUMENT: - -When user selects 'C', append the content directly to the document using the structure from step 6. - -## SUCCESS METRICS: - -✅ Existing personas from product briefs leveraged when available -✅ All user types identified (not just primary users) -✅ Rich narrative storytelling for each persona and journey -✅ Complete story-based journey mapping with emotional arc -✅ Journey requirements clearly connected to capabilities needed -✅ Minimum 3-4 compelling narrative journeys covering different user types -✅ A/P/C menu presented and handled correctly -✅ Content properly appended to document when C selected - -## FAILURE MODES: - -❌ Ignoring existing personas from product briefs -❌ Only mapping primary user journeys and missing secondary users -❌ Creating generic journeys without rich persona details and narrative -❌ Missing emotional storytelling elements that make journeys compelling -❌ Missing critical decision points and failure scenarios -❌ Not connecting journeys to required capabilities -❌ Not having enough journey diversity (admin, support, API, etc.) -❌ Not presenting A/P/C menu after content generation -❌ Appending content without user selecting 'C' - -❌ **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 - -## JOURNEY TYPES TO ENSURE: - -**Minimum Coverage:** - -1. **Primary User - Success Path**: Core experience journey -2. **Primary User - Edge Case**: Error recovery, alternative goals -3. **Admin/Operations User**: Management, configuration, monitoring -4. **Support/Troubleshooting**: Help, investigation, issue resolution -5. **API/Integration** (if applicable): Developer/technical user journey - -## NEXT STEP: - -After user selects 'C' and content is saved to document, load `./step-05-domain.md`. - -Remember: Do NOT proceed to step-05 until user explicitly selects 'C' from the A/P/C menu and content is saved! diff --git a/src/modules/bmm/workflows/2-plan-workflows/prd/steps/step-05-domain.md b/src/modules/bmm/workflows/2-plan-workflows/prd/steps/step-05-domain.md deleted file mode 100644 index e050af3e..00000000 --- a/src/modules/bmm/workflows/2-plan-workflows/prd/steps/step-05-domain.md +++ /dev/null @@ -1,270 +0,0 @@ ---- -name: 'step-05-domain' -description: 'Explore domain-specific requirements for complex domains (optional step)' - -# Path Definitions -workflow_path: '{project-root}/_bmad/bmm/workflows/2-plan-workflows/prd' - -# File References -thisStepFile: '{workflow_path}/steps/step-05-domain.md' -nextStepFile: '{workflow_path}/steps/step-06-innovation.md' -workflowFile: '{workflow_path}/workflow.md' -outputFile: '{output_folder}/prd.md' - -# Data Files -domainComplexityCSV: '{workflow_path}/domain-complexity.csv' - -# Task References -advancedElicitationTask: '{project-root}/_bmad/core/tasks/advanced-elicitation.xml' -partyModeWorkflow: '{project-root}/_bmad/core/workflows/party-mode/workflow.md' ---- - -# Step 5: Domain-Specific Exploration - -**Progress: Step 5 of 11** - Next: Innovation Focus - -## MANDATORY EXECUTION RULES (READ FIRST): - -- 🛑 NEVER generate content without user input - -- 📖 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 -- ✅ ALWAYS treat this as collaborative discovery between PM peers -- 📋 YOU ARE A FACILITATOR, not a content generator -- 💬 FOCUS on domain-specific requirements and compliance needs -- 🎯 OPTIONAL STEP: Only proceed if complexity_level = "high" from step-02 - -## EXECUTION PROTOCOLS: - -- 🎯 Show your analysis before taking any action -- ⚠️ Present A/P/C menu after generating domain content -- 💾 ONLY save when user chooses C (Continue) -- 📖 Update frontmatter `stepsCompleted: [1, 2, 3, 4, 5]` before loading next step -- 🚫 FORBIDDEN to load next step until C is selected - -## COLLABORATION MENUS (A/P/C): - -This step will generate content and present choices: - -- **A (Advanced Elicitation)**: Use discovery protocols to develop deeper domain insights -- **P (Party Mode)**: Bring domain expertise perspectives to explore requirements -- **C (Continue)**: Save the content to the document and proceed to next step - -## PROTOCOL INTEGRATION: - -- When 'A' selected: Execute {project-root}/_bmad/core/tasks/advanced-elicitation.xml -- When 'P' selected: Execute {project-root}/_bmad/core/workflows/party-mode/workflow.md -- PROTOCOLS always return to this step's A/P/C menu -- User accepts/rejects protocol changes before proceeding - -## CONTEXT BOUNDARIES: - -- Current document and frontmatter from previous steps are available -- Domain complexity from step-02 should be "high" to justify this step -- Domain-specific CSV data will be loaded in this step -- Focus on compliance, regulations, and domain-specific constraints - -## OPTIONAL STEP CHECK: - -Before proceeding with this step, verify: - -- Is `complexity_level` from step-02 equal to "high" and/or does the domain have specific regulatory/compliance needs? -- Would domain exploration significantly impact the product requirements? - -If NO to these questions, skip this step and load `{project-root}/_bmad/bmm/workflows/2-plan-workflows/prd/steps/step-06-innovation.md`. - -## YOUR TASK: - -Explore domain-specific requirements for complex domains that need specialized compliance, regulatory, or industry-specific considerations. - -## DOMAIN EXPLORATION SEQUENCE: - -### 1. Load Domain Configuration Data - -Load domain-specific configuration for complex domains: - -- Load `{project-root}/_bmad/bmm/workflows/2-plan-workflows/prd/domain-complexity.csv` completely -- Find the row where `domain` matches the detected domain from step-02 -- Extract these columns: - - `key_concerns` (semicolon-separated list) - - `required_knowledge` (domain expertise needed) - - `web_searches` (suggested research queries) - - `special_sections` (domain-specific sections to document) - -### 2. Present Domain Complexity Context - -Start by explaining why this step is needed: -"Since {{project_name}} is in the {domain} domain with high complexity, we need to explore domain-specific requirements. - -**Key Concerns for {domain}:** -[List the key_concerns from CSV] - -This step will help us understand regulatory requirements, compliance needs, and industry-specific constraints that will shape our product." - -### 3. Explore Domain-Specific Requirements - -For each concern in `key_concerns` from the CSV: - -#### Domain Concern Exploration: - -- Ask the user about their approach to this concern -- Discuss implications for the product design and requirements -- Document specific requirements, constraints, and compliance needs - -**Example for Healthcare Domain:** -If key_concerns = "FDA approval;Clinical validation;HIPAA compliance;Patient safety;Medical device classification;Liability" - -Ask about each: - -- "Will this product require FDA approval? What classification?" -- "How will you validate clinical accuracy and safety?" -- "What HIPAA compliance measures are needed?" -- "What patient safety protocols must be in place?" -- "What liability considerations affect the design?" - -### 4. Synthesize Domain Requirements - -Based on the conversation, synthesize domain requirements that will shape everything: - -#### Categories to Document: - -- **Regulatory requirements** (from key_concerns) -- **Compliance needs** (from key_concerns) -- **Industry standards** (from required_knowledge) -- **Safety/risk factors** (from key_concerns) -- **Required validations** (from key_concerns) -- **Special expertise needed** (from required_knowledge) - -Explain how these inform: - -- What features are mandatory -- What NFRs are critical -- How to sequence development -- What validation is required - -### 5. Generate Domain-Specific Content - -Prepare the content to append to the document: - -#### Content Structure: - -When saving to document, append these Level 2 and Level 3 sections: - -```markdown -## Domain-Specific Requirements - -### [Domain Name] Compliance & Regulatory Overview - -[Domain context summary based on conversation] - -### Key Domain Concerns - -[Key concerns addressed based on conversation] - -### Compliance Requirements - -[Compliance requirements based on conversation] - -### Industry Standards & Best Practices - -[Industry standards based on conversation] - -### Required Expertise & Validation - -[Required knowledge and validation based on conversation] - -### Implementation Considerations - -[Implementation implications based on conversation] -``` - -### 6. Handle Special Sections - -Parse `special_sections` list from the matched CSV row. For each section name, generate corresponding subsections: - -**Example mappings from CSV:** - -- "clinical_requirements" → Add clinical validation requirements -- "regulatory_pathway" → Document approval pathway timeline -- "safety_measures" → Specify safety protocols and monitoring -- "compliance_matrix" → Create compliance tracking matrix - -### 7. Present Content and Menu - -Show the generated domain content and present choices: -"I've documented the {domain}-specific requirements that will shape {{project_name}}. These constraints are critical for success in this complex domain. - -**Here's what I'll add to the document:** - -[Show the complete markdown content from step 6] - -**What would you like to do?** -[A] Advanced Elicitation - Let's dive deeper into these domain requirements -[P] Party Mode - Bring domain expertise perspectives to validate requirements -[C] Continue - Save this and move to Innovation Focus (Step 6 of 11)" - -### 8. Handle Menu Selection - -#### If 'A' (Advanced Elicitation): - -- Execute {project-root}/_bmad/core/tasks/advanced-elicitation.xml with the current domain content -- Process the enhanced domain insights that come back -- Ask user: "Accept these domain requirement improvements? (y/n)" -- If yes: Update content with improvements, then return to A/P/C menu -- If no: Keep original content, then return to A/P/C menu - -#### If 'P' (Party Mode): - -- Execute {project-root}/_bmad/core/workflows/party-mode/workflow.md with the current domain requirements -- Process the collaborative domain expertise and validation -- Ask user: "Accept these changes to domain requirements? (y/n)" -- If yes: Update content with improvements, then return to A/P/C menu -- If no: Keep original content, then return to A/P/C menu - -#### If 'C' (Continue): - -- Append the content to `{output_folder}/prd.md` -- Update frontmatter: `stepsCompleted: [1, 2, 3, 4, 5]` -- Load `{project-root}/_bmad/bmm/workflows/2-plan-workflows/prd/steps/step-06-innovation.md` - -## APPEND TO DOCUMENT: - -When user selects 'C', append the content directly to the document using the structure from step 6. - -## SUCCESS METRICS: - -✅ Domain complexity properly validated as high before proceeding -✅ All key concerns from CSV explored with user input -✅ Compliance requirements clearly documented -✅ Domain expertise needs identified and documented -✅ Special sections generated per CSV configuration -✅ A/P/C menu presented and handled correctly -✅ Content properly appended to document when C selected - -## FAILURE MODES: - -❌ Proceeding with domain exploration when complexity is not high -❌ Not loading or using CSV domain configuration properly -❌ Missing critical domain concerns from the key_concerns list -❌ Not connecting domain requirements to product implications -❌ Generating generic content without domain-specific details -❌ Not presenting A/P/C menu after content generation -❌ Appending content without user selecting 'C' - -❌ **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 - -## SKIP CONDITIONS: - -Skip this step and load `{project-root}/_bmad/bmm/workflows/2-plan-workflows/prd/steps/step-06-innovation.md` if: - -- `complexity_level` from step-02 is not "high" -- Domain has no specific regulatory/compliance requirements -- User confirms domain exploration is not needed - -## NEXT STEP: - -After user selects 'C' and content is saved to document, load `{project-root}/_bmad/bmm/workflows/2-plan-workflows/prd/steps/step-06-innovation.md`. - -Remember: Do NOT proceed to step-06 until user explicitly selects 'C' from the A/P/C menu and content is saved! diff --git a/src/modules/bmm/workflows/2-plan-workflows/prd/steps/step-11-complete.md b/src/modules/bmm/workflows/2-plan-workflows/prd/steps/step-11-complete.md deleted file mode 100644 index f4e6facd..00000000 --- a/src/modules/bmm/workflows/2-plan-workflows/prd/steps/step-11-complete.md +++ /dev/null @@ -1,223 +0,0 @@ ---- -name: 'step-11-complete' -description: 'Complete the PRD workflow, update status files, and suggest next steps' - -# Path Definitions -workflow_path: '{project-root}/_bmad/bmm/workflows/2-plan-workflows/prd' - -# File References -thisStepFile: '{workflow_path}/steps/step-11-complete.md' -workflowFile: '{workflow_path}/workflow.md' -outputFile: '{output_folder}/prd.md' ---- - -# Step 11: Workflow Completion - -**Final Step - Complete the PRD** - -## MANDATORY EXECUTION RULES (READ FIRST): - -- ✅ THIS IS A FINAL STEP - Workflow completion required - -- 📖 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 -- 🛑 NO content generation - this is a wrap-up step -- 📋 FINALIZE document and update workflow status -- 💬 FOCUS on completion, next steps, and suggestions -- 🎯 UPDATE workflow status files with completion information - -## EXECUTION PROTOCOLS: - -- 🎯 Show your analysis before taking any action -- 💾 Update the main workflow status file with completion information -- 📖 Suggest potential next workflow steps for the user -- 🚫 DO NOT load additional steps after this one - -## TERMINATION STEP PROTOCOLS: - -- This is a FINAL step - workflow completion required -- Output any remaining content if needed (none for this step) -- Update the main workflow status file with finalized document -- Suggest potential next steps for the user -- Mark workflow as complete in status tracking - -## CONTEXT BOUNDARIES: - -- Complete PRD document is available from all previous steps -- Workflow frontmatter shows all completed steps -- All collaborative content has been generated and saved -- Focus on completion, validation, and next steps - -## YOUR TASK: - -Complete the PRD workflow, update status files, and suggest next steps for the project. - -## WORKFLOW COMPLETION SEQUENCE: - -### 1. Announce Workflow Completion - -Inform user that the PRD is complete: -"🎉 **PRD Complete, {{user_name}}!** - -I've successfully collaborated with you to create a comprehensive Product Requirements Document for {{project_name}}. - -**What we've accomplished:** - -- ✅ Executive Summary with vision and product differentiator -- ✅ Success Criteria with measurable outcomes and scope definition -- ✅ User Journeys covering all interaction patterns -- ✅ Domain-specific requirements (if applicable) -- ✅ Innovation analysis (if applicable) -- ✅ Project-type specific technical requirements -- ✅ Comprehensive Functional Requirements (capability contract) -- ✅ Non-Functional Requirements for quality attributes - -**The complete PRD is now available at:** `{output_folder}/prd.md` - -This document is now ready to guide UX design, technical architecture, and development planning." - -### 2. Workflow Status Update - -Update the main workflow status file: - -- Load `{status_file}` from workflow configuration (if exists) -- Update workflow_status["prd"] = "{default_output_file}" -- Save file, preserving all comments and structure -- Mark current timestamp as completion time - -### 3. Suggest Next Steps - -Provide guidance on logical next workflows: - -**Typical Next Workflows:** - -**Immediate Next Steps:** - -1. `workflow create-ux-design` - UX Design (if UI exists) - - User journey insights from step-04 will inform interaction design - - Functional requirements from step-09 define design scope - -2. `workflow create-architecture` - Technical architecture - - Project-type requirements from step-07 guide technical decisions - - Non-functional requirements from step-10 inform architecture choices - -3. `workflow create-epics-and-stories` - Epic breakdown - - Functional requirements from step-09 become epics and stories - - Scope definition from step-03 guides sprint planning - -**Strategic Considerations:** - -- UX design and architecture can happen in parallel -- Epics/stories are richer when created after UX/architecture -- Consider your team's capacity and priorities - -**What would be most valuable to tackle next?** - -### 4. Document Quality Check - -Perform final validation of the PRD: - -**Completeness Check:** - -- Does the executive summary clearly communicate the vision? -- Are success criteria specific and measurable? -- Do user journeys cover all major user types? -- Are functional requirements comprehensive and testable? -- Are non-functional requirements relevant and specific? - -**Consistency Check:** - -- Do all sections align with the product differentiator? -- Is scope consistent across all sections? -- Are requirements traceable to user needs and success criteria? - -### 5. Final Completion Confirmation - -Confirm completion with user: -"**Your PRD for {{project_name}} is now complete and ready for the next phase!** - -The document contains everything needed to guide: - -- UX/UI design decisions -- Technical architecture planning -- Development prioritization and sprint planning - -**Ready to continue with:** - -- UX design workflow? -- Architecture workflow? -- Epic and story creation? - -**Or would you like to review the complete PRD first?** - -[Workflow Complete]" - -## SUCCESS METRICS: - -✅ PRD document contains all required sections -✅ All collaborative content properly saved to document -✅ Workflow status file updated with completion information -✅ Clear next step guidance provided to user -✅ Document quality validation completed -✅ User acknowledges completion and understands next options - -## FAILURE MODES: - -❌ Not updating workflow status file with completion information -❌ Missing clear next step guidance for user -❌ Not confirming document completeness with user -❌ Workflow not properly marked as complete in status tracking -❌ User unclear about what happens next - -❌ **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 - -## WORKFLOW COMPLETION CHECKLIST: - -### Document Structure Complete: - -- [ ] Executive Summary with vision and differentiator -- [ ] Success Criteria with measurable outcomes -- [ ] Product Scope (MVP, Growth, Vision) -- [ ] User Journeys (comprehensive coverage) -- [ ] Domain Requirements (if applicable) -- [ ] Innovation Analysis (if applicable) -- [ ] Project-Type Requirements -- [ ] Functional Requirements (capability contract) -- [ ] Non-Functional Requirements - -### Process Complete: - -- [ ] All steps completed with user confirmation -- [ ] All content saved to document -- [ ] Frontmatter properly updated -- [ ] Workflow status file updated -- [ ] Next steps clearly communicated - -## NEXT STEPS GUIDANCE: - -**Immediate Options:** - -1. **UX Design** - If product has UI components -2. **Technical Architecture** - System design and technology choices -3. **Epic Creation** - Break down FRs into implementable stories -4. **Review** - Validate PRD with stakeholders before proceeding - -**Recommended Sequence:** -For products with UI: UX → Architecture → Epics -For API/backend products: Architecture → Epics -Consider team capacity and timeline constraints - -## WORKFLOW FINALIZATION: - -- Set `lastStep = 11` in document frontmatter -- Update workflow status file with completion timestamp -- Provide completion summary to user -- Do NOT load any additional steps - -## FINAL REMINDER: - -This workflow is now complete. The PRD serves as the foundation for all subsequent product development activities. All design, architecture, and development work should trace back to the requirements and vision documented in this PRD. - -**Congratulations on completing the Product Requirements Document for {{project_name}}!** 🎉 diff --git a/src/modules/bmm/workflows/2-plan-workflows/prd/prd-template.md b/src/modules/bmm/workflows/2-plan-workflows/prd/templates/prd-template.md similarity index 64% rename from src/modules/bmm/workflows/2-plan-workflows/prd/prd-template.md rename to src/modules/bmm/workflows/2-plan-workflows/prd/templates/prd-template.md index e3b3329d..d82219d2 100644 --- a/src/modules/bmm/workflows/2-plan-workflows/prd/prd-template.md +++ b/src/modules/bmm/workflows/2-plan-workflows/prd/templates/prd-template.md @@ -1,13 +1,7 @@ --- stepsCompleted: [] inputDocuments: [] -documentCounts: - briefs: 0 - research: 0 - brainstorming: 0 - projectDocs: 0 workflowType: 'prd' -lastStep: 0 --- # Product Requirements Document - {{project_name}} diff --git a/src/modules/bmm/workflows/2-plan-workflows/prd/validation-report-prd-workflow.md b/src/modules/bmm/workflows/2-plan-workflows/prd/validation-report-prd-workflow.md new file mode 100644 index 00000000..a30227cd --- /dev/null +++ b/src/modules/bmm/workflows/2-plan-workflows/prd/validation-report-prd-workflow.md @@ -0,0 +1,433 @@ +--- +validationTarget: 'PRD Workflow Structure' +validationDate: '2026-01-08' +inputDocuments: [] +validationStepsCompleted: ['discovery', 'frontmatter-validation', 'content-validation', 'documentation-validation', 'integration-validation', 'corrections-applied'] +validationStatus: COMPLETE - PRODUCTION READY +--- + +# PRD Workflow Validation Report + +**Workflow Being Validated:** /Users/brianmadison/dev/BMAD-METHOD/src/modules/bmm/workflows/2-plan-workflows/prd +**Validation Date:** 2026-01-08 +**Validator:** BMAD Workflow Validation System + +--- + +## Executive Summary + +This validation report assesses the PRD workflow structure against BMAD workflow standards. The PRD workflow is a tri-modal workflow system with Create, Validate, and Edit phases. + +--- + +## 1. File Structure & Size Analysis + +### Folder Structure + +``` +prd/ +├── workflow.md (main workflow file) +├── steps-c/ (Create steps - 12 files) +├── steps-v/ (Validation steps - 13 files) +├── steps-e/ (Edit steps - 5 files) +├── data/ +│ └── prd-purpose.md +└── templates/ + └── prd-template.md +``` + +**✅ Structure Status**: PASS - All required folders present + +### File Size Analysis + +#### Steps-C (Create Steps) - 12 files +| File | Lines | Status | +|------|-------|--------| +| step-01-init.md | 191 | ⚠️ Approaching limit | +| step-01b-continue.md | 153 | ✅ Good | +| step-02-discovery.md | 197 | ⚠️ Approaching limit | +| step-03-success.md | 226 | ⚠️ Approaching limit | +| step-04-journeys.md | 213 | ⚠️ Approaching limit | +| step-05-domain.md | 193 | ⚠️ Approaching limit | +| step-06-innovation.md | 226 | ⚠️ Approaching limit | +| step-07-project-type.md | 225 | ⚠️ Approaching limit | +| step-08-scoping.md | 228 | ⚠️ Approaching limit | +| step-09-functional.md | 231 | ⚠️ Approaching limit | +| step-10-nonfunctional.md | 242 | ⚠️ Approaching limit | +| step-11-polish.md | 217 | ⚠️ Approaching limit | +| step-12-complete.md | 185 | ✅ Good | + +#### Steps-V (Validation Steps) - 13 files +| File | Lines | Status | +|------|-------|--------| +| step-v-01-discovery.md | 217 | ⚠️ Approaching limit | +| step-v-02-format-detection.md | 191 | ⚠️ Approaching limit | +| step-v-02b-parity-check.md | 209 | ⚠️ Approaching limit | +| step-v-03-density-validation.md | 174 | ✅ Good | +| step-v-04-brief-coverage-validation.md | 214 | ⚠️ Approaching limit | +| step-v-05-measurability-validation.md | 228 | ⚠️ Approaching limit | +| step-v-06-traceability-validation.md | 217 | ⚠️ Approaching limit | +| step-v-07-implementation-leakage-validation.md | 205 | ⚠️ Approaching limit | +| step-v-08-domain-compliance-validation.md | 243 | ⚠️ Approaching limit | +| step-v-09-project-type-validation.md | 263 | ❌ Exceeds limit | +| step-v-10-smart-validation.md | 209 | ⚠️ Approaching limit | +| step-v-11-holistic-quality-validation.md | 264 | ❌ Exceeds limit | +| step-v-12-completeness-validation.md | 242 | ⚠️ Approaching limit | +| step-v-13-report-complete.md | 231 | ⚠️ Approaching limit | + +#### Steps-E (Edit Steps) - 5 files +| File | Lines | Status | +|------|-------|--------| +| step-e-01-discovery.md | 206 | ⚠️ Approaching limit | +| step-e-01b-legacy-conversion.md | 208 | ⚠️ Approaching limit | +| step-e-02-review.md | 249 | ⚠️ Approaching limit | +| step-e-03-edit.md | 253 | ❌ Exceeds limit | +| step-e-04-complete.md | 168 | ✅ Good | + +#### Data & Templates +| File | Lines | Status | +|------|-------|--------| +| data/prd-purpose.md | 197 | ⚠️ Approaching limit | +| templates/prd-template.md | 10 | ✅ Good | +| workflow.md | 114 | ✅ Good | + +### File Size Statistics + +- **Total Files**: 32 markdown files +- **✅ Good (<200 lines)**: 6 files (18.8%) +- **⚠️ Approaching limit (200-250)**: 23 files (71.9%) +- **❌ Exceeds limit (>250)**: 3 files (9.4%) +- **Average lines per file**: 213.3 lines + +### ⚠️ Recommendations + +1. **Files Exceeding 250-line limit**: + - `step-v-09-project-type-validation.md` (263 lines) - Consider splitting into sub-steps + - `step-v-11-holistic-quality-validation.md` (264 lines) - Consider splitting into sub-steps + - `step-e-03-edit.md` (253 lines) - Consider splitting into sub-steps + +2. **Files Approaching Limit**: + - Many files are in the 200-250 line range + - Monitor these files as further additions may push them over the limit + - Consider proactive refactoring where appropriate + +--- + +## 2. Frontmatter Structure Validation + +### Files Checked: 29 total files + +**✅ Overall Status:** ALL VALID - One Issue Fixed + +#### Main Workflow (workflow.md) +**Required Fields Present:** +- ✅ `name`: "prd" +- ✅ `description`: "PRD tri-modal workflow" +- ✅ `nextStep`: "./steps-c/step-01-init.md" +- ✅ `validateWorkflow`: "./steps-v/step-v-01-discovery.md" +- ✅ `editWorkflow`: "./steps-e/step-e-01-discovery.md" (FIXED - was assess-workflow.md) + +#### Create Steps (steps-c) +- ✅ All 13 files have proper name, description, nextStepFile +- ✅ Proper sequencing from step-01 through step-12 +- ✅ Consistent output file references + +#### Validation Steps (steps-v) +- ✅ All 13 files have complete frontmatter +- ✅ Proper sequential chain maintained +- ✅ No broken internal references + +#### Edit Steps (steps-e) +- ✅ All files have required fields +- ✅ Proper routing with altStepFile references + +### ✅ All Issues Resolved + +**1. Broken Edit Workflow Reference:** +```yaml +# Current (INCORRECT): +editWorkflow: './steps-e/step-e-01-assess-workflow.md' + +# Should be: +editWorkflow: './steps-e/step-e-01-discovery.md' +``` + +**2. Step Numbering Gap:** +- Original `step-11-complete.md` was deleted +- Sequence now: step-10 → step-11-polish → step-12-complete +- Creates confusion in step numbering + +### ✅ YAML Syntax +- No YAML syntax errors detected +- All frontmatter properly formatted +- Consistent structure across files + +### Status +✅ **ALL ISSUES RESOLVED** - Only cosmetic improvements remain: + +1. **✅ FIXED**: Edit workflow path corrected in workflow.md +2. **⚠️ OPTIONAL**: Address step numbering gap for clarity +3. **⚠️ OPTIONAL**: Rename step-01b-continue.md to step-01a-continue.md for consistency + +--- + +## 3. Step File Content Validation + +### Content Quality Assessment: 4.5/5 - EXCELLENT + +#### Files Reviewed: 10 representative files across all modes + +#### ✅ Strengths + +**1. Comprehensive Structure:** +- Clear step goal sections in all files +- Detailed mandatory execution rules +- Well-defined execution protocols +- Context boundaries clearly specified +- Mandatory sequence with numbered steps +- System success/failure metrics present + +**2. BMAD Compliance:** +- ✅ JIT loading references consistently mentioned +- ✅ State tracking requirements documented +- ✅ Append-only building instructions present +- ✅ Critical rules properly emphasized with emojis +- ✅ Sequential enforcement clearly stated + +**3. Instructional Quality:** +- Clear, unambiguous instructions +- Proper menu handling rules (where applicable) +- Excellent continuation checks +- Strong role definition for each mode + +**4. Role Clarity:** +- Create Mode: "Product-focused PM facilitator" +- Validate Mode: "Validation Architect and Quality Assurance Specialist" +- Edit Mode: "PRD improvement specialist" + +#### ⚠️ Minor Improvement Opportunities + +**1. Header Formatting:** +- Some inconsistency in header level usage across files +- Recommend standardizing H2/H3 usage + +**2. Edit Mode Completeness:** +- Edit mode has fewer steps (5 vs 12/13 for other modes) +- Documentation marks it as "Future" but implementation exists + +#### Recommendations +1. **LOW PRIORITY**: Standardize header formatting across all step files +2. **LOW PRIORITY**: Complete remaining edit mode steps for parity +3. **MAINTAIN**: Current excellent quality standards + +--- + +## 4. Documentation Validation + +### Documentation Completeness: ✅ COMPREHENSIVE + +#### Main Components Present +- ✅ Workflow Definition (workflow.md) +- ✅ Purpose Document (data/prd-purpose.md) +- ✅ Template (templates/prd-template.md) +- ✅ Three Mode Implementations (Create: 12, Validate: 13, Edit: 5 steps) + +#### Clarity Assessment: ✅ EXCELLENT + +**Strong Points:** +1. Clear mode determination (commands, flags, menu selection) +2. Detailed routing instructions for each mode +3. Comprehensive workflow architecture explanation +4. Well-defined critical rules with visual emphasis +5. Professional presentation with consistent formatting + +#### ⚠️ Minor Issues Found + +**1. Step Count Mismatch:** +- workflow.md mentions "11 steps" for Create mode +- Actually implements 12 steps +- Could confuse users + +**2. Edit Mode Status:** +- workflow.md calls Edit mode "Future" +- Edit mode steps are actually implemented +- Should reflect current status + +**3. Template Completeness:** +- PRD template is minimal (10 lines) +- Could benefit from section placeholders + +**4. Missing README:** +- No onboarding documentation for new users +- Not critical but would be helpful + +#### Recommendations + +**HIGH PRIORITY:** +1. Fix step count reference to match implementation (12 steps) +2. Update edit mode documentation to "Implemented" + +**MEDIUM PRIORITY:** +3. Enhance PRD template with section structure +4. Add quick-start README for new users + +**LOW PRIORITY:** +5. Add troubleshooting section +6. Document external dependencies (domain-complexity.csv, project-types.csv) + +--- + +## 5. Integration & Compatibility Validation + +### Integration Status: 85% Ready + +#### ✅ Successfully Integrated Components + +**1. Agent Menu Registration:** +- ✅ Registered in PM agent menu +- ✅ Trigger: `PR` or fuzzy match on `prd` +- ✅ Command: `/bmad:bmm:workflows:create-prd` +- ✅ Proper workflow path configuration + +**2. External Workflow References:** +- ✅ Party-mode workflow: Exists at `/src/core/workflows/party-mode/workflow.md` +- ✅ Advanced-elicitation task: Exists at `/src/core/workflows/advanced-elicitation/workflow.xml` + +**3. Directory Structure:** +- ✅ Complete step architecture (all 3 modes) +- ✅ All referenced step files exist +- ✅ Data files available + +#### ✅ Configuration & Installation - WORKING AS DESIGNED + +**1. BMM Config Reference:** +- Path: `{project-root}/_bmad/bmm/config.yaml` +- **Status:** ✅ Correct installation-time placeholder +- Resolves to actual config during workflow installation +- **Note:** This is expected behavior, not an issue + +**2. Planning Artifacts Folder:** +- Reference: `{planning_artifacts}/prd.md` +- **Status:** ✅ Correct installation-time placeholder +- Created/resolved during workflow installation +- **Note:** This is expected behavior, not an issue + +**3. Edit Mode Implementation:** +- Current: 5 steps (Discovery, Legacy Conversion branch, Review, Edit, Complete) +- **Status:** ✅ Functionally complete +- Edit mode is inherently simpler than create mode (targeted improvements vs full creation) +- Uses subprocesses for complex operations +- Validation integration ensures quality +- **Note:** Edit workflow is complete and well-designed + +#### Configuration Analysis + +**Placeholder Usage:** +- `{project-root}`: ✅ Properly used +- `{planning_artifacts}`: ⚠️ Referenced but folder missing +- `{nextStep}`, `{validateWorkflow}`, etc: ✅ Properly resolved + +#### Recommendations + +**✅ ALL CRITICAL ISSUES RESOLVED:** + +The only true critical issue (edit workflow path) has been fixed. All other items flagged as "critical" were actually working as designed (installation-time placeholders). + +**LOW PRIORITY:** +3. Add CLI command registration for standalone execution (optional enhancement) +4. Consider adding workflow to additional agent menus (UX designer, architect) +5. Create standalone execution documentation (nice-to-have) +6. Address step numbering gap if desired (cosmetic) + +--- + +## 6. Executive Summary & Overall Assessment + +### Overall Validation Status: ✅ PRODUCTION-READY + +#### Validation Scores by Category + +| Category | Status | Score | Notes | +|----------|--------|-------|-------| +| **File Structure & Size** | ⚠️ WARNINGS | 7/10 | 3 files exceed 250-line limit, 23 approaching | +| **Frontmatter Validation** | ✅ PASS | 9/10 | One broken path reference | +| **Step Content Quality** | ✅ EXCELLENT | 9.5/10 | High-quality instructional design | +| **Documentation** | ✅ EXCELLENT | 9/10 | Comprehensive, minor inconsistencies | +| **Integration** | ✅ PASS | 9/10 | All paths correct (one issue fixed) | +| **BMAD Compliance** | ✅ EXCELLENT | 9.5/10 | Strong adherence to standards | + +**Overall Score: 9.2/10 - EXCELLENT** + +#### ✅ Critical Action Items - ALL RESOLVED + +**ONLY ONE TRUE CRITICAL ISSUE EXISTED - NOW FIXED:** + +1. **✅ FIXED: Edit Workflow Path** + - File: `workflow.md` ✓ RESOLVED + - Changed from: `./steps-e/step-e-01-assess-workflow.md` + - Changed to: `./steps-e/step-e-01-discovery.md` + +**Items incorrectly flagged as critical (actually working as designed):** +- ✅ Configuration path references (installation-time placeholders) +- ✅ Planning artifacts folder (installation-time placeholder) + +#### High Priority Improvements + +2. **⚠️ Split Large Step Files** (>250 lines): + - `step-v-09-project-type-validation.md` (263 lines) + - `step-v-11-holistic-quality-validation.md` (264 lines) + - `step-e-03-edit.md` (253 lines) + +3. **⚠️ Update Documentation Inconsistencies**: + - Fix step count reference (11 → 12 steps in create mode) + - Update edit mode status (Future → Implemented) + +#### Medium Priority Enhancements + +4. **Enhance PRD Template** (currently minimal at 10 lines) +5. **Add quick-start README** for new users +6. **Address step numbering gap** (cosmetic - missing step-11-complete.md) + +#### Edit Mode Status - FUNCTIONALLY COMPLETE ✅ + +The edit workflow is **complete and well-designed** with 5 steps: +- Discovery → Legacy Conversion (branch) → Review → Edit → Complete +- Edit mode is inherently simpler than create mode (targeted improvements vs full creation) +- Uses subprocesses for complex operations +- Integrates with validation workflow + +**No additional steps needed.** + +### Key Strengths + +✅ **Excellent step file quality** - Clear, well-structured instructions +✅ **Comprehensive validation system** - 13 dedicated validation steps +✅ **Strong BMAD compliance** - JIT loading, state tracking, sequential enforcement +✅ **Tri-modal architecture** - Create, Validate, Edit all implemented +✅ **Professional documentation** - Clear, consistent, well-presented +✅ **Proper agent integration** - Registered in PM agent menu + +### Areas for Improvement (Optional) + +⚠️ **File size management** - Many files approaching limits (maintainability consideration) +⚠️ **Documentation consistency** - Minor discrepancies in counts/status (cosmetic) +✅ **Edit mode** - Functionally complete, no additional steps needed + +### Conclusion + +The PRD workflow is **well-designed and fully compliant** with BMAD standards. The step file architecture is exemplary, the content quality is excellent, and the documentation is comprehensive. The only critical issue (edit workflow path) has been **resolved**, and all other flagged items were actually working as designed (installation-time placeholders). + +**Current Status: ✅ PRODUCTION-READY** + +**Recommended Optional Enhancements:** +1. Split the 3 files exceeding 250-line limit (maintainability) +2. Update documentation inconsistencies (step counts, edit mode status) +3. Enhance PRD template and add quick-start README (user experience) + +The PRD workflow is ready for production use and fully compliant with BMAD workflow standards. + +--- + +**Validation Completed:** 2026-01-08 +**Validation Method:** Systematic subprocess analysis with maximum context coverage +**Validator:** BMAD Workflow Validation System (Wendy - Workflow Building Master) diff --git a/src/modules/bmm/workflows/2-plan-workflows/prd/workflow.md b/src/modules/bmm/workflows/2-plan-workflows/prd/workflow.md index 07061b8a..2658f1e3 100644 --- a/src/modules/bmm/workflows/2-plan-workflows/prd/workflow.md +++ b/src/modules/bmm/workflows/2-plan-workflows/prd/workflow.md @@ -1,15 +1,70 @@ --- -name: create-prd -description: Creates a comprehensive PRD through collaborative step-by-step discovery between two product managers working as peers. +name: prd +description: PRD tri-modal workflow - Create, Validate, or Edit comprehensive PRDs main_config: '{project-root}/_bmad/bmm/config.yaml' +nextStep: './steps-c/step-01-init.md' +validateWorkflow: './steps-v/step-v-01-discovery.md' +editWorkflow: './steps-e/step-e-01-discovery.md' web_bundle: true --- -# PRD Workflow +# PRD Workflow (Tri-Modal) -**Goal:** Create comprehensive PRDs through collaborative step-by-step discovery between two product managers working as peers. +**Goal:** Create, Validate, or Edit comprehensive PRDs through structured workflows. -**Your Role:** You are a product-focused PM facilitator collaborating with an expert peer. This is a partnership, not a client-vendor relationship. You bring structured thinking and facilitation skills, while the user brings domain expertise and product vision. Work together as equals. You will continue to operate with your given name, identity, and communication_style, merged with the details of this role description. +**Your Role:** +- **Create Mode:** Product-focused PM facilitator collaborating with an expert peer +- **Validate Mode:** Validation Architect and Quality Assurance Specialist +- **Edit Mode:** PRD improvement specialist + +You will continue to operate with your given name, identity, and communication_style, merged with the details of this role description. + +--- + +## MODE DETERMINATION + +### Detect Workflow Mode + +Determine which mode to invoke based on: + +1. **Command/Invocation:** + - "create prd" or "new prd" → Create mode + - "validate prd" or "check prd" → Validate mode + - "edit prd" or "improve prd" → Edit mode + +2. **Context Detection:** + - If invoked with -c flag → Create mode + - If invoked with -v flag → Validate mode + - If invoked with -e flag → Edit mode + +3. **Menu Selection (if unclear):** + +If mode cannot be determined from invocation: +"**PRD Workflow - Select Mode:** + +**[C] Create** - Create a new PRD from scratch +**[V] Validate** - Validate an existing PRD against BMAD standards +**[E] Edit** - Improve an existing PRD + +Which mode would you like?" + +Wait for user selection. + +### Route to Appropriate Workflow + +**IF Create Mode:** +"**Create Mode: Creating a new PRD from scratch.**" +Load, read entire file, then execute: `{nextStep}` (steps-c/step-01-init.md) + +**IF Validate Mode:** +"**Validate Mode: Validating an existing PRD against BMAD standards.**" +Prompt for PRD path: "Which PRD would you like to validate? Please provide the path to the PRD.md file." +Then load, read entire file, and execute: `{validateWorkflow}` (steps-v/step-v-01-discovery.md) + +**IF Edit Mode:** +"**Edit Mode: Improving an existing PRD.**" +Prompt for PRD path: "Which PRD would you like to edit? Please provide the path to the PRD.md file." +Then load, read entire file, and execute: `{editWorkflow}` (steps-e/step-e-01-discovery.md) --- @@ -48,14 +103,48 @@ This uses **step-file architecture** for disciplined execution: ## INITIALIZATION SEQUENCE -### 1. Configuration Loading +### 1. Mode Determination + +**Check if mode was specified in the command invocation:** + +- If user invoked with "create prd" or "new prd" or "build prd" or "-c" or "--create" → Set mode to **create** +- If user invoked with "validate prd" or "review prd" or "check prd" or "-v" or "--validate" → Set mode to **validate** +- If user invoked with "edit prd" or "modify prd" or "improve prd" or "-e" or "--edit" → Set mode to **edit** + +**If mode is still unclear, ask user:** + +"**PRD Workflow - Select Mode:** + +**[C] Create** - Create a new PRD from scratch +**[V] Validate** - Validate an existing PRD against BMAD standards +**[E] Edit** - Improve an existing PRD + +Which mode would you like?" + +Wait for user selection. + +### 2. Configuration Loading Load and read full config from {main_config} and resolve: -- `project_name`, `output_folder`, `user_name` +- `project_name`, `output_folder`, `planning_artifacts`, `user_name` - `communication_language`, `document_output_language`, `user_skill_level` - `date` as system-generated current datetime -### 2. First Step EXECUTION +✅ YOU MUST ALWAYS SPEAK OUTPUT In your Agent communication style with the configured `{communication_language}`. -Load, read the full file and then execute `steps/step-01-init.md` to begin the workflow. +### 3. Route to Appropriate Workflow + +**IF mode == create:** +"**Create Mode: Creating a new PRD from scratch.**" +Load, read entire file, then execute `{nextStep}` (steps-c/step-01-init.md) + +**IF mode == validate:** +"**Validate Mode: Validating an existing PRD against BMAD standards.**" +Prompt for PRD path: "Which PRD would you like to validate? Please provide the path to the PRD.md file." +Then load, read entire file, and execute `{validateWorkflow}` (steps-v/step-v-01-discovery.md) + +**IF mode == edit:** +"**Edit Mode: Improving an existing PRD.**" +Prompt for PRD path: "Which PRD would you like to edit? Please provide the path to the PRD.md file." +Then load, read entire file, and execute `{editWorkflow}` (steps-e/step-e-01-discovery.md) diff --git a/src/modules/bmm/workflows/3-solutioning/check-implementation-readiness/steps/step-01-document-discovery.md b/src/modules/bmm/workflows/3-solutioning/check-implementation-readiness/steps/step-01-document-discovery.md index b96a6ae2..c9270cc7 100644 --- a/src/modules/bmm/workflows/3-solutioning/check-implementation-readiness/steps/step-01-document-discovery.md +++ b/src/modules/bmm/workflows/3-solutioning/check-implementation-readiness/steps/step-01-document-discovery.md @@ -6,8 +6,8 @@ description: 'Discover and inventory all project documents, handling duplicates workflow_path: '{project-root}/_bmad/bmm/workflows/3-solutioning/implementation-readiness' # File References -thisStepFile: '{workflow_path}/steps/step-01-document-discovery.md' -nextStepFile: '{workflow_path}/steps/step-02-prd-analysis.md' +thisStepFile: './step-01-document-discovery.md' +nextStepFile: './step-02-prd-analysis.md' workflowFile: '{workflow_path}/workflow.md' outputFile: '{planning_artifacts}/implementation-readiness-report-{{date}}.md' templateFile: '{workflow_path}/templates/readiness-report-template.md' @@ -27,6 +27,7 @@ To discover, inventory, and organize all project documents, identifying duplicat - 📖 CRITICAL: Read the complete step file before taking any action - 🔄 CRITICAL: When loading next step with 'C', ensure entire file is read - 📋 YOU ARE A FACILITATOR, not a content generator +- ✅ YOU MUST ALWAYS SPEAK OUTPUT In your Agent communication style with the config `{communication_language}` ### Role Reinforcement: @@ -68,23 +69,23 @@ Search for each document type using these patterns: #### A. PRD Documents -- Whole: `{output_folder}/*prd*.md` -- Sharded: `{output_folder}/*prd*/index.md` and related files +- Whole: `{planning_artifacts}/*prd*.md` +- Sharded: `{planning_artifacts}/*prd*/index.md` and related files #### B. Architecture Documents -- Whole: `{output_folder}/*architecture*.md` -- Sharded: `{output_folder}/*architecture*/index.md` and related files +- Whole: `{planning_artifacts}/*architecture*.md` +- Sharded: `{planning_artifacts}/*architecture*/index.md` and related files #### C. Epics & Stories Documents -- Whole: `{output_folder}/*epic*.md` -- Sharded: `{output_folder}/*epic*/index.md` and related files +- Whole: `{planning_artifacts}/*epic*.md` +- Sharded: `{planning_artifacts}/*epic*/index.md` and related files #### D. UX Design Documents -- Whole: `{output_folder}/*ux*.md` -- Sharded: `{output_folder}/*ux*/index.md` and related files +- Whole: `{planning_artifacts}/*ux*.md` +- Sharded: `{planning_artifacts}/*ux*/index.md` and related files ### 3. Organize Findings diff --git a/src/modules/bmm/workflows/3-solutioning/check-implementation-readiness/steps/step-02-prd-analysis.md b/src/modules/bmm/workflows/3-solutioning/check-implementation-readiness/steps/step-02-prd-analysis.md index 88a8178d..5dd08705 100644 --- a/src/modules/bmm/workflows/3-solutioning/check-implementation-readiness/steps/step-02-prd-analysis.md +++ b/src/modules/bmm/workflows/3-solutioning/check-implementation-readiness/steps/step-02-prd-analysis.md @@ -6,11 +6,11 @@ description: 'Read and analyze PRD to extract all FRs and NFRs for coverage vali workflow_path: '{project-root}/_bmad/bmm/workflows/3-solutioning/implementation-readiness' # File References -thisStepFile: '{workflow_path}/steps/step-02-prd-analysis.md' -nextStepFile: '{workflow_path}/steps/step-03-epic-coverage-validation.md' +thisStepFile: './step-02-prd-analysis.md' +nextStepFile: './step-03-epic-coverage-validation.md' workflowFile: '{workflow_path}/workflow.md' outputFile: '{planning_artifacts}/implementation-readiness-report-{{date}}.md' -epicsFile: '{output_folder}/*epic*.md' # Will be resolved to actual file +epicsFile: '{planning_artifacts}/*epic*.md' # Will be resolved to actual file --- # Step 2: PRD Analysis @@ -27,6 +27,7 @@ To fully read and analyze the PRD document (whole or sharded) to extract all Fun - 📖 CRITICAL: Read the complete step file before taking any action - 🔄 CRITICAL: When loading next step with 'C', ensure entire file is read - 📋 YOU ARE A FACILITATOR, not a content generator +- ✅ YOU MUST ALWAYS SPEAK OUTPUT In your Agent communication style with the config `{communication_language}` ### Role Reinforcement: diff --git a/src/modules/bmm/workflows/3-solutioning/check-implementation-readiness/steps/step-03-epic-coverage-validation.md b/src/modules/bmm/workflows/3-solutioning/check-implementation-readiness/steps/step-03-epic-coverage-validation.md index b4a90c99..981a5b63 100644 --- a/src/modules/bmm/workflows/3-solutioning/check-implementation-readiness/steps/step-03-epic-coverage-validation.md +++ b/src/modules/bmm/workflows/3-solutioning/check-implementation-readiness/steps/step-03-epic-coverage-validation.md @@ -6,8 +6,8 @@ description: 'Validate that all PRD FRs are covered in epics and stories' workflow_path: '{project-root}/_bmad/bmm/workflows/3-solutioning/implementation-readiness' # File References -thisStepFile: '{workflow_path}/steps/step-03-epic-coverage-validation.md' -nextStepFile: '{workflow_path}/steps/step-04-ux-alignment.md' +thisStepFile: './step-03-epic-coverage-validation.md' +nextStepFile: './step-04-ux-alignment.md' workflowFile: '{workflow_path}/workflow.md' outputFile: '{planning_artifacts}/implementation-readiness-report-{{date}}.md' --- @@ -26,6 +26,7 @@ To validate that all Functional Requirements from the PRD are captured in the ep - 📖 CRITICAL: Read the complete step file before taking any action - 🔄 CRITICAL: When loading next step with 'C', ensure entire file is read - 📋 YOU ARE A FACILITATOR, not a content generator +- ✅ YOU MUST ALWAYS SPEAK OUTPUT In your Agent communication style with the config `{communication_language}` ### Role Reinforcement: diff --git a/src/modules/bmm/workflows/3-solutioning/check-implementation-readiness/steps/step-04-ux-alignment.md b/src/modules/bmm/workflows/3-solutioning/check-implementation-readiness/steps/step-04-ux-alignment.md index e3ddd53b..33aad045 100644 --- a/src/modules/bmm/workflows/3-solutioning/check-implementation-readiness/steps/step-04-ux-alignment.md +++ b/src/modules/bmm/workflows/3-solutioning/check-implementation-readiness/steps/step-04-ux-alignment.md @@ -6,8 +6,8 @@ description: 'Check for UX document and validate alignment with PRD and Architec workflow_path: '{project-root}/_bmad/bmm/workflows/3-solutioning/implementation-readiness' # File References -thisStepFile: '{workflow_path}/steps/step-04-ux-alignment.md' -nextStepFile: '{workflow_path}/steps/step-05-epic-quality-review.md' +thisStepFile: './step-04-ux-alignment.md' +nextStepFile: './step-05-epic-quality-review.md' workflowFile: '{workflow_path}/workflow.md' outputFile: '{planning_artifacts}/implementation-readiness-report-{{date}}.md' --- @@ -26,6 +26,7 @@ To check if UX documentation exists and validate that it aligns with PRD require - 📖 CRITICAL: Read the complete step file before taking any action - 🔄 CRITICAL: When loading next step with 'C', ensure entire file is read - 📋 YOU ARE A FACILITATOR, not a content generator +- ✅ YOU MUST ALWAYS SPEAK OUTPUT In your Agent communication style with the config `{communication_language}` ### Role Reinforcement: @@ -64,8 +65,8 @@ I will: Search patterns: -- `{output_folder}/*ux*.md` (whole document) -- `{output_folder}/*ux*/index.md` (sharded) +- `{planning_artifacts}/*ux*.md` (whole document) +- `{planning_artifacts}/*ux*/index.md` (sharded) - Look for UI-related terms in other documents ### 3. If UX Document Exists diff --git a/src/modules/bmm/workflows/3-solutioning/check-implementation-readiness/steps/step-05-epic-quality-review.md b/src/modules/bmm/workflows/3-solutioning/check-implementation-readiness/steps/step-05-epic-quality-review.md index 597f62a2..0203cdc1 100644 --- a/src/modules/bmm/workflows/3-solutioning/check-implementation-readiness/steps/step-05-epic-quality-review.md +++ b/src/modules/bmm/workflows/3-solutioning/check-implementation-readiness/steps/step-05-epic-quality-review.md @@ -6,8 +6,8 @@ description: 'Validate epics and stories against create-epics-and-stories best p workflow_path: '{project-root}/_bmad/bmm/workflows/3-solutioning/implementation-readiness' # File References -thisStepFile: '{workflow_path}/steps/step-05-epic-quality-review.md' -nextStepFile: '{workflow_path}/steps/step-06-final-assessment.md' +thisStepFile: './step-05-epic-quality-review.md' +nextStepFile: './step-06-final-assessment.md' workflowFile: '{workflow_path}/workflow.md' outputFile: '{planning_artifacts}/implementation-readiness-report-{{date}}.md' epicsBestPractices: '{project-root}/_bmad/bmm/workflows/3-solutioning/create-epics-and-stories' @@ -27,6 +27,7 @@ To validate epics and stories against the best practices defined in create-epics - 📖 CRITICAL: Read the complete step file before taking any action - 🔄 CRITICAL: When loading next step with 'C', ensure entire file is read - 📋 YOU ARE A FACILITATOR, not a content generator +- ✅ YOU MUST ALWAYS SPEAK OUTPUT In your Agent communication style with the config `{communication_language}` ### Role Reinforcement: diff --git a/src/modules/bmm/workflows/3-solutioning/check-implementation-readiness/steps/step-06-final-assessment.md b/src/modules/bmm/workflows/3-solutioning/check-implementation-readiness/steps/step-06-final-assessment.md index 204e6aeb..9469a226 100644 --- a/src/modules/bmm/workflows/3-solutioning/check-implementation-readiness/steps/step-06-final-assessment.md +++ b/src/modules/bmm/workflows/3-solutioning/check-implementation-readiness/steps/step-06-final-assessment.md @@ -6,7 +6,7 @@ description: 'Compile final assessment and polish the readiness report' workflow_path: '{project-root}/_bmad/bmm/workflows/3-solutioning/implementation-readiness' # File References -thisStepFile: '{workflow_path}/steps/step-06-final-assessment.md' +thisStepFile: './step-06-final-assessment.md' workflowFile: '{workflow_path}/workflow.md' outputFile: '{planning_artifacts}/implementation-readiness-report-{{date}}.md' --- @@ -25,6 +25,7 @@ To provide a comprehensive summary of all findings and give the report a final p - 📖 CRITICAL: Read the complete step file before taking any action - 📖 You are at the final step - complete the assessment - 📋 YOU ARE A FACILITATOR, not a content generator +- ✅ YOU MUST ALWAYS SPEAK OUTPUT In your Agent communication style with the config `{communication_language}` ### Role Reinforcement: diff --git a/src/modules/bmm/workflows/3-solutioning/check-implementation-readiness/workflow.md b/src/modules/bmm/workflows/3-solutioning/check-implementation-readiness/workflow.md index 11ac56bb..a06276fa 100644 --- a/src/modules/bmm/workflows/3-solutioning/check-implementation-readiness/workflow.md +++ b/src/modules/bmm/workflows/3-solutioning/check-implementation-readiness/workflow.md @@ -48,7 +48,8 @@ web_bundle: false Load and read full config from {project-root}/_bmad/bmm/config.yaml and resolve: - `project_name`, `output_folder`, `planning_artifacts`, `user_name`, `communication_language`, `document_output_language` +- ✅ YOU MUST ALWAYS SPEAK OUTPUT In your Agent communication style with the config `{communication_language}` ### 2. First Step EXECUTION -Load, read the full file and then execute `{workflow_path}/steps/step-01-document-discovery.md` to begin the workflow. +Load, read the full file and then execute `./step-01-document-discovery.md` to begin the workflow. diff --git a/src/modules/bmm/workflows/3-solutioning/create-architecture/steps/step-01-init.md b/src/modules/bmm/workflows/3-solutioning/create-architecture/steps/step-01-init.md index 8cbcaa47..93a83c70 100644 --- a/src/modules/bmm/workflows/3-solutioning/create-architecture/steps/step-01-init.md +++ b/src/modules/bmm/workflows/3-solutioning/create-architecture/steps/step-01-init.md @@ -3,7 +3,6 @@ ## MANDATORY EXECUTION RULES (READ FIRST): - 🛑 NEVER generate content without user input - - 📖 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 - ✅ ALWAYS treat this as collaborative discovery between architectural peers @@ -11,6 +10,7 @@ - 💬 FOCUS on initialization and setup only - don't look ahead to future steps - 🚪 DETECT existing workflow state and handle continuation properly - ⚠️ ABSOLUTELY NO TIME ESTIMATES - AI development speed has fundamentally changed +- ✅ YOU MUST ALWAYS SPEAK OUTPUT In your Agent communication style with the config `{communication_language}` ## EXECUTION PROTOCOLS: @@ -36,7 +36,7 @@ Initialize the Architecture workflow by detecting continuation state, discoverin First, check if the output document already exists: -- Look for existing {output_folder}||{planning_artifacts} architecture.md or \*\*/architecture/ +- Look for existing {planning_artifacts}/`*architecture*.md` - If exists, read the complete file(s) including frontmatter - If not exists, this is a fresh workflow @@ -54,58 +54,30 @@ If no document exists or no `stepsCompleted` in frontmatter: #### A. Input Document Discovery -Discover and load context documents using smart discovery: +Discover and load context documents using smart discovery. Documents can be in the following locations: +- {planning_artifacts}/** +- {output_folder}/** +- {product_knowledge}/** +- docs/** -**PRD Document (Priority: Analysis → Main → Sharded → Whole):** +Also - when searching - documents can be a single markdown file, or a folder with an index and multiple files. For Example, if searching for `*foo*.md` and not found, also search for a folder called *foo*/index.md (which indicates sharded content) -1. Check analysis folders: {output_folder} and {planning_artifacts} for a `*prd*.md` -2. If no main files: Check for sharded PRD folder: `**/*prd*/**/*.md` -3. If sharded folder exists: Load EVERY file in that folder completely -4. Add discovered files to `inputDocuments` frontmatter +Try to discover the following: +- Product Brief (`*brief*.md`) +- Product Requirements Document (`*prd*.md`) +- UX Design (`*ux-design*.md`) and other +- Research Documents (`*research*.md`) +- Project Documentation (generally multiple documents might be found for this in the `{product_knowledge}` or `docs` folder.) +- Project Context (`**/project-context.md`) -**Epics/Stories Document (Priority: Analysis → Main → Sharded → Whole):** - -1. Check folders: {output_folder} and {planning_artifacts} for a `*epic*.md` -2. If no analysis files: Try main folder: `{output_folder}/*epic*.md` -3. If no main files: Check for sharded epics folder: `{output_folder}/*epic*/**/*.md` -4. If sharded folder exists: Load EVERY file in that folder completely -5. Add discovered files to `inputDocuments` frontmatter - -**UX Design Specification (Priority: Analysis → Main → Sharded → Whole):** - -1. Check folders: {output_folder} and {planning_artifacts} for a `*ux*.md` -2. If no main files: Check for sharded UX folder: `{output_folder}/*ux*/**/*.md` -3. If sharded folder exists: Load EVERY file in that folder completely -4. Add discovered files to `inputDocuments` frontmatter - -**Research Documents (Priority: Analysis → Main):** - -1. Check folders {output_folder} and {planning_artifacts} for `/research/*research*.md` -2. If no files: Try folder: `{output_folder}/*research*.md` -3. Add discovered files to `inputDocuments` frontmatter - -**Project Documentation (Existing Projects):** - -1. Look for index file: `{project_knowledge}/index.md` -2. CRITICAL: Load index.md to understand what project files are available -3. Read available files from index to understand existing project context -4. This provides essential context for extending existing project with new architecture -5. Add discovered files to `inputDocuments` frontmatter -6. IF no index.md, ask user which files from the folder to include - -**Project Context Rules (Critical for AI Agents):** - -1. Check for project context file: `**/project-context.md` -2. If exists: Load COMPLETE file contents - this contains critical rules for AI agents -3. Add to frontmatter `hasProjectContext: true` and track file path -4. Report to user: "Found existing project context with {number_of_rules} agent rules" -5. This file contains language-specific patterns, testing rules, and implementation guidelines that must be followed +Confirm what you have found with the user, along with asking if the user wants to provide anything else. Only after this confirmation will you proceed to follow the loading rules **Loading Rules:** -- Load ALL discovered files completely (no offset/limit) -- For sharded folders, load ALL files to get complete picture -- For existing projects, use index.md as guide to what's relevant +- Load ALL discovered files completely that the user confirmed or provided (no offset/limit) +- If there is a project context, whatever is relevant should try to be biased in the remainder of this whole workflow process +- For sharded folders, load ALL files to get complete picture, using the index first to potentially know the potential of each document +- index.md is a guide to what's relevant whenever available - Track all successfully loaded files in frontmatter `inputDocuments` array #### B. Validate Required Inputs @@ -117,13 +89,13 @@ Before proceeding, verify we have the essential inputs: - If no PRD found: "Architecture requires a PRD to work from. Please run the PRD workflow first or provide the PRD file path." - Do NOT proceed without PRD -**Other Inputs:** +**Other Input that might exist:** -- UX Spec: "Provides UI/UX architectural requirements" (Optional) +- UX Spec: "Provides UI/UX architectural requirements" #### C. Create Initial Document -Copy the template from `{installed_path}/architecture-decision-template.md` to `{output_folder}/architecture.md` +Copy the template from `{installed_path}/architecture-decision-template.md` to `{planning_artifacts}/architecture.md` #### D. Complete Initialization and Report @@ -131,7 +103,7 @@ Complete setup and report to user: **Document Setup:** -- Created: `{output_folder}/architecture.md` from template +- Created: `{planning_artifacts}/architecture.md` from template - Initialized frontmatter with workflow state **Input Documents Discovered:** @@ -141,7 +113,6 @@ Report what was found: **Documents Found:** - PRD: {number of PRD files loaded or "None found - REQUIRED"} -- Epics/Stories: {number of epic files loaded or "None found"} - UX Design: {number of UX files loaded or "None found"} - Research: {number of research files loaded or "None found"} - Project docs: {number of project files loaded or "None found"} @@ -177,6 +148,6 @@ Ready to begin architectural decision making. Do you have any other documents yo ## NEXT STEP: -After user selects [C] to continue, load `./step-02-context.md` to analyze the project context and begin architectural decision making. +After user selects [C] to continue, only after ensuring all the template output has been created, then load `./step-02-context.md` to analyze the project context and begin architectural decision making. Remember: Do NOT proceed to step-02 until user explicitly selects [C] from the menu and setup is confirmed! diff --git a/src/modules/bmm/workflows/3-solutioning/create-architecture/steps/step-01b-continue.md b/src/modules/bmm/workflows/3-solutioning/create-architecture/steps/step-01b-continue.md index 38f87d34..6e800e7f 100644 --- a/src/modules/bmm/workflows/3-solutioning/create-architecture/steps/step-01b-continue.md +++ b/src/modules/bmm/workflows/3-solutioning/create-architecture/steps/step-01b-continue.md @@ -11,6 +11,7 @@ - 💬 FOCUS on understanding current state and getting user confirmation - 🚪 HANDLE workflow resumption smoothly and transparently - ⚠️ ABSOLUTELY NO TIME ESTIMATES - AI development speed has fundamentally changed +- ✅ YOU MUST ALWAYS SPEAK OUTPUT In your Agent communication style with the config `{communication_language}` ## EXECUTION PROTOCOLS: diff --git a/src/modules/bmm/workflows/3-solutioning/create-architecture/steps/step-02-context.md b/src/modules/bmm/workflows/3-solutioning/create-architecture/steps/step-02-context.md index 84b34629..83195452 100644 --- a/src/modules/bmm/workflows/3-solutioning/create-architecture/steps/step-02-context.md +++ b/src/modules/bmm/workflows/3-solutioning/create-architecture/steps/step-02-context.md @@ -11,6 +11,7 @@ - 💬 FOCUS on understanding project scope and requirements for architecture - 🎯 ANALYZE loaded documents, don't assume or generate requirements - ⚠️ ABSOLUTELY NO TIME ESTIMATES - AI development speed has fundamentally changed +- ✅ YOU MUST ALWAYS SPEAK OUTPUT In your Agent communication style with the config `{communication_language}` ## EXECUTION PROTOCOLS: @@ -30,7 +31,7 @@ This step will generate content and present choices: ## PROTOCOL INTEGRATION: -- When 'A' selected: Execute {project-root}/_bmad/core/tasks/advanced-elicitation.xml +- When 'A' selected: Execute {project-root}/_bmad/core/workflows/advanced-elicitation/workflow.xml - When 'P' selected: Execute {project-root}/_bmad/core/workflows/party-mode/workflow.md - PROTOCOLS always return to display this step's A/P/C menu after the A or P have completed - User accepts/rejects protocol changes before proceeding @@ -169,7 +170,7 @@ Show the generated content and present choices: #### If 'A' (Advanced Elicitation): -- Execute {project-root}/_bmad/core/tasks/advanced-elicitation.xml with the current context analysis +- Execute {project-root}/_bmad/core/workflows/advanced-elicitation/workflow.xml with the current context analysis - Process the enhanced architectural insights that come back - Ask user: "Accept these enhancements to the project context analysis? (y/n)" - If yes: Update content with improvements, then return to A/P/C menu @@ -185,7 +186,7 @@ Show the generated content and present choices: #### If 'C' (Continue): -- Append the final content to `{output_folder}/architecture.md` +- Append the final content to `{planning_artifacts}/architecture.md` - Update frontmatter: `stepsCompleted: [1, 2]` - Load `./step-03-starter.md` diff --git a/src/modules/bmm/workflows/3-solutioning/create-architecture/steps/step-03-starter.md b/src/modules/bmm/workflows/3-solutioning/create-architecture/steps/step-03-starter.md index 7480b79e..8e83b9b1 100644 --- a/src/modules/bmm/workflows/3-solutioning/create-architecture/steps/step-03-starter.md +++ b/src/modules/bmm/workflows/3-solutioning/create-architecture/steps/step-03-starter.md @@ -10,6 +10,7 @@ - ⚠️ ABSOLUTELY NO TIME ESTIMATES - AI development speed has fundamentally changed - 📖 CRITICAL: ALWAYS read the complete step file before taking any action - partial understanding leads to incomplete architecture - 🔄 CRITICAL: When loading next step with 'C', ensure the entire file is read and understood before proceeding +- ✅ YOU MUST ALWAYS SPEAK OUTPUT In your Agent communication style with the config `{communication_language}` ## EXECUTION PROTOCOLS: @@ -30,7 +31,7 @@ This step will generate content and present choices: ## PROTOCOL INTEGRATION: -- When 'A' selected: Execute {project-root}/_bmad/core/tasks/advanced-elicitation.xml +- When 'A' selected: Execute {project-root}/_bmad/core/workflows/advanced-elicitation/workflow.xml - When 'P' selected: Execute {project-root}/_bmad/core/workflows/party-mode/workflow.md - PROTOCOLS always return to display this step's A/P/C menu after the A or P have completed - User accepts/rejects protocol changes before proceeding @@ -276,7 +277,7 @@ Show the generated content and present choices: #### If 'A' (Advanced Elicitation): -- Execute {project-root}/_bmad/core/tasks/advanced-elicitation.xml with current starter analysis +- Execute {project-root}/_bmad/core/workflows/advanced-elicitation/workflow.xml with current starter analysis - Process enhanced insights about starter options or custom approaches - Ask user: "Accept these changes to the starter template evaluation? (y/n)" - If yes: Update content, then return to A/P/C menu @@ -292,7 +293,7 @@ Show the generated content and present choices: #### If 'C' (Continue): -- Append the final content to `{output_folder}/architecture.md` +- Append the final content to `{planning_artifacts}/architecture.md` - Update frontmatter: `stepsCompleted: [1, 2, 3]` - Load `./step-04-decisions.md` diff --git a/src/modules/bmm/workflows/3-solutioning/create-architecture/steps/step-04-decisions.md b/src/modules/bmm/workflows/3-solutioning/create-architecture/steps/step-04-decisions.md index 1b145cfd..1b8ed9c2 100644 --- a/src/modules/bmm/workflows/3-solutioning/create-architecture/steps/step-04-decisions.md +++ b/src/modules/bmm/workflows/3-solutioning/create-architecture/steps/step-04-decisions.md @@ -11,6 +11,7 @@ - 💬 FOCUS on making critical architectural decisions collaboratively - 🌐 ALWAYS search the web to verify current technology versions - ⚠️ ABSOLUTELY NO TIME ESTIMATES - AI development speed has fundamentally changed +- ✅ YOU MUST ALWAYS SPEAK OUTPUT In your Agent communication style with the config `{communication_language}` ## EXECUTION PROTOCOLS: @@ -31,7 +32,7 @@ This step will generate content and present choices for each decision category: ## PROTOCOL INTEGRATION: -- When 'A' selected: Execute {project-root}/_bmad/core/tasks/advanced-elicitation.xml +- When 'A' selected: Execute {project-root}/_bmad/core/workflows/advanced-elicitation/workflow.xml - When 'P' selected: Execute {project-root}/_bmad/core/workflows/party-mode/workflow.md - PROTOCOLS always return to display this step's A/P/C menu after the A or P have completed - User accepts/rejects protocol changes before proceeding @@ -263,7 +264,7 @@ Show the generated decisions content and present choices: #### If 'A' (Advanced Elicitation): -- Execute {project-root}/_bmad/core/tasks/advanced-elicitation.xml with specific decision categories +- Execute {project-root}/_bmad/core/workflows/advanced-elicitation/workflow.xml with specific decision categories - Process enhanced insights about particular decisions - Ask user: "Accept these enhancements to the architectural decisions? (y/n)" - If yes: Update content, then return to A/P/C menu @@ -279,7 +280,7 @@ Show the generated decisions content and present choices: #### If 'C' (Continue): -- Append the final content to `{output_folder}/architecture.md` +- Append the final content to `{planning_artifacts}/architecture.md` - Update frontmatter: `stepsCompleted: [1, 2, 3, 4]` - Load `./step-05-patterns.md` diff --git a/src/modules/bmm/workflows/3-solutioning/create-architecture/steps/step-05-patterns.md b/src/modules/bmm/workflows/3-solutioning/create-architecture/steps/step-05-patterns.md index ec5a85a6..921d504d 100644 --- a/src/modules/bmm/workflows/3-solutioning/create-architecture/steps/step-05-patterns.md +++ b/src/modules/bmm/workflows/3-solutioning/create-architecture/steps/step-05-patterns.md @@ -11,6 +11,7 @@ - 💬 FOCUS on patterns that prevent AI agent implementation conflicts - 🎯 EMPHASIZE what agents could decide DIFFERENTLY if not specified - ⚠️ ABSOLUTELY NO TIME ESTIMATES - AI development speed has fundamentally changed +- ✅ YOU MUST ALWAYS SPEAK OUTPUT In your Agent communication style with the config `{communication_language}` ## EXECUTION PROTOCOLS: @@ -31,7 +32,7 @@ This step will generate content and present choices: ## PROTOCOL INTEGRATION: -- When 'A' selected: Execute {project-root}/_bmad/core/tasks/advanced-elicitation.xml +- When 'A' selected: Execute {project-root}/_bmad/core/workflows/advanced-elicitation/workflow.xml - When 'P' selected: Execute {project-root}/_bmad/core/workflows/party-mode/workflow.md - PROTOCOLS always return to display this step's A/P/C menu after the A or P have completed - User accepts/rejects protocol changes before proceeding @@ -304,7 +305,7 @@ Show the generated patterns content and present choices: #### If 'A' (Advanced Elicitation): -- Execute {project-root}/_bmad/core/tasks/advanced-elicitation.xml with current patterns +- Execute {project-root}/_bmad/core/workflows/advanced-elicitation/workflow.xml with current patterns - Process enhanced consistency rules that come back - Ask user: "Accept these additional pattern refinements? (y/n)" - If yes: Update content, then return to A/P/C menu @@ -320,7 +321,7 @@ Show the generated patterns content and present choices: #### If 'C' (Continue): -- Append the final content to `{output_folder}/architecture.md` +- Append the final content to `{planning_artifacts}/architecture.md` - Update frontmatter: `stepsCompleted: [1, 2, 3, 4, 5]` - Load `./step-06-structure.md` diff --git a/src/modules/bmm/workflows/3-solutioning/create-architecture/steps/step-06-structure.md b/src/modules/bmm/workflows/3-solutioning/create-architecture/steps/step-06-structure.md index 9628ad18..01158cc5 100644 --- a/src/modules/bmm/workflows/3-solutioning/create-architecture/steps/step-06-structure.md +++ b/src/modules/bmm/workflows/3-solutioning/create-architecture/steps/step-06-structure.md @@ -11,6 +11,7 @@ - 💬 FOCUS on defining complete project structure and clear boundaries - 🗺️ MAP requirements/epics to architectural components - ⚠️ ABSOLUTELY NO TIME ESTIMATES - AI development speed has fundamentally changed +- ✅ YOU MUST ALWAYS SPEAK OUTPUT In your Agent communication style with the config `{communication_language}` ## EXECUTION PROTOCOLS: @@ -31,7 +32,7 @@ This step will generate content and present choices: ## PROTOCOL INTEGRATION: -- When 'A' selected: Execute {project-root}/_bmad/core/tasks/advanced-elicitation.xml +- When 'A' selected: Execute {project-root}/_bmad/core/workflows/advanced-elicitation/workflow.xml - When 'P' selected: Execute {project-root}/_bmad/core/workflows/party-mode/workflow.md - PROTOCOLS always return to display this step's A/P/C menu after the A or P have completed - User accepts/rejects protocol changes before proceeding @@ -324,7 +325,7 @@ Show the generated project structure content and present choices: #### If 'A' (Advanced Elicitation): -- Execute {project-root}/_bmad/core/tasks/advanced-elicitation.xml with current project structure +- Execute {project-root}/_bmad/core/workflows/advanced-elicitation/workflow.xml with current project structure - Process enhanced organizational insights that come back - Ask user: "Accept these changes to the project structure? (y/n)" - If yes: Update content, then return to A/P/C menu @@ -340,7 +341,7 @@ Show the generated project structure content and present choices: #### If 'C' (Continue): -- Append the final content to `{output_folder}/architecture.md` +- Append the final content to `{planning_artifacts}/architecture.md` - Update frontmatter: `stepsCompleted: [1, 2, 3, 4, 5, 6]` - Load `./step-07-validation.md` diff --git a/src/modules/bmm/workflows/3-solutioning/create-architecture/steps/step-07-validation.md b/src/modules/bmm/workflows/3-solutioning/create-architecture/steps/step-07-validation.md index aa6d8e38..e841825a 100644 --- a/src/modules/bmm/workflows/3-solutioning/create-architecture/steps/step-07-validation.md +++ b/src/modules/bmm/workflows/3-solutioning/create-architecture/steps/step-07-validation.md @@ -11,6 +11,7 @@ - 💬 FOCUS on validating architectural coherence and completeness - ✅ VALIDATE all requirements are covered by architectural decisions - ⚠️ ABSOLUTELY NO TIME ESTIMATES - AI development speed has fundamentally changed +- ✅ YOU MUST ALWAYS SPEAK OUTPUT In your Agent communication style with the config `{communication_language}` ## EXECUTION PROTOCOLS: @@ -31,7 +32,7 @@ This step will generate content and present choices: ## PROTOCOL INTEGRATION: -- When 'A' selected: Execute {project-root}/_bmad/core/tasks/advanced-elicitation.xml +- When 'A' selected: Execute {project-root}/_bmad/core/workflows/advanced-elicitation/workflow.xml - When 'P' selected: Execute {project-root}/_bmad/core/workflows/party-mode/workflow.md - PROTOCOLS always return to display this step's A/P/C menu after the A or P have completed - User accepts/rejects protocol changes before proceeding @@ -304,7 +305,7 @@ Show the validation results and present choices: #### If 'A' (Advanced Elicitation): -- Execute {project-root}/_bmad/core/tasks/advanced-elicitation.xml with validation issues +- Execute {project-root}/_bmad/core/workflows/advanced-elicitation/workflow.xml with validation issues - Process enhanced solutions for complex concerns - Ask user: "Accept these architectural improvements? (y/n)" - If yes: Update content, then return to A/P/C menu @@ -320,7 +321,7 @@ Show the validation results and present choices: #### If 'C' (Continue): -- Append the final content to `{output_folder}/architecture.md` +- Append the final content to `{planning_artifacts}/architecture.md` - Update frontmatter: `stepsCompleted: [1, 2, 3, 4, 5, 6, 7]` - Load `./step-08-complete.md` diff --git a/src/modules/bmm/workflows/3-solutioning/create-architecture/steps/step-08-complete.md b/src/modules/bmm/workflows/3-solutioning/create-architecture/steps/step-08-complete.md index 0cbc2f10..fd73cb87 100644 --- a/src/modules/bmm/workflows/3-solutioning/create-architecture/steps/step-08-complete.md +++ b/src/modules/bmm/workflows/3-solutioning/create-architecture/steps/step-08-complete.md @@ -11,6 +11,7 @@ - 💬 FOCUS on successful workflow completion and implementation handoff - 🎯 PROVIDE clear next steps for implementation phase - ⚠️ ABSOLUTELY NO TIME ESTIMATES - AI development speed has fundamentally changed +- ✅ YOU MUST ALWAYS SPEAK OUTPUT In your Agent communication style with the config `{communication_language}` ## EXECUTION PROTOCOLS: @@ -116,7 +117,7 @@ Provide specific next steps for implementation: **Immediate Next Steps:** -1. **Review the complete architecture document** at `{output_folder}/architecture.md` +1. **Review the complete architecture document** at `{planning_artifacts}/architecture.md` 2. **Begin with project initialization** using the starter template command documented 3. **Create first implementation story** for project setup 4. **Start implementing user stories** following the architectural decisions @@ -151,7 +152,7 @@ Prepare the final content to append to the document: **Architecture Decision Workflow:** COMPLETED ✅ **Total Steps Completed:** 8 **Date Completed:** {{current_date}} -**Document Location:** {output_folder}/architecture.md +**Document Location:** {planning_artifacts}/architecture.md ### Final Architecture Deliverables @@ -243,15 +244,15 @@ The chosen starter template and architectural patterns provide a production-read **Save Final Document:** -- Ensure all content is properly appended to `{output_folder}/architecture.md` +- Ensure all content is properly appended to `{planning_artifacts}/architecture.md` - Update frontmatter with completion status - Verify document is complete and coherent **Workflow Status Update:** If not in standalone mode, update workflow status: -- Load `{output_folder}/bmm-workflow-status.yaml` -- Update workflow_status["create-architecture"] = "{output_folder}/architecture.md" +- Load `{planning_artifacts}/bmm-workflow-status.yaml` +- Update workflow_status["create-architecture"] = "{planning_artifacts}/architecture.md" - Save file with all structure and comments preserved ### 6. Present Completion to User @@ -268,7 +269,7 @@ Your architecture for {{project_name}} is comprehensive, validated, and ready fo - Implementation guidance for the development phase **📍 Where to find it:** -`{output_folder}/architecture.md` +`{planning_artifacts}/architecture.md` **🚀 What's next:** diff --git a/src/modules/bmm/workflows/3-solutioning/create-architecture/workflow.md b/src/modules/bmm/workflows/3-solutioning/create-architecture/workflow.md index 12efcbb1..da437202 100644 --- a/src/modules/bmm/workflows/3-solutioning/create-architecture/workflow.md +++ b/src/modules/bmm/workflows/3-solutioning/create-architecture/workflow.md @@ -33,6 +33,7 @@ Load config from `{project-root}/_bmad/bmm/config.yaml` and resolve: - `project_name`, `output_folder`, `planning_artifacts`, `user_name` - `communication_language`, `document_output_language`, `user_skill_level` - `date` as system-generated current datetime +- ✅ YOU MUST ALWAYS SPEAK OUTPUT In your Agent communication style with the config `{communication_language}` ### Paths diff --git a/src/modules/bmm/workflows/3-solutioning/create-epics-and-stories/steps/step-01-validate-prerequisites.md b/src/modules/bmm/workflows/3-solutioning/create-epics-and-stories/steps/step-01-validate-prerequisites.md index 19516510..ca52d4d2 100644 --- a/src/modules/bmm/workflows/3-solutioning/create-epics-and-stories/steps/step-01-validate-prerequisites.md +++ b/src/modules/bmm/workflows/3-solutioning/create-epics-and-stories/steps/step-01-validate-prerequisites.md @@ -6,14 +6,14 @@ description: 'Validate required documents exist and extract all requirements for workflow_path: '{project-root}/_bmad/bmm/workflows/3-solutioning/create-epics-and-stories' # File References -thisStepFile: '{workflow_path}/steps/step-01-validate-prerequisites.md' -nextStepFile: '{workflow_path}/steps/step-02-design-epics.md' +thisStepFile: './step-01-validate-prerequisites.md' +nextStepFile: './step-02-design-epics.md' workflowFile: '{workflow_path}/workflow.md' outputFile: '{planning_artifacts}/epics.md' epicsTemplate: '{workflow_path}/templates/epics-template.md' # Task References -advancedElicitationTask: '{project-root}/_bmad/core/tasks/advanced-elicitation.xml' +advancedElicitationTask: '{project-root}/_bmad/core/workflows/advanced-elicitation/workflow.xml' partyModeWorkflow: '{project-root}/_bmad/core/workflows/party-mode/workflow.md' # Template References @@ -34,6 +34,7 @@ To validate that all required input documents exist and extract all requirements - 📖 CRITICAL: Read the complete step file before taking any action - 🔄 CRITICAL: When loading next step with 'C', ensure entire file is read - 📋 YOU ARE A FACILITATOR, not a content generator +- ✅ YOU MUST ALWAYS SPEAK OUTPUT In your Agent communication style with the config `{communication_language}` ### Role Reinforcement: @@ -90,11 +91,11 @@ Search for required documents using these patterns (sharded means a large docume 1. `{planning_artifacts}/*ux*.md` (whole document) 2. `{planning_artifacts}/*ux*/index.md` (sharded version) -Before proceeding, Ask the user if there are any other documents, or if what you have found is all there is [Yes/No]. Wait for user confirmation. Once confirmed, create the {outputFile} from the {epicsTemplate} and in the front matter list the files in the array of `inputDocuments: []`. +Before proceeding, Ask the user if there are any other documents to include for analysis, and if anything found should be excluded. Wait for user confirmation. Once confirmed, create the {outputFile} from the {epicsTemplate} and in the front matter list the files in the array of `inputDocuments: []`. ### 3. Extract Functional Requirements (FRs) -From the PRD document (full or sharded), extract ALL functional requirements: +From the PRD document (full or sharded), read then entire document and extract ALL functional requirements: **Extraction Method:** diff --git a/src/modules/bmm/workflows/3-solutioning/create-epics-and-stories/steps/step-02-design-epics.md b/src/modules/bmm/workflows/3-solutioning/create-epics-and-stories/steps/step-02-design-epics.md index ca4c85de..65b36627 100644 --- a/src/modules/bmm/workflows/3-solutioning/create-epics-and-stories/steps/step-02-design-epics.md +++ b/src/modules/bmm/workflows/3-solutioning/create-epics-and-stories/steps/step-02-design-epics.md @@ -6,13 +6,13 @@ description: 'Design and approve the epics_list that will organize all requireme workflow_path: '{project-root}/_bmad/bmm/workflows/3-solutioning/create-epics-and-stories' # File References -thisStepFile: '{workflow_path}/steps/step-02-design-epics.md' -nextStepFile: '{workflow_path}/steps/step-03-create-stories.md' +thisStepFile: './step-02-design-epics.md' +nextStepFile: './step-03-create-stories.md' workflowFile: '{workflow_path}/workflow.md' outputFile: '{planning_artifacts}/epics.md' # Task References -advancedElicitationTask: '{project-root}/_bmad/core/tasks/advanced-elicitation.xml' +advancedElicitationTask: '{project-root}/_bmad/core/workflows/advanced-elicitation/workflow.xml' partyModeWorkflow: '{project-root}/_bmad/core/workflows/party-mode/workflow.md' # Template References @@ -33,6 +33,7 @@ To design and get approval for the epics_list that will organize all requirement - 📖 CRITICAL: Read the complete step file before taking any action - 🔄 CRITICAL: When loading next step with 'C', ensure entire file is read - 📋 YOU ARE A FACILITATOR, not a content generator +- ✅ YOU MUST ALWAYS SPEAK OUTPUT In your Agent communication style with the config `{communication_language}` ### Role Reinforcement: diff --git a/src/modules/bmm/workflows/3-solutioning/create-epics-and-stories/steps/step-03-create-stories.md b/src/modules/bmm/workflows/3-solutioning/create-epics-and-stories/steps/step-03-create-stories.md index b018bd5b..3cdb3bf6 100644 --- a/src/modules/bmm/workflows/3-solutioning/create-epics-and-stories/steps/step-03-create-stories.md +++ b/src/modules/bmm/workflows/3-solutioning/create-epics-and-stories/steps/step-03-create-stories.md @@ -6,13 +6,13 @@ description: 'Generate all epics with their stories following the template struc workflow_path: '{project-root}/_bmad/bmm/workflows/3-solutioning/create-epics-and-stories' # File References -thisStepFile: '{workflow_path}/steps/step-03-create-stories.md' -nextStepFile: '{workflow_path}/steps/step-04-final-validation.md' +thisStepFile: './step-03-create-stories.md' +nextStepFile: './step-04-final-validation.md' workflowFile: '{workflow_path}/workflow.md' outputFile: '{planning_artifacts}/epics.md' # Task References -advancedElicitationTask: '{project-root}/_bmad/core/tasks/advanced-elicitation.xml' +advancedElicitationTask: '{project-root}/_bmad/core/workflows/advanced-elicitation/workflow.xml' partyModeWorkflow: '{project-root}/_bmad/core/workflows/party-mode/workflow.md' # Template References @@ -33,6 +33,7 @@ To generate all epics with their stories based on the approved epics_list, follo - 📖 CRITICAL: Read the complete step file before taking any action - 🔄 CRITICAL: Process epics sequentially - 📋 YOU ARE A FACILITATOR, not a content generator +- ✅ YOU MUST ALWAYS SPEAK OUTPUT In your Agent communication style with the config `{communication_language}` ### Role Reinforcement: diff --git a/src/modules/bmm/workflows/3-solutioning/create-epics-and-stories/steps/step-04-final-validation.md b/src/modules/bmm/workflows/3-solutioning/create-epics-and-stories/steps/step-04-final-validation.md index 252a9ee1..3df1675b 100644 --- a/src/modules/bmm/workflows/3-solutioning/create-epics-and-stories/steps/step-04-final-validation.md +++ b/src/modules/bmm/workflows/3-solutioning/create-epics-and-stories/steps/step-04-final-validation.md @@ -6,12 +6,12 @@ description: 'Validate complete coverage of all requirements and ensure implemen workflow_path: '{project-root}/_bmad/bmm/workflows/3-solutioning/create-epics-and-stories' # File References -thisStepFile: '{workflow_path}/steps/step-04-final-validation.md' +thisStepFile: './step-04-final-validation.md' workflowFile: '{workflow_path}/workflow.md' outputFile: '{planning_artifacts}/epics.md' # Task References -advancedElicitationTask: '{project-root}/_bmad/core/tasks/advanced-elicitation.xml' +advancedElicitationTask: '{project-root}/_bmad/core/workflows/advanced-elicitation/workflow.xml' partyModeWorkflow: '{project-root}/_bmad/core/workflows/party-mode/workflow.md' # Template References @@ -32,6 +32,7 @@ To validate complete coverage of all requirements and ensure stories are ready f - 📖 CRITICAL: Read the complete step file before taking any action - 🔄 CRITICAL: Process validation sequentially without skipping - 📋 YOU ARE A FACILITATOR, not a content generator +- ✅ YOU MUST ALWAYS SPEAK OUTPUT In your Agent communication style with the config `{communication_language}` ### Role Reinforcement: diff --git a/src/modules/bmm/workflows/3-solutioning/create-epics-and-stories/workflow.md b/src/modules/bmm/workflows/3-solutioning/create-epics-and-stories/workflow.md index dee834f5..b6906dc7 100644 --- a/src/modules/bmm/workflows/3-solutioning/create-epics-and-stories/workflow.md +++ b/src/modules/bmm/workflows/3-solutioning/create-epics-and-stories/workflow.md @@ -52,6 +52,7 @@ This uses **step-file architecture** for disciplined execution: Load and read full config from {project-root}/_bmad/bmm/config.yaml and resolve: - `project_name`, `output_folder`, `planning_artifacts`, `user_name`, `communication_language`, `document_output_language` +- ✅ YOU MUST ALWAYS SPEAK OUTPUT In your Agent communication style with the config `{communication_language}` ### 2. First Step EXECUTION diff --git a/src/modules/bmm/workflows/4-implementation/code-review/instructions.xml b/src/modules/bmm/workflows/4-implementation/code-review/instructions.xml index e57a940d..e5649559 100644 --- a/src/modules/bmm/workflows/4-implementation/code-review/instructions.xml +++ b/src/modules/bmm/workflows/4-implementation/code-review/instructions.xml @@ -12,6 +12,8 @@ Read EVERY file in the File List - verify implementation against story requirements Tasks marked complete but not done = CRITICAL finding Acceptance Criteria not implemented = HIGH severity finding + Do not review files that are not part of the application's source code. Always exclude the _bmad/ and _bmad-output/ folders from the review. Always exclude IDE and CLI configuration folders like .cursor/ and .windsurf/ and .claude/ + Use provided {{story_path}} or ask user which story file to review diff --git a/src/modules/bmm/workflows/4-implementation/code-review/workflow.yaml b/src/modules/bmm/workflows/4-implementation/code-review/workflow.yaml index db51becc..9e66b932 100644 --- a/src/modules/bmm/workflows/4-implementation/code-review/workflow.yaml +++ b/src/modules/bmm/workflows/4-implementation/code-review/workflow.yaml @@ -10,9 +10,10 @@ communication_language: "{config_source}:communication_language" user_skill_level: "{config_source}:user_skill_level" document_output_language: "{config_source}:document_output_language" date: system-generated +planning_artifacts: "{config_source}:planning_artifacts" implementation_artifacts: "{config_source}:implementation_artifacts" output_folder: "{implementation_artifacts}" -sprint_status: "{implementation_artifacts}/sprint-status.yaml || {output_folder}/sprint-status.yaml" +sprint_status: "{implementation_artifacts}/sprint-status.yaml" # Workflow components installed_path: "{project-root}/_bmad/bmm/workflows/4-implementation/code-review" @@ -31,24 +32,20 @@ variables: input_file_patterns: architecture: description: "System architecture for review context" - whole: "{output_folder}/*architecture*.md" - sharded: "{output_folder}/*architecture*/*.md" + whole: "{planning_artifacts}/*architecture*.md" + sharded: "{planning_artifacts}/*architecture*/*.md" load_strategy: "FULL_LOAD" ux_design: description: "UX design specification (if UI review)" - whole: "{output_folder}/*ux*.md" - sharded: "{output_folder}/*ux*/*.md" + whole: "{planning_artifacts}/*ux*.md" + sharded: "{planning_artifacts}/*ux*/*.md" load_strategy: "FULL_LOAD" epics: description: "Epic containing story being reviewed" - whole: "{output_folder}/*epic*.md" - sharded_index: "{output_folder}/*epic*/index.md" - sharded_single: "{output_folder}/*epic*/epic-{{epic_num}}.md" + whole: "{planning_artifacts}/*epic*.md" + sharded_index: "{planning_artifacts}/*epic*/index.md" + sharded_single: "{planning_artifacts}/*epic*/epic-{{epic_num}}.md" load_strategy: "SELECTIVE_LOAD" - document_project: - description: "Brownfield project documentation (optional)" - sharded: "{output_folder}/index.md" - load_strategy: "INDEX_GUIDED" standalone: true web_bundle: false diff --git a/src/modules/bmm/workflows/4-implementation/correct-course/workflow.yaml b/src/modules/bmm/workflows/4-implementation/correct-course/workflow.yaml index 436aeff0..70813514 100644 --- a/src/modules/bmm/workflows/4-implementation/correct-course/workflow.yaml +++ b/src/modules/bmm/workflows/4-implementation/correct-course/workflow.yaml @@ -13,7 +13,7 @@ implementation_artifacts: "{config_source}:implementation_artifacts" planning_artifacts: "{config_source}:planning_artifacts" project_knowledge: "{config_source}:project_knowledge" output_folder: "{implementation_artifacts}" -sprint_status: "{implementation_artifacts}/sprint-status.yaml || {output_folder}/sprint-status.yaml" +sprint_status: "{implementation_artifacts}/sprint-status.yaml" # Smart input file references - handles both whole docs and sharded docs # Priority: Whole document first, then sharded version diff --git a/src/modules/bmm/workflows/4-implementation/create-story/checklist.md b/src/modules/bmm/workflows/4-implementation/create-story/checklist.md index b0f22385..55e6c397 100644 --- a/src/modules/bmm/workflows/4-implementation/create-story/checklist.md +++ b/src/modules/bmm/workflows/4-implementation/create-story/checklist.md @@ -33,7 +33,7 @@ This is a COMPETITION to create the **ULTIMATE story context** that makes LLM de ### **When Running from Create-Story Workflow:** -- The `{project_root}/_bmad/core/tasks/validate-workflow.xml` framework will automatically: +- The `{project-root}/_bmad/core/tasks/validate-workflow.xml` framework will automatically: - Load this checklist file - Load the newly created story file (`{story_file_path}`) - Load workflow variables from `{installed_path}/workflow.yaml` @@ -63,7 +63,7 @@ You will systematically re-do the entire story creation process, but with a crit 1. **Load the workflow configuration**: `{installed_path}/workflow.yaml` for variable inclusion 2. **Load the story file**: `{story_file_path}` (provided by user or discovered) -3. **Load validation framework**: `{project_root}/_bmad/core/tasks/validate-workflow.xml` +3. **Load validation framework**: `{project-root}/_bmad/core/tasks/validate-workflow.xml` 4. **Extract metadata**: epic_num, story_num, story_key, story_title from story file 5. **Resolve all workflow variables**: story_dir, output_folder, epics_file, architecture_file, etc. 6. **Understand current status**: What story implementation guidance is currently provided? diff --git a/src/modules/bmm/workflows/4-implementation/create-story/instructions.xml b/src/modules/bmm/workflows/4-implementation/create-story/instructions.xml index 52405e71..701b438e 100644 --- a/src/modules/bmm/workflows/4-implementation/create-story/instructions.xml +++ b/src/modules/bmm/workflows/4-implementation/create-story/instructions.xml @@ -336,9 +336,10 @@ 1. Review the comprehensive story in {{story_file}} 2. Run dev agents `dev-story` for optimized implementation 3. Run `code-review` when complete (auto-marks done) + 4. Optional: Run TEA `*automate` after `dev-story` to generate guardrail tests **The developer now has everything needed for flawless implementation!** - \ No newline at end of file + diff --git a/src/modules/bmm/workflows/4-implementation/create-story/workflow.yaml b/src/modules/bmm/workflows/4-implementation/create-story/workflow.yaml index 225028fa..258794c7 100644 --- a/src/modules/bmm/workflows/4-implementation/create-story/workflow.yaml +++ b/src/modules/bmm/workflows/4-implementation/create-story/workflow.yaml @@ -7,6 +7,7 @@ config_source: "{project-root}/_bmad/bmm/config.yaml" user_name: "{config_source}:user_name" communication_language: "{config_source}:communication_language" date: system-generated +planning_artifacts: "{config_source}:planning_artifacts" implementation_artifacts: "{config_source}:implementation_artifacts" output_folder: "{implementation_artifacts}" story_dir: "{implementation_artifacts}" @@ -19,11 +20,11 @@ validation: "{installed_path}/checklist.md" # Variables and inputs variables: - sprint_status: "{implementation_artifacts}/sprint-status.yaml || {output_folder}/sprint-status.yaml" # Primary source for story tracking - epics_file: "{output_folder}/epics.md" # Enhanced epics+stories with BDD and source hints - prd_file: "{output_folder}/PRD.md" # Fallback for requirements (if not in epics file) - architecture_file: "{output_folder}/architecture.md" # Fallback for constraints (if not in epics file) - ux_file: "{output_folder}/ux.md" # Fallback for UX requirements (if not in epics file) + sprint_status: "{implementation_artifacts}/sprint-status.yaml" # Primary source for story tracking + epics_file: "{planning_artifacts}/epics.md" # Enhanced epics+stories with BDD and source hints + prd_file: "{planning_artifacts}/prd.md" # Fallback for requirements (if not in epics file) + architecture_file: "{planning_artifacts}/architecture.md" # Fallback for constraints (if not in epics file) + ux_file: "{planning_artifacts}/*ux*.md" # Fallback for UX requirements (if not in epics file) story_title: "" # Will be elicited if not derivable # Project context @@ -36,23 +37,23 @@ default_output_file: "{story_dir}/{{story_key}}.md" input_file_patterns: prd: description: "PRD (fallback - epics file should have most content)" - whole: "{output_folder}/*prd*.md" - sharded: "{output_folder}/*prd*/*.md" + whole: "{planning_artifacts}/*prd*.md" + sharded: "{planning_artifacts}/*prd*/*.md" load_strategy: "SELECTIVE_LOAD" # Only load if needed architecture: description: "Architecture (fallback - epics file should have relevant sections)" - whole: "{output_folder}/*architecture*.md" - sharded: "{output_folder}/*architecture*/*.md" + whole: "{planning_artifacts}/*architecture*.md" + sharded: "{planning_artifacts}/*architecture*/*.md" load_strategy: "SELECTIVE_LOAD" # Only load if needed ux: description: "UX design (fallback - epics file should have relevant sections)" - whole: "{output_folder}/*ux*.md" - sharded: "{output_folder}/*ux*/*.md" + whole: "{planning_artifacts}/*ux*.md" + sharded: "{planning_artifacts}/*ux*/*.md" load_strategy: "SELECTIVE_LOAD" # Only load if needed epics: description: "Enhanced epics+stories file with BDD and source hints" - whole: "{output_folder}/*epic*.md" - sharded: "{output_folder}/*epic*/*.md" + whole: "{planning_artifacts}/*epic*.md" + sharded: "{planning_artifacts}/*epic*/*.md" load_strategy: "SELECTIVE_LOAD" # Only load needed epic standalone: true diff --git a/src/modules/bmm/workflows/4-implementation/dev-story/instructions.xml b/src/modules/bmm/workflows/4-implementation/dev-story/instructions.xml index 40c56244..4fb70efe 100644 --- a/src/modules/bmm/workflows/4-implementation/dev-story/instructions.xml +++ b/src/modules/bmm/workflows/4-implementation/dev-story/instructions.xml @@ -397,6 +397,7 @@ - Verify all acceptance criteria are met - Ensure deployment readiness if applicable - Run `code-review` workflow for peer review + - Optional: Run TEA `*automate` to expand guardrail tests 💡 **Tip:** For best results, run `code-review` using a **different** LLM than the one that implemented this story. @@ -406,4 +407,4 @@ Remain flexible - allow user to choose their own path or ask for other assistance - \ No newline at end of file + diff --git a/src/modules/bmm/workflows/4-implementation/retrospective/instructions.md b/src/modules/bmm/workflows/4-implementation/retrospective/instructions.md index 70b1ae80..01750312 100644 --- a/src/modules/bmm/workflows/4-implementation/retrospective/instructions.md +++ b/src/modules/bmm/workflows/4-implementation/retrospective/instructions.md @@ -365,16 +365,16 @@ Alice (Product Owner): "Good thinking - helps us connect what we learned to what Attempt to load next epic using selective loading strategy: **Try sharded first (more specific):** -Check if file exists: {output_folder}/epic\*/epic-{{next_epic_num}}.md +Check if file exists: {planning_artifacts}/epic\*/epic-{{next_epic_num}}.md - Load {output_folder}/*epic*/epic-{{next_epic_num}}.md + Load {planning_artifacts}/*epic*/epic-{{next_epic_num}}.md Set {{next_epic_source}} = "sharded" **Fallback to whole document:** -Check if file exists: {output_folder}/epic\*.md +Check if file exists: {planning_artifacts}/epic\*.md Load entire epics document diff --git a/src/modules/bmm/workflows/4-implementation/retrospective/workflow.yaml b/src/modules/bmm/workflows/4-implementation/retrospective/workflow.yaml index 9be242e7..80d934b2 100644 --- a/src/modules/bmm/workflows/4-implementation/retrospective/workflow.yaml +++ b/src/modules/bmm/workflows/4-implementation/retrospective/workflow.yaml @@ -4,12 +4,13 @@ description: "Run after epic completion to review overall success, extract lesso author: "BMad" config_source: "{project-root}/_bmad/bmm/config.yaml" -output_folder: "{config_source}:output_folder" +output_folder: "{config_source}:implementation_artifacts}" user_name: "{config_source}:user_name" communication_language: "{config_source}:communication_language" user_skill_level: "{config_source}:user_skill_level" document_output_language: "{config_source}:document_output_language" date: system-generated +planning_artifacts: "{config_source}:planning_artifacts" implementation_artifacts: "{config_source}:implementation_artifacts" installed_path: "{project-root}/_bmad/bmm/workflows/4-implementation/retrospective" @@ -25,9 +26,9 @@ required_inputs: input_file_patterns: epics: description: "The completed epic for retrospective" - whole: "{output_folder}/*epic*.md" - sharded_index: "{output_folder}/*epic*/index.md" - sharded_single: "{output_folder}/*epic*/epic-{{epic_num}}.md" + whole: "{planning_artifacts}/*epic*.md" + sharded_index: "{planning_artifacts}/*epic*/index.md" + sharded_single: "{planning_artifacts}/*epic*/epic-{{epic_num}}.md" load_strategy: "SELECTIVE_LOAD" previous_retrospective: description: "Previous epic's retrospective (optional)" @@ -35,21 +36,21 @@ input_file_patterns: load_strategy: "SELECTIVE_LOAD" architecture: description: "System architecture for context" - whole: "{output_folder}/*architecture*.md" - sharded: "{output_folder}/*architecture*/*.md" + whole: "{planning_artifacts}/*architecture*.md" + sharded: "{planning_artifacts}/*architecture*/*.md" load_strategy: "FULL_LOAD" prd: description: "Product requirements for context" - whole: "{output_folder}/*prd*.md" - sharded: "{output_folder}/*prd*/*.md" + whole: "{planning_artifacts}/*prd*.md" + sharded: "{planning_artifacts}/*prd*/*.md" load_strategy: "FULL_LOAD" document_project: description: "Brownfield project documentation (optional)" - sharded: "{output_folder}/*.md" + sharded: "{planning_artifacts}/*.md" load_strategy: "INDEX_GUIDED" # Required files -sprint_status_file: "{implementation_artifacts}/sprint-status.yaml || {output_folder}/sprint-status.yaml" +sprint_status_file: "{implementation_artifacts}/sprint-status.yaml" story_directory: "{implementation_artifacts}" retrospectives_folder: "{implementation_artifacts}" diff --git a/src/modules/bmm/workflows/4-implementation/sprint-status/workflow.yaml b/src/modules/bmm/workflows/4-implementation/sprint-status/workflow.yaml index 2dd2f25c..6f10a9a6 100644 --- a/src/modules/bmm/workflows/4-implementation/sprint-status/workflow.yaml +++ b/src/modules/bmm/workflows/4-implementation/sprint-status/workflow.yaml @@ -19,14 +19,14 @@ instructions: "{installed_path}/instructions.md" # Inputs variables: - sprint_status_file: "{implementation_artifacts}/sprint-status.yaml || {output_folder}/sprint-status.yaml" + sprint_status_file: "{implementation_artifacts}/sprint-status.yaml" tracking_system: "file-system" # Smart input file references input_file_patterns: sprint_status: description: "Sprint status file generated by sprint-planning" - whole: "{implementation_artifacts}/sprint-status.yaml || {output_folder}/sprint-status.yaml" + whole: "{implementation_artifacts}/sprint-status.yaml" load_strategy: "FULL_LOAD" # Standalone so IDE commands get generated diff --git a/src/modules/bmm/workflows/bmad-quick-flow/create-tech-spec/instructions.md b/src/modules/bmm/workflows/bmad-quick-flow/create-tech-spec/instructions.md deleted file mode 100644 index 64fccf29..00000000 --- a/src/modules/bmm/workflows/bmad-quick-flow/create-tech-spec/instructions.md +++ /dev/null @@ -1,115 +0,0 @@ -# Create Tech-Spec - Spec Engineering for AI Development - - - -Communicate in {communication_language}, tailored to {user_skill_level} -Generate documents in {document_output_language} -Conversational spec engineering - ask questions, investigate code, produce complete spec -Spec must contain ALL context a fresh dev agent needs to implement it - - - Load and execute {advanced_elicitation}, then return to current step - Load and execute {party_mode_workflow}, then return to current step - Load and execute {quick_dev_workflow} with the tech-spec file - - - - -Greet {user_name} and ask them to describe what they want to build or change. - -Ask clarifying questions: problem, who's affected, scope, constraints, existing code? - -Check for existing context in {output_folder} and {implementation_artifacts} - - -[a] Advanced Elicitation [c] Continue [p] Party Mode - - - - - - -If brownfield: get file paths, read code, identify patterns/conventions/dependencies - -Document: tech stack, code patterns, files to modify, test patterns - - -[a] Advanced Elicitation [c] Continue [p] Party Mode - - - - - - -Create tech-spec using this structure: - -```markdown -# Tech-Spec: {title} - -**Created:** {date} -**Status:** Ready for Development - -## Overview - -### Problem Statement - -### Solution - -### Scope (In/Out) - -## Context for Development - -### Codebase Patterns - -### Files to Reference - -### Technical Decisions - -## Implementation Plan - -### Tasks - -- [ ] Task 1: Description -- [ ] Task 2: Description - -### Acceptance Criteria - -- [ ] AC 1: Given/When/Then -- [ ] AC 2: ... - -## Additional Context - -### Dependencies - -### Testing Strategy - -### Notes -``` - - - -Save to {implementation_artifacts}/tech-spec-{slug}.md - - - - - -Present spec to {user_name}, ask if it captures intent, make changes as needed - -**Tech-Spec Complete!** - -Saved to: {implementation_artifacts}/tech-spec-{slug}.md - -[a] Advanced Elicitation - refine further -[b] Begin Development (not recommended - fresh context better) -[d] Done - exit -[p] Party Mode - get feedback - -**Recommended:** Run `dev-spec {implementation_artifacts}/tech-spec-{slug}.md` in fresh context. - - -Choice (a/b/d/p): - - - - diff --git a/src/modules/bmm/workflows/bmad-quick-flow/create-tech-spec/workflow.yaml b/src/modules/bmm/workflows/bmad-quick-flow/create-tech-spec/workflow.yaml deleted file mode 100644 index cf2b2815..00000000 --- a/src/modules/bmm/workflows/bmad-quick-flow/create-tech-spec/workflow.yaml +++ /dev/null @@ -1,28 +0,0 @@ -# Quick-Flow: Create Tech-Spec -name: create-tech-spec -description: "Conversational spec engineering - ask questions, investigate code, produce implementation-ready tech-spec." -author: "BMad" - -# Config -config_source: "{project-root}/_bmad/bmm/config.yaml" -implementation_artifacts: "{config_source}:implementation_artifacts" -planning_artifacts: "{config_source}:planning_artifacts" -project_knowledge: "{config_source}:project_knowledge" -output_folder: "{implementation_artifacts}" -user_name: "{config_source}:user_name" -communication_language: "{config_source}:communication_language" -document_output_language: "{config_source}:document_output_language" -user_skill_level: "{config_source}:user_skill_level" -date: system-generated - -# Workflow components -installed_path: "{project-root}/_bmad/bmm/workflows/bmad-quick-flow/create-tech-spec" -instructions: "{installed_path}/instructions.md" - -# Related workflows -quick_dev_workflow: "{project-root}/_bmad/bmm/workflows/bmad-quick-flow/quick-dev/workflow.yaml" -party_mode_exec: "{project-root}/_bmad/core/workflows/party-mode/workflow.md" -advanced_elicitation: "{project-root}/_bmad/core/tasks/advanced-elicitation.xml" - -standalone: true -web_bundle: false diff --git a/src/modules/bmm/workflows/bmad-quick-flow/quick-dev/steps/step-01-mode-detection.md b/src/modules/bmm/workflows/bmad-quick-flow/quick-dev/steps/step-01-mode-detection.md index d6e79845..cbb32894 100644 --- a/src/modules/bmm/workflows/bmad-quick-flow/quick-dev/steps/step-01-mode-detection.md +++ b/src/modules/bmm/workflows/bmad-quick-flow/quick-dev/steps/step-01-mode-detection.md @@ -3,9 +3,9 @@ name: 'step-01-mode-detection' description: 'Determine execution mode (tech-spec vs direct), handle escalation, set state variables' workflow_path: '{project-root}/_bmad/bmm/workflows/bmad-quick-flow/quick-dev' -thisStepFile: '{workflow_path}/steps/step-01-mode-detection.md' -nextStepFile_modeA: '{workflow_path}/steps/step-03-execute.md' -nextStepFile_modeB: '{workflow_path}/steps/step-02-context-gathering.md' +thisStepFile: './step-01-mode-detection.md' +nextStepFile_modeA: './step-03-execute.md' +nextStepFile_modeB: './step-02-context-gathering.md' --- # Step 1: Mode Detection @@ -40,7 +40,7 @@ First, check if the project uses Git version control: ### 2. Load Project Context -Check if `{project_context}` exists (`**/project-context.md`). If found, load it - this is foundational reference for ALL implementation decisions. +Check if `{project_context}` exists (`**/project-context.md`). If found, load it as a foundational reference for ALL implementation decisions. ### 3. Parse User Input @@ -95,7 +95,7 @@ Present choice: **[e] Execute directly** - Start now ``` -- **[t]:** Direct user to `{create_tech_spec_workflow}`. **EXIT Quick Dev.** +- **[t]:** Direct user to `{quick_spec_workflow}`. **EXIT Quick Dev.** - **[e]:** Ask for any additional guidance, then **NEXT:** Load `step-02-context-gathering.md` ### Escalation Triggered - Level 0-2 @@ -108,7 +108,7 @@ This looks like a focused feature with multiple components. **[e] Execute directly** ``` -- **[t]:** Direct to `{create_tech_spec_workflow}`. **EXIT Quick Dev.** +- **[t]:** Direct to `{quick_spec_workflow}`. **EXIT Quick Dev.** - **[w]:** Direct to `{workflow_init}`. **EXIT Quick Dev.** - **[e]:** Ask for guidance, then **NEXT:** Load `step-02-context-gathering.md` @@ -123,7 +123,7 @@ This sounds like platform/system work. ``` - **[w]:** Direct to `{workflow_init}`. **EXIT Quick Dev.** -- **[t]:** Direct to `{create_tech_spec_workflow}`. **EXIT Quick Dev.** +- **[t]:** Direct to `{quick_spec_workflow}`. **EXIT Quick Dev.** - **[e]:** Ask for guidance, then **NEXT:** Load `step-02-context-gathering.md` --- diff --git a/src/modules/bmm/workflows/bmad-quick-flow/quick-dev/steps/step-02-context-gathering.md b/src/modules/bmm/workflows/bmad-quick-flow/quick-dev/steps/step-02-context-gathering.md index 8e2126bc..a886b5f5 100644 --- a/src/modules/bmm/workflows/bmad-quick-flow/quick-dev/steps/step-02-context-gathering.md +++ b/src/modules/bmm/workflows/bmad-quick-flow/quick-dev/steps/step-02-context-gathering.md @@ -3,8 +3,8 @@ name: 'step-02-context-gathering' description: 'Quick context gathering for direct mode - identify files, patterns, dependencies' workflow_path: '{project-root}/_bmad/bmm/workflows/bmad-quick-flow/quick-dev' -thisStepFile: '{workflow_path}/steps/step-02-context-gathering.md' -nextStepFile: '{workflow_path}/steps/step-03-execute.md' +thisStepFile: './step-02-context-gathering.md' +nextStepFile: './step-03-execute.md' --- # Step 2: Context Gathering (Direct Mode) diff --git a/src/modules/bmm/workflows/bmad-quick-flow/quick-dev/steps/step-03-execute.md b/src/modules/bmm/workflows/bmad-quick-flow/quick-dev/steps/step-03-execute.md index 1be12b98..f12113cf 100644 --- a/src/modules/bmm/workflows/bmad-quick-flow/quick-dev/steps/step-03-execute.md +++ b/src/modules/bmm/workflows/bmad-quick-flow/quick-dev/steps/step-03-execute.md @@ -3,8 +3,8 @@ name: 'step-03-execute' description: 'Execute implementation - iterate through tasks, write code, run tests' workflow_path: '{project-root}/_bmad/bmm/workflows/bmad-quick-flow/quick-dev' -thisStepFile: '{workflow_path}/steps/step-03-execute.md' -nextStepFile: '{workflow_path}/steps/step-04-self-check.md' +thisStepFile: './step-03-execute.md' +nextStepFile: './step-04-self-check.md' --- # Step 3: Execute Implementation diff --git a/src/modules/bmm/workflows/bmad-quick-flow/quick-dev/steps/step-04-self-check.md b/src/modules/bmm/workflows/bmad-quick-flow/quick-dev/steps/step-04-self-check.md index c6d93162..6179ebba 100644 --- a/src/modules/bmm/workflows/bmad-quick-flow/quick-dev/steps/step-04-self-check.md +++ b/src/modules/bmm/workflows/bmad-quick-flow/quick-dev/steps/step-04-self-check.md @@ -3,8 +3,8 @@ name: 'step-04-self-check' description: 'Self-audit implementation against tasks, tests, AC, and patterns' workflow_path: '{project-root}/_bmad/bmm/workflows/bmad-quick-flow/quick-dev' -thisStepFile: '{workflow_path}/steps/step-04-self-check.md' -nextStepFile: '{workflow_path}/steps/step-05-adversarial-review.md' +thisStepFile: './step-04-self-check.md' +nextStepFile: './step-05-adversarial-review.md' --- # Step 4: Self-Check diff --git a/src/modules/bmm/workflows/bmad-quick-flow/quick-dev/steps/step-05-adversarial-review.md b/src/modules/bmm/workflows/bmad-quick-flow/quick-dev/steps/step-05-adversarial-review.md index fd349801..db03665f 100644 --- a/src/modules/bmm/workflows/bmad-quick-flow/quick-dev/steps/step-05-adversarial-review.md +++ b/src/modules/bmm/workflows/bmad-quick-flow/quick-dev/steps/step-05-adversarial-review.md @@ -3,8 +3,8 @@ name: 'step-05-adversarial-review' description: 'Construct diff and invoke adversarial review task' workflow_path: '{project-root}/_bmad/bmm/workflows/bmad-quick-flow/quick-dev' -thisStepFile: '{workflow_path}/steps/step-05-adversarial-review.md' -nextStepFile: '{workflow_path}/steps/step-06-resolve-findings.md' +thisStepFile: './step-05-adversarial-review.md' +nextStepFile: './step-06-resolve-findings.md' --- # Step 5: Adversarial Code Review @@ -79,7 +79,7 @@ Evaluate severity (Critical, High, Medium, Low) and validity (real, noise, undec 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 WriteTodos 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 +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 --- diff --git a/src/modules/bmm/workflows/bmad-quick-flow/quick-dev/steps/step-06-resolve-findings.md b/src/modules/bmm/workflows/bmad-quick-flow/quick-dev/steps/step-06-resolve-findings.md index f6af4697..fcc5146e 100644 --- a/src/modules/bmm/workflows/bmad-quick-flow/quick-dev/steps/step-06-resolve-findings.md +++ b/src/modules/bmm/workflows/bmad-quick-flow/quick-dev/steps/step-06-resolve-findings.md @@ -3,7 +3,7 @@ name: 'step-06-resolve-findings' description: 'Handle review findings interactively, apply fixes, update tech-spec with final status' workflow_path: '{project-root}/_bmad/bmm/workflows/bmad-quick-flow/quick-dev' -thisStepFile: '{workflow_path}/steps/step-06-resolve-findings.md' +thisStepFile: './step-06-resolve-findings.md' --- # Step 6: Resolve Findings diff --git a/src/modules/bmm/workflows/bmad-quick-flow/quick-dev/workflow.md b/src/modules/bmm/workflows/bmad-quick-flow/quick-dev/workflow.md index 1f0468ba..1c1d3038 100644 --- a/src/modules/bmm/workflows/bmad-quick-flow/quick-dev/workflow.md +++ b/src/modules/bmm/workflows/bmad-quick-flow/quick-dev/workflow.md @@ -28,8 +28,9 @@ This uses **step-file architecture** for focused execution: Load config from `{project-root}/_bmad/bmm/config.yaml` and resolve: - `user_name`, `communication_language`, `user_skill_level` -- `output_folder`, `sprint_artifacts` +- `output_folder`, `planning_artifacts`, `implementation_artifacts` - `date` as system-generated current datetime +- ✅ YOU MUST ALWAYS SPEAK OUTPUT In your Agent communication style with the config `{communication_language}` ### Paths @@ -39,10 +40,10 @@ Load config from `{project-root}/_bmad/bmm/config.yaml` and resolve: ### Related Workflows -- `create_tech_spec_workflow` = `{project-root}/_bmad/bmm/workflows/bmad-quick-flow/create-tech-spec/workflow.yaml` +- `quick_spec_workflow` = `{project-root}/_bmad/bmm/workflows/bmad-quick-flow/quick-spec/workflow.md` - `workflow_init` = `{project-root}/_bmad/bmm/workflows/workflow-status/init/workflow.yaml` - `party_mode_exec` = `{project-root}/_bmad/core/workflows/party-mode/workflow.md` -- `advanced_elicitation` = `{project-root}/_bmad/core/tasks/advanced-elicitation.xml` +- `advanced_elicitation` = `{project-root}/_bmad/core/workflows/advanced-elicitation/workflow.xml` --- diff --git a/src/modules/bmm/workflows/bmad-quick-flow/quick-spec/steps/step-01-understand.md b/src/modules/bmm/workflows/bmad-quick-flow/quick-spec/steps/step-01-understand.md new file mode 100644 index 00000000..c321dcc7 --- /dev/null +++ b/src/modules/bmm/workflows/bmad-quick-flow/quick-spec/steps/step-01-understand.md @@ -0,0 +1,189 @@ +--- +name: 'step-01-understand' +description: 'Analyze the requirement delta between current state and what user wants to build' + +workflow_path: '{project-root}/_bmad/bmm/workflows/bmad-quick-flow/create-tech-spec' +nextStepFile: './step-02-investigate.md' +skipToStepFile: './step-03-generate.md' +templateFile: '{workflow_path}/tech-spec-template.md' +wipFile: '{implementation_artifacts}/tech-spec-wip.md' +--- + +# Step 1: Analyze Requirement Delta + +**Progress: Step 1 of 4** - Next: Deep Investigation + +## RULES: + +- MUST NOT skip steps. +- MUST NOT optimize sequence. +- MUST follow exact instructions. +- MUST NOT look ahead to future steps. +- ✅ YOU MUST ALWAYS SPEAK OUTPUT In your Agent communication style with the config `{communication_language}` + +## CONTEXT: + +- Variables from `workflow.md` are available in memory. +- Focus: Define the technical requirement delta and scope. +- Investigation: Perform surface-level code scans ONLY to verify the delta. Reserve deep dives into implementation consequences for Step 2. +- Objective: Establish a verifiable delta between current state and target state. + +## SEQUENCE OF INSTRUCTIONS + +### 0. Check for Work in Progress + +a) **Before anything else, check if `{wipFile}` exists:** + +b) **IF WIP FILE EXISTS:** + +1. Read the frontmatter and extract: `title`, `slug`, `stepsCompleted` +2. Calculate progress: `lastStep = max(stepsCompleted)` +3. Present to user: + +``` +Hey {user_name}! Found a tech-spec in progress: + +**{title}** - Step {lastStep} of 4 complete + +Is this what you're here to continue? + +[y] Yes, pick up where I left off +[n] No, archive it and start something new +``` + +4. **HALT and wait for user selection.** + +a) **Menu Handling:** + +- **[y] Continue existing:** + - Jump directly to the appropriate step based on `stepsCompleted`: + - `[1]` → Load `{nextStepFile}` (Step 2) + - `[1, 2]` → Load `{skipToStepFile}` (Step 3) + - `[1, 2, 3]` → Load `./step-04-review.md` (Step 4) +- **[n] Archive and start fresh:** + - Rename `{wipFile}` to `{implementation_artifacts}/tech-spec-{slug}-archived-{date}.md` + +### 1. Greet and Ask for Initial Request + +a) **Greet the user briefly:** + +"Hey {user_name}! What are we building today?" + +b) **Get their initial description.** Don't ask detailed questions yet - just understand enough to know where to look. + +### 2. Quick Orient Scan + +a) **Before asking detailed questions, do a rapid scan to understand the landscape:** + +b) **Check for existing context docs:** + +- Check `{output_folder}` and `{planning_artifacts}`for planning documents (PRD, architecture, epics, research) +- Check for `**/project-context.md` - if it exists, skim for patterns and conventions +- Check for any existing stories or specs related to user's request + +c) **If user mentioned specific code/features, do a quick scan:** + +- Search for relevant files/classes/functions they mentioned +- Skim the structure (don't deep-dive yet - that's Step 2) +- Note: tech stack, obvious patterns, file locations + +d) **Build mental model:** + +- What's the likely landscape for this feature? +- What's the likely scope based on what you found? +- What questions do you NOW have, informed by the code? + +**This scan should take < 30 seconds. Just enough to ask smart questions.** + +### 3. Ask Informed Questions + +a) **Now ask clarifying questions - but make them INFORMED by what you found:** + +Instead of generic questions like "What's the scope?", ask specific ones like: +- "`AuthService` handles validation in the controller — should the new field follow that pattern or move it to a dedicated validator?" +- "`NavigationSidebar` component uses local state for the 'collapsed' toggle — should we stick with that or move it to the global store?" +- "The epics doc mentions X - is this related?" + +**Adapt to {user_skill_level}.** Technical users want technical questions. Non-technical users need translation. + +b) **If no existing code is found:** + +- Ask about intended architecture, patterns, constraints +- Ask what similar systems they'd like to emulate + +### 4. Capture Core Understanding + +a) **From the conversation, extract and confirm:** + +- **Title**: A clear, concise name for this work +- **Slug**: URL-safe version of title (lowercase, hyphens, no spaces) +- **Problem Statement**: What problem are we solving? +- **Solution**: High-level approach (1-2 sentences) +- **In Scope**: What's included +- **Out of Scope**: What's explicitly NOT included + +b) **Ask the user to confirm the captured understanding before proceeding.** + +### 5. Initialize WIP File + +a) **Create the tech-spec WIP file:** + +1. Copy template from `{templateFile}` +2. Write to `{wipFile}` +3. Update frontmatter with captured values: + ```yaml + --- + title: '{title}' + slug: '{slug}' + created: '{date}' + status: 'in-progress' + stepsCompleted: [1] + tech_stack: [] + files_to_modify: [] + code_patterns: [] + test_patterns: [] + --- + ``` +4. Fill in Overview section with Problem Statement, Solution, and Scope +5. Fill in Context for Development section with any technical preferences or constraints gathered during informed discovery. +6. Write the file + +b) **Report to user:** + +"Created: `{wipFile}` + +**Captured:** + +- Title: {title} +- Problem: {problem_statement_summary} +- Scope: {scope_summary}" + +### 6. Present Checkpoint Menu + +a) **Display menu:** + +``` +[a] Advanced Elicitation - dig deeper into requirements +[c] Continue - proceed to next step +[p] Party Mode - bring in other experts +``` + +b) **HALT and wait for user selection.** + +#### Menu Handling: + +- **[a]**: Load and execute `{advanced_elicitation}`, then return here and redisplay menu +- **[c]**: Load and execute `{nextStepFile}` (Map Technical Constraints) +- **[p]**: Load and execute `{party_mode_exec}`, then return here and redisplay menu + +--- + +## REQUIRED OUTPUTS: + +- MUST initialize WIP file with captured metadata. + +## VERIFICATION CHECKLIST: + +- [ ] WIP check performed FIRST before any greeting. +- [ ] `{wipFile}` created with correct frontmatter, Overview, Context for Development, and `stepsCompleted: [1]`. +- [ ] User selected [c] to continue. diff --git a/src/modules/bmm/workflows/bmad-quick-flow/quick-spec/steps/step-02-investigate.md b/src/modules/bmm/workflows/bmad-quick-flow/quick-spec/steps/step-02-investigate.md new file mode 100644 index 00000000..1cb2ee40 --- /dev/null +++ b/src/modules/bmm/workflows/bmad-quick-flow/quick-spec/steps/step-02-investigate.md @@ -0,0 +1,144 @@ +--- +name: 'step-02-investigate' +description: 'Map technical constraints and anchor points within the codebase' + +workflow_path: '{project-root}/_bmad/bmm/workflows/bmad-quick-flow/create-tech-spec' +nextStepFile: './step-03-generate.md' +wipFile: '{implementation_artifacts}/tech-spec-wip.md' +--- + +# Step 2: Map Technical Constraints & Anchor Points + +**Progress: Step 2 of 4** - Next: Generate Plan + +## RULES: + +- MUST NOT skip steps. +- MUST NOT optimize sequence. +- MUST follow exact instructions. +- MUST NOT generate the full spec yet (that's Step 3). +- ✅ YOU MUST ALWAYS SPEAK OUTPUT In your Agent communication style with the config `{communication_language}` + +## CONTEXT: + +- Requires `{wipFile}` from Step 1 with the "Problem Statement" defined. +- Focus: Map the problem statement to specific anchor points in the codebase. +- Output: Exact files to touch, classes/patterns to extend, and technical constraints identified. +- Objective: Provide the implementation-ready ground truth for the plan. + +## SEQUENCE OF INSTRUCTIONS + +### 1. Load Current State + +**Read `{wipFile}` and extract:** + +- Problem statement and scope from Overview section +- Any context gathered in Step 1 + +### 2. Execute Investigation Path + +**Universal Code Investigation:** + +_Isolate deep exploration in sub-agents/tasks where available. Return distilled summaries only to prevent context snowballing._ + +a) **Build on Step 1's Quick Scan** + +Review what was found in Step 1's orient scan. Then ask: + +"Based on my quick look, I see [files/patterns found]. Are there other files or directories I should investigate deeply?" + +b) **Read and Analyze Code** + +For each file/directory provided: + +- Read the complete file(s) +- Identify patterns, conventions, coding style +- Note dependencies and imports +- Find related test files + +**If NO relevant code is found (Clean Slate):** + +- Identify the target directory where the feature should live. +- Scan parent directories for architectural context. +- Identify standard project utilities or boilerplate that SHOULD be used. +- Document this as "Confirmed Clean Slate" - establishing that no legacy constraints exist. + + +c) **Document Technical Context** + +Capture and confirm with user: + +- **Tech Stack**: Languages, frameworks, libraries +- **Code Patterns**: Architecture patterns, naming conventions, file structure +- **Files to Modify/Create**: Specific files that will need changes or new files to be created +- **Test Patterns**: How tests are structured, test frameworks used + +d) **Look for project-context.md** + +If `**/project-context.md` exists and wasn't loaded in Step 1: + +- Load it now +- Extract patterns and conventions +- Note any rules that must be followed + +### 3. Update WIP File + +**Update `{wipFile}` frontmatter:** + +```yaml +--- +# ... existing frontmatter ... +stepsCompleted: [1, 2] +tech_stack: ['{captured_tech_stack}'] +files_to_modify: ['{captured_files}'] +code_patterns: ['{captured_patterns}'] +test_patterns: ['{captured_test_patterns}'] +--- +``` + +**Update the Context for Development section:** + +Fill in: + +- Codebase Patterns (from investigation) +- Files to Reference table (files reviewed) +- Technical Decisions (any decisions made during investigation) + +**Report to user:** + +"**Context Gathered:** + +- Tech Stack: {tech_stack_summary} +- Files to Modify: {files_count} files identified +- Patterns: {patterns_summary} +- Tests: {test_patterns_summary}" + +### 4. Present Checkpoint Menu + +**Display menu:** + +``` +[a] Advanced Elicitation - explore more context +[c] Continue - proceed to Generate Spec +[p] Party Mode - bring in other experts +``` + +**HALT and wait for user selection.** + +#### Menu Handling: + +- **[a]**: Load and execute `{advanced_elicitation}`, then return here and redisplay menu +- **[c]**: Verify frontmatter updated with `stepsCompleted: [1, 2]`, then load and execute `{nextStepFile}` +- **[p]**: Load and execute `{party_mode_exec}`, then return here and redisplay menu + +--- + +## REQUIRED OUTPUTS: + +- MUST document technical context (stack, patterns, files identified). +- MUST update `{wipFile}` with functional context. + +## VERIFICATION CHECKLIST: + +- [ ] Technical mapping performed and documented. +- [ ] `stepsCompleted: [1, 2]` set in frontmatter. diff --git a/src/modules/bmm/workflows/bmad-quick-flow/quick-spec/steps/step-03-generate.md b/src/modules/bmm/workflows/bmad-quick-flow/quick-spec/steps/step-03-generate.md new file mode 100644 index 00000000..4a33c7a1 --- /dev/null +++ b/src/modules/bmm/workflows/bmad-quick-flow/quick-spec/steps/step-03-generate.md @@ -0,0 +1,128 @@ +--- +name: 'step-03-generate' +description: 'Build the implementation plan based on the technical mapping of constraints' + +workflow_path: '{project-root}/_bmad/bmm/workflows/bmad-quick-flow/create-tech-spec' +nextStepFile: './step-04-review.md' +wipFile: '{implementation_artifacts}/tech-spec-wip.md' +--- + +# Step 3: Generate Implementation Plan + +**Progress: Step 3 of 4** - Next: Review & Finalize + +## RULES: + +- MUST NOT skip steps. +- MUST NOT optimize sequence. +- MUST follow exact instructions. +- MUST NOT implement anything - just document. +- ✅ YOU MUST ALWAYS SPEAK OUTPUT In your Agent communication style with the config `{communication_language}` + +## CONTEXT: + +- Requires `{wipFile}` with defined "Overview" and "Context for Development" sections. +- Focus: Create the implementation sequence that addresses the requirement delta using the captured technical context. +- Output: Implementation-ready tasks with specific files and instructions. +- Target: Meet the **READY FOR DEVELOPMENT** standard defined in `workflow.md`. + +## SEQUENCE OF INSTRUCTIONS + +### 1. Load Current State + +**Read `{wipFile}` completely and extract:** + +- All frontmatter values +- Overview section (Problem, Solution, Scope) +- Context for Development section (Patterns, Files, Decisions) + +### 2. Generate Implementation Plan + +Generate specific implementation tasks: + +a) **Task Breakdown** + +- Each task should be a discrete, completable unit of work +- Tasks should be ordered logically (dependencies first) +- Include the specific files to modify in each task +- Be explicit about what changes to make + +b) **Task Format** + +```markdown +- [ ] Task N: Clear action description + - File: `path/to/file.ext` + - Action: Specific change to make + - Notes: Any implementation details +``` + +### 3. Generate Acceptance Criteria + +**Create testable acceptance criteria:** + +Each AC should follow Given/When/Then format: + +```markdown +- [ ] AC N: Given [precondition], when [action], then [expected result] +``` + +**Ensure ACs cover:** + +- Happy path functionality +- Error handling +- Edge cases (if relevant) +- Integration points (if relevant) + +### 4. Complete Additional Context + +**Fill in remaining sections:** + +a) **Dependencies** + +- External libraries or services needed +- Other tasks or features this depends on +- API or data dependencies + +b) **Testing Strategy** + +- Unit tests needed +- Integration tests needed +- Manual testing steps + +c) **Notes** + +- High-risk items from pre-mortem analysis +- Known limitations +- Future considerations (out of scope but worth noting) + +### 5. Write Complete Spec + +a) **Update `{wipFile}` with all generated content:** + +- Ensure all template sections are filled in +- No placeholder text remaining +- All frontmatter values current +- Update status to 'review' (NOT 'ready-for-dev' - that happens after user review in Step 4) + +b) **Update frontmatter:** + +```yaml +--- +# ... existing values ... +status: 'review' +stepsCompleted: [1, 2, 3] +--- +``` + +c) **Load and execute `{nextStepFile}` (Step 4)** + +## REQUIRED OUTPUTS: + +- Tasks MUST be specific, actionable, ordered logically, with files to modify. +- ACs MUST be testable, using Given/When/Then format. +- Status MUST be updated to 'review'. + +## VERIFICATION CHECKLIST: + +- [ ] `stepsCompleted: [1, 2, 3]` set in frontmatter. +- [ ] Spec meets the **READY FOR DEVELOPMENT** standard. diff --git a/src/modules/bmm/workflows/bmad-quick-flow/quick-spec/steps/step-04-review.md b/src/modules/bmm/workflows/bmad-quick-flow/quick-spec/steps/step-04-review.md new file mode 100644 index 00000000..3e612d9b --- /dev/null +++ b/src/modules/bmm/workflows/bmad-quick-flow/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}`. + Review {finalFile} using {project-root}/_bmad/core/tasks/review-adversarial-general.xml + > **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. diff --git a/src/modules/bmm/workflows/bmad-quick-flow/quick-spec/tech-spec-template.md b/src/modules/bmm/workflows/bmad-quick-flow/quick-spec/tech-spec-template.md new file mode 100644 index 00000000..8d201149 --- /dev/null +++ b/src/modules/bmm/workflows/bmad-quick-flow/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} diff --git a/src/modules/bmm/workflows/bmad-quick-flow/quick-spec/workflow.md b/src/modules/bmm/workflows/bmad-quick-flow/quick-spec/workflow.md new file mode 100644 index 00000000..dcda8a91 --- /dev/null +++ b/src/modules/bmm/workflows/bmad-quick-flow/quick-spec/workflow.md @@ -0,0 +1,79 @@ +--- +name: quick-spec +description: Conversational spec engineering - ask questions, investigate code, produce implementation-ready tech-spec. +main_config: '{project-root}/_bmad/bmm/config.yaml' +web_bundle: true + +# Checkpoint handler paths +advanced_elicitation: '{project-root}/_bmad/core/workflows/advanced-elicitation/workflow.xml' +party_mode_exec: '{project-root}/_bmad/core/workflows/party-mode/workflow.md' +quick_dev_workflow: '{project-root}/_bmad/bmm/workflows/bmad-quick-flow/quick-dev/workflow.md' +--- + +# Quick-Spec Workflow + +**Goal:** Create implementation-ready technical specifications through conversational discovery, code investigation, and structured documentation. + +**READY FOR DEVELOPMENT STANDARD:** + +A specification is considered "Ready for Development" ONLY if it meets the following: + +- **Actionable**: Every task has a clear file path and specific action. +- **Logical**: Tasks are ordered by dependency (lowest level first). +- **Testable**: All ACs follow Given/When/Then and cover happy path and edge cases. +- **Complete**: All investigation results from Step 2 are inlined; no placeholders or "TBD". +- **Self-Contained**: A fresh agent can implement the feature without reading the workflow history. + +--- + +**Your Role:** You are an elite developer and spec engineer. You ask sharp questions, investigate existing code thoroughly, and produce specs that contain ALL context a fresh dev agent needs to implement the feature. No handoffs, no missing context - just complete, actionable specs. + +--- + +## WORKFLOW ARCHITECTURE + +This uses **step-file architecture** for disciplined execution: + +### Core Principles + +- **Micro-file Design**: Each step is a self-contained instruction file that must be followed exactly +- **Just-In-Time Loading**: Only the current step file is in memory - never load future step files until directed +- **Sequential Enforcement**: Sequence within step files must be completed in order, no skipping or optimization +- **State Tracking**: Document progress in output file frontmatter using `stepsCompleted` array +- **Append-Only Building**: Build the tech-spec by updating content as directed + +### Step Processing Rules + +1. **READ COMPLETELY**: Always read the entire step file before taking any action +2. **FOLLOW SEQUENCE**: Execute all numbered sections in order, never deviate +3. **WAIT FOR INPUT**: If a menu is presented, halt and wait for user selection +4. **CHECK CONTINUATION**: Only proceed to next step when user selects [c] (Continue) +5. **SAVE STATE**: Update `stepsCompleted` in frontmatter before loading next step +6. **LOAD NEXT**: When directed, load and read entire next step file, then execute + +### Critical Rules (NO EXCEPTIONS) + +- **NEVER** load multiple step files simultaneously +- **ALWAYS** read entire step file before execution +- **NEVER** skip steps or optimize the sequence +- **ALWAYS** update frontmatter of output file when completing a step +- **ALWAYS** follow the exact instructions in the step file +- **ALWAYS** halt at menus and wait for user input +- **NEVER** create mental todo lists from future steps + +--- + +## INITIALIZATION SEQUENCE + +### 1. Configuration Loading + +Load and read full config from `{main_config}` and resolve: + +- `project_name`, `output_folder`, `planning_artifacts`, `implementation_artifacts`, `user_name` +- `communication_language`, `document_output_language`, `user_skill_level` +- `date` as system-generated current datetime +- ✅ YOU MUST ALWAYS SPEAK OUTPUT In your Agent communication style with the config `{communication_language}` + +### 2. First Step Execution + +Load, read the full file, and then execute `steps/step-01-understand.md` to begin the workflow. diff --git a/src/modules/bmm/workflows/document-project/checklist.md b/src/modules/bmm/workflows/document-project/checklist.md index 636312b4..7b67d1e5 100644 --- a/src/modules/bmm/workflows/document-project/checklist.md +++ b/src/modules/bmm/workflows/document-project/checklist.md @@ -1,6 +1,6 @@ # Document Project Workflow - Validation Checklist -## Scan Level and Resumability (v1.2.0) +## Scan Level and Resumability - [ ] Scan level selection offered (quick/deep/exhaustive) for initial_scan and full_rescan modes - [ ] Deep-dive mode automatically uses exhaustive scan (no choice given) @@ -223,7 +223,7 @@ All items in the following sections must be checked: -- ✓ Scan Level and Resumability (v1.2.0) +- ✓ Scan Level and Resumability - ✓ Write-as-you-go Architecture - ✓ Batching Strategy (if deep/exhaustive scan) - ✓ Project Detection and Classification diff --git a/src/modules/bmm/workflows/excalidraw-diagrams/create-dataflow/instructions.md b/src/modules/bmm/workflows/excalidraw-diagrams/create-dataflow/instructions.md index 2902a8f6..30d32ed3 100644 --- a/src/modules/bmm/workflows/excalidraw-diagrams/create-dataflow/instructions.md +++ b/src/modules/bmm/workflows/excalidraw-diagrams/create-dataflow/instructions.md @@ -1,7 +1,7 @@ # Create Data Flow Diagram - Workflow Instructions ```xml -The workflow execution engine is governed by: {project_root}/_bmad/core/tasks/workflow.xml +The workflow execution engine is governed by: {project-root}/_bmad/core/tasks/workflow.xml You MUST have already loaded and processed: {installed_path}/workflow.yaml This workflow creates data flow diagrams (DFD) in Excalidraw format. diff --git a/src/modules/bmm/workflows/excalidraw-diagrams/create-diagram/instructions.md b/src/modules/bmm/workflows/excalidraw-diagrams/create-diagram/instructions.md index 1595bad1..407a76bf 100644 --- a/src/modules/bmm/workflows/excalidraw-diagrams/create-diagram/instructions.md +++ b/src/modules/bmm/workflows/excalidraw-diagrams/create-diagram/instructions.md @@ -1,7 +1,7 @@ # Create Diagram - Workflow Instructions ```xml -The workflow execution engine is governed by: {project_root}/_bmad/core/tasks/workflow.xml +The workflow execution engine is governed by: {project-root}/_bmad/core/tasks/workflow.xml You MUST have already loaded and processed: {installed_path}/workflow.yaml This workflow creates system architecture diagrams, ERDs, UML diagrams, or general technical diagrams in Excalidraw format. diff --git a/src/modules/bmm/workflows/excalidraw-diagrams/create-flowchart/instructions.md b/src/modules/bmm/workflows/excalidraw-diagrams/create-flowchart/instructions.md index b70607c7..74267905 100644 --- a/src/modules/bmm/workflows/excalidraw-diagrams/create-flowchart/instructions.md +++ b/src/modules/bmm/workflows/excalidraw-diagrams/create-flowchart/instructions.md @@ -1,7 +1,7 @@ # Create Flowchart - Workflow Instructions ```xml -The workflow execution engine is governed by: {project_root}/_bmad/core/tasks/workflow.xml +The workflow execution engine is governed by: {project-root}/_bmad/core/tasks/workflow.xml You MUST have already loaded and processed: {installed_path}/workflow.yaml This workflow creates a flowchart visualization in Excalidraw format for processes, pipelines, or logic flows. diff --git a/src/modules/bmm/workflows/excalidraw-diagrams/create-wireframe/instructions.md b/src/modules/bmm/workflows/excalidraw-diagrams/create-wireframe/instructions.md index cc727434..dc9506b0 100644 --- a/src/modules/bmm/workflows/excalidraw-diagrams/create-wireframe/instructions.md +++ b/src/modules/bmm/workflows/excalidraw-diagrams/create-wireframe/instructions.md @@ -1,7 +1,7 @@ # Create Wireframe - Workflow Instructions ```xml -The workflow execution engine is governed by: {project_root}/_bmad/core/tasks/workflow.xml +The workflow execution engine is governed by: {project-root}/_bmad/core/tasks/workflow.xml You MUST have already loaded and processed: {installed_path}/workflow.yaml This workflow creates website or app wireframes in Excalidraw format. diff --git a/src/modules/bmm/workflows/generate-project-context/steps/step-01-discover.md b/src/modules/bmm/workflows/generate-project-context/steps/step-01-discover.md index b14a13dc..fa36993d 100644 --- a/src/modules/bmm/workflows/generate-project-context/steps/step-01-discover.md +++ b/src/modules/bmm/workflows/generate-project-context/steps/step-01-discover.md @@ -8,6 +8,7 @@ - 💬 FOCUS on discovering existing project context and technology stack - 🎯 IDENTIFY critical implementation rules that AI agents need - ⚠️ ABSOLUTELY NO TIME ESTIMATES - AI development speed has fundamentally changed +- ✅ YOU MUST ALWAYS SPEAK OUTPUT In your Agent communication style with the config `{communication_language}` ## EXECUTION PROTOCOLS: diff --git a/src/modules/bmm/workflows/generate-project-context/steps/step-02-generate.md b/src/modules/bmm/workflows/generate-project-context/steps/step-02-generate.md index 587fb741..c2b428c5 100644 --- a/src/modules/bmm/workflows/generate-project-context/steps/step-02-generate.md +++ b/src/modules/bmm/workflows/generate-project-context/steps/step-02-generate.md @@ -8,6 +8,7 @@ - 💬 FOCUS on unobvious rules that AI agents need to be reminded of - 🎯 KEEP CONTENT LEAN - optimize for LLM context efficiency - ⚠️ ABSOLUTELY NO TIME ESTIMATES - AI development speed has fundamentally changed +- ✅ YOU MUST ALWAYS SPEAK OUTPUT In your Agent communication style with the config `{communication_language}` ## EXECUTION PROTOCOLS: @@ -28,7 +29,7 @@ This step will generate content and present choices for each rule category: ## PROTOCOL INTEGRATION: -- When 'A' selected: Execute {project-root}/_bmad/core/tasks/advanced-elicitation.xml +- When 'A' selected: Execute {project-root}/_bmad/core/workflows/advanced-elicitation/workflow.xml - When 'P' selected: Execute {project-root}/_bmad/core/workflows/party-mode - PROTOCOLS always return to display this step's A/P/C menu after the A or P have completed - User accepts/rejects protocol changes before proceeding diff --git a/src/modules/bmm/workflows/generate-project-context/steps/step-03-complete.md b/src/modules/bmm/workflows/generate-project-context/steps/step-03-complete.md index d7da5df7..85dd4db7 100644 --- a/src/modules/bmm/workflows/generate-project-context/steps/step-03-complete.md +++ b/src/modules/bmm/workflows/generate-project-context/steps/step-03-complete.md @@ -8,6 +8,7 @@ - 💬 FOCUS on finalizing a lean, LLM-optimized project context - 🎯 ENSURE all critical rules are captured and actionable - ⚠️ ABSOLUTELY NO TIME ESTIMATES - AI development speed has fundamentally changed +- ✅ YOU MUST ALWAYS SPEAK OUTPUT In your Agent communication style with the config `{communication_language}` ## EXECUTION PROTOCOLS: diff --git a/src/modules/bmm/workflows/generate-project-context/workflow.md b/src/modules/bmm/workflows/generate-project-context/workflow.md index db86e620..3f626d65 100644 --- a/src/modules/bmm/workflows/generate-project-context/workflow.md +++ b/src/modules/bmm/workflows/generate-project-context/workflow.md @@ -32,6 +32,7 @@ Load config from `{project-root}/_bmad/bmm/config.yaml` and resolve: - `project_name`, `output_folder`, `user_name` - `communication_language`, `document_output_language`, `user_skill_level` - `date` as system-generated current datetime +- ✅ YOU MUST ALWAYS SPEAK OUTPUT In your Agent communication style with the config `{communication_language}` ### Paths diff --git a/src/modules/bmm/workflows/testarch/test-design/instructions.md b/src/modules/bmm/workflows/testarch/test-design/instructions.md index 217d7c86..86561cfd 100644 --- a/src/modules/bmm/workflows/testarch/test-design/instructions.md +++ b/src/modules/bmm/workflows/testarch/test-design/instructions.md @@ -25,11 +25,11 @@ The workflow auto-detects which mode to use based on project phase. ### Mode Detection 1. **Check for sprint-status.yaml** - - If `{output_folder}/bmm-sprint-status.yaml` exists → **Epic-Level Mode** (Phase 4) + - If `{implementation_artifacts}/sprint-status.yaml` exists → **Epic-Level Mode** (Phase 4) - If NOT exists → Check workflow status 2. **Check workflow-status.yaml** - - Read `{output_folder}/bmm-workflow-status.yaml` + - Read `{planning_artifacts}/bmm-workflow-status.yaml` - If `implementation-readiness: required` or `implementation-readiness: recommended` → **System-Level Mode** (Phase 3) - Otherwise → **Epic-Level Mode** (Phase 4 without sprint status yet) diff --git a/src/modules/bmm/workflows/workflow-status/init/instructions.md b/src/modules/bmm/workflows/workflow-status/init/instructions.md index 51c1b6de..eeee90d9 100644 --- a/src/modules/bmm/workflows/workflow-status/init/instructions.md +++ b/src/modules/bmm/workflows/workflow-status/init/instructions.md @@ -15,8 +15,8 @@ - BMM artifacts: PRD, epics, architecture, UX, brief, research, brainstorm - Implementation: stories, sprint-status, workflow-status - Codebase: source directories, package files, git repo -- Check both {output_folder} and {implementation_artifacts} locations - +- Check both {planning_artifacts} and {implementation_artifacts} locations + Categorize into one of these states: @@ -25,7 +25,7 @@ - ACTIVE: Has stories or sprint status - LEGACY: Has code but no BMM artifacts - UNCLEAR: Mixed state needs clarification - + What's your project called? {{#if project_name}}(Config shows: {{project_name}}){{/if}} Store project_name @@ -68,7 +68,7 @@ Choice [1-4] Archive existing work? (y/n) - Move artifacts to {output_folder}/archive/ + Move artifacts to {planning_artifacts}/archive/ Ready for fresh start! Continue to step 3 @@ -323,10 +323,10 @@ Choice: Generate YAML from template with all variables - Save to {output_folder}/bmm-workflow-status.yaml + Save to {planning_artifacts}/bmm-workflow-status.yaml Identify next workflow and agent -✅ **Created:** {output_folder}/bmm-workflow-status.yaml +✅ **Created:** {planning_artifacts}/bmm-workflow-status.yaml **Next:** {{next_workflow_name}} **Agent:** {{next_agent}} diff --git a/src/modules/bmm/workflows/workflow-status/init/workflow.yaml b/src/modules/bmm/workflows/workflow-status/init/workflow.yaml index 63fe168c..5e1c7618 100644 --- a/src/modules/bmm/workflows/workflow-status/init/workflow.yaml +++ b/src/modules/bmm/workflows/workflow-status/init/workflow.yaml @@ -7,6 +7,7 @@ author: "BMad" config_source: "{project-root}/_bmad/bmm/config.yaml" output_folder: "{config_source}:output_folder" implementation_artifacts: "{config_source}:implementation_artifacts" +planning_artifacts: "{config_source}:planning_artifacts" user_name: "{config_source}:user_name" project_name: "{config_source}:project_name" communication_language: "{config_source}:communication_language" @@ -23,7 +24,7 @@ template: "{project-root}/_bmad/bmm/workflows/workflow-status/workflow-status-te path_files: "{project-root}/_bmad/bmm/workflows/workflow-status/paths/" # Output configuration -default_output_file: "{output_folder}/bmm-workflow-status.yaml" +default_output_file: "{planning_artifacts}/bmm-workflow-status.yaml" standalone: true web_bundle: false diff --git a/src/modules/bmm/workflows/workflow-status/instructions.md b/src/modules/bmm/workflows/workflow-status/instructions.md index 9c5b7723..6c25bdb1 100644 --- a/src/modules/bmm/workflows/workflow-status/instructions.md +++ b/src/modules/bmm/workflows/workflow-status/instructions.md @@ -34,7 +34,7 @@ -Search {output_folder}/ for file: bmm-workflow-status.yaml +Search {planning_artifacts}/ for file: bmm-workflow-status.yaml No workflow status found. @@ -197,7 +197,7 @@ Your choice: -Read {output_folder}/bmm-workflow-status.yaml if exists +Read {planning_artifacts}/bmm-workflow-status.yaml if exists status_exists = false @@ -261,7 +261,7 @@ Your choice: -Read {output_folder}/bmm-workflow-status.yaml if exists +Read {planning_artifacts}/bmm-workflow-status.yaml if exists status_exists = false @@ -309,7 +309,7 @@ Your choice: -Check if {output_folder}/bmm-workflow-status.yaml exists +Check if {planning_artifacts}/bmm-workflow-status.yaml exists status_exists = true @@ -325,7 +325,7 @@ Your choice: -Read {output_folder}/bmm-workflow-status.yaml +Read {planning_artifacts}/bmm-workflow-status.yaml success = false @@ -343,11 +343,11 @@ Your choice: Get {{workflow_id}} parameter (required) - Get {{output_file}} parameter (required - path to created file) + Get {{default_output_file}} parameter (required - path to created file) ONLY write the file path as the status value - no other text, notes, or metadata Update workflow status in YAML: - - In workflow_status section, update: {{workflow_id}}: {{output_file}} + - In workflow_status section, update: {{workflow_id}}: {{default_output_file}} Find {{workflow_id}} in loaded path YAML Determine next workflow from path sequence @@ -359,7 +359,7 @@ Your choice: next_workflow = {{determined next workflow}} next_agent = {{determined next agent from path file}} completed_workflow = {{workflow_id}} - output_file = {{output_file}} + default_output_file = {{default_output_file}} diff --git a/src/modules/bmm/workflows/workflow-status/paths/enterprise-brownfield.yaml b/src/modules/bmm/workflows/workflow-status/paths/enterprise-brownfield.yaml index 5064030d..738cc9c0 100644 --- a/src/modules/bmm/workflows/workflow-status/paths/enterprise-brownfield.yaml +++ b/src/modules/bmm/workflows/workflow-status/paths/enterprise-brownfield.yaml @@ -7,116 +7,97 @@ field_type: "brownfield" description: "Enterprise-grade planning for complex brownfield additions with extended requirements" phases: - - prerequisite: true + - phase: 0 name: "Documentation" conditional: "if_undocumented" - note: "NOT a phase - prerequisite for brownfield without docs (nearly mandatory for enterprise)" + note: "Prerequisite for brownfield without docs" workflows: - id: "document-project" required: true + workflow: "{project-root}/_bmad/bmm/workflows/document-project/workflow.yaml" agent: "analyst" - command: "document-project" + command: "/bmad:bmm:workflows:document-project" output: "Comprehensive project documentation" - purpose: "Understand existing codebase - critical for enterprise brownfield" - - - phase: 0 - name: "Discovery (Required)" - required: true - note: "Analysis phase required for enterprise projects" + purpose: "Understand existing codebase before planning" + - phase: 1 + name: "Analysis (Optional)" + optional: true + note: "User-selected during workflow-init" workflows: - id: "brainstorm-project" + exec: "{project-root}/_bmad/core/workflows/brainstorming/workflow.md" optional: true agent: "analyst" - command: "brainstorm-project" + command: "/bmad:bmm:workflows:brainstorming" + included_by: "user_choice" note: "Uses core brainstorming workflow with project context template" - included_by: "user_choice" - - id: "research" - recommended: true - agent: "analyst" - command: "research" - included_by: "user_choice" - note: "Highly recommended - compliance, integration, risk research" - - - id: "product-brief" + exec: "{project-root}/_bmad/bmm/workflows/1-analysis/research/workflow.md" optional: true agent: "analyst" - command: "product-brief" + command: "/bmad:bmm:workflows:research" included_by: "user_choice" - note: "Optional for brownfield enterprise" - - - phase: 1 + note: "Can have multiple research workflows" + - id: "product-brief" + exec: "{project-root}/_bmad/bmm/workflows/1-analysis/create-product-brief/workflow.md" + optional: true + agent: "analyst" + command: "/bmad:bmm:workflows:create-product-brief" + included_by: "user_choice" + note: "Recommended for greenfield Method projects" + - phase: 2 name: "Planning" required: true workflows: - id: "prd" + exec: "{project-root}/_bmad/bmm/workflows/2-plan-workflows/prd/workflow.md" required: true agent: "pm" - command: "prd" - output: "Enterprise PRD with compliance requirements" - note: "Must address existing system constraints and migration strategy" - + command: "/bmad:bmm:workflows:create-prd" + output: "Product Requirements Document with FRs and NFRs" - id: "create-ux-design" - recommended: true + conditional: "if_has_ui" + exec: "{project-root}/_bmad/bmm/workflows/2-plan-workflows/create-ux-design/workflow.md" agent: "ux-designer" - command: "create-ux-design" - note: "Recommended - must integrate with existing UX patterns" - - - phase: 2 + command: "/bmad:bmm:workflows:create-ux-design" + note: "Determined after PRD - user/agent decides if needed" + - phase: 3 name: "Solutioning" required: true workflows: - id: "create-architecture" required: true + exec: "{project-root}/_bmad/bmm/workflows/3-solutioning/create-architecture/workflow.md" agent: "architect" - command: "create-architecture" - output: "Integration architecture with enterprise considerations" - note: "Distills brownfield context + adds security/scalability/compliance design" - + command: "/bmad:bmm:workflows:create-architecture" + output: "System architecture document" + note: "Complete system design for greenfield projects" - id: "create-epics-and-stories" required: true + exec: "{project-root}/_bmad/bmm/workflows/3-solutioning/create-epics-and-stories/workflow.md" agent: "pm" - command: "create-epics-and-stories" + command: "/bmad:bmm:workflows:create-epics-and-stories" note: "Required: Break down PRD into implementable epics and stories with full context (PRD + UX + Architecture)" - - id: "test-design" - required: true + optional: true + workflow: "{project-root}/_bmad/bmm/workflows/testarch/test-design/workflow.yaml" agent: "tea" - command: "test-design" + command: "/bmad:bmm:workflows:test-design" output: "System-level testability review" - note: "Enterprise requires testability validation - auto-detects system-level mode" - - # - id: "create-security-architecture" - # optional: true - # agent: "architect" - # command: "create-security-architecture" - # output: "Security architecture for brownfield integration" - # note: "Future workflow - optional extended enterprise workflow for threat model, auth integration, audit requirements" - - # - id: "create-devops-strategy" - # optional: true - # agent: "architect" - # command: "create-devops-strategy" - # output: "DevOps strategy for brownfield deployment" - # note: "Future workflow - optional extended enterprise workflow for CI/CD integration, deployment strategy, monitoring" - - - id: "validate-architecture" - recommended: true - agent: "architect" - command: "validate-architecture" - + note: "Testability assessment before gate check - auto-detects system-level mode" - id: "implementation-readiness" required: true + exec: "{project-root}/_bmad/bmm/workflows/3-solutioning/check-implementation-readiness/workflow.md" agent: "architect" - command: "implementation-readiness" + command: "/bmad:bmm:workflows:implementation-readiness" note: "Validates PRD + Architecture + Epics + UX (optional)" - - - phase: 3 + - phase: 4 name: "Implementation" required: true workflows: - id: "sprint-planning" required: true + workflow: "{project-root}/_bmad/bmm/workflows/4-implementation/sprint-planning/workflow.yaml" agent: "sm" - command: "sprint-planning" - note: "Enterprise brownfield requires careful phasing and feature flags" + command: "/bmad:bmm:workflows:sprint-planning" + note: "Creates sprint plan - subsequent work tracked there" diff --git a/src/modules/bmm/workflows/workflow-status/paths/enterprise-greenfield.yaml b/src/modules/bmm/workflows/workflow-status/paths/enterprise-greenfield.yaml index 94757114..31d35244 100644 --- a/src/modules/bmm/workflows/workflow-status/paths/enterprise-greenfield.yaml +++ b/src/modules/bmm/workflows/workflow-status/paths/enterprise-greenfield.yaml @@ -7,104 +7,94 @@ field_type: "greenfield" description: "Complete enterprise-grade planning with security, devops, and test strategy" phases: - - phase: 0 - name: "Discovery (Required)" - required: true - note: "Analysis phase required for enterprise projects" + - phase: 1 + name: "Analysis (Optional)" + optional: true + note: "User-selected during workflow-init" workflows: - id: "brainstorm-project" + exec: "{project-root}/_bmad/core/workflows/brainstorming/workflow.md" optional: true agent: "analyst" - command: "brainstorm-project" - note: "Uses core brainstorming workflow with project context template" + command: "/bmad:bmm:workflows:brainstorming" included_by: "user_choice" + note: "Uses core brainstorming workflow with project context template" - id: "research" - recommended: true + exec: "{project-root}/_bmad/bmm/workflows/1-analysis/research/workflow.md" + optional: true agent: "analyst" - command: "research" + command: "/bmad:bmm:workflows:research" included_by: "user_choice" - note: "Highly recommended for enterprise - domain and compliance research" + note: "Can have multiple research workflows" - id: "product-brief" - recommended: true + exec: "{project-root}/_bmad/bmm/workflows/1-analysis/create-product-brief/workflow.md" + optional: true agent: "analyst" - command: "product-brief" + command: "/bmad:bmm:workflows:create-product-brief" included_by: "user_choice" - note: "Recommended for strategic alignment" + note: "Recommended for greenfield Method projects" - - phase: 1 + - phase: 2 name: "Planning" required: true workflows: - id: "prd" + exec: "{project-root}/_bmad/bmm/workflows/2-plan-workflows/prd/workflow.md" required: true agent: "pm" - command: "prd" - output: "Comprehensive Product Requirements Document" - note: "Enterprise-level requirements with compliance considerations" + command: "/bmad:bmm:workflows:create-prd" + output: "Product Requirements Document with FRs and NFRs" - id: "create-ux-design" - recommended: true + conditional: "if_has_ui" + exec: "{project-root}/_bmad/bmm/workflows/2-plan-workflows/create-ux-design/workflow.md" agent: "ux-designer" - command: "create-ux-design" - note: "Highly recommended for enterprise - design system and patterns" + command: "/bmad:bmm:workflows:create-ux-design" + note: "Determined after PRD - user/agent decides if needed" - - phase: 2 + - phase: 3 name: "Solutioning" required: true workflows: - id: "create-architecture" required: true + exec: "{project-root}/_bmad/bmm/workflows/3-solutioning/create-architecture/workflow.md" agent: "architect" - command: "create-architecture" - output: "Enterprise-grade system architecture" - note: "Includes scalability, multi-tenancy, integration architecture" - - - id: "test-design" - required: true - agent: "tea" - command: "test-design" - output: "System-level testability review" - note: "Enterprise requires testability validation - auto-detects system-level mode" - - # - id: "create-security-architecture" - # optional: true - # agent: "architect" - # command: "create-security-architecture" - # output: "Security architecture and threat model" - # note: "Future workflow - optional extended enterprise workflow for security design, auth, compliance" - - # - id: "create-devops-strategy" - # optional: true - # agent: "architect" - # command: "create-devops-strategy" - # output: "DevOps pipeline and infrastructure plan" - # note: "Future workflow - optional extended enterprise workflow for CI/CD, deployment, monitoring" - - - id: "validate-architecture" - recommended: true - agent: "architect" - command: "validate-architecture" + command: "/bmad:bmm:workflows:create-architecture" + output: "System architecture document" + note: "Complete system design for greenfield projects" - id: "create-epics-and-stories" required: true + exec: "{project-root}/_bmad/bmm/workflows/3-solutioning/create-epics-and-stories/workflow.md" agent: "pm" - command: "create-epics-and-stories" + command: "/bmad:bmm:workflows:create-epics-and-stories" note: "Required: Break down PRD into implementable epics and stories with full context (PRD + UX + Architecture)" + - id: "test-design" + optional: true + workflow: "{project-root}/_bmad/bmm/workflows/testarch/test-design/workflow.yaml" + agent: "tea" + command: "/bmad:bmm:workflows:test-design" + output: "System-level testability review" + note: "Testability assessment before gate check - auto-detects system-level mode" + - id: "implementation-readiness" required: true + exec: "{project-root}/_bmad/bmm/workflows/3-solutioning/check-implementation-readiness/workflow.md" agent: "architect" - command: "implementation-readiness" + command: "/bmad:bmm:workflows:implementation-readiness" note: "Validates PRD + Architecture + Epics + UX (optional)" - - phase: 3 + - phase: 4 name: "Implementation" required: true workflows: - id: "sprint-planning" required: true + workflow: "{project-root}/_bmad/bmm/workflows/4-implementation/sprint-planning/workflow.yaml" agent: "sm" - command: "sprint-planning" - note: "Creates sprint plan - enterprise projects may require phased rollout" + command: "/bmad:bmm:workflows:sprint-planning" + note: "Creates sprint plan - subsequent work tracked there" diff --git a/src/modules/bmm/workflows/workflow-status/paths/method-brownfield.yaml b/src/modules/bmm/workflows/workflow-status/paths/method-brownfield.yaml index 67ee6cd0..fa3aad67 100644 --- a/src/modules/bmm/workflows/workflow-status/paths/method-brownfield.yaml +++ b/src/modules/bmm/workflows/workflow-status/paths/method-brownfield.yaml @@ -7,100 +7,97 @@ field_type: "brownfield" description: "Complete product and system design for complex brownfield work" phases: - - prerequisite: true + - phase: 0 name: "Documentation" conditional: "if_undocumented" - note: "NOT a phase - prerequisite for brownfield without docs" + note: "Prerequisite for brownfield without docs" workflows: - id: "document-project" required: true + workflow: "{project-root}/_bmad/bmm/workflows/document-project/workflow.yaml" agent: "analyst" - command: "document-project" + command: "/bmad:bmm:workflows:document-project" output: "Comprehensive project documentation" purpose: "Understand existing codebase before planning" - - - phase: 0 - name: "Discovery (Optional)" + - phase: 1 + name: "Analysis (Optional)" optional: true note: "User-selected during workflow-init" workflows: - id: "brainstorm-project" + exec: "{project-root}/_bmad/core/workflows/brainstorming/workflow.md" optional: true agent: "analyst" - command: "brainstorm-project" + command: "/bmad:bmm:workflows:brainstorming" included_by: "user_choice" note: "Uses core brainstorming workflow with project context template" - - id: "research" + exec: "{project-root}/_bmad/bmm/workflows/1-analysis/research/workflow.md" optional: true agent: "analyst" - command: "research" + command: "/bmad:bmm:workflows:research" included_by: "user_choice" - + note: "Can have multiple research workflows" - id: "product-brief" + exec: "{project-root}/_bmad/bmm/workflows/1-analysis/create-product-brief/workflow.md" optional: true agent: "analyst" - command: "product-brief" + command: "/bmad:bmm:workflows:create-product-brief" included_by: "user_choice" - note: "Optional for brownfield, less common than greenfield" - - - phase: 1 + note: "Recommended for greenfield Method projects" + - phase: 2 name: "Planning" required: true workflows: - id: "prd" + exec: "{project-root}/_bmad/bmm/workflows/2-plan-workflows/prd/workflow.md" required: true agent: "pm" - command: "prd" - output: "PRD focused on new features/changes" - note: "Must consider existing system constraints" - + command: "/bmad:bmm:workflows:create-prd" + output: "Product Requirements Document with FRs and NFRs" - id: "create-ux-design" conditional: "if_has_ui" + exec: "{project-root}/_bmad/bmm/workflows/2-plan-workflows/create-ux-design/workflow.md" agent: "ux-designer" - command: "create-ux-design" - - - phase: 2 + command: "/bmad:bmm:workflows:create-ux-design" + note: "Determined after PRD - user/agent decides if needed" + - phase: 3 name: "Solutioning" required: true workflows: - id: "create-architecture" - recommended: true + required: true + exec: "{project-root}/_bmad/bmm/workflows/3-solutioning/create-architecture/workflow.md" agent: "architect" - command: "create-architecture" - output: "Integration architecture - solution design for THIS project" - note: "HIGHLY RECOMMENDED: Distills massive brownfield context into focused solution design. Prevents agent confusion." - + command: "/bmad:bmm:workflows:create-architecture" + output: "System architecture document" + note: "Complete system design for greenfield projects" - id: "create-epics-and-stories" required: true + exec: "{project-root}/_bmad/bmm/workflows/3-solutioning/create-epics-and-stories/workflow.md" agent: "pm" - command: "create-epics-and-stories" + command: "/bmad:bmm:workflows:create-epics-and-stories" note: "Required: Break down PRD into implementable epics and stories with full context (PRD + UX + Architecture)" - - id: "test-design" - recommended: true + optional: true + workflow: "{project-root}/_bmad/bmm/workflows/testarch/test-design/workflow.yaml" agent: "tea" - command: "test-design" + command: "/bmad:bmm:workflows:test-design" output: "System-level testability review" note: "Testability assessment before gate check - auto-detects system-level mode" - - - id: "validate-architecture" - optional: true - agent: "architect" - command: "validate-architecture" - - id: "implementation-readiness" required: true + exec: "{project-root}/_bmad/bmm/workflows/3-solutioning/check-implementation-readiness/workflow.md" agent: "architect" - command: "implementation-readiness" + command: "/bmad:bmm:workflows:implementation-readiness" note: "Validates PRD + Architecture + Epics + UX (optional)" - - - phase: 3 + - phase: 4 name: "Implementation" required: true workflows: - id: "sprint-planning" required: true + workflow: "{project-root}/_bmad/bmm/workflows/4-implementation/sprint-planning/workflow.yaml" agent: "sm" - command: "sprint-planning" - note: "Creates sprint plan with stories" + command: "/bmad:bmm:workflows:sprint-planning" + note: "Creates sprint plan - subsequent work tracked there" diff --git a/src/modules/bmm/workflows/workflow-status/paths/method-greenfield.yaml b/src/modules/bmm/workflows/workflow-status/paths/method-greenfield.yaml index aca183e9..2cb2195e 100644 --- a/src/modules/bmm/workflows/workflow-status/paths/method-greenfield.yaml +++ b/src/modules/bmm/workflows/workflow-status/paths/method-greenfield.yaml @@ -7,90 +7,94 @@ field_type: "greenfield" description: "Complete product and system design methodology for greenfield projects" phases: - - phase: 0 - name: "Discovery (Optional)" + - phase: 1 + name: "Analysis (Optional)" optional: true note: "User-selected during workflow-init" workflows: - id: "brainstorm-project" + exec: "{project-root}/_bmad/core/workflows/brainstorming/workflow.md" optional: true agent: "analyst" - command: "brainstorm-project" + command: "/bmad:bmm:workflows:brainstorming" included_by: "user_choice" note: "Uses core brainstorming workflow with project context template" - id: "research" + exec: "{project-root}/_bmad/bmm/workflows/1-analysis/research/workflow.md" optional: true agent: "analyst" - command: "research" + command: "/bmad:bmm:workflows:research" included_by: "user_choice" note: "Can have multiple research workflows" - id: "product-brief" + exec: "{project-root}/_bmad/bmm/workflows/1-analysis/create-product-brief/workflow.md" optional: true agent: "analyst" - command: "product-brief" + command: "/bmad:bmm:workflows:create-product-brief" included_by: "user_choice" note: "Recommended for greenfield Method projects" - - phase: 1 + - phase: 2 name: "Planning" required: true workflows: - id: "prd" + exec: "{project-root}/_bmad/bmm/workflows/2-plan-workflows/prd/workflow.md" required: true agent: "pm" - command: "prd" + command: "/bmad:bmm:workflows:create-prd" output: "Product Requirements Document with FRs and NFRs" - id: "create-ux-design" conditional: "if_has_ui" + exec: "{project-root}/_bmad/bmm/workflows/2-plan-workflows/create-ux-design/workflow.md" agent: "ux-designer" - command: "create-ux-design" + command: "/bmad:bmm:workflows:create-ux-design" note: "Determined after PRD - user/agent decides if needed" - - phase: 2 + - phase: 3 name: "Solutioning" required: true workflows: - id: "create-architecture" required: true + exec: "{project-root}/_bmad/bmm/workflows/3-solutioning/create-architecture/workflow.md" agent: "architect" - command: "create-architecture" + command: "/bmad:bmm:workflows:create-architecture" output: "System architecture document" note: "Complete system design for greenfield projects" - id: "create-epics-and-stories" required: true + exec: "{project-root}/_bmad/bmm/workflows/3-solutioning/create-epics-and-stories/workflow.md" agent: "pm" - command: "create-epics-and-stories" + command: "/bmad:bmm:workflows:create-epics-and-stories" note: "Required: Break down PRD into implementable epics and stories with full context (PRD + UX + Architecture)" - id: "test-design" - recommended: true + optional: true + workflow: "{project-root}/_bmad/bmm/workflows/testarch/test-design/workflow.yaml" agent: "tea" - command: "test-design" + command: "/bmad:bmm:workflows:test-design" output: "System-level testability review" note: "Testability assessment before gate check - auto-detects system-level mode" - - id: "validate-architecture" - optional: true - agent: "architect" - command: "validate-architecture" - note: "Quality check for architecture completeness" - - id: "implementation-readiness" required: true + exec: "{project-root}/_bmad/bmm/workflows/3-solutioning/check-implementation-readiness/workflow.md" agent: "architect" - command: "implementation-readiness" + command: "/bmad:bmm:workflows:implementation-readiness" note: "Validates PRD + Architecture + Epics + UX (optional)" - - phase: 3 + - phase: 4 name: "Implementation" required: true workflows: - id: "sprint-planning" required: true + workflow: "{project-root}/_bmad/bmm/workflows/4-implementation/sprint-planning/workflow.yaml" agent: "sm" - command: "sprint-planning" + command: "/bmad:bmm:workflows:sprint-planning" note: "Creates sprint plan - subsequent work tracked there" diff --git a/src/modules/cis/agents/brainstorming-coach.agent.yaml b/src/modules/cis/agents/brainstorming-coach.agent.yaml index fc2df635..c3ca20ee 100644 --- a/src/modules/cis/agents/brainstorming-coach.agent.yaml +++ b/src/modules/cis/agents/brainstorming-coach.agent.yaml @@ -7,6 +7,7 @@ agent: title: Elite Brainstorming Specialist icon: 🧠 module: cis + hasSidecar: false persona: role: Master Brainstorming Facilitator + Innovation Catalyst @@ -15,15 +16,6 @@ agent: principles: Psychological safety unlocks breakthroughs. Wild ideas today become innovations tomorrow. Humor and play are serious innovation tools. menu: - - trigger: brainstorm - workflow: "{project-root}/_bmad/core/workflows/brainstorming/workflow.yaml" - description: Guide me through Brainstorming any topic - - - trigger: party-mode - exec: "{project-root}/_bmad/core/workflows/party-mode/workflow.md" - description: Consult with other expert agents from the party - - - trigger: advanced-elicitation - exec: "{project-root}/_bmad/core/tasks/advanced-elicitation.xml" - description: Advanced elicitation techniques to challenge the LLM to get better results - web-only: true + - trigger: BS or fuzzy match on brainstorm + workflow: "{project-root}/_bmad/core/workflows/brainstorming/workflow.md" + description: "[BS] Guide me through Brainstorming any topic" diff --git a/src/modules/cis/agents/creative-problem-solver.agent.yaml b/src/modules/cis/agents/creative-problem-solver.agent.yaml index 9e30b37f..ec9b5d84 100644 --- a/src/modules/cis/agents/creative-problem-solver.agent.yaml +++ b/src/modules/cis/agents/creative-problem-solver.agent.yaml @@ -7,6 +7,7 @@ agent: title: Master Problem Solver icon: 🔬 module: cis + hasSidecar: false persona: role: Systematic Problem-Solving Expert + Solutions Architect @@ -15,15 +16,6 @@ agent: principles: Every problem is a system revealing weaknesses. Hunt for root causes relentlessly. The right question beats a fast answer. menu: - - trigger: solve + - trigger: PS or fuzzy match on problem-solving workflow: "{project-root}/_bmad/cis/workflows/problem-solving/workflow.yaml" - description: Apply systematic problem-solving methodologies - - - trigger: party-mode - exec: "{project-root}/_bmad/core/workflows/party-mode/workflow.md" - description: Consult with other expert agents from the party - - - trigger: advanced-elicitation - exec: "{project-root}/_bmad/core/tasks/advanced-elicitation.xml" - description: Advanced elicitation techniques to challenge the LLM to get better results - web-only: true + description: "[PS] Apply systematic problem-solving methodologies" diff --git a/src/modules/cis/agents/design-thinking-coach.agent.yaml b/src/modules/cis/agents/design-thinking-coach.agent.yaml index ac2c37b7..f71ecccc 100644 --- a/src/modules/cis/agents/design-thinking-coach.agent.yaml +++ b/src/modules/cis/agents/design-thinking-coach.agent.yaml @@ -7,6 +7,7 @@ agent: title: Design Thinking Maestro icon: 🎨 module: cis + hasSidecar: false persona: role: Human-Centered Design Expert + Empathy Architect @@ -15,15 +16,6 @@ agent: principles: Design is about THEM not us. Validate through real human interaction. Failure is feedback. Design WITH users not FOR them. menu: - - trigger: design + - trigger: DT or fuzzy match on design-thinking workflow: "{project-root}/_bmad/cis/workflows/design-thinking/workflow.yaml" - description: Guide human-centered design process - - - trigger: party-mode - exec: "{project-root}/_bmad/core/workflows/party-mode/workflow.md" - description: Consult with other expert agents from the party - - - trigger: advanced-elicitation - exec: "{project-root}/_bmad/core/tasks/advanced-elicitation.xml" - description: Advanced elicitation techniques to challenge the LLM to get better results - web-only: true + description: "[DT] Guide human-centered design process" diff --git a/src/modules/cis/agents/innovation-strategist.agent.yaml b/src/modules/cis/agents/innovation-strategist.agent.yaml index 7684ce3a..39dadf73 100644 --- a/src/modules/cis/agents/innovation-strategist.agent.yaml +++ b/src/modules/cis/agents/innovation-strategist.agent.yaml @@ -7,6 +7,7 @@ agent: title: Disruptive Innovation Oracle icon: ⚡ module: cis + hasSidecar: false persona: role: Business Model Innovator + Strategic Disruption Expert @@ -15,15 +16,6 @@ agent: principles: Markets reward genuine new value. Innovation without business model thinking is theater. Incremental thinking means obsolete. menu: - - trigger: innovate + - trigger: IS or fuzzy match on innovation-strategy workflow: "{project-root}/_bmad/cis/workflows/innovation-strategy/workflow.yaml" - description: Identify disruption opportunities and business model innovation - - - trigger: party-mode - exec: "{project-root}/_bmad/core/workflows/party-mode/workflow.md" - description: Consult with other expert agents from the party - - - trigger: advanced-elicitation - exec: "{project-root}/_bmad/core/tasks/advanced-elicitation.xml" - description: Advanced elicitation techniques to challenge the LLM to get better results - web-only: true + description: "[IS] Identify disruption opportunities and business model innovation" diff --git a/src/modules/cis/agents/presentation-master.agent.yaml b/src/modules/cis/agents/presentation-master.agent.yaml index 84e01bbd..96aa5935 100644 --- a/src/modules/cis/agents/presentation-master.agent.yaml +++ b/src/modules/cis/agents/presentation-master.agent.yaml @@ -7,6 +7,7 @@ agent: title: Visual Communication + Presentation Expert icon: 🎨 module: cis + hasSidecar: false persona: role: Visual Communication Expert + Presentation Designer + Educator @@ -23,39 +24,30 @@ agent: - Story structure applies everywhere - hook, build tension, deliver payoff menu: - - trigger: slide-deck + - trigger: SD or fuzzy match on slide-deck workflow: "todo" - description: Create multi-slide presentation with professional layouts and visual hierarchy + description: "[SD] Create multi-slide presentation with professional layouts and visual hierarchy" - - trigger: explainer + - trigger: EX or fuzzy match on youtube-explainer workflow: "todo" - description: Design YouTube/video explainer layout with visual script and engagement hooks + description: "[EX] Design YouTube/video explainer layout with visual script and engagement hooks" - - trigger: pitch-deck + - trigger: PD or fuzzy match on pitch-deck workflow: "todo" - description: Craft investor pitch presentation with data visualization and narrative arc + description: "[PD] Craft investor pitch presentation with data visualization and narrative arc" - - trigger: talk + - trigger: CT or fuzzy match on conference-talk workflow: "todo" - description: Build conference or workshop presentation materials with speaker notes + description: "[CT] Build conference talk or workshop presentation materials with speaker notes" - - trigger: infographic + - trigger: IN or fuzzy match on infographic workflow: "todo" - description: Design creative information visualization with visual storytelling + description: "[IN] Design creative information visualization with visual storytelling" - - trigger: visual-metaphor + - trigger: VM or fuzzy match on visual-metaphor workflow: "todo" - description: Create conceptual illustrations (Rube Goldberg machines, journey maps, creative processes) + description: "[VM] Create conceptual illustrations (Rube Goldberg machines, journey maps, creative processes)" - - trigger: concept-visual + - trigger: CV or fuzzy match on concept-visual workflow: "todo" - description: Generate single expressive image that explains ideas creatively and memorably - - - trigger: party-mode - exec: "{project-root}/_bmad/core/workflows/party-mode/workflow.md" - description: Consult with other expert agents from the party - - - trigger: advanced-elicitation - exec: "{project-root}/_bmad/core/tasks/advanced-elicitation.xml" - description: Advanced elicitation techniques to challenge the LLM to get better results - web-only: true + description: "[CV] Generate single expressive image that explains ideas creatively and memorably" diff --git a/src/modules/cis/agents/storyteller/storyteller.agent.yaml b/src/modules/cis/agents/storyteller/storyteller.agent.yaml index 3a1daeb7..102e2f31 100644 --- a/src/modules/cis/agents/storyteller/storyteller.agent.yaml +++ b/src/modules/cis/agents/storyteller/storyteller.agent.yaml @@ -20,15 +20,6 @@ agent: - "Load COMPLETE file {project-root}/_bmad/_memory/storyteller-sidecar/stories-told.md and review the history of stories created for this user" menu: - - trigger: story + - trigger: ST or fuzzy match on story exec: "{project-root}/_bmad/cis/workflows/storytelling/workflow.yaml" - description: Craft compelling narrative using proven frameworks - - - trigger: party-mode - exec: "{project-root}/_bmad/core/workflows/party-mode/workflow.md" - description: Consult with other expert agents from the party - - - trigger: advanced-elicitation - exec: "{project-root}/_bmad/core/tasks/advanced-elicitation.xml" - description: Advanced elicitation techniques to challenge the LLM to get better results - web-only: true + description: "[ST] Craft compelling narrative using proven frameworks" diff --git a/src/modules/cis/module.yaml b/src/modules/cis/module.yaml index f03960d0..02ce7ca9 100644 --- a/src/modules/cis/module.yaml +++ b/src/modules/cis/module.yaml @@ -4,6 +4,7 @@ header: "Creative Innovation Suite (CIS) Module" subheader: "No custom configuration required - uses Core settings only" default_selected: false # This module will not be selected by default for new installations + # Variables from Core Config inserted: ## user_name ## communication_language diff --git a/src/modules/cis/workflows/design-thinking/instructions.md b/src/modules/cis/workflows/design-thinking/instructions.md index a1812f6a..84090391 100644 --- a/src/modules/cis/workflows/design-thinking/instructions.md +++ b/src/modules/cis/workflows/design-thinking/instructions.md @@ -1,7 +1,7 @@ # Design Thinking Workflow Instructions -The workflow execution engine is governed by: {project_root}/_bmad/core/tasks/workflow.xml -You MUST have already loaded and processed: {project_root}/_bmad/cis/workflows/design-thinking/workflow.yaml +The workflow execution engine is governed by: {project-root}/_bmad/core/tasks/workflow.xml +You MUST have already loaded and processed: {project-root}/_bmad/cis/workflows/design-thinking/workflow.yaml Load and understand design methods from: {design_methods} ⚠️ ABSOLUTELY NO TIME ESTIMATES - NEVER mention hours, days, weeks, months, or ANY time-based predictions. AI has fundamentally changed development speed - what once took teams weeks/months can now be done by one person in hours. DO NOT give ANY time estimates whatsoever. ⚠️ CHECKPOINT PROTOCOL: After EVERY tag, you MUST follow workflow.xml substep 2c: SAVE content to file immediately → SHOW checkpoint separator (━━━━━━━━━━━━━━━━━━━━━━━) → DISPLAY generated content → PRESENT options [a]Advanced Elicitation/[c]Continue/[p]Party-Mode/[y]YOLO → WAIT for user response. Never batch saves or skip checkpoints. diff --git a/src/modules/cis/workflows/innovation-strategy/instructions.md b/src/modules/cis/workflows/innovation-strategy/instructions.md index cf0179a8..713da6e9 100644 --- a/src/modules/cis/workflows/innovation-strategy/instructions.md +++ b/src/modules/cis/workflows/innovation-strategy/instructions.md @@ -1,7 +1,7 @@ # Innovation Strategy Workflow Instructions -The workflow execution engine is governed by: {project_root}/_bmad/core/tasks/workflow.xml -You MUST have already loaded and processed: {project_root}/_bmad/cis/workflows/innovation-strategy/workflow.yaml +The workflow execution engine is governed by: {project-root}/_bmad/core/tasks/workflow.xml +You MUST have already loaded and processed: {project-root}/_bmad/cis/workflows/innovation-strategy/workflow.yaml Load and understand innovation frameworks from: {innovation_frameworks} ⚠️ ABSOLUTELY NO TIME ESTIMATES - NEVER mention hours, days, weeks, months, or ANY time-based predictions. AI has fundamentally changed development speed - what once took teams weeks/months can now be done by one person in hours. DO NOT give ANY time estimates whatsoever. ⚠️ CHECKPOINT PROTOCOL: After EVERY tag, you MUST follow workflow.xml substep 2c: SAVE content to file immediately → SHOW checkpoint separator (━━━━━━━━━━━━━━━━━━━━━━━) → DISPLAY generated content → PRESENT options [a]Advanced Elicitation/[c]Continue/[p]Party-Mode/[y]YOLO → WAIT for user response. Never batch saves or skip checkpoints. diff --git a/src/modules/cis/workflows/problem-solving/instructions.md b/src/modules/cis/workflows/problem-solving/instructions.md index c9ff9343..3d571898 100644 --- a/src/modules/cis/workflows/problem-solving/instructions.md +++ b/src/modules/cis/workflows/problem-solving/instructions.md @@ -1,7 +1,7 @@ # Problem Solving Workflow Instructions -The workflow execution engine is governed by: {project_root}/_bmad/core/tasks/workflow.xml -You MUST have already loaded and processed: {project_root}/_bmad/cis/workflows/problem-solving/workflow.yaml +The workflow execution engine is governed by: {project-root}/_bmad/core/tasks/workflow.xml +You MUST have already loaded and processed: {project-root}/_bmad/cis/workflows/problem-solving/workflow.yaml Load and understand solving methods from: {solving_methods} ⚠️ ABSOLUTELY NO TIME ESTIMATES - NEVER mention hours, days, weeks, months, or ANY time-based predictions. AI has fundamentally changed development speed - what once took teams weeks/months can now be done by one person in hours. DO NOT give ANY time estimates whatsoever. ⚠️ CHECKPOINT PROTOCOL: After EVERY tag, you MUST follow workflow.xml substep 2c: SAVE content to file immediately → SHOW checkpoint separator (━━━━━━━━━━━━━━━━━━━━━━━) → DISPLAY generated content → PRESENT options [a]Advanced Elicitation/[c]Continue/[p]Party-Mode/[y]YOLO → WAIT for user response. Never batch saves or skip checkpoints. diff --git a/src/modules/cis/workflows/storytelling/instructions.md b/src/modules/cis/workflows/storytelling/instructions.md index 0c0fcbe3..f67dd101 100644 --- a/src/modules/cis/workflows/storytelling/instructions.md +++ b/src/modules/cis/workflows/storytelling/instructions.md @@ -3,8 +3,8 @@ ## Workflow -The workflow execution engine is governed by: {project_root}/_bmad/core/tasks/workflow.xml -You MUST have already loaded and processed: {project_root}/_bmad/cis/workflows/storytelling/workflow.yaml +The workflow execution engine is governed by: {project-root}/_bmad/core/tasks/workflow.xml +You MUST have already loaded and processed: {project-root}/_bmad/cis/workflows/storytelling/workflow.yaml Communicate all responses in {communication_language} ⚠️ ABSOLUTELY NO TIME ESTIMATES - NEVER mention hours, days, weeks, months, or ANY time-based predictions. AI has fundamentally changed development speed - what once took teams weeks/months can now be done by one person in hours. DO NOT give ANY time estimates whatsoever. ⚠️ CHECKPOINT PROTOCOL: After EVERY tag, you MUST follow workflow.xml substep 2c: SAVE content to file immediately → SHOW checkpoint separator (━━━━━━━━━━━━━━━━━━━━━━━) → DISPLAY generated content → PRESENT options [a]Advanced Elicitation/[c]Continue/[p]Party-Mode/[y]YOLO → WAIT for user response. Never batch saves or skip checkpoints. diff --git a/test/fixtures/agent-schema/invalid/critical-actions/actions-as-string.agent.yaml b/test/fixtures/agent-schema/invalid/critical-actions/actions-as-string.agent.yaml index d8113382..46396e0f 100644 --- a/test/fixtures/agent-schema/invalid/critical-actions/actions-as-string.agent.yaml +++ b/test/fixtures/agent-schema/invalid/critical-actions/actions-as-string.agent.yaml @@ -10,6 +10,7 @@ agent: name: Actions String title: Actions String icon: ❌ + hasSidecar: false persona: role: Test agent diff --git a/test/fixtures/agent-schema/invalid/critical-actions/empty-string-in-actions.agent.yaml b/test/fixtures/agent-schema/invalid/critical-actions/empty-string-in-actions.agent.yaml index 1ebbc192..3a87232c 100644 --- a/test/fixtures/agent-schema/invalid/critical-actions/empty-string-in-actions.agent.yaml +++ b/test/fixtures/agent-schema/invalid/critical-actions/empty-string-in-actions.agent.yaml @@ -10,6 +10,7 @@ agent: name: Empty Action String title: Empty Action String icon: ❌ + hasSidecar: false persona: role: Test agent diff --git a/test/fixtures/agent-schema/invalid/menu-commands/empty-command-target.agent.yaml b/test/fixtures/agent-schema/invalid/menu-commands/empty-command-target.agent.yaml index 946b369f..0194c402 100644 --- a/test/fixtures/agent-schema/invalid/menu-commands/empty-command-target.agent.yaml +++ b/test/fixtures/agent-schema/invalid/menu-commands/empty-command-target.agent.yaml @@ -10,6 +10,7 @@ agent: name: Empty Command Target title: Empty Command icon: ❌ + hasSidecar: false persona: role: Test agent diff --git a/test/fixtures/agent-schema/invalid/menu-commands/no-command-target.agent.yaml b/test/fixtures/agent-schema/invalid/menu-commands/no-command-target.agent.yaml index ccb50dbc..888e2d36 100644 --- a/test/fixtures/agent-schema/invalid/menu-commands/no-command-target.agent.yaml +++ b/test/fixtures/agent-schema/invalid/menu-commands/no-command-target.agent.yaml @@ -10,6 +10,7 @@ agent: name: No Command Target title: No Command icon: ❌ + hasSidecar: false persona: role: Test agent diff --git a/test/fixtures/agent-schema/invalid/menu-triggers/camel-case.agent.yaml b/test/fixtures/agent-schema/invalid/menu-triggers/camel-case.agent.yaml index 551371eb..62fbb313 100644 --- a/test/fixtures/agent-schema/invalid/menu-triggers/camel-case.agent.yaml +++ b/test/fixtures/agent-schema/invalid/menu-triggers/camel-case.agent.yaml @@ -10,6 +10,7 @@ agent: name: CamelCase Trigger title: CamelCase icon: ❌ + hasSidecar: false persona: role: Test agent diff --git a/test/fixtures/agent-schema/invalid/menu-triggers/compound-invalid-format.agent.yaml b/test/fixtures/agent-schema/invalid/menu-triggers/compound-invalid-format.agent.yaml index 7d511299..07a550f4 100644 --- a/test/fixtures/agent-schema/invalid/menu-triggers/compound-invalid-format.agent.yaml +++ b/test/fixtures/agent-schema/invalid/menu-triggers/compound-invalid-format.agent.yaml @@ -10,6 +10,7 @@ agent: name: Invalid Format title: Invalid Format Test icon: 🧪 + hasSidecar: false persona: role: Test agent diff --git a/test/fixtures/agent-schema/invalid/menu-triggers/compound-mismatched-kebab.agent.yaml b/test/fixtures/agent-schema/invalid/menu-triggers/compound-mismatched-kebab.agent.yaml index 3208b39f..46febb32 100644 --- a/test/fixtures/agent-schema/invalid/menu-triggers/compound-mismatched-kebab.agent.yaml +++ b/test/fixtures/agent-schema/invalid/menu-triggers/compound-mismatched-kebab.agent.yaml @@ -1,15 +1,16 @@ -# Test: Compound trigger with mismatched kebab portions +# Test: Compound trigger with old format (no longer supported) # Expected: FAIL # Error code: custom # Error path: agent.menu[0].trigger -# Error message: agent.menu[].trigger compound format error: kebab-case trigger mismatch: "tech-spec" vs "other-thing" +# Error message: agent.menu[].trigger compound format error: invalid compound trigger format agent: metadata: id: compound-mismatched-kebab - name: Mismatched Kebab - title: Mismatched Kebab Test + name: Old Format + title: Old Format Test icon: 🧪 + hasSidecar: false persona: role: Test agent @@ -19,6 +20,6 @@ agent: - Test principle menu: - - trigger: TS or tech-spec or fuzzy match on other-thing - description: Kebab portions do not match + - trigger: TS or tech-spec or fuzzy match on tech-spec + description: Old format with middle kebab-case (no longer supported) action: test diff --git a/test/fixtures/agent-schema/invalid/menu-triggers/compound-wrong-shortcut.agent.yaml b/test/fixtures/agent-schema/invalid/menu-triggers/compound-wrong-shortcut.agent.yaml deleted file mode 100644 index aa73e8ae..00000000 --- a/test/fixtures/agent-schema/invalid/menu-triggers/compound-wrong-shortcut.agent.yaml +++ /dev/null @@ -1,24 +0,0 @@ -# Test: Compound trigger with wrong shortcut -# Expected: FAIL -# Error code: custom -# Error path: agent.menu[0].trigger -# Error message: agent.menu[].trigger compound format error: shortcut "XX" does not match expected "TS" for "tech-spec" - -agent: - metadata: - id: compound-wrong-shortcut - name: Wrong Shortcut - title: Wrong Shortcut Test - icon: 🧪 - - persona: - role: Test agent - identity: Test identity - communication_style: Test style - principles: - - Test principle - - menu: - - trigger: XX or tech-spec or fuzzy match on tech-spec - description: Shortcut does not match kebab trigger - action: test diff --git a/test/fixtures/agent-schema/invalid/menu-triggers/duplicate-triggers.agent.yaml b/test/fixtures/agent-schema/invalid/menu-triggers/duplicate-triggers.agent.yaml index bbc03b8c..8b5cf7c8 100644 --- a/test/fixtures/agent-schema/invalid/menu-triggers/duplicate-triggers.agent.yaml +++ b/test/fixtures/agent-schema/invalid/menu-triggers/duplicate-triggers.agent.yaml @@ -10,6 +10,7 @@ agent: name: Duplicate Triggers title: Duplicate icon: ❌ + hasSidecar: false persona: role: Test agent diff --git a/test/fixtures/agent-schema/invalid/menu-triggers/empty-trigger.agent.yaml b/test/fixtures/agent-schema/invalid/menu-triggers/empty-trigger.agent.yaml index 37c3c572..c6d9fbfa 100644 --- a/test/fixtures/agent-schema/invalid/menu-triggers/empty-trigger.agent.yaml +++ b/test/fixtures/agent-schema/invalid/menu-triggers/empty-trigger.agent.yaml @@ -10,6 +10,7 @@ agent: name: Empty Trigger title: Empty icon: ❌ + hasSidecar: false persona: role: Test agent diff --git a/test/fixtures/agent-schema/invalid/menu-triggers/leading-asterisk.agent.yaml b/test/fixtures/agent-schema/invalid/menu-triggers/leading-asterisk.agent.yaml index 856b6c84..5e958596 100644 --- a/test/fixtures/agent-schema/invalid/menu-triggers/leading-asterisk.agent.yaml +++ b/test/fixtures/agent-schema/invalid/menu-triggers/leading-asterisk.agent.yaml @@ -10,6 +10,7 @@ agent: name: Asterisk Trigger title: Asterisk icon: ❌ + hasSidecar: false persona: role: Test agent diff --git a/test/fixtures/agent-schema/invalid/menu-triggers/snake-case.agent.yaml b/test/fixtures/agent-schema/invalid/menu-triggers/snake-case.agent.yaml index 7cee63d1..7dc17793 100644 --- a/test/fixtures/agent-schema/invalid/menu-triggers/snake-case.agent.yaml +++ b/test/fixtures/agent-schema/invalid/menu-triggers/snake-case.agent.yaml @@ -10,6 +10,7 @@ agent: name: Snake Case Trigger title: Snake Case icon: ❌ + hasSidecar: false persona: role: Test agent diff --git a/test/fixtures/agent-schema/invalid/menu-triggers/trigger-with-spaces.agent.yaml b/test/fixtures/agent-schema/invalid/menu-triggers/trigger-with-spaces.agent.yaml index b665ed43..b64a406d 100644 --- a/test/fixtures/agent-schema/invalid/menu-triggers/trigger-with-spaces.agent.yaml +++ b/test/fixtures/agent-schema/invalid/menu-triggers/trigger-with-spaces.agent.yaml @@ -10,6 +10,7 @@ agent: name: Spaces Trigger title: Spaces icon: ❌ + hasSidecar: false persona: role: Test agent diff --git a/test/fixtures/agent-schema/invalid/menu/empty-menu.agent.yaml b/test/fixtures/agent-schema/invalid/menu/empty-menu.agent.yaml index 3a9d5e7e..b5be54ef 100644 --- a/test/fixtures/agent-schema/invalid/menu/empty-menu.agent.yaml +++ b/test/fixtures/agent-schema/invalid/menu/empty-menu.agent.yaml @@ -10,6 +10,7 @@ agent: name: Empty Menu title: Empty Menu icon: ❌ + hasSidecar: false persona: role: Test agent diff --git a/test/fixtures/agent-schema/invalid/menu/missing-menu.agent.yaml b/test/fixtures/agent-schema/invalid/menu/missing-menu.agent.yaml index 1816f737..55e7789a 100644 --- a/test/fixtures/agent-schema/invalid/menu/missing-menu.agent.yaml +++ b/test/fixtures/agent-schema/invalid/menu/missing-menu.agent.yaml @@ -10,6 +10,7 @@ agent: name: Missing Menu title: Missing Menu icon: ❌ + hasSidecar: false persona: role: Test agent diff --git a/test/fixtures/agent-schema/invalid/metadata/extra-metadata-fields.agent.yaml b/test/fixtures/agent-schema/invalid/metadata/extra-metadata-fields.agent.yaml index ede4aed5..10f283d5 100644 --- a/test/fixtures/agent-schema/invalid/metadata/extra-metadata-fields.agent.yaml +++ b/test/fixtures/agent-schema/invalid/metadata/extra-metadata-fields.agent.yaml @@ -10,6 +10,7 @@ agent: name: Extra Fields title: Extra Fields icon: ❌ + hasSidecar: false unknown_field: This is not allowed another_extra: Also invalid diff --git a/test/fixtures/agent-schema/invalid/metadata/module-agent-missing-module.agent.yaml b/test/fixtures/agent-schema/invalid/metadata/module-agent-missing-module.agent.yaml deleted file mode 100644 index bf5b6043..00000000 --- a/test/fixtures/agent-schema/invalid/metadata/module-agent-missing-module.agent.yaml +++ /dev/null @@ -1,25 +0,0 @@ -# Test: Module agent missing required module field -# Expected: FAIL -# Error code: custom -# Error path: agent.metadata.module -# Error message: module-scoped agents must declare agent.metadata.module -# Path context: src/modules/bmm/agents/module-agent-missing-module.agent.yaml - -agent: - metadata: - id: bmm-missing-module - name: BMM Missing Module - title: Missing Module - icon: ❌ - - persona: - role: Test agent - identity: Test identity - communication_style: Test style - principles: - - Test principle - - menu: - - trigger: help - description: Show help - action: display_help diff --git a/test/fixtures/agent-schema/invalid/metadata/wrong-module-value.agent.yaml b/test/fixtures/agent-schema/invalid/metadata/wrong-module-value.agent.yaml deleted file mode 100644 index df266693..00000000 --- a/test/fixtures/agent-schema/invalid/metadata/wrong-module-value.agent.yaml +++ /dev/null @@ -1,26 +0,0 @@ -# Test: Module agent with wrong module value -# Expected: FAIL -# Error code: custom -# Error path: agent.metadata.module -# Error message: agent.metadata.module must equal "bmm" -# Path context: src/modules/bmm/agents/wrong-module-value.agent.yaml - -agent: - metadata: - id: wrong-module - name: Wrong Module - title: Wrong Module - icon: ❌ - module: cis - - persona: - role: Test agent - identity: Test identity - communication_style: Test style - principles: - - Test principle - - menu: - - trigger: help - description: Show help - action: display_help diff --git a/test/fixtures/agent-schema/invalid/persona/empty-principles-array.agent.yaml b/test/fixtures/agent-schema/invalid/persona/empty-principles-array.agent.yaml index 0a09d7e2..4033e690 100644 --- a/test/fixtures/agent-schema/invalid/persona/empty-principles-array.agent.yaml +++ b/test/fixtures/agent-schema/invalid/persona/empty-principles-array.agent.yaml @@ -10,6 +10,7 @@ agent: name: Empty Principles title: Empty Principles icon: ❌ + hasSidecar: false persona: role: Test agent diff --git a/test/fixtures/agent-schema/invalid/persona/empty-string-in-principles.agent.yaml b/test/fixtures/agent-schema/invalid/persona/empty-string-in-principles.agent.yaml index 73a6393f..9bba71bb 100644 --- a/test/fixtures/agent-schema/invalid/persona/empty-string-in-principles.agent.yaml +++ b/test/fixtures/agent-schema/invalid/persona/empty-string-in-principles.agent.yaml @@ -10,6 +10,7 @@ agent: name: Empty Principle String title: Empty Principle icon: ❌ + hasSidecar: false persona: role: Test agent diff --git a/test/fixtures/agent-schema/invalid/persona/extra-persona-fields.agent.yaml b/test/fixtures/agent-schema/invalid/persona/extra-persona-fields.agent.yaml index 60c9ae6e..73365a5e 100644 --- a/test/fixtures/agent-schema/invalid/persona/extra-persona-fields.agent.yaml +++ b/test/fixtures/agent-schema/invalid/persona/extra-persona-fields.agent.yaml @@ -10,6 +10,7 @@ agent: name: Extra Persona Fields title: Extra Persona icon: ❌ + hasSidecar: false persona: role: Test agent diff --git a/test/fixtures/agent-schema/invalid/persona/missing-role.agent.yaml b/test/fixtures/agent-schema/invalid/persona/missing-role.agent.yaml index 17e99767..3dbd6c45 100644 --- a/test/fixtures/agent-schema/invalid/persona/missing-role.agent.yaml +++ b/test/fixtures/agent-schema/invalid/persona/missing-role.agent.yaml @@ -10,6 +10,7 @@ agent: name: Missing Role title: Missing Role icon: ❌ + hasSidecar: false persona: identity: Test identity diff --git a/test/fixtures/agent-schema/invalid/prompts/empty-content.agent.yaml b/test/fixtures/agent-schema/invalid/prompts/empty-content.agent.yaml index 1bb4a191..3248edca 100644 --- a/test/fixtures/agent-schema/invalid/prompts/empty-content.agent.yaml +++ b/test/fixtures/agent-schema/invalid/prompts/empty-content.agent.yaml @@ -10,6 +10,7 @@ agent: name: Empty Content title: Empty Content icon: ❌ + hasSidecar: false persona: role: Test agent diff --git a/test/fixtures/agent-schema/invalid/prompts/extra-prompt-fields.agent.yaml b/test/fixtures/agent-schema/invalid/prompts/extra-prompt-fields.agent.yaml index d90173c5..aeccee29 100644 --- a/test/fixtures/agent-schema/invalid/prompts/extra-prompt-fields.agent.yaml +++ b/test/fixtures/agent-schema/invalid/prompts/extra-prompt-fields.agent.yaml @@ -10,6 +10,7 @@ agent: name: Extra Prompt Fields title: Extra Fields icon: ❌ + hasSidecar: false persona: role: Test agent diff --git a/test/fixtures/agent-schema/invalid/prompts/missing-content.agent.yaml b/test/fixtures/agent-schema/invalid/prompts/missing-content.agent.yaml index 196660e7..7f31723b 100644 --- a/test/fixtures/agent-schema/invalid/prompts/missing-content.agent.yaml +++ b/test/fixtures/agent-schema/invalid/prompts/missing-content.agent.yaml @@ -10,6 +10,7 @@ agent: name: Prompt Missing Content title: Missing Content icon: ❌ + hasSidecar: false persona: role: Test agent diff --git a/test/fixtures/agent-schema/invalid/prompts/missing-id.agent.yaml b/test/fixtures/agent-schema/invalid/prompts/missing-id.agent.yaml index 764cc221..f05f054a 100644 --- a/test/fixtures/agent-schema/invalid/prompts/missing-id.agent.yaml +++ b/test/fixtures/agent-schema/invalid/prompts/missing-id.agent.yaml @@ -10,6 +10,7 @@ agent: name: Prompt Missing ID title: Missing ID icon: ❌ + hasSidecar: false persona: role: Test agent diff --git a/test/fixtures/agent-schema/invalid/top-level/extra-top-level-keys.agent.yaml b/test/fixtures/agent-schema/invalid/top-level/extra-top-level-keys.agent.yaml index be8cac4e..cc888a51 100644 --- a/test/fixtures/agent-schema/invalid/top-level/extra-top-level-keys.agent.yaml +++ b/test/fixtures/agent-schema/invalid/top-level/extra-top-level-keys.agent.yaml @@ -10,6 +10,7 @@ agent: name: Extra Test Agent title: Extra Test icon: 🧪 + hasSidecar: false persona: role: Test agent diff --git a/test/fixtures/agent-schema/valid/critical-actions/empty-critical-actions.agent.yaml b/test/fixtures/agent-schema/valid/critical-actions/empty-critical-actions.agent.yaml index 9f2502da..dc73477f 100644 --- a/test/fixtures/agent-schema/valid/critical-actions/empty-critical-actions.agent.yaml +++ b/test/fixtures/agent-schema/valid/critical-actions/empty-critical-actions.agent.yaml @@ -7,6 +7,7 @@ agent: name: Empty Critical Actions title: Empty Critical Actions icon: 🧪 + hasSidecar: false persona: role: Test agent with empty critical actions diff --git a/test/fixtures/agent-schema/valid/critical-actions/no-critical-actions.agent.yaml b/test/fixtures/agent-schema/valid/critical-actions/no-critical-actions.agent.yaml index 8bd30141..2df52f7f 100644 --- a/test/fixtures/agent-schema/valid/critical-actions/no-critical-actions.agent.yaml +++ b/test/fixtures/agent-schema/valid/critical-actions/no-critical-actions.agent.yaml @@ -7,6 +7,7 @@ agent: name: No Critical Actions title: No Critical Actions icon: 🧪 + hasSidecar: false persona: role: Test agent without critical actions diff --git a/test/fixtures/agent-schema/valid/critical-actions/valid-critical-actions.agent.yaml b/test/fixtures/agent-schema/valid/critical-actions/valid-critical-actions.agent.yaml index fca1acbe..198bc835 100644 --- a/test/fixtures/agent-schema/valid/critical-actions/valid-critical-actions.agent.yaml +++ b/test/fixtures/agent-schema/valid/critical-actions/valid-critical-actions.agent.yaml @@ -7,6 +7,7 @@ agent: name: Valid Critical Actions title: Valid Critical Actions icon: 🧪 + hasSidecar: false persona: role: Test agent with critical actions diff --git a/test/fixtures/agent-schema/valid/menu-commands/all-command-types.agent.yaml b/test/fixtures/agent-schema/valid/menu-commands/all-command-types.agent.yaml index eaa2a891..959085cb 100644 --- a/test/fixtures/agent-schema/valid/menu-commands/all-command-types.agent.yaml +++ b/test/fixtures/agent-schema/valid/menu-commands/all-command-types.agent.yaml @@ -7,6 +7,7 @@ agent: name: All Command Types title: All Commands icon: 🧪 + hasSidecar: false persona: role: Test agent with all command types diff --git a/test/fixtures/agent-schema/valid/menu-commands/multiple-commands.agent.yaml b/test/fixtures/agent-schema/valid/menu-commands/multiple-commands.agent.yaml index fe5396c8..945722b5 100644 --- a/test/fixtures/agent-schema/valid/menu-commands/multiple-commands.agent.yaml +++ b/test/fixtures/agent-schema/valid/menu-commands/multiple-commands.agent.yaml @@ -7,6 +7,7 @@ agent: name: Multiple Commands title: Multiple Commands icon: 🧪 + hasSidecar: false persona: role: Test agent with multiple command targets diff --git a/test/fixtures/agent-schema/valid/menu-triggers/compound-triggers.agent.yaml b/test/fixtures/agent-schema/valid/menu-triggers/compound-triggers.agent.yaml index 5ce29421..f43d9e1b 100644 --- a/test/fixtures/agent-schema/valid/menu-triggers/compound-triggers.agent.yaml +++ b/test/fixtures/agent-schema/valid/menu-triggers/compound-triggers.agent.yaml @@ -7,6 +7,7 @@ agent: name: Compound Triggers title: Compound Triggers Test icon: 🧪 + hasSidecar: false persona: role: Test agent with compound triggers @@ -16,15 +17,15 @@ agent: - Test compound format menu: - - trigger: TS or tech-spec or fuzzy match on tech-spec - description: Two-word compound trigger + - trigger: TS or fuzzy match on tech-spec + description: "[TS] Two-word compound trigger" action: tech_spec - - trigger: DS or dev-story or fuzzy match on dev-story - description: Another two-word compound trigger + - trigger: DS or fuzzy match on dev-story + description: "[DS] Another two-word compound trigger" action: dev_story - - trigger: WI or workflow-init-process or fuzzy match on workflow-init-process - description: Three-word compound trigger (uses first 2 words for shortcut) + - trigger: WI or fuzzy match on workflow-init-process + description: "[WI] Three-word compound trigger (uses first 2 words for shortcut)" action: workflow_init - - trigger: H or help or fuzzy match on help - description: Single-word compound trigger (1-letter shortcut) + - trigger: H or fuzzy match on help + description: "[H] Single-word compound trigger (1-letter shortcut)" action: help diff --git a/test/fixtures/agent-schema/valid/menu-triggers/kebab-case-triggers.agent.yaml b/test/fixtures/agent-schema/valid/menu-triggers/kebab-case-triggers.agent.yaml index f24e0eac..06184350 100644 --- a/test/fixtures/agent-schema/valid/menu-triggers/kebab-case-triggers.agent.yaml +++ b/test/fixtures/agent-schema/valid/menu-triggers/kebab-case-triggers.agent.yaml @@ -7,6 +7,7 @@ agent: name: Kebab Case Triggers title: Kebab Triggers icon: 🧪 + hasSidecar: false persona: role: Test agent with kebab-case triggers diff --git a/test/fixtures/agent-schema/valid/menu/multiple-menu-items.agent.yaml b/test/fixtures/agent-schema/valid/menu/multiple-menu-items.agent.yaml index 7c8ab82e..c8a23a9d 100644 --- a/test/fixtures/agent-schema/valid/menu/multiple-menu-items.agent.yaml +++ b/test/fixtures/agent-schema/valid/menu/multiple-menu-items.agent.yaml @@ -7,6 +7,7 @@ agent: name: Multiple Menu Items title: Multiple Menu icon: 🧪 + hasSidecar: false persona: role: Test agent with multiple menu items diff --git a/test/fixtures/agent-schema/valid/menu/single-menu-item.agent.yaml b/test/fixtures/agent-schema/valid/menu/single-menu-item.agent.yaml index 7d0f8695..00c361d0 100644 --- a/test/fixtures/agent-schema/valid/menu/single-menu-item.agent.yaml +++ b/test/fixtures/agent-schema/valid/menu/single-menu-item.agent.yaml @@ -7,6 +7,7 @@ agent: name: Single Menu Item title: Single Menu icon: 🧪 + hasSidecar: false persona: role: Test agent with single menu item diff --git a/test/fixtures/agent-schema/invalid/metadata/core-agent-with-module.agent.yaml b/test/fixtures/agent-schema/valid/metadata/core-agent-with-module.agent.yaml similarity index 55% rename from test/fixtures/agent-schema/invalid/metadata/core-agent-with-module.agent.yaml rename to test/fixtures/agent-schema/valid/metadata/core-agent-with-module.agent.yaml index 40ab45dc..e8ad0497 100644 --- a/test/fixtures/agent-schema/invalid/metadata/core-agent-with-module.agent.yaml +++ b/test/fixtures/agent-schema/valid/metadata/core-agent-with-module.agent.yaml @@ -1,17 +1,15 @@ -# Test: Core agent with unexpected module field -# Expected: FAIL -# Error code: custom -# Error path: agent.metadata.module -# Error message: core agents must not include agent.metadata.module -# Path context: src/core/agents/core-agent-with-module.agent.yaml +# Test: Core agent can have module field +# Expected: PASS +# Note: Core agents can now include module field if needed agent: metadata: id: core-with-module name: Core With Module title: Core Agent - icon: ❌ + icon: ✅ module: bmm + hasSidecar: false persona: role: Test agent diff --git a/test/fixtures/agent-schema/valid/metadata/empty-module-name-in-path.agent.yaml b/test/fixtures/agent-schema/valid/metadata/empty-module-name-in-path.agent.yaml index bd1dd5a7..10a54cb8 100644 --- a/test/fixtures/agent-schema/valid/metadata/empty-module-name-in-path.agent.yaml +++ b/test/fixtures/agent-schema/valid/metadata/empty-module-name-in-path.agent.yaml @@ -8,6 +8,7 @@ agent: name: Empty Module in Path title: Empty Module Path icon: 🧪 + hasSidecar: false # No module field - path has empty module name, treated as core persona: diff --git a/test/fixtures/agent-schema/valid/metadata/malformed-path-treated-as-core.agent.yaml b/test/fixtures/agent-schema/valid/metadata/malformed-path-treated-as-core.agent.yaml index 1bd025b1..707be64f 100644 --- a/test/fixtures/agent-schema/valid/metadata/malformed-path-treated-as-core.agent.yaml +++ b/test/fixtures/agent-schema/valid/metadata/malformed-path-treated-as-core.agent.yaml @@ -8,6 +8,7 @@ agent: name: Malformed Path Test title: Malformed Path icon: 🧪 + hasSidecar: false # No module field - will be treated as core since path parsing returns null persona: diff --git a/test/fixtures/agent-schema/valid/metadata/module-agent-correct.agent.yaml b/test/fixtures/agent-schema/valid/metadata/module-agent-correct.agent.yaml index 2ccd89cf..6ebf470e 100644 --- a/test/fixtures/agent-schema/valid/metadata/module-agent-correct.agent.yaml +++ b/test/fixtures/agent-schema/valid/metadata/module-agent-correct.agent.yaml @@ -9,6 +9,7 @@ agent: title: BMM Test icon: 🧪 module: bmm + hasSidecar: false persona: role: Test module agent diff --git a/test/fixtures/agent-schema/valid/metadata/module-agent-missing-module.agent.yaml b/test/fixtures/agent-schema/valid/metadata/module-agent-missing-module.agent.yaml new file mode 100644 index 00000000..6919c614 --- /dev/null +++ b/test/fixtures/agent-schema/valid/metadata/module-agent-missing-module.agent.yaml @@ -0,0 +1,23 @@ +# Test: Module agent can omit module field +# Expected: PASS +# Note: Module field is optional + +agent: + metadata: + id: bmm-missing-module + name: No Module + title: Optional Module + icon: ✅ + hasSidecar: false + + persona: + role: Test agent + identity: Test identity + communication_style: Test style + principles: + - Test principle + + menu: + - trigger: help + description: Show help + action: display_help diff --git a/test/fixtures/agent-schema/valid/metadata/wrong-module-value.agent.yaml b/test/fixtures/agent-schema/valid/metadata/wrong-module-value.agent.yaml new file mode 100644 index 00000000..9f6c9d21 --- /dev/null +++ b/test/fixtures/agent-schema/valid/metadata/wrong-module-value.agent.yaml @@ -0,0 +1,24 @@ +# Test: Module agent can have any module value +# Expected: PASS +# Note: Module validation removed - agents can declare any module + +agent: + metadata: + id: wrong-module + name: Any Module + title: Any Module Value + icon: ✅ + module: cis + hasSidecar: false + + persona: + role: Test agent + identity: Test identity + communication_style: Test style + principles: + - Test principle + + menu: + - trigger: help + description: Show help + action: display_help diff --git a/test/fixtures/agent-schema/valid/persona/complete-persona.agent.yaml b/test/fixtures/agent-schema/valid/persona/complete-persona.agent.yaml index e247e286..bee421b2 100644 --- a/test/fixtures/agent-schema/valid/persona/complete-persona.agent.yaml +++ b/test/fixtures/agent-schema/valid/persona/complete-persona.agent.yaml @@ -7,6 +7,7 @@ agent: name: Complete Persona Agent title: Complete Persona icon: 🧪 + hasSidecar: false persona: role: Comprehensive test agent with all persona fields diff --git a/test/fixtures/agent-schema/valid/prompts/empty-prompts.agent.yaml b/test/fixtures/agent-schema/valid/prompts/empty-prompts.agent.yaml index 7a785eab..da32f70e 100644 --- a/test/fixtures/agent-schema/valid/prompts/empty-prompts.agent.yaml +++ b/test/fixtures/agent-schema/valid/prompts/empty-prompts.agent.yaml @@ -7,6 +7,7 @@ agent: name: Empty Prompts title: Empty Prompts icon: 🧪 + hasSidecar: false persona: role: Test agent with empty prompts diff --git a/test/fixtures/agent-schema/valid/prompts/no-prompts.agent.yaml b/test/fixtures/agent-schema/valid/prompts/no-prompts.agent.yaml index e4ea8670..46c50f11 100644 --- a/test/fixtures/agent-schema/valid/prompts/no-prompts.agent.yaml +++ b/test/fixtures/agent-schema/valid/prompts/no-prompts.agent.yaml @@ -7,6 +7,7 @@ agent: name: No Prompts title: No Prompts icon: 🧪 + hasSidecar: false persona: role: Test agent without prompts diff --git a/test/fixtures/agent-schema/valid/prompts/valid-prompts-minimal.agent.yaml b/test/fixtures/agent-schema/valid/prompts/valid-prompts-minimal.agent.yaml index 2f95b1f3..2a2d7d98 100644 --- a/test/fixtures/agent-schema/valid/prompts/valid-prompts-minimal.agent.yaml +++ b/test/fixtures/agent-schema/valid/prompts/valid-prompts-minimal.agent.yaml @@ -7,6 +7,7 @@ agent: name: Valid Prompts Minimal title: Valid Prompts icon: 🧪 + hasSidecar: false persona: role: Test agent with minimal prompts diff --git a/test/fixtures/agent-schema/valid/prompts/valid-prompts-with-description.agent.yaml b/test/fixtures/agent-schema/valid/prompts/valid-prompts-with-description.agent.yaml index 349ed143..5585415e 100644 --- a/test/fixtures/agent-schema/valid/prompts/valid-prompts-with-description.agent.yaml +++ b/test/fixtures/agent-schema/valid/prompts/valid-prompts-with-description.agent.yaml @@ -7,6 +7,7 @@ agent: name: Valid Prompts With Description title: Valid Prompts Desc icon: 🧪 + hasSidecar: false persona: role: Test agent with prompts including descriptions diff --git a/test/fixtures/agent-schema/valid/top-level/minimal-core-agent.agent.yaml b/test/fixtures/agent-schema/valid/top-level/minimal-core-agent.agent.yaml index 1e48443a..f3bf0b9e 100644 --- a/test/fixtures/agent-schema/valid/top-level/minimal-core-agent.agent.yaml +++ b/test/fixtures/agent-schema/valid/top-level/minimal-core-agent.agent.yaml @@ -8,6 +8,7 @@ agent: name: Minimal Test Agent title: Minimal Test icon: 🧪 + hasSidecar: false persona: role: Test agent with minimal configuration diff --git a/test/test-installation-components.js b/test/test-installation-components.js index 464ca613..1f9c99dd 100644 --- a/test/test-installation-components.js +++ b/test/test-installation-components.js @@ -175,7 +175,7 @@ async function runTests() { assert(compiled.includes('testarch/knowledge'), 'TEA agent compilation includes knowledge base path'); - assert(compiled.includes('*test-design'), 'TEA agent menu includes test-design workflow'); + assert(compiled.includes('test-design'), 'TEA agent menu includes test-design workflow'); // Cleanup await fs.remove(tempOutput); diff --git a/tools/build-docs.js b/tools/build-docs.js index fbab38aa..791026b9 100644 --- a/tools/build-docs.js +++ b/tools/build-docs.js @@ -2,12 +2,11 @@ * BMAD Documentation Build Pipeline * * Consolidates docs from multiple sources, generates LLM-friendly files, - * creates downloadable bundles, and builds the Docusaurus site. + * creates downloadable bundles, and builds the Astro+Starlight site. * * Build outputs: - * build/consolidated/ - Merged docs from all sources * build/artifacts/ - With llms.txt, llms-full.txt, ZIPs - * build/site/ - Final Docusaurus output (deployable) + * build/site/ - Final Astro output (deployable) */ const { execSync } = require('node:child_process'); @@ -28,17 +27,17 @@ const REPO_URL = 'https://github.com/bmad-code-org/BMAD-METHOD'; const LLM_MAX_CHARS = 600_000; const LLM_WARN_CHARS = 500_000; -const MODULES = ['bmm', 'bmb', 'bmgd', 'cis']; - -// No root docs copied - only docs/ folder content goes to site -// README.md, CHANGELOG.md etc. link to GitHub -const ROOT_DOCS = []; - const LLM_EXCLUDE_PATTERNS = ['changelog', 'ide-info/', 'v4-to-v6-upgrade', 'downloads/', 'faq']; // ============================================================================= // Main Entry Point -// ============================================================================= +/** + * Orchestrates the full BMAD documentation build pipeline. + * + * Executes the high-level build steps in sequence: prints headers and paths, validates internal + * documentation links, cleans the build directory, generates artifacts from the `docs/` folder, + * builds the Astro site, and prints a final build summary. + */ async function main() { console.log(); @@ -48,13 +47,16 @@ async function main() { console.log(`Build directory: ${BUILD_DIR}`); console.log(); + // Check for broken internal links before building + checkDocLinks(); + cleanBuildDirectory(); - const consolidatedDir = consolidateDocs(); - const artifactsDir = await generateArtifacts(consolidatedDir); - const siteDir = buildDocusaurusSite(artifactsDir); + const docsDir = path.join(PROJECT_ROOT, 'docs'); + const artifactsDir = await generateArtifacts(docsDir); + const siteDir = buildAstroSite(); - printBuildSummary(consolidatedDir, artifactsDir, siteDir); + printBuildSummary(docsDir, artifactsDir, siteDir); } main().catch((error) => { @@ -64,33 +66,25 @@ main().catch((error) => { // ============================================================================= // Pipeline Stages -// ============================================================================= +/** + * Generate LLM files and downloadable bundles for the documentation pipeline. + * + * Creates the build/artifacts directory, writes `llms.txt` and `llms-full.txt` (sourced from the provided docs directory), + * and produces download ZIP bundles. + * + * @param {string} docsDir - Path to the source docs directory containing Markdown files. + * @returns {string} Path to the created artifacts directory. + */ -function consolidateDocs() { - printHeader('Consolidating documentation sources'); - - const outputDir = path.join(BUILD_DIR, 'consolidated'); - fs.mkdirSync(outputDir, { recursive: true }); - - copyMainDocs(outputDir); - copyRootDocs(outputDir); - copyModuleDocs(outputDir); - - const mdCount = countMarkdownFiles(outputDir); - console.log(); - console.log(` \u001B[32m✓\u001B[0m Consolidation complete: ${mdCount} markdown files`); - - return outputDir; -} - -async function generateArtifacts(consolidatedDir) { +async function generateArtifacts(docsDir) { printHeader('Generating LLM files and download bundles'); const outputDir = path.join(BUILD_DIR, 'artifacts'); - copyDirectory(consolidatedDir, outputDir); + fs.mkdirSync(outputDir, { recursive: true }); + // Generate LLM files reading from docs/, output to artifacts/ generateLlmsTxt(outputDir); - generateLlmsFullTxt(outputDir); + generateLlmsFullTxt(docsDir, outputDir); await generateDownloadBundles(outputDir); console.log(); @@ -99,81 +93,39 @@ async function generateArtifacts(consolidatedDir) { return outputDir; } -function buildDocusaurusSite(artifactsDir) { - printHeader('Building Docusaurus site'); +/** + * Builds the Astro + Starlight site and copies generated artifacts into the site output directory. + * + * @returns {string} The filesystem path to the built site directory (e.g., build/site). + */ +function buildAstroSite() { + printHeader('Building Astro + Starlight site'); const siteDir = path.join(BUILD_DIR, 'site'); - const mainDocs = path.join(PROJECT_ROOT, 'docs'); - const docsBackup = path.join(BUILD_DIR, 'docs-backup'); - - backupAndReplaceDocs(mainDocs, docsBackup, artifactsDir); - - try { - runDocusaurusBuild(siteDir); - } finally { - restoreDocs(mainDocs, docsBackup); - } + const artifactsDir = path.join(BUILD_DIR, 'artifacts'); + // Build Astro site (outputs to build/site via astro.config.mjs) + runAstroBuild(); copyArtifactsToSite(artifactsDir, siteDir); + // No longer needed: Inject AI agents banner into every HTML page + // injectAgentBanner(siteDir); + console.log(); - console.log(` \u001B[32m✓\u001B[0m Docusaurus build complete`); + console.log(` \u001B[32m✓\u001B[0m Astro build complete`); return siteDir; } -// ============================================================================= -// Documentation Consolidation -// ============================================================================= - -function copyMainDocs(destDir) { - console.log(' → Copying main docs...'); - const docsDir = path.join(PROJECT_ROOT, 'docs'); - copyDirectory(docsDir, destDir, ['modules', 'llms.txt', 'llms-full.txt'], true); -} - -function copyRootDocs(destDir) { - console.log(' → Copying root documentation files...'); - - for (const doc of ROOT_DOCS) { - const srcPath = path.join(PROJECT_ROOT, doc.src); - const destPath = path.join(destDir, doc.dest); - - if (fs.existsSync(srcPath)) { - let content = fs.readFileSync(srcPath, 'utf-8'); - - if (!content.startsWith('---')) { - content = `---\ntitle: "${doc.title}"\n---\n\n${content}`; - } - - content = transformMarkdownLinks(content); - fs.writeFileSync(destPath, content); - console.log(` ${doc.src} → ${doc.dest}`); - } - } -} - -function copyModuleDocs(destDir) { - fs.mkdirSync(path.join(destDir, 'modules'), { recursive: true }); - - for (const moduleName of MODULES) { - const srcPath = path.join(PROJECT_ROOT, 'src', 'modules', moduleName, 'docs'); - const moduleDest = path.join(destDir, 'modules', moduleName); - - if (fs.existsSync(srcPath)) { - console.log(` → Copying ${moduleName} docs...`); - copyDirectory(srcPath, moduleDest, [], false, moduleName); - const count = countMarkdownFiles(moduleDest); - console.log(` ${count} markdown files`); - } else { - console.log(` ⚠ WARNING: ${moduleName} docs not found`); - } - } -} - // ============================================================================= // LLM File Generation -// ============================================================================= +/** + * Create a concise llms.txt summary file containing project metadata, core links, and quick navigation entries for LLM consumption. + * + * Writes the file to `${outputDir}/llms.txt`. + * + * @param {string} outputDir - Destination directory where `llms.txt` will be written. + */ function generateLlmsTxt(outputDir) { console.log(' → Generating llms.txt...'); @@ -219,11 +171,18 @@ function generateLlmsTxt(outputDir) { console.log(` Generated llms.txt (${content.length.toLocaleString()} chars)`); } -function generateLlmsFullTxt(outputDir) { +/** + * Builds a consolidated llms-full.txt containing all Markdown files under docsDir wrapped in tags for LLM consumption. + * + * Writes the generated file to outputDir/llms-full.txt. Files matching LLM_EXCLUDE_PATTERNS are skipped; read errors for individual files are logged. The combined content is validated against configured size thresholds (will exit on overflow and warn if near limit). + * @param {string} docsDir - Root directory containing source Markdown files; paths in the output are relative to this directory. + * @param {string} outputDir - Directory where llms-full.txt will be written. + */ +function generateLlmsFullTxt(docsDir, outputDir) { console.log(' → Generating llms-full.txt...'); const date = new Date().toISOString().split('T')[0]; - const files = getDocsFromSidebar(); + const files = getAllMarkdownFiles(docsDir); const output = [ '# BMAD Method Documentation (Full)', @@ -243,7 +202,7 @@ function generateLlmsFullTxt(outputDir) { continue; } - const fullPath = path.join(outputDir, mdPath); + const fullPath = path.join(docsDir, mdPath); try { const content = readMarkdownContent(fullPath); output.push(``, content, '', ''); @@ -265,34 +224,35 @@ function generateLlmsFullTxt(outputDir) { ); } -function getDocsFromSidebar() { - const sidebarsPath = path.join(PROJECT_ROOT, 'website', 'sidebars.js'); +/** + * Collects all Markdown (.md) files under a directory and returns their paths relative to a base directory. + * @param {string} dir - Directory to search for Markdown files. + * @param {string} [baseDir=dir] - Base directory used to compute returned relative paths. + * @returns {string[]} An array of file paths (relative to `baseDir`) for every `.md` file found under `dir`. + */ +function getAllMarkdownFiles(dir, baseDir = dir) { + const files = []; - try { - const sidebarContent = fs.readFileSync(sidebarsPath, 'utf-8'); - const matches = sidebarContent.matchAll(/'([a-zA-Z0-9\-_/]+)'/g); - const files = []; + for (const entry of fs.readdirSync(dir, { withFileTypes: true })) { + const fullPath = path.join(dir, entry.name); - for (const match of matches) { - const docId = match[1]; - // Skip Docusaurus keywords - if (docId.includes('Sidebar') || docId === 'doc' || docId === 'category') { - continue; - } - // Skip category labels (Title Case words without slashes like 'Workflows', 'Reference') - if (!docId.includes('/') && /^[A-Z][a-z]/.test(docId)) { - continue; - } - files.push(docId + '.md'); + if (entry.isDirectory()) { + files.push(...getAllMarkdownFiles(fullPath, baseDir)); + } else if (entry.name.endsWith('.md')) { + // Return relative path from baseDir + const relativePath = path.relative(baseDir, fullPath); + files.push(relativePath); } - - return files; - } catch { - console.log(' Warning: Could not parse sidebars'); - return []; } + + return files; } +/** + * Determine whether a file path matches any configured LLM exclusion pattern. + * @param {string} filePath - The file path to test. + * @returns {boolean} `true` if the path contains any pattern from LLM_EXCLUDE_PATTERNS, `false` otherwise. + */ function shouldExcludeFromLlm(filePath) { return LLM_EXCLUDE_PATTERNS.some((pattern) => filePath.includes(pattern)); } @@ -346,6 +306,12 @@ async function generateSourcesBundle(downloadsDir) { console.log(` bmad-sources.zip (${size}M)`); } +/** + * Create a zip archive of the project's prompts modules and place it in the downloads directory. + * + * Creates bmad-prompts.zip from src/modules, excluding common unwanted paths, writes it to the provided downloads directory, and logs the resulting file size. If the modules directory does not exist, the function returns without creating a bundle. + * @param {string} downloadsDir - Destination directory where bmad-prompts.zip will be written. + */ async function generatePromptsBundle(downloadsDir) { const modulesDir = path.join(PROJECT_ROOT, 'src', 'modules'); if (!fs.existsSync(modulesDir)) return; @@ -358,39 +324,31 @@ async function generatePromptsBundle(downloadsDir) { } // ============================================================================= -// Docusaurus Build -// ============================================================================= - -function backupAndReplaceDocs(mainDocs, backupDir, artifactsDir) { - console.log(' → Preparing docs for Docusaurus...'); - - if (fs.existsSync(mainDocs)) { - copyDirectory(mainDocs, backupDir); - fs.rmSync(mainDocs, { recursive: true }); - } - - copyDirectory(artifactsDir, mainDocs, ['llms.txt', 'llms-full.txt']); - removeZipFiles(path.join(mainDocs, 'downloads')); -} - -function runDocusaurusBuild(siteDir) { - console.log(' → Running docusaurus build...'); - execSync('npx docusaurus build --config website/docusaurus.config.js --out-dir ' + siteDir, { +// Astro Build +/** + * Builds the Astro site to build/site (configured in astro.config.mjs). + */ +function runAstroBuild() { + console.log(' → Running astro build...'); + execSync('npx astro build --root website', { cwd: PROJECT_ROOT, stdio: 'inherit', + env: { + ...process.env, + NODE_OPTIONS: `${process.env.NODE_OPTIONS || ''} --disable-warning=MODULE_TYPELESS_PACKAGE_JSON`.trim(), + }, }); } -function restoreDocs(mainDocs, backupDir) { - console.log(' → Restoring original docs...'); - fs.rmSync(mainDocs, { recursive: true }); - - if (fs.existsSync(backupDir)) { - copyDirectory(backupDir, mainDocs); - fs.rmSync(backupDir, { recursive: true }); - } -} - +/** + * Copy generated artifact files into the built site directory. + * + * Copies llms.txt and llms-full.txt from the artifacts directory into the site directory. + * If a downloads subdirectory exists under artifacts, copies it into siteDir/downloads. + * + * @param {string} artifactsDir - Path to the build artifacts directory containing generated files. + * @param {string} siteDir - Path to the target site directory where artifacts should be placed. + */ function copyArtifactsToSite(artifactsDir, siteDir) { console.log(' → Copying artifacts to site...'); @@ -403,28 +361,24 @@ function copyArtifactsToSite(artifactsDir, siteDir) { } } -function removeZipFiles(dir) { - if (!fs.existsSync(dir)) return; - - for (const file of fs.readdirSync(dir)) { - if (file.endsWith('.zip')) { - fs.unlinkSync(path.join(dir, file)); - } - } -} - // ============================================================================= // Build Summary -// ============================================================================= +/** + * Prints a concise end-of-build summary and displays a sample listing of the final site directory. + * + * @param {string} docsDir - Path to the source documentation directory used for the build. + * @param {string} artifactsDir - Path to the directory containing generated artifacts (e.g., llms.txt, downloads). + * @param {string} siteDir - Path to the final built site directory whose contents will be listed. + */ -function printBuildSummary(consolidatedDir, artifactsDir, siteDir) { +function printBuildSummary(docsDir, artifactsDir, siteDir) { console.log(); printBanner('Build Complete!'); console.log(); console.log('Build artifacts:'); - console.log(` Consolidated docs: ${consolidatedDir}`); - console.log(` Generated files: ${artifactsDir}`); - console.log(` Final site: ${siteDir}`); + console.log(` Source docs: ${docsDir}`); + console.log(` Generated files: ${artifactsDir}`); + console.log(` Final site: ${siteDir}`); console.log(); console.log(`Deployable output: ${siteDir}/`); console.log(); @@ -448,6 +402,11 @@ function listDirectoryContents(dir) { } } +/** + * Format a byte count into a compact human-readable string using B, K, or M units. + * @param {number} bytes - The number of bytes to format. + * @returns {string} The formatted size: bytes as `N B` (e.g. `512B`), kilobytes truncated to an integer with `K` (e.g. `2K`), or megabytes with one decimal and `M` (e.g. `1.2M`). + */ function formatFileSize(bytes) { if (bytes > 1024 * 1024) { return `${(bytes / 1024 / 1024).toFixed(1)}M`; @@ -458,8 +417,38 @@ function formatFileSize(bytes) { } // ============================================================================= -// File System Utilities +// Post-build Injection +/** + * Recursively collects all files with the given extension under a directory. + * + * @param {string} dir - Root directory to search. + * @param {string} ext - File extension to match (include the leading dot, e.g. ".md"). + * @returns {string[]} An array of file paths for files ending with `ext` found under `dir`. + */ + +function getAllFilesByExtension(dir, ext) { + const result = []; + const entries = fs.readdirSync(dir, { withFileTypes: true }); + + for (const entry of entries) { + const fullPath = path.join(dir, entry.name); + if (entry.isDirectory()) { + result.push(...getAllFilesByExtension(fullPath, ext)); + } else if (entry.name.endsWith(ext)) { + result.push(fullPath); + } + } + + return result; +} + // ============================================================================= +// File System Utilities +/** + * Remove any existing build output and recreate the build directory. + * + * Ensures the configured BUILD_DIR is empty by deleting it if present and then creating a fresh directory. + */ function cleanBuildDirectory() { console.log('Cleaning previous build...'); @@ -470,7 +459,15 @@ function cleanBuildDirectory() { fs.mkdirSync(BUILD_DIR, { recursive: true }); } -function copyDirectory(src, dest, exclude = [], transformMd = false, moduleName = null) { +/** + * Recursively copies all files and subdirectories from one directory to another, creating the destination if needed. + * + * @param {string} src - Path to the source directory to copy from. + * @param {string} dest - Path to the destination directory to copy to. + * @param {string[]} [exclude=[]] - List of file or directory names (not paths) to skip while copying. + * @returns {boolean} `true` if the source existed and copying proceeded, `false` if the source did not exist. + */ +function copyDirectory(src, dest, exclude = []) { if (!fs.existsSync(src)) return false; fs.mkdirSync(dest, { recursive: true }); @@ -481,12 +478,7 @@ function copyDirectory(src, dest, exclude = [], transformMd = false, moduleName const destPath = path.join(dest, entry.name); if (entry.isDirectory()) { - copyDirectory(srcPath, destPath, exclude, transformMd, moduleName); - } else if (entry.name.endsWith('.md')) { - // Always transform markdown links, use module context if provided - let content = fs.readFileSync(srcPath, 'utf-8'); - content = transformMarkdownLinks(content, moduleName); - fs.writeFileSync(destPath, content); + copyDirectory(srcPath, destPath, exclude); } else { fs.copyFileSync(srcPath, destPath); } @@ -494,102 +486,13 @@ function copyDirectory(src, dest, exclude = [], transformMd = false, moduleName return true; } -function transformMarkdownLinks(content, moduleName = null) { - // Transform HTML img src attributes for module docs images - content = content.replaceAll(/src="\.\/src\/modules\/([^/]+)\/docs\/images\/([^"]+)"/g, (match, mod, file) => { - return `src="./modules/${mod}/images/${file}"`; - }); - - return content.replaceAll(/\]\(([^)]+)\)/g, (match, url) => { - // src/modules/{mod}/docs/{path}.md → ./modules/{mod}/{path}.md - // Keeps .md - Docusaurus handles .md → page conversion - const docsMatch = url.match(/^\.\.?\/src\/modules\/([^/]+)\/docs\/(.+\.md)$/); - if (docsMatch) return `](./modules/${docsMatch[1]}/${docsMatch[2]})`; - - // src/modules/{mod}/docs/ → ./modules/{mod}/ - const docsDirMatch = url.match(/^\.\.?\/src\/modules\/([^/]+)\/docs\/$/); - if (docsDirMatch) return `](./modules/${docsDirMatch[1]}/)`; - - // src/modules/{mod}/docs/images/{file} → ./modules/{mod}/images/{file} - const docsImageMatch = url.match(/^\.\.?\/src\/modules\/([^/]+)\/docs\/images\/(.+)$/); - if (docsImageMatch) return `](./modules/${docsImageMatch[1]}/images/${docsImageMatch[2]})`; - - // src/modules/{mod}/README.md → GitHub (not in docs folder) - const readmeMatch = url.match(/^\.\.?\/src\/modules\/([^/]+)\/README\.md$/i); - if (readmeMatch) return `](${REPO_URL}/blob/main/src/modules/${readmeMatch[1]}/README.md)`; - - // src/modules/* (non-docs) → GitHub - const srcMatch = url.match(/^\.\.?\/src\/modules\/(.+)$/); - if (srcMatch) return `](${REPO_URL}/tree/main/src/modules/${srcMatch[1]})`; - - // Relative paths escaping docs/ folder → GitHub (when module context is known) - // e.g., ../workflows/foo/bar.md from within docs/ → src/modules/{mod}/workflows/foo/bar.md - if (moduleName) { - const relativeEscapeMatch = url.match(/^\.\.\/([^.][^)]+)$/); - if (relativeEscapeMatch && !relativeEscapeMatch[1].startsWith('src/')) { - const relativePath = relativeEscapeMatch[1]; - return `](${REPO_URL}/blob/main/src/modules/${moduleName}/${relativePath})`; - } - } - - // ./docs/{path}.md → ./{path}.md (docs folder contents are at root in build) - // Keeps .md - Docusaurus handles .md → page conversion - const rootDocsMatch = url.match(/^\.\/docs\/(.+\.md)$/); - if (rootDocsMatch) return `](./${rootDocsMatch[1]})`; - - // Root docs → GitHub (not part of docs site) - if (url === '../README.md' || url === './README.md' || url === './project-readme') { - return `](${REPO_URL}/blob/main/README.md)`; - } - if (url === '../CHANGELOG.md' || url === './CHANGELOG.md' || url === './changelog') { - return `](${REPO_URL}/blob/main/CHANGELOG.md)`; - } - - // Root files → GitHub (CONTRIBUTING, LICENSE, CODE_OF_CONDUCT, etc.) - const contributingMatch = url.match(/^(\.\.\/)?CONTRIBUTING\.md(#.*)?$/); - if (contributingMatch) { - const anchor = contributingMatch[2] || ''; - return `](${REPO_URL}/blob/main/CONTRIBUTING.md${anchor})`; - } - if (url === 'LICENSE' || url === '../LICENSE') { - return `](${REPO_URL}/blob/main/LICENSE)`; - } - if (url === '.github/CODE_OF_CONDUCT.md' || url === '../.github/CODE_OF_CONDUCT.md') { - return `](${REPO_URL}/blob/main/.github/CODE_OF_CONDUCT.md)`; - } - - // Other root .md files → GitHub - const rootFileMatch = url.match(/^\.\.\/([A-Z][^/]+\.md)$/); - if (rootFileMatch) return `](${REPO_URL}/blob/main/${rootFileMatch[1]})`; - - // Cross-module doc links: ../../{mod}/docs/{path}.md → ../{mod}/{path}.md - // Fixes path structure but keeps .md (Docusaurus handles .md → page conversion) - const crossModuleDocsMatch = url.match(/^\.\.\/\.\.\/([^/]+)\/docs\/(.+\.md)$/); - if (crossModuleDocsMatch) return `](../${crossModuleDocsMatch[1]}/${crossModuleDocsMatch[2]})`; - - // Root-level folders (samples/) → GitHub - const rootFolderMatch = url.match(/^\.\.\/((samples)\/.*)/); - if (rootFolderMatch) return `](${REPO_URL}/blob/main/${rootFolderMatch[1]})`; - - return match; - }); -} - -function countMarkdownFiles(dir) { - let count = 0; - if (!fs.existsSync(dir)) return 0; - - for (const entry of fs.readdirSync(dir, { withFileTypes: true })) { - const fullPath = path.join(dir, entry.name); - if (entry.isDirectory()) { - count += countMarkdownFiles(fullPath); - } else if (entry.name.endsWith('.md')) { - count++; - } - } - return count; -} - +/** + * Create a ZIP archive of a directory, optionally excluding entries that match given substrings. + * @param {string} sourceDir - Path to the source directory to archive. + * @param {string} outputPath - Path to write the resulting ZIP file. + * @param {string[]} [exclude=[]] - Array of substrings; any entry whose path includes one of these substrings will be omitted. + * @returns {Promise} Resolves when the archive has been fully written and closed, rejects on error. + */ function createZipArchive(sourceDir, outputPath, exclude = []) { return new Promise((resolve, reject) => { const output = fs.createWriteStream(outputPath); @@ -623,8 +526,34 @@ function printHeader(title) { console.log('└' + '─'.repeat(62) + '┘'); } +/** + * Prints a centered decorative ASCII banner to the console using the provided title. + * @param {string} title - Text to display centered inside the banner. */ function printBanner(title) { console.log('╔' + '═'.repeat(62) + '╗'); console.log(`║${title.padStart(31 + title.length / 2).padEnd(62)}║`); console.log('╚' + '═'.repeat(62) + '╝'); } + +// ============================================================================= +// Link Checking +/** + * Verify internal documentation links by running the link-checking script. + * + * Executes the Node script tools/check-doc-links.js from the project root and + * exits the process with code 1 if the check fails. + */ + +function checkDocLinks() { + printHeader('Checking documentation links'); + + try { + execSync('node tools/validate-doc-links.js', { + cwd: PROJECT_ROOT, + stdio: 'inherit', + }); + } catch { + console.error('\n \u001B[31m✗\u001B[0m Link check failed - fix broken links before building\n'); + process.exit(1); + } +} diff --git a/tools/cli/bmad-cli.js b/tools/cli/bmad-cli.js index 53134524..ad3aac34 100755 --- a/tools/cli/bmad-cli.js +++ b/tools/cli/bmad-cli.js @@ -2,6 +2,24 @@ const { program } = require('commander'); const path = require('node:path'); const fs = require('node:fs'); +// Fix for stdin issues when running through npm on Windows +// Ensures keyboard interaction works properly with CLI prompts +if (process.stdin.isTTY) { + try { + process.stdin.resume(); + process.stdin.setEncoding('utf8'); + + // On Windows, explicitly reference the stdin stream to ensure it's properly initialized + if (process.platform === 'win32') { + process.stdin.on('error', () => { + // Ignore stdin errors - they can occur when the terminal is closing + }); + } + } catch { + // Silently ignore - some environments may not support these operations + } +} + // Load package.json from root for version info const packageJson = require('../../package.json'); diff --git a/tools/cli/commands/install.js b/tools/cli/commands/install.js index 6e241610..26b6425e 100644 --- a/tools/cli/commands/install.js +++ b/tools/cli/commands/install.js @@ -9,9 +9,15 @@ const ui = new UI(); module.exports = { command: 'install', description: 'Install BMAD Core agents and tools', - options: [], + options: [['-d, --debug', 'Enable debug output for manifest generation']], action: async (options) => { try { + // Set debug flag as environment variable for all components + if (options.debug) { + process.env.BMAD_DEBUG_MANIFEST = 'true'; + console.log(chalk.cyan('Debug mode enabled\n')); + } + const config = await ui.promptInstall(); // Handle cancel @@ -65,17 +71,9 @@ module.exports = { console.log(chalk.dim(' • ElevenLabs AI (150+ premium voices)')); console.log(chalk.dim(' • Piper TTS (50+ free voices)\n')); - const readline = require('node:readline'); - const rl = readline.createInterface({ - input: process.stdin, - output: process.stdout, - }); - - await new Promise((resolve) => { - rl.question(chalk.green('Press Enter to start AgentVibes installer...'), () => { - rl.close(); - resolve(); - }); + const prompts = require('../lib/prompts'); + await prompts.text({ + message: chalk.green('Press Enter to start AgentVibes installer...'), }); console.log(''); diff --git a/tools/cli/installers/install-messages.yaml b/tools/cli/installers/install-messages.yaml index 1de5c070..860b8352 100644 --- a/tools/cli/installers/install-messages.yaml +++ b/tools/cli/installers/install-messages.yaml @@ -6,26 +6,24 @@ startMessage: | ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ - 🎉🎉 Happy Holidays and New Year 🍾🍾 + ⭐ IMPORTANT: Version Alpha.23 Changes - IMPORTANT Changes with Version Alpha.20 - PLEASE READ THIS if upgrading from earlier Alpha Versions: + If your current version is older than Alpha.21, you'll need a fresh install: + - Remove .bmad folder and reinstall + - Only needed during final push to beta (ETA January 18th) - 1. The BMad Core default output folder has changed from docs to `_bmad-output`. `docs` is meant for long-term artifacts, which you can always decide to move content to. + 📚 New Docs Site: http://docs.bmad-method.org/ + - Tons of guides and articles coming soon! + - Everything is free. No paywalls. No gated content. + - Knowledge should be shared, not sold. - 2. If utilizing the BMad Method Module (BMM) please be aware of the following important recent changes: + 📺 YouTube Master Class & Podcast launching February 1st! - - Phases 1-3 (Analysis, Planning, Solutioning) will now default output to _bmad-output/planning-artifacts - - Phase 4 (Implementation) will now default output to _bmad-output/implementation-artifacts - - Long term project knowledge (research, docs, references, document-project output) will now default to docs/ + 💡 Love BMad? Please star us on GitHub & subscribe on YouTube! + - GitHub: https://github.com/bmad-code-org/BMAD-METHOD/ + - YouTube: https://www.youtube.com/@BMadCode - IT IS STRONGLY SUGGESTED to align with these folder conventions instead of dumping all to docs/ - if you are upgrading from a prior - version where all output was going to docs or docs/sprint-artifacts, it is suggested to reset configs to these new values. - - If you have anything in progress, you can move what was in sprint-artifacts to _bmad-output/implementation-artifacts, and if you had brainstorming - content, a PRD, UX or Architecture, you can move the content to _bmad-output/planning-artifacts. - - Read the latest updates before continuing: - https://github.com/bmad-code-org/BMAD-METHOD/blob/main/CHANGELOG.md + Latest updates: https://github.com/bmad-code-org/BMAD-METHOD/blob/main/CHANGELOG.md ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ @@ -33,20 +31,28 @@ startMessage: | endMessage: | ════════════════════════════════════════════════════════════════════════════════ - ✨ BMAD IS READY TO USE! + ✨ BMAD IS READY! Beta is just days away! Thank you for your support! - ONE FINAL NOTE WITH VERSION Alpha.20: Phase 4 (Implementation) is still in the process of being migrated to the improved workflow progressive disclosure system. - Along with this, the full conversion to the new path locations for content being searched may possibly be incomplete. If you run a workflow that relies on finding input documents automatically, and you notice they are not being found / looking in the wrong location, either: - 1. Manually specify the correct input location when prompted - 2. Open an issue on GitHub so we can address the problem quickly if you think its a bug. - 3. Ensure your content is in the new locations for best results: - - Planning Artifacts (Phases 1-3): _bmad-output/planning-artifacts - - Implementation Artifacts (Phase 4): _bmad-output/implementation-artifacts - - Long Term Project Knowledge (docs, research, references): docs/ + 🌟 BMad is 100% free and open source. + - No gated Discord. No paywalls. + - We believe in empowering everyone, not just those who can pay. - Thank you for helping test the early release version of the new BMad Core and BMad Method! - Stable Beta coming soon - please read the full README.md and linked documentation to get started. + 🙏 SUPPORT BMAD DEVELOPMENT: + - Donate: https://buymeacoffee.com/bmad + - Corporate Sponsorship available - DM on Discord - And again, here is the Change Log with all the details of recent updates: https://github.com/bmad-code-org/BMAD-METHOD/blob/main/CHANGELOG.md + 🎤 SPEAKING & MEDIA: + - Available for conferences, podcasts, and media appearances + - Topics: AI-Native Transformation, Spec and Context Engineering, BMad Method + - For speaking inquiries or interviews, reach out to BMad on Discord! + + 📚 RESOURCES: + - Docs: http://docs.bmad-method.org/ (bookmark it!) + - Changelog: https://github.com/bmad-code-org/BMAD-METHOD/blob/main/CHANGELOG.md + + ⭐⭐⭐ HELP US GROW: + - Star us on GitHub: https://github.com/bmad-code-org/BMAD-METHOD/ + - Subscribe on YouTube: https://www.youtube.com/@BMadCode + - Every star & sub helps us reach more developers! ════════════════════════════════════════════════════════════════════════════════ diff --git a/tools/cli/installers/lib/core/config-collector.js b/tools/cli/installers/lib/core/config-collector.js index ca09ca2f..ee486955 100644 --- a/tools/cli/installers/lib/core/config-collector.js +++ b/tools/cli/installers/lib/core/config-collector.js @@ -2,9 +2,9 @@ const path = require('node:path'); const fs = require('fs-extra'); const yaml = require('yaml'); const chalk = require('chalk'); -const inquirer = require('inquirer'); const { getProjectRoot, getModulePath } = require('../../../lib/project-root'); const { CLIUtils } = require('../../../lib/cli-utils'); +const prompts = require('../../../lib/prompts'); class ConfigCollector { constructor() { @@ -350,7 +350,7 @@ class ConfigCollector { // Only show header if we actually have questions CLIUtils.displayModuleConfigHeader(moduleName, moduleConfig.header, moduleConfig.subheader); console.log(); // Line break before questions - const promptedAnswers = await inquirer.prompt(questions); + const promptedAnswers = await prompts.prompt(questions); // Merge prompted answers with static answers Object.assign(allAnswers, promptedAnswers); @@ -587,7 +587,7 @@ class ConfigCollector { console.log(chalk.cyan('?') + ' ' + chalk.magenta(moduleDisplayName)); let customize = true; if (moduleName !== 'core') { - const customizeAnswer = await inquirer.prompt([ + const customizeAnswer = await prompts.prompt([ { type: 'confirm', name: 'customize', @@ -604,7 +604,7 @@ class ConfigCollector { if (questionsWithoutDefaults.length > 0) { console.log(chalk.dim(`\n Asking required questions for ${moduleName.toUpperCase()}...`)); - const promptedAnswers = await inquirer.prompt(questionsWithoutDefaults); + const promptedAnswers = await prompts.prompt(questionsWithoutDefaults); Object.assign(allAnswers, promptedAnswers); } @@ -618,7 +618,7 @@ class ConfigCollector { allAnswers[question.name] = question.default; } } else { - const promptedAnswers = await inquirer.prompt(questions); + const promptedAnswers = await prompts.prompt(questions); Object.assign(allAnswers, promptedAnswers); } } @@ -740,7 +740,7 @@ class ConfigCollector { console.log(chalk.cyan('?') + ' ' + chalk.magenta(moduleDisplayName)); // Ask user if they want to accept defaults or customize on the next line - const { customize } = await inquirer.prompt([ + const { customize } = await prompts.prompt([ { type: 'confirm', name: 'customize', @@ -835,7 +835,7 @@ class ConfigCollector { } /** - * Build an inquirer question from a config item + * Build a prompt question from a config item * @param {string} moduleName - Module name * @param {string} key - Config key * @param {Object} item - Config item definition @@ -997,7 +997,7 @@ class ConfigCollector { message: message, }; - // Set default - if it's dynamic, use a function that inquirer will evaluate with current answers + // Set default - if it's dynamic, use a function that the prompt will evaluate with current answers // But if we have an existing value, always use that instead if (existingValue !== null && existingValue !== undefined && questionType !== 'list') { question.default = existingValue; diff --git a/tools/cli/installers/lib/core/detector.js b/tools/cli/installers/lib/core/detector.js index 1fe76104..9bb73658 100644 --- a/tools/cli/installers/lib/core/detector.js +++ b/tools/cli/installers/lib/core/detector.js @@ -203,127 +203,17 @@ class Detector { } /** - * Detect legacy BMAD v4 footprints (case-sensitive path checks) - * V4 used _bmad-method as default folder name - * V6+ uses configurable folder names and ALWAYS has _config/manifest.yaml with installation.version + * Detect legacy BMAD v4 .bmad-method folder * @param {string} projectDir - Project directory to check * @returns {{ hasLegacyV4: boolean, offenders: string[] }} */ async detectLegacyV4(projectDir) { - // Helper: check existence of a nested path with case-sensitive segment matching - const existsCaseSensitive = async (baseDir, segments) => { - let dir = baseDir; - for (let i = 0; i < segments.length; i++) { - const seg = segments[i]; - let entries; - try { - entries = await fs.readdir(dir, { withFileTypes: true }); - } catch { - return false; - } - const hit = entries.find((e) => e.name === seg); - if (!hit) return false; - // Parents must be directories; the last segment may be a file or directory - if (i < segments.length - 1 && !hit.isDirectory()) return false; - dir = path.join(dir, hit.name); - } - return true; - }; - - // Helper: check if a directory is a V6+ installation - const isV6Installation = async (dirPath) => { - const manifestPath = path.join(dirPath, '_config', 'manifest.yaml'); - if (!(await fs.pathExists(manifestPath))) { - return false; - } - try { - const yaml = require('yaml'); - const manifestContent = await fs.readFile(manifestPath, 'utf8'); - const manifest = yaml.parse(manifestContent); - // V6+ manifest has installation.version - return manifest && manifest.installation && manifest.installation.version; - } catch { - return false; - } - }; - const offenders = []; - // Strategy: - // 1. First scan for ANY V6+ installation (_config/manifest.yaml) - // 2. If V6+ found → don't flag anything (user is already on V6+) - // 3. If NO V6+ found → flag folders with "bmad" in name as potential V4 legacy - - let hasV6Installation = false; - const potentialV4Folders = []; - - try { - const entries = await fs.readdir(projectDir, { withFileTypes: true }); - - for (const entry of entries) { - if (entry.isDirectory()) { - const name = entry.name; - const fullPath = path.join(projectDir, entry.name); - - // Check if directory is empty (skip empty leftover folders) - const dirContents = await fs.readdir(fullPath); - if (dirContents.length === 0) { - continue; // Skip empty folders - } - - // Check if it's a V6+ installation by looking for _config/manifest.yaml - // This works for ANY folder name (not just bmad-prefixed) - const isV6 = await isV6Installation(fullPath); - - if (isV6) { - // Found a V6+ installation - user is already on V6+ - hasV6Installation = true; - // Don't break - continue scanning to be thorough - } else { - // Not V6+, check if this is the exact V4 folder name "bmad-method" - if (name === 'bmad-method') { - // This is the V4 default folder - flag it as legacy - potentialV4Folders.push(fullPath); - } - } - } - } - } catch { - // Ignore errors reading directory - } - - // Only flag V4 folders if NO V6+ installation was found - if (!hasV6Installation && potentialV4Folders.length > 0) { - offenders.push(...potentialV4Folders); - } - - // Check inside various IDE command folders for legacy bmad folders - // V4 used folders like 'bmad-method' or custom names in IDE commands - // V6+ uses 'bmad' in IDE commands (hardcoded in IDE handlers) - // Legacy V4 IDE command folders won't have a corresponding V6+ installation - const ideConfigFolders = ['.opencode', '.claude', '.crush', '.continue', '.cursor', '.windsurf', '.cline', '.roo-cline']; - - for (const ideFolder of ideConfigFolders) { - const commandsDirName = ideFolder === '.opencode' ? 'command' : 'commands'; - const commandsPath = path.join(projectDir, ideFolder, commandsDirName); - if (await fs.pathExists(commandsPath)) { - try { - const commandEntries = await fs.readdir(commandsPath, { withFileTypes: true }); - for (const entry of commandEntries) { - if (entry.isDirectory()) { - const name = entry.name; - // V4 used 'bmad-method' or similar in IDE commands folders - // V6+ uses 'bmad' (hardcoded) - // So anything that's NOT 'bmad' but starts with bmad/Bmad is likely V4 - if ((name.startsWith('bmad') || name.startsWith('Bmad') || name === 'BMad') && name !== 'bmad') { - offenders.push(path.join(commandsPath, entry.name)); - } - } - } - } catch { - // Ignore errors reading commands directory - } - } + // Check for .bmad-method folder + const bmadMethodPath = path.join(projectDir, '.bmad-method'); + if (await fs.pathExists(bmadMethodPath)) { + offenders.push(bmadMethodPath); } return { hasLegacyV4: offenders.length > 0, offenders }; diff --git a/tools/cli/installers/lib/core/installer.js b/tools/cli/installers/lib/core/installer.js index 5b403972..97506847 100644 --- a/tools/cli/installers/lib/core/installer.js +++ b/tools/cli/installers/lib/core/installer.js @@ -2,7 +2,6 @@ const path = require('node:path'); const fs = require('fs-extra'); const chalk = require('chalk'); const ora = require('ora'); -const inquirer = require('inquirer'); const { Detector } = require('./detector'); const { Manifest } = require('./manifest'); const { ModuleManager } = require('../modules/manager'); @@ -17,6 +16,7 @@ const { CLIUtils } = require('../../../lib/cli-utils'); const { ManifestGenerator } = require('./manifest-generator'); const { IdeConfigManager } = require('./ide-config-manager'); const { CustomHandler } = require('../custom/handler'); +const prompts = require('../../../lib/prompts'); // BMAD installation folder name - this is constant and should never change const BMAD_FOLDER_NAME = '_bmad'; @@ -759,6 +759,9 @@ class Installer { config.skipIde = toolSelection.skipIde; const ideConfigurations = toolSelection.configurations; + // Add spacing after prompts before installation progress + console.log(''); + if (spinner.isSpinning) { spinner.text = 'Continuing installation...'; } else { @@ -2140,102 +2143,61 @@ class Installer { * Private: Prompt for update action */ async promptUpdateAction() { - const inquirer = require('inquirer'); - return await inquirer.prompt([ - { - type: 'list', - name: 'action', - message: 'What would you like to do?', - choices: [{ name: 'Update existing installation', value: 'update' }], - }, - ]); + const action = await prompts.select({ + message: 'What would you like to do?', + choices: [{ name: 'Update existing installation', value: 'update' }], + }); + return { action }; } /** - * Handle legacy BMAD v4 migration with automatic backup - * @param {string} projectDir - Project directory - * @param {Object} legacyV4 - Legacy V4 detection result with offenders array + * Handle legacy BMAD v4 detection with simple warning + * @param {string} _projectDir - Project directory (unused in simplified version) + * @param {Object} _legacyV4 - Legacy V4 detection result (unused in simplified version) */ - async handleLegacyV4Migration(projectDir, legacyV4) { - console.log(chalk.yellow.bold('\n⚠️ Legacy BMAD v4 detected')); - console.log(chalk.dim('The installer found legacy artefacts in your project.\n')); + async handleLegacyV4Migration(_projectDir, _legacyV4) { + console.log(''); + console.log(chalk.yellow.bold('⚠️ Legacy BMAD v4 detected')); + console.log(chalk.yellow('─'.repeat(80))); + console.log(chalk.yellow('Found .bmad-method folder from BMAD v4 installation.')); + console.log(''); - // Separate _bmad* folders (auto-backup) from other offending paths (manual cleanup) - const bmadFolders = legacyV4.offenders.filter((p) => { - const name = path.basename(p); - return name.startsWith('_bmad'); // Only dot-prefixed folders get auto-backed up - }); - const otherOffenders = legacyV4.offenders.filter((p) => { - const name = path.basename(p); - return !name.startsWith('_bmad'); // Everything else is manual cleanup + console.log(chalk.dim('Before continuing with installation, we recommend:')); + console.log(chalk.dim(' 1. Remove the .bmad-method folder, OR')); + console.log(chalk.dim(' 2. Back it up by renaming it to another name (e.g., bmad-method-backup)')); + console.log(''); + + console.log(chalk.dim('If your v4 installation set up rules or commands, you should remove those as well.')); + console.log(''); + + const proceed = await prompts.select({ + message: 'What would you like to do?', + choices: [ + { + name: 'Exit and clean up manually (recommended)', + value: 'exit', + hint: 'Exit installation', + }, + { + name: 'Continue with installation anyway', + value: 'continue', + hint: 'Continue', + }, + ], + default: 'exit', }); - const inquirer = require('inquirer'); - - // Show warning for other offending paths FIRST - if (otherOffenders.length > 0) { - console.log(chalk.yellow('⚠️ Recommended cleanup:')); - console.log(chalk.dim('It is recommended to remove the following items before proceeding:\n')); - for (const p of otherOffenders) console.log(chalk.dim(` - ${p}`)); - - console.log(chalk.cyan('\nCleanup commands you can copy/paste:')); - console.log(chalk.dim('macOS/Linux:')); - for (const p of otherOffenders) console.log(chalk.dim(` rm -rf '${p}'`)); - console.log(chalk.dim('Windows:')); - for (const p of otherOffenders) console.log(chalk.dim(` rmdir /S /Q "${p}"`)); - - const { cleanedUp } = await inquirer.prompt([ - { - type: 'confirm', - name: 'cleanedUp', - message: 'Have you completed the recommended cleanup? (You can proceed without it, but it is recommended)', - default: false, - }, - ]); - - if (cleanedUp) { - console.log(chalk.green('✓ Cleanup acknowledged\n')); - } else { - console.log(chalk.yellow('⚠️ Proceeding without recommended cleanup\n')); - } + if (proceed === 'exit') { + console.log(''); + console.log(chalk.cyan('Please remove the .bmad-method folder and any v4 rules/commands,')); + console.log(chalk.cyan('then run the installer again.')); + console.log(''); + process.exit(0); } - // Handle _bmad* folders with automatic backup - if (bmadFolders.length > 0) { - console.log(chalk.cyan('The following legacy folders will be moved to v4-backup:')); - for (const p of bmadFolders) console.log(chalk.dim(` - ${p}`)); - - const { proceed } = await inquirer.prompt([ - { - type: 'confirm', - name: 'proceed', - message: 'Proceed with backing up legacy v4 folders?', - default: true, - }, - ]); - - if (proceed) { - const backupDir = path.join(projectDir, 'v4-backup'); - await fs.ensureDir(backupDir); - - for (const folder of bmadFolders) { - const folderName = path.basename(folder); - const backupPath = path.join(backupDir, folderName); - - // If backup already exists, add timestamp - let finalBackupPath = backupPath; - if (await fs.pathExists(backupPath)) { - const timestamp = new Date().toISOString().replaceAll(/[:.]/g, '-').split('T')[0]; - finalBackupPath = path.join(backupDir, `${folderName}-${timestamp}`); - } - - await fs.move(folder, finalBackupPath, { overwrite: false }); - console.log(chalk.green(`✓ Moved ${folderName} to ${path.relative(projectDir, finalBackupPath)}`)); - } - } else { - throw new Error('Installation cancelled by user'); - } - } + console.log(''); + console.log(chalk.yellow('⚠️ Proceeding with installation despite legacy v4 folder')); + console.log(''); } /** @@ -2469,7 +2431,6 @@ class Installer { console.log(chalk.yellow(`\n⚠️ Found ${customModulesWithMissingSources.length} custom module(s) with missing sources:`)); - const inquirer = require('inquirer'); let keptCount = 0; let updatedCount = 0; let removedCount = 0; @@ -2483,12 +2444,12 @@ class Installer { { name: 'Keep installed (will not be processed)', value: 'keep', - short: 'Keep', + hint: 'Keep', }, { name: 'Specify new source location', value: 'update', - short: 'Update', + hint: 'Update', }, ]; @@ -2497,47 +2458,40 @@ class Installer { choices.push({ name: '⚠️ REMOVE module completely (destructive!)', value: 'remove', - short: 'Remove', + hint: 'Remove', }); } - const { action } = await inquirer.prompt([ - { - type: 'list', - name: 'action', - message: `How would you like to handle "${missing.name}"?`, - choices, - }, - ]); + const action = await prompts.select({ + message: `How would you like to handle "${missing.name}"?`, + choices, + }); switch (action) { case 'update': { - const { newSourcePath } = await inquirer.prompt([ - { - type: 'input', - name: 'newSourcePath', - message: 'Enter the new path to the custom module:', - default: missing.sourcePath, - validate: async (input) => { - if (!input || input.trim() === '') { - return 'Please enter a path'; - } - const expandedPath = path.resolve(input.trim()); - if (!(await fs.pathExists(expandedPath))) { - return 'Path does not exist'; - } - // Check if it looks like a valid module - const moduleYamlPath = path.join(expandedPath, 'module.yaml'); - const agentsPath = path.join(expandedPath, 'agents'); - const workflowsPath = path.join(expandedPath, 'workflows'); + // Use sync validation because @clack/prompts doesn't support async validate + const newSourcePath = await prompts.text({ + message: 'Enter the new path to the custom module:', + default: missing.sourcePath, + validate: (input) => { + if (!input || input.trim() === '') { + return 'Please enter a path'; + } + const expandedPath = path.resolve(input.trim()); + if (!fs.pathExistsSync(expandedPath)) { + return 'Path does not exist'; + } + // Check if it looks like a valid module + const moduleYamlPath = path.join(expandedPath, 'module.yaml'); + const agentsPath = path.join(expandedPath, 'agents'); + const workflowsPath = path.join(expandedPath, 'workflows'); - if (!(await fs.pathExists(moduleYamlPath)) && !(await fs.pathExists(agentsPath)) && !(await fs.pathExists(workflowsPath))) { - return 'Path does not appear to contain a valid custom module'; - } - return true; - }, + if (!fs.pathExistsSync(moduleYamlPath) && !fs.pathExistsSync(agentsPath) && !fs.pathExistsSync(workflowsPath)) { + return 'Path does not appear to contain a valid custom module'; + } + return; // clack expects undefined for valid input }, - ]); + }); // Update the source in manifest const resolvedPath = path.resolve(newSourcePath.trim()); @@ -2563,46 +2517,38 @@ class Installer { console.log(chalk.red.bold(`\n⚠️ WARNING: This will PERMANENTLY DELETE "${missing.name}" and all its files!`)); console.log(chalk.red(` Module location: ${path.join(bmadDir, missing.id)}`)); - const { confirm } = await inquirer.prompt([ - { - type: 'confirm', - name: 'confirm', - message: chalk.red.bold('Are you absolutely sure you want to delete this module?'), - default: false, - }, - ]); + const confirmDelete = await prompts.confirm({ + message: chalk.red.bold('Are you absolutely sure you want to delete this module?'), + default: false, + }); - if (confirm) { - const { typedConfirm } = await inquirer.prompt([ - { - type: 'input', - name: 'typedConfirm', - message: chalk.red.bold('Type "DELETE" to confirm permanent deletion:'), - validate: (input) => { - if (input !== 'DELETE') { - return chalk.red('You must type "DELETE" exactly to proceed'); - } - return true; - }, + if (confirmDelete) { + const typedConfirm = await prompts.text({ + message: chalk.red.bold('Type "DELETE" to confirm permanent deletion:'), + validate: (input) => { + if (input !== 'DELETE') { + return chalk.red('You must type "DELETE" exactly to proceed'); + } + return; // clack expects undefined for valid input }, - ]); + }); if (typedConfirm === 'DELETE') { // Remove the module from filesystem and manifest - const modulePath = path.join(bmadDir, moduleId); + const modulePath = path.join(bmadDir, missing.id); if (await fs.pathExists(modulePath)) { const fsExtra = require('fs-extra'); await fsExtra.remove(modulePath); console.log(chalk.yellow(` ✓ Deleted module directory: ${path.relative(projectRoot, modulePath)}`)); } - await this.manifest.removeModule(bmadDir, moduleId); - await this.manifest.removeCustomModule(bmadDir, moduleId); + await this.manifest.removeModule(bmadDir, missing.id); + await this.manifest.removeCustomModule(bmadDir, missing.id); console.log(chalk.yellow(` ✓ Removed from manifest`)); // Also remove from installedModules list - if (installedModules && installedModules.includes(moduleId)) { - const index = installedModules.indexOf(moduleId); + if (installedModules && installedModules.includes(missing.id)) { + const index = installedModules.indexOf(missing.id); if (index !== -1) { installedModules.splice(index, 1); } @@ -2623,7 +2569,7 @@ class Installer { } case 'keep': { keptCount++; - keptModulesWithoutSources.push(moduleId); + keptModulesWithoutSources.push(missing.id); console.log(chalk.dim(` Module will be kept as-is`)); break; diff --git a/tools/cli/installers/lib/core/manifest-generator.js b/tools/cli/installers/lib/core/manifest-generator.js index 2de9c2cf..f9c8c401 100644 --- a/tools/cli/installers/lib/core/manifest-generator.js +++ b/tools/cli/installers/lib/core/manifest-generator.js @@ -121,8 +121,16 @@ class ManifestGenerator { async getWorkflowsFromPath(basePath, moduleName) { const workflows = []; const workflowsPath = path.join(basePath, 'workflows'); + const debug = process.env.BMAD_DEBUG_MANIFEST === 'true'; + + if (debug) { + console.log(`[DEBUG] Scanning workflows in: ${workflowsPath}`); + } if (!(await fs.pathExists(workflowsPath))) { + if (debug) { + console.log(`[DEBUG] Workflows path does not exist: ${workflowsPath}`); + } return workflows; } @@ -139,8 +147,13 @@ class ManifestGenerator { await findWorkflows(fullPath, newRelativePath); } else if (entry.name === 'workflow.yaml' || entry.name === 'workflow.md') { // Parse workflow file (both YAML and MD formats) + if (debug) { + console.log(`[DEBUG] Found workflow file: ${fullPath}`); + } try { - const content = await fs.readFile(fullPath, 'utf8'); + // Read and normalize line endings (fix Windows CRLF issues) + const rawContent = await fs.readFile(fullPath, 'utf8'); + const content = rawContent.replaceAll('\r\n', '\n').replaceAll('\r', '\n'); let workflow; if (entry.name === 'workflow.yaml') { @@ -150,13 +163,31 @@ class ManifestGenerator { // Parse MD workflow with YAML frontmatter const frontmatterMatch = content.match(/^---\n([\s\S]*?)\n---/); if (!frontmatterMatch) { + if (debug) { + console.log(`[DEBUG] Skipped (no frontmatter): ${fullPath}`); + } continue; // Skip MD files without frontmatter } workflow = yaml.parse(frontmatterMatch[1]); } + if (debug) { + console.log(`[DEBUG] Parsed: name="${workflow.name}", description=${workflow.description ? 'OK' : 'MISSING'}`); + } + // Skip template workflows (those with placeholder values) if (workflow.name && workflow.name.includes('{') && workflow.name.includes('}')) { + if (debug) { + console.log(`[DEBUG] Skipped (template placeholder): ${workflow.name}`); + } + continue; + } + + // Skip workflows marked as non-standalone (reference/example workflows) + if (workflow.standalone === false) { + if (debug) { + console.log(`[DEBUG] Skipped (standalone=false): ${workflow.name}`); + } continue; } @@ -167,7 +198,7 @@ class ManifestGenerator { ? `${this.bmadFolderName}/core/workflows/${relativePath}/${entry.name}` : `${this.bmadFolderName}/${moduleName}/workflows/${relativePath}/${entry.name}`; - // ALL workflows now generate commands - no standalone property needed + // Workflows with standalone: false are filtered out above workflows.push({ name: workflow.name, description: workflow.description.replaceAll('"', '""'), // Escape quotes for CSV @@ -182,6 +213,14 @@ class ManifestGenerator { module: moduleName, path: installPath, }); + + if (debug) { + console.log(`[DEBUG] ✓ Added workflow: ${workflow.name} (${moduleName})`); + } + } else { + if (debug) { + console.log(`[DEBUG] Skipped (missing name or description): ${fullPath}`); + } } } catch (error) { console.warn(`Warning: Failed to parse workflow at ${fullPath}: ${error.message}`); @@ -191,6 +230,11 @@ class ManifestGenerator { }; await findWorkflows(workflowsPath); + + if (debug) { + console.log(`[DEBUG] Total workflows found in ${moduleName}: ${workflows.length}`); + } + return workflows; } diff --git a/tools/cli/installers/lib/ide/antigravity.js b/tools/cli/installers/lib/ide/antigravity.js index b921b4de..57071cdc 100644 --- a/tools/cli/installers/lib/ide/antigravity.js +++ b/tools/cli/installers/lib/ide/antigravity.js @@ -13,6 +13,7 @@ const { resolveSubagentFiles, } = require('./shared/module-injections'); const { getAgentsFromBmad, getAgentsFromDir } = require('./shared/bmad-artifacts'); +const prompts = require('../../../lib/prompts'); /** * Google Antigravity IDE setup handler @@ -26,6 +27,21 @@ class AntigravitySetup extends BaseIdeSetup { this.workflowsDir = 'workflows'; } + /** + * Prompt for subagent installation location + * @returns {Promise} Selected location ('project' or 'user') + */ + async _promptInstallLocation() { + return prompts.select({ + message: 'Where would you like to install Antigravity subagents?', + choices: [ + { name: 'Project level (.agent/agents/)', value: 'project' }, + { name: 'User level (~/.agent/agents/)', value: 'user' }, + ], + default: 'project', + }); + } + /** * Collect configuration choices before installation * @param {Object} options - Configuration options @@ -57,21 +73,7 @@ class AntigravitySetup extends BaseIdeSetup { config.subagentChoices = await this.promptSubagentInstallation(injectionConfig.subagents); if (config.subagentChoices.install !== 'none') { - // Ask for installation location - const inquirer = require('inquirer'); - const locationAnswer = await inquirer.prompt([ - { - type: 'list', - name: 'location', - message: 'Where would you like to install Antigravity subagents?', - choices: [ - { name: 'Project level (.agent/agents/)', value: 'project' }, - { name: 'User level (~/.agent/agents/)', value: 'user' }, - ], - default: 'project', - }, - ]); - config.installLocation = locationAnswer.location; + config.installLocation = await this._promptInstallLocation(); } } } catch (error) { @@ -297,20 +299,7 @@ class AntigravitySetup extends BaseIdeSetup { choices = await this.promptSubagentInstallation(config.subagents); if (choices.install !== 'none') { - const inquirer = require('inquirer'); - const locationAnswer = await inquirer.prompt([ - { - type: 'list', - name: 'location', - message: 'Where would you like to install Antigravity subagents?', - choices: [ - { name: 'Project level (.agent/agents/)', value: 'project' }, - { name: 'User level (~/.agent/agents/)', value: 'user' }, - ], - default: 'project', - }, - ]); - location = locationAnswer.location; + location = await this._promptInstallLocation(); } } @@ -334,22 +323,16 @@ class AntigravitySetup extends BaseIdeSetup { * Prompt user for subagent installation preferences */ async promptSubagentInstallation(subagentConfig) { - const inquirer = require('inquirer'); - // First ask if they want to install subagents - const { install } = await inquirer.prompt([ - { - type: 'list', - name: 'install', - message: 'Would you like to install Antigravity subagents for enhanced functionality?', - choices: [ - { name: 'Yes, install all subagents', value: 'all' }, - { name: 'Yes, let me choose specific subagents', value: 'selective' }, - { name: 'No, skip subagent installation', value: 'none' }, - ], - default: 'all', - }, - ]); + const install = await prompts.select({ + message: 'Would you like to install Antigravity subagents for enhanced functionality?', + choices: [ + { name: 'Yes, install all subagents', value: 'all' }, + { name: 'Yes, let me choose specific subagents', value: 'selective' }, + { name: 'No, skip subagent installation', value: 'none' }, + ], + default: 'all', + }); if (install === 'selective') { // Show list of available subagents with descriptions @@ -361,18 +344,14 @@ class AntigravitySetup extends BaseIdeSetup { 'document-reviewer.md': 'Document quality review', }; - const { selected } = await inquirer.prompt([ - { - type: 'checkbox', - name: 'selected', - message: 'Select subagents to install:', - choices: subagentConfig.files.map((file) => ({ - name: `${file.replace('.md', '')} - ${subagentInfo[file] || 'Specialized assistant'}`, - value: file, - checked: true, - })), - }, - ]); + const selected = await prompts.multiselect({ + message: `Select subagents to install ${chalk.dim('(↑/↓ navigate, SPACE select, ENTER confirm)')}:`, + choices: subagentConfig.files.map((file) => ({ + name: `${file.replace('.md', '')} - ${subagentInfo[file] || 'Specialized assistant'}`, + value: file, + checked: true, + })), + }); return { install: 'selective', selected }; } diff --git a/tools/cli/installers/lib/ide/claude-code.js b/tools/cli/installers/lib/ide/claude-code.js index 56131e44..02c65b40 100644 --- a/tools/cli/installers/lib/ide/claude-code.js +++ b/tools/cli/installers/lib/ide/claude-code.js @@ -13,6 +13,7 @@ const { resolveSubagentFiles, } = require('./shared/module-injections'); const { getAgentsFromBmad, getAgentsFromDir } = require('./shared/bmad-artifacts'); +const prompts = require('../../../lib/prompts'); /** * Claude Code IDE setup handler @@ -25,6 +26,21 @@ class ClaudeCodeSetup extends BaseIdeSetup { this.agentsDir = 'agents'; } + /** + * Prompt for subagent installation location + * @returns {Promise} Selected location ('project' or 'user') + */ + async promptInstallLocation() { + return prompts.select({ + message: 'Where would you like to install Claude Code subagents?', + choices: [ + { name: 'Project level (.claude/agents/)', value: 'project' }, + { name: 'User level (~/.claude/agents/)', value: 'user' }, + ], + default: 'project', + }); + } + /** * Collect configuration choices before installation * @param {Object} options - Configuration options @@ -56,21 +72,7 @@ class ClaudeCodeSetup extends BaseIdeSetup { config.subagentChoices = await this.promptSubagentInstallation(injectionConfig.subagents); if (config.subagentChoices.install !== 'none') { - // Ask for installation location - const inquirer = require('inquirer'); - const locationAnswer = await inquirer.prompt([ - { - type: 'list', - name: 'location', - message: 'Where would you like to install Claude Code subagents?', - choices: [ - { name: 'Project level (.claude/agents/)', value: 'project' }, - { name: 'User level (~/.claude/agents/)', value: 'user' }, - ], - default: 'project', - }, - ]); - config.installLocation = locationAnswer.location; + config.installLocation = await this.promptInstallLocation(); } } } catch (error) { @@ -305,20 +307,7 @@ class ClaudeCodeSetup extends BaseIdeSetup { choices = await this.promptSubagentInstallation(config.subagents); if (choices.install !== 'none') { - const inquirer = require('inquirer'); - const locationAnswer = await inquirer.prompt([ - { - type: 'list', - name: 'location', - message: 'Where would you like to install Claude Code subagents?', - choices: [ - { name: 'Project level (.claude/agents/)', value: 'project' }, - { name: 'User level (~/.claude/agents/)', value: 'user' }, - ], - default: 'project', - }, - ]); - location = locationAnswer.location; + location = await this.promptInstallLocation(); } } @@ -342,22 +331,16 @@ class ClaudeCodeSetup extends BaseIdeSetup { * Prompt user for subagent installation preferences */ async promptSubagentInstallation(subagentConfig) { - const inquirer = require('inquirer'); - // First ask if they want to install subagents - const { install } = await inquirer.prompt([ - { - type: 'list', - name: 'install', - message: 'Would you like to install Claude Code subagents for enhanced functionality?', - choices: [ - { name: 'Yes, install all subagents', value: 'all' }, - { name: 'Yes, let me choose specific subagents', value: 'selective' }, - { name: 'No, skip subagent installation', value: 'none' }, - ], - default: 'all', - }, - ]); + const install = await prompts.select({ + message: 'Would you like to install Claude Code subagents for enhanced functionality?', + choices: [ + { name: 'Yes, install all subagents', value: 'all' }, + { name: 'Yes, let me choose specific subagents', value: 'selective' }, + { name: 'No, skip subagent installation', value: 'none' }, + ], + default: 'all', + }); if (install === 'selective') { // Show list of available subagents with descriptions @@ -369,18 +352,14 @@ class ClaudeCodeSetup extends BaseIdeSetup { 'document-reviewer.md': 'Document quality review', }; - const { selected } = await inquirer.prompt([ - { - type: 'checkbox', - name: 'selected', - message: 'Select subagents to install:', - choices: subagentConfig.files.map((file) => ({ - name: `${file.replace('.md', '')} - ${subagentInfo[file] || 'Specialized assistant'}`, - value: file, - checked: true, - })), - }, - ]); + const selected = await prompts.multiselect({ + message: `Select subagents to install ${chalk.dim('(↑/↓ navigate, SPACE select, ENTER confirm)')}:`, + options: subagentConfig.files.map((file) => ({ + label: `${file.replace('.md', '')} - ${subagentInfo[file] || 'Specialized assistant'}`, + value: file, + })), + initialValues: subagentConfig.files, + }); return { install: 'selective', selected }; } diff --git a/tools/cli/installers/lib/ide/codex.js b/tools/cli/installers/lib/ide/codex.js index e538fa6f..e037a779 100644 --- a/tools/cli/installers/lib/ide/codex.js +++ b/tools/cli/installers/lib/ide/codex.js @@ -6,6 +6,7 @@ const { BaseIdeSetup } = require('./_base-ide'); const { WorkflowCommandGenerator } = require('./shared/workflow-command-generator'); const { AgentCommandGenerator } = require('./shared/agent-command-generator'); const { getTasksFromBmad } = require('./shared/bmad-artifacts'); +const prompts = require('../../../lib/prompts'); /** * Codex setup handler (CLI mode) @@ -21,32 +22,24 @@ class CodexSetup extends BaseIdeSetup { * @returns {Object} Collected configuration */ async collectConfiguration(options = {}) { - const inquirer = require('inquirer'); - let confirmed = false; let installLocation = 'global'; while (!confirmed) { - const { location } = await inquirer.prompt([ - { - type: 'list', - name: 'location', - message: 'Where would you like to install Codex CLI prompts?', - choices: [ - { - name: 'Global - Simple for single project ' + '(~/.codex/prompts, but references THIS project only)', - value: 'global', - }, - { - name: `Project-specific - Recommended for real work (requires CODEX_HOME=${path.sep}.codex)`, - value: 'project', - }, - ], - default: 'global', - }, - ]); - - installLocation = location; + installLocation = await prompts.select({ + message: 'Where would you like to install Codex CLI prompts?', + choices: [ + { + name: 'Global - Simple for single project ' + '(~/.codex/prompts, but references THIS project only)', + value: 'global', + }, + { + name: `Project-specific - Recommended for real work (requires CODEX_HOME=${path.sep}.codex)`, + value: 'project', + }, + ], + default: 'global', + }); // Display detailed instructions for the chosen option console.log(''); @@ -57,16 +50,10 @@ class CodexSetup extends BaseIdeSetup { } // Confirm the choice - const { proceed } = await inquirer.prompt([ - { - type: 'confirm', - name: 'proceed', - message: 'Proceed with this installation option?', - default: true, - }, - ]); - - confirmed = proceed; + confirmed = await prompts.confirm({ + message: 'Proceed with this installation option?', + default: true, + }); if (!confirmed) { console.log(chalk.yellow("\n Let's choose a different installation option.\n")); diff --git a/tools/cli/installers/lib/ide/cursor.js b/tools/cli/installers/lib/ide/cursor.js index 183bbced..61f374a4 100644 --- a/tools/cli/installers/lib/ide/cursor.js +++ b/tools/cli/installers/lib/ide/cursor.js @@ -3,6 +3,7 @@ const { BaseIdeSetup } = require('./_base-ide'); const chalk = require('chalk'); const { AgentCommandGenerator } = require('./shared/agent-command-generator'); const { WorkflowCommandGenerator } = require('./shared/workflow-command-generator'); +const { TaskToolCommandGenerator } = require('./shared/task-tool-command-generator'); /** * Cursor IDE setup handler @@ -12,6 +13,7 @@ class CursorSetup extends BaseIdeSetup { super('cursor', 'Cursor', true); // preferred IDE this.configDir = '.cursor'; this.rulesDir = 'rules'; + this.commandsDir = 'commands'; } /** @@ -21,11 +23,17 @@ class CursorSetup extends BaseIdeSetup { async cleanup(projectDir) { const fs = require('fs-extra'); const bmadRulesDir = path.join(projectDir, this.configDir, this.rulesDir, 'bmad'); + const bmadCommandsDir = path.join(projectDir, this.configDir, this.commandsDir, 'bmad'); if (await fs.pathExists(bmadRulesDir)) { await fs.remove(bmadRulesDir); console.log(chalk.dim(` Removed old BMAD rules from ${this.name}`)); } + + if (await fs.pathExists(bmadCommandsDir)) { + await fs.remove(bmadCommandsDir); + console.log(chalk.dim(` Removed old BMAD commands from ${this.name}`)); + } } /** @@ -40,330 +48,76 @@ class CursorSetup extends BaseIdeSetup { // Clean up old BMAD installation first await this.cleanup(projectDir); - // Create .cursor/rules directory structure + // Create .cursor/commands directory structure const cursorDir = path.join(projectDir, this.configDir); - const rulesDir = path.join(cursorDir, this.rulesDir); - const bmadRulesDir = path.join(rulesDir, 'bmad'); + const commandsDir = path.join(cursorDir, this.commandsDir); + const bmadCommandsDir = path.join(commandsDir, 'bmad'); - await this.ensureDir(bmadRulesDir); + await this.ensureDir(bmadCommandsDir); - // Generate agent launchers first + // Generate agent launchers using AgentCommandGenerator + // This creates small launcher files that reference the actual agents in _bmad/ const agentGen = new AgentCommandGenerator(this.bmadFolderName); - const { artifacts: agentArtifacts } = await agentGen.collectAgentArtifacts(bmadDir, options.selectedModules || []); - - // Convert artifacts to agent format for index creation - const agents = agentArtifacts.map((a) => ({ module: a.module, name: a.name })); - - // Get tasks, tools, and workflows (ALL workflows now generate commands) - const tasks = await this.getTasks(bmadDir, true); - const tools = await this.getTools(bmadDir, true); - - // Get ALL workflows using the new workflow command generator - const workflowGenerator = new WorkflowCommandGenerator(this.bmadFolderName); - const { artifacts: workflowArtifacts, counts: workflowCounts } = await workflowGenerator.collectWorkflowArtifacts(bmadDir); - - // Convert artifacts to workflow objects for directory creation - const workflows = workflowArtifacts - .filter((artifact) => artifact.type === 'workflow-command') - .map((artifact) => ({ - module: artifact.module, - name: path.basename(artifact.relativePath, '.md'), - path: artifact.sourcePath, - })); + const { artifacts: agentArtifacts, counts: agentCounts } = await agentGen.collectAgentArtifacts(bmadDir, options.selectedModules || []); // Create directories for each module const modules = new Set(); - for (const item of [...agents, ...tasks, ...tools, ...workflows]) modules.add(item.module); + for (const artifact of agentArtifacts) { + modules.add(artifact.module); + } for (const module of modules) { - await this.ensureDir(path.join(bmadRulesDir, module)); - await this.ensureDir(path.join(bmadRulesDir, module, 'agents')); - await this.ensureDir(path.join(bmadRulesDir, module, 'tasks')); - await this.ensureDir(path.join(bmadRulesDir, module, 'tools')); - await this.ensureDir(path.join(bmadRulesDir, module, 'workflows')); + await this.ensureDir(path.join(bmadCommandsDir, module)); + await this.ensureDir(path.join(bmadCommandsDir, module, 'agents')); } - // Process and write agent launchers with MDC format - let agentCount = 0; - for (const artifact of agentArtifacts) { - // Add MDC metadata header to launcher (but don't call processContent which adds activation headers) - const content = this.wrapLauncherWithMDC(artifact.content, { - module: artifact.module, - name: artifact.name, - }); + // Write agent launcher files + const agentCount = await agentGen.writeAgentLaunchers(bmadCommandsDir, agentArtifacts); - const targetPath = path.join(bmadRulesDir, artifact.module, 'agents', `${artifact.name}.mdc`); + // Generate workflow commands from manifest (if it exists) + const workflowGen = new WorkflowCommandGenerator(this.bmadFolderName); + const { artifacts: workflowArtifacts } = await workflowGen.collectWorkflowArtifacts(bmadDir); - await this.writeFile(targetPath, content); - agentCount++; - } - - // Process and copy tasks - let taskCount = 0; - for (const task of tasks) { - const content = await this.readAndProcess(task.path, { - module: task.module, - name: task.name, - }); - - const targetPath = path.join(bmadRulesDir, task.module, 'tasks', `${task.name}.mdc`); - - await this.writeFile(targetPath, content); - taskCount++; - } - - // Process and copy tools - let toolCount = 0; - for (const tool of tools) { - const content = await this.readAndProcess(tool.path, { - module: tool.module, - name: tool.name, - }); - - const targetPath = path.join(bmadRulesDir, tool.module, 'tools', `${tool.name}.mdc`); - - await this.writeFile(targetPath, content); - toolCount++; - } - - // Process and copy workflow commands (generated, not raw workflows) - let workflowCount = 0; + // Write only workflow-command artifacts, skip workflow-launcher READMEs + let workflowCommandCount = 0; for (const artifact of workflowArtifacts) { if (artifact.type === 'workflow-command') { - // Add MDC metadata header to workflow command - const content = this.wrapLauncherWithMDC(artifact.content, { - module: artifact.module, - name: path.basename(artifact.relativePath, '.md'), - }); - - const targetPath = path.join(bmadRulesDir, artifact.module, 'workflows', `${path.basename(artifact.relativePath, '.md')}.mdc`); - - await this.writeFile(targetPath, content); - workflowCount++; + const moduleWorkflowsDir = path.join(bmadCommandsDir, artifact.module, 'workflows'); + await this.ensureDir(moduleWorkflowsDir); + const commandPath = path.join(moduleWorkflowsDir, path.basename(artifact.relativePath)); + await this.writeFile(commandPath, artifact.content); + workflowCommandCount++; } + // Skip workflow-launcher READMEs as they would be treated as slash commands } - // Create BMAD index file (but NOT .cursorrules - user manages that) - await this.createBMADIndex(bmadRulesDir, agents, tasks, tools, workflows, modules); + // Generate task and tool commands from manifests (if they exist) + const taskToolGen = new TaskToolCommandGenerator(); + const taskToolResult = await taskToolGen.generateTaskToolCommands(projectDir, bmadDir, bmadCommandsDir); console.log(chalk.green(`✓ ${this.name} configured:`)); console.log(chalk.dim(` - ${agentCount} agents installed`)); - console.log(chalk.dim(` - ${taskCount} tasks installed`)); - console.log(chalk.dim(` - ${toolCount} tools installed`)); - console.log(chalk.dim(` - ${workflowCount} workflows installed`)); - console.log(chalk.dim(` - Rules directory: ${path.relative(projectDir, bmadRulesDir)}`)); + if (workflowCommandCount > 0) { + console.log(chalk.dim(` - ${workflowCommandCount} workflow commands generated`)); + } + if (taskToolResult.generated > 0) { + console.log( + chalk.dim( + ` - ${taskToolResult.generated} task/tool commands generated (${taskToolResult.tasks} tasks, ${taskToolResult.tools} tools)`, + ), + ); + } + console.log(chalk.dim(` - Commands directory: ${path.relative(projectDir, bmadCommandsDir)}`)); return { success: true, agents: agentCount, - tasks: taskCount, - tools: toolCount, - workflows: workflowCount, + tasks: taskToolResult.tasks || 0, + tools: taskToolResult.tools || 0, + workflows: workflowCommandCount, }; } - /** - * Create BMAD index file for easy navigation - */ - async createBMADIndex(bmadRulesDir, agents, tasks, tools, workflows, modules) { - const indexPath = path.join(bmadRulesDir, 'index.mdc'); - - let content = `--- -description: BMAD Method - Master Index -globs: -alwaysApply: true ---- - -# BMAD Method - Cursor Rules Index - -This is the master index for all BMAD agents, tasks, tools, and workflows available in your project. - -## Installation Complete! - -BMAD rules have been installed to: \`.cursor/rules/bmad/\` - -**Note:** BMAD does not modify your \`.cursorrules\` file. You manage that separately. - -## How to Use - -- Reference specific agents: @bmad/{module}/agents/{agent-name} -- Reference specific tasks: @bmad/{module}/tasks/{task-name} -- Reference specific tools: @bmad/{module}/tools/{tool-name} -- Reference specific workflows: @bmad/{module}/workflows/{workflow-name} -- Reference entire modules: @bmad/{module} -- Reference this index: @bmad/index - -## Available Modules - -`; - - for (const module of modules) { - content += `### ${module.toUpperCase()}\n\n`; - - // List agents for this module - const moduleAgents = agents.filter((a) => a.module === module); - if (moduleAgents.length > 0) { - content += `**Agents:**\n`; - for (const agent of moduleAgents) { - content += `- @bmad/${module}/agents/${agent.name} - ${agent.name}\n`; - } - content += '\n'; - } - - // List tasks for this module - const moduleTasks = tasks.filter((t) => t.module === module); - if (moduleTasks.length > 0) { - content += `**Tasks:**\n`; - for (const task of moduleTasks) { - content += `- @bmad/${module}/tasks/${task.name} - ${task.name}\n`; - } - content += '\n'; - } - - // List tools for this module - const moduleTools = tools.filter((t) => t.module === module); - if (moduleTools.length > 0) { - content += `**Tools:**\n`; - for (const tool of moduleTools) { - content += `- @bmad/${module}/tools/${tool.name} - ${tool.name}\n`; - } - content += '\n'; - } - - // List workflows for this module - const moduleWorkflows = workflows.filter((w) => w.module === module); - if (moduleWorkflows.length > 0) { - content += `**Workflows:**\n`; - for (const workflow of moduleWorkflows) { - content += `- @bmad/${module}/workflows/${workflow.name} - ${workflow.name}\n`; - } - content += '\n'; - } - } - - content += ` -## Quick Reference - -- All BMAD rules are Manual type - reference them explicitly when needed -- Agents provide persona-based assistance with specific expertise -- Tasks are reusable workflows for common operations -- Tools provide specialized functionality -- Workflows orchestrate multi-step processes -- Each agent includes an activation block for proper initialization - -## Configuration - -BMAD rules are configured as Manual rules (alwaysApply: false) to give you control -over when they're included in your context. Reference them explicitly when you need -specific agent expertise, task workflows, tools, or guided workflows. -`; - - await this.writeFile(indexPath, content); - } - - /** - * Read and process file content - */ - async readAndProcess(filePath, metadata) { - const fs = require('fs-extra'); - const content = await fs.readFile(filePath, 'utf8'); - return this.processContent(content, metadata); - } - - /** - * Override processContent to add MDC metadata header for Cursor - * @param {string} content - File content - * @param {Object} metadata - File metadata - * @returns {string} Processed content with MDC header - */ - processContent(content, metadata = {}) { - // First apply base processing (includes activation injection for agents) - let processed = super.processContent(content, metadata); - - // Strip any existing frontmatter from the processed content - // This prevents duplicate frontmatter blocks - const frontmatterRegex = /^---\s*\n[\s\S]*?\n---\s*\n/; - if (frontmatterRegex.test(processed)) { - processed = processed.replace(frontmatterRegex, ''); - } - - // Determine the type and description based on content - const isAgent = content.includes(' `; - // Cursor uses MDC format with metadata header - const mdcContent = `--- -description: "${agentName} agent" -globs: -alwaysApply: false + // Cursor uses YAML frontmatter matching Claude Code format + const commandContent = `--- +name: '${agentName}' +description: '${agentName} agent' --- ${launcherContent} `; - const launcherPath = path.join(customAgentsDir, `${agentName}.mdc`); - await this.writeFile(launcherPath, mdcContent); + const launcherPath = path.join(customAgentsDir, `${agentName}.md`); + await this.writeFile(launcherPath, commandContent); return { path: launcherPath, - command: `@${agentName}`, + command: `/bmad/custom/agents/${agentName}`, }; } } diff --git a/tools/cli/installers/lib/ide/github-copilot.js b/tools/cli/installers/lib/ide/github-copilot.js index 998ec657..c500a284 100644 --- a/tools/cli/installers/lib/ide/github-copilot.js +++ b/tools/cli/installers/lib/ide/github-copilot.js @@ -1,8 +1,8 @@ const path = require('node:path'); const { BaseIdeSetup } = require('./_base-ide'); const chalk = require('chalk'); -const inquirer = require('inquirer'); const { AgentCommandGenerator } = require('./shared/agent-command-generator'); +const prompts = require('../../../lib/prompts'); /** * GitHub Copilot setup handler @@ -27,23 +27,18 @@ class GitHubCopilotSetup extends BaseIdeSetup { console.log('\n' + chalk.blue(' 🔧 VS Code Settings Configuration')); console.log(chalk.dim(' GitHub Copilot works best with specific settings\n')); - const response = await inquirer.prompt([ - { - type: 'list', - name: 'configChoice', - message: 'How would you like to configure VS Code settings?', - choices: [ - { name: 'Use recommended defaults (fastest)', value: 'defaults' }, - { name: 'Configure each setting manually', value: 'manual' }, - { name: 'Skip settings configuration', value: 'skip' }, - ], - default: 'defaults', - }, - ]); - config.vsCodeConfig = response.configChoice; + config.vsCodeConfig = await prompts.select({ + message: 'How would you like to configure VS Code settings?', + choices: [ + { name: 'Use recommended defaults (fastest)', value: 'defaults' }, + { name: 'Configure each setting manually', value: 'manual' }, + { name: 'Skip settings configuration', value: 'skip' }, + ], + default: 'defaults', + }); - if (response.configChoice === 'manual') { - config.manualSettings = await inquirer.prompt([ + if (config.vsCodeConfig === 'manual') { + config.manualSettings = await prompts.prompt([ { type: 'input', name: 'maxRequests', @@ -52,7 +47,8 @@ class GitHubCopilotSetup extends BaseIdeSetup { validate: (input) => { const num = parseInt(input, 10); if (isNaN(num)) return 'Enter a valid number 1-50'; - return (num >= 1 && num <= 50) || 'Enter 1-50'; + if (num < 1 || num > 50) return 'Enter a number between 1-50'; + return true; }, }, { diff --git a/tools/cli/lib/agent/compiler.js b/tools/cli/lib/agent/compiler.js index 90b75573..cf8704be 100644 --- a/tools/cli/lib/agent/compiler.js +++ b/tools/cli/lib/agent/compiler.js @@ -128,7 +128,8 @@ function buildMenuXml(menuItems) { let xml = ' \n'; // Always inject menu display option first - xml += ` [M] Redisplay Menu Options\n`; + xml += ` [MH] Redisplay Menu Help\n`; + xml += ` [CH] Chat with the Agent about anything\n`; // Add user-defined menu items if (menuItems && menuItems.length > 0) { @@ -141,11 +142,7 @@ function buildMenuXml(menuItems) { } // Handle legacy format menu items else if (item.trigger) { - // For legacy items, keep using cmd with * format let trigger = item.trigger || ''; - if (!trigger.startsWith('*')) { - trigger = '*' + trigger; - } const attrs = [`cmd="${trigger}"`]; @@ -161,8 +158,8 @@ function buildMenuXml(menuItems) { } } - // Always inject dismiss last - xml += ` [D] Dismiss Agent\n`; + xml += ` [PM] Start Party Mode\n`; + xml += ` [DA] Dismiss Agent\n`; xml += ' \n'; diff --git a/tools/cli/lib/prompts.js b/tools/cli/lib/prompts.js new file mode 100644 index 00000000..96b80ba1 --- /dev/null +++ b/tools/cli/lib/prompts.js @@ -0,0 +1,432 @@ +/** + * @clack/prompts wrapper for BMAD CLI + * + * This module provides a unified interface for CLI prompts using @clack/prompts. + * It replaces Inquirer.js to fix Windows arrow key navigation issues (libuv #852). + * + * @module prompts + */ + +let _clack = null; + +/** + * Lazy-load @clack/prompts (ESM module) + * @returns {Promise} The clack prompts module + */ +async function getClack() { + if (!_clack) { + _clack = await import('@clack/prompts'); + } + return _clack; +} + +/** + * Handle user cancellation gracefully + * @param {any} value - The value to check + * @param {string} [message='Operation cancelled'] - Message to display + * @returns {boolean} True if cancelled + */ +async function handleCancel(value, message = 'Operation cancelled') { + const clack = await getClack(); + if (clack.isCancel(value)) { + clack.cancel(message); + process.exit(0); + } + return false; +} + +/** + * Display intro message + * @param {string} message - The intro message + */ +async function intro(message) { + const clack = await getClack(); + clack.intro(message); +} + +/** + * Display outro message + * @param {string} message - The outro message + */ +async function outro(message) { + const clack = await getClack(); + clack.outro(message); +} + +/** + * Display a note/info box + * @param {string} message - The note content + * @param {string} [title] - Optional title + */ +async function note(message, title) { + const clack = await getClack(); + clack.note(message, title); +} + +/** + * Display a spinner for async operations + * @returns {Object} Spinner controller with start, stop, message methods + */ +async function spinner() { + const clack = await getClack(); + return clack.spinner(); +} + +/** + * Single-select prompt (replaces Inquirer 'list' type) + * @param {Object} options - Prompt options + * @param {string} options.message - The question to ask + * @param {Array} options.choices - Array of choices [{name, value, hint?}] + * @param {any} [options.default] - Default selected value + * @returns {Promise} Selected value + */ +async function select(options) { + const clack = await getClack(); + + // Convert Inquirer-style choices to clack format + // Handle both object choices {name, value, hint} and primitive choices (string/number) + const clackOptions = options.choices + .filter((c) => c.type !== 'separator') // Skip separators for now + .map((choice) => { + if (typeof choice === 'string' || typeof choice === 'number') { + return { value: choice, label: String(choice) }; + } + return { + value: choice.value === undefined ? choice.name : choice.value, + label: choice.name || choice.label || String(choice.value), + hint: choice.hint || choice.description, + }; + }); + + // Find initial value + let initialValue; + if (options.default !== undefined) { + initialValue = options.default; + } + + const result = await clack.select({ + message: options.message, + options: clackOptions, + initialValue, + }); + + await handleCancel(result); + return result; +} + +/** + * Multi-select prompt (replaces Inquirer 'checkbox' type) + * @param {Object} options - Prompt options + * @param {string} options.message - The question to ask + * @param {Array} options.choices - Array of choices [{name, value, checked?, hint?}] + * @param {boolean} [options.required=false] - Whether at least one must be selected + * @returns {Promise} Array of selected values + */ +async function multiselect(options) { + const clack = await getClack(); + + // Support both clack-native (options) and Inquirer-style (choices) APIs + let clackOptions; + let initialValues; + + if (options.options) { + // Native clack format: options with label/value + clackOptions = options.options; + initialValues = options.initialValues || []; + } else { + // Convert Inquirer-style choices to clack format + // Handle both object choices {name, value, hint} and primitive choices (string/number) + clackOptions = options.choices + .filter((c) => c.type !== 'separator') // Skip separators + .map((choice) => { + if (typeof choice === 'string' || typeof choice === 'number') { + return { value: choice, label: String(choice) }; + } + return { + value: choice.value === undefined ? choice.name : choice.value, + label: choice.name || choice.label || String(choice.value), + hint: choice.hint || choice.description, + }; + }); + + // Find initial values (pre-checked items) + initialValues = options.choices + .filter((c) => c.checked && c.type !== 'separator') + .map((c) => (c.value === undefined ? c.name : c.value)); + } + + const result = await clack.multiselect({ + message: options.message, + options: clackOptions, + initialValues: initialValues.length > 0 ? initialValues : undefined, + required: options.required || false, + }); + + await handleCancel(result); + return result; +} + +/** + * Grouped multi-select prompt for categorized options + * @param {Object} options - Prompt options + * @param {string} options.message - The question to ask + * @param {Object} options.options - Object mapping group names to arrays of choices + * @param {Array} [options.initialValues] - Array of initially selected values + * @param {boolean} [options.required=false] - Whether at least one must be selected + * @param {boolean} [options.selectableGroups=false] - Whether groups can be selected as a whole + * @returns {Promise} Array of selected values + */ +async function groupMultiselect(options) { + const clack = await getClack(); + + const result = await clack.groupMultiselect({ + message: options.message, + options: options.options, + initialValues: options.initialValues, + required: options.required || false, + }); + + await handleCancel(result); + return result; +} + +/** + * Confirm prompt (replaces Inquirer 'confirm' type) + * @param {Object} options - Prompt options + * @param {string} options.message - The question to ask + * @param {boolean} [options.default=true] - Default value + * @returns {Promise} User's answer + */ +async function confirm(options) { + const clack = await getClack(); + + const result = await clack.confirm({ + message: options.message, + initialValue: options.default === undefined ? true : options.default, + }); + + await handleCancel(result); + return result; +} + +/** + * Text input prompt (replaces Inquirer 'input' type) + * @param {Object} options - Prompt options + * @param {string} options.message - The question to ask + * @param {string} [options.default] - Default value + * @param {string} [options.placeholder] - Placeholder text (defaults to options.default if not provided) + * @param {Function} [options.validate] - Validation function + * @returns {Promise} User's input + */ +async function text(options) { + const clack = await getClack(); + + // Use default as placeholder if placeholder not explicitly provided + // This shows the default value as grayed-out hint text + const placeholder = options.placeholder === undefined ? options.default : options.placeholder; + + const result = await clack.text({ + message: options.message, + defaultValue: options.default, + placeholder: typeof placeholder === 'string' ? placeholder : undefined, + validate: options.validate, + }); + + await handleCancel(result); + return result; +} + +/** + * Password input prompt (replaces Inquirer 'password' type) + * @param {Object} options - Prompt options + * @param {string} options.message - The question to ask + * @param {Function} [options.validate] - Validation function + * @returns {Promise} User's input + */ +async function password(options) { + const clack = await getClack(); + + const result = await clack.password({ + message: options.message, + validate: options.validate, + }); + + await handleCancel(result); + return result; +} + +/** + * Group multiple prompts together + * @param {Object} prompts - Object of prompt functions + * @param {Object} [options] - Group options + * @returns {Promise} Object with all answers + */ +async function group(prompts, options = {}) { + const clack = await getClack(); + + const result = await clack.group(prompts, { + onCancel: () => { + clack.cancel('Operation cancelled'); + process.exit(0); + }, + ...options, + }); + + return result; +} + +/** + * Run tasks with spinner feedback + * @param {Array} tasks - Array of task objects [{title, task, enabled?}] + * @returns {Promise} + */ +async function tasks(taskList) { + const clack = await getClack(); + await clack.tasks(taskList); +} + +/** + * Log messages with styling + */ +const log = { + async info(message) { + const clack = await getClack(); + clack.log.info(message); + }, + async success(message) { + const clack = await getClack(); + clack.log.success(message); + }, + async warn(message) { + const clack = await getClack(); + clack.log.warn(message); + }, + async error(message) { + const clack = await getClack(); + clack.log.error(message); + }, + async message(message) { + const clack = await getClack(); + clack.log.message(message); + }, + async step(message) { + const clack = await getClack(); + clack.log.step(message); + }, +}; + +/** + * Execute an array of Inquirer-style questions using @clack/prompts + * This provides compatibility with dynamic question arrays + * @param {Array} questions - Array of Inquirer-style question objects + * @returns {Promise} Object with answers keyed by question name + */ +async function prompt(questions) { + const answers = {}; + + for (const question of questions) { + const { type, name, message, choices, default: defaultValue, validate, when } = question; + + // Handle conditional questions via 'when' property + if (when !== undefined) { + const shouldAsk = typeof when === 'function' ? await when(answers) : when; + if (!shouldAsk) continue; + } + + let answer; + + switch (type) { + case 'input': { + // Note: @clack/prompts doesn't support async validation, so validate must be sync + answer = await text({ + message, + default: typeof defaultValue === 'function' ? defaultValue(answers) : defaultValue, + validate: validate + ? (val) => { + const result = validate(val, answers); + if (result instanceof Promise) { + throw new TypeError('Async validation is not supported by @clack/prompts. Please use synchronous validation.'); + } + return result === true ? undefined : result; + } + : undefined, + }); + break; + } + + case 'confirm': { + answer = await confirm({ + message, + default: typeof defaultValue === 'function' ? defaultValue(answers) : defaultValue, + }); + break; + } + + case 'list': { + answer = await select({ + message, + choices: choices || [], + default: typeof defaultValue === 'function' ? defaultValue(answers) : defaultValue, + }); + break; + } + + case 'checkbox': { + answer = await multiselect({ + message, + choices: choices || [], + required: false, + }); + break; + } + + case 'password': { + // Note: @clack/prompts doesn't support async validation, so validate must be sync + answer = await password({ + message, + validate: validate + ? (val) => { + const result = validate(val, answers); + if (result instanceof Promise) { + throw new TypeError('Async validation is not supported by @clack/prompts. Please use synchronous validation.'); + } + return result === true ? undefined : result; + } + : undefined, + }); + break; + } + + default: { + // Default to text input for unknown types + answer = await text({ + message, + default: typeof defaultValue === 'function' ? defaultValue(answers) : defaultValue, + }); + } + } + + answers[name] = answer; + } + + return answers; +} + +module.exports = { + getClack, + handleCancel, + intro, + outro, + note, + spinner, + select, + multiselect, + groupMultiselect, + confirm, + text, + password, + group, + tasks, + log, + prompt, +}; diff --git a/tools/cli/lib/ui.js b/tools/cli/lib/ui.js index d2997178..a78cfec9 100644 --- a/tools/cli/lib/ui.js +++ b/tools/cli/lib/ui.js @@ -1,10 +1,23 @@ const chalk = require('chalk'); -const inquirer = require('inquirer'); const path = require('node:path'); const os = require('node:os'); const fs = require('fs-extra'); const { CLIUtils } = require('./cli-utils'); const { CustomHandler } = require('../installers/lib/custom/handler'); +const prompts = require('./prompts'); + +// Separator class for visual grouping in select/multiselect prompts +// Note: @clack/prompts doesn't support separators natively, they are filtered out +class Separator { + constructor(text = '────────') { + this.line = text; + this.name = text; + } + type = 'separator'; +} + +// Separator for choice lists (compatible interface) +const choiceUtils = { Separator }; /** * UI utilities for the installer @@ -104,26 +117,20 @@ class UI { console.log(chalk.yellow('─'.repeat(80))); console.log(''); - const { proceed } = await inquirer.prompt([ - { - type: 'list', - name: 'proceed', - message: 'What would you like to do?', - choices: [ - { - name: 'Cancel and do a fresh install (recommended)', - value: 'cancel', - short: 'Cancel installation', - }, - { - name: 'Proceed anyway (will attempt update, potentially may fail or have unstable behavior)', - value: 'proceed', - short: 'Proceed with update', - }, - ], - default: 'cancel', - }, - ]); + const proceed = await prompts.select({ + message: 'What would you like to do?', + choices: [ + { + name: 'Cancel and do a fresh install (recommended)', + value: 'cancel', + }, + { + name: 'Proceed anyway (will attempt update, potentially may fail or have unstable behavior)', + value: 'proceed', + }, + ], + default: 'cancel', + }); if (proceed === 'cancel') { console.log(''); @@ -179,14 +186,10 @@ class UI { // If Claude Code was selected, ask about TTS if (claudeCodeSelected) { - const { enableTts } = await inquirer.prompt([ - { - type: 'confirm', - name: 'enableTts', - message: 'Claude Code supports TTS (Text-to-Speech). Would you like to enable it?', - default: false, - }, - ]); + const enableTts = await prompts.confirm({ + message: 'Claude Code supports TTS (Text-to-Speech). Would you like to enable it?', + default: false, + }); if (enableTts) { agentVibesConfig = { enabled: true, alreadyInstalled: false }; @@ -241,18 +244,11 @@ class UI { // Common actions choices.push({ name: 'Modify BMAD Installation', value: 'update' }); - const promptResult = await inquirer.prompt([ - { - type: 'list', - name: 'actionType', - message: 'What would you like to do?', - choices: choices, - default: choices[0].value, // Use the first option as default - }, - ]); - - // Extract actionType from prompt result - actionType = promptResult.actionType; + actionType = await prompts.select({ + message: 'What would you like to do?', + choices: choices, + default: choices[0].value, + }); // Handle quick update separately if (actionType === 'quick-update') { @@ -281,14 +277,10 @@ class UI { const { installedModuleIds } = await this.getExistingInstallation(confirmedDirectory); console.log(chalk.dim(` Found existing modules: ${[...installedModuleIds].join(', ')}`)); - const { changeModuleSelection } = await inquirer.prompt([ - { - type: 'confirm', - name: 'changeModuleSelection', - message: 'Modify official module selection (BMad Method, BMad Builder, Creative Innovation Suite)?', - default: false, - }, - ]); + const changeModuleSelection = await prompts.confirm({ + message: 'Modify official module selection (BMad Method, BMad Builder, Creative Innovation Suite)?', + default: false, + }); let selectedModules = []; if (changeModuleSelection) { @@ -301,14 +293,10 @@ class UI { // After module selection, ask about custom modules console.log(''); - const { changeCustomModules } = await inquirer.prompt([ - { - type: 'confirm', - name: 'changeCustomModules', - message: 'Modify custom module selection (add, update, or remove custom modules/agents/workflows)?', - default: false, - }, - ]); + const changeCustomModules = await prompts.confirm({ + message: 'Modify custom module selection (add, update, or remove custom modules/agents/workflows)?', + default: false, + }); let customModuleResult = { selectedCustomModules: [], customContentConfig: { hasCustomContent: false } }; if (changeCustomModules) { @@ -343,15 +331,10 @@ class UI { let enableTts = false; if (hasClaudeCode) { - const { enableTts: enable } = await inquirer.prompt([ - { - type: 'confirm', - name: 'enableTts', - message: 'Claude Code supports TTS (Text-to-Speech). Would you like to enable it?', - default: false, - }, - ]); - enableTts = enable; + enableTts = await prompts.confirm({ + message: 'Claude Code supports TTS (Text-to-Speech). Would you like to enable it?', + default: false, + }); } // Core config with existing defaults (ask after TTS) @@ -376,14 +359,10 @@ class UI { const { installedModuleIds } = await this.getExistingInstallation(confirmedDirectory); // Ask about official modules for new installations - const { wantsOfficialModules } = await inquirer.prompt([ - { - type: 'confirm', - name: 'wantsOfficialModules', - message: 'Will you be installing any official BMad modules (BMad Method, BMad Builder, Creative Innovation Suite)?', - default: true, - }, - ]); + const wantsOfficialModules = await prompts.confirm({ + message: 'Will you be installing any official BMad modules (BMad Method, BMad Builder, Creative Innovation Suite)?', + default: true, + }); let selectedOfficialModules = []; if (wantsOfficialModules) { @@ -392,14 +371,10 @@ class UI { } // Ask about custom content - const { wantsCustomContent } = await inquirer.prompt([ - { - type: 'confirm', - name: 'wantsCustomContent', - message: 'Would you like to install a local custom module (this includes custom agents and workflows also)?', - default: false, - }, - ]); + const wantsCustomContent = await prompts.confirm({ + message: 'Would you like to install a local custom module (this includes custom agents and workflows also)?', + default: false, + }); if (wantsCustomContent) { customContentConfig = await this.promptCustomContentSource(); @@ -467,13 +442,14 @@ class UI { const preferredIdes = ideManager.getPreferredIdes(); const otherIdes = ideManager.getOtherIdes(); - // Build IDE choices array with separators - const ideChoices = []; + // Build grouped options object for groupMultiselect + const groupedOptions = {}; const processedIdes = new Set(); + const initialValues = []; // First, add previously configured IDEs at the top, marked with ✅ if (configuredIdes.length > 0) { - ideChoices.push(new inquirer.Separator('── Previously Configured ──')); + const configuredGroup = []; for (const ideValue of configuredIdes) { // Skip empty or invalid IDE values if (!ideValue || typeof ideValue !== 'string') { @@ -486,81 +462,71 @@ class UI { const ide = preferredIde || otherIde; if (ide) { - ideChoices.push({ - name: `${ide.name} ✅`, + configuredGroup.push({ + label: `${ide.name} ✅`, value: ide.value, - checked: true, // Previously configured IDEs are checked by default }); processedIdes.add(ide.value); + initialValues.push(ide.value); // Pre-select configured IDEs } else { // Warn about unrecognized IDE (but don't fail) console.log(chalk.yellow(`⚠️ Previously configured IDE '${ideValue}' is no longer available`)); } } + if (configuredGroup.length > 0) { + groupedOptions['Previously Configured'] = configuredGroup; + } } // Add preferred tools (excluding already processed) const remainingPreferred = preferredIdes.filter((ide) => !processedIdes.has(ide.value)); if (remainingPreferred.length > 0) { - ideChoices.push(new inquirer.Separator('── Recommended Tools ──')); - for (const ide of remainingPreferred) { - ideChoices.push({ - name: `${ide.name} ⭐`, - value: ide.value, - checked: false, - }); + groupedOptions['Recommended Tools'] = remainingPreferred.map((ide) => { processedIdes.add(ide.value); - } + return { + label: `${ide.name} ⭐`, + value: ide.value, + }; + }); } // Add other tools (excluding already processed) const remainingOther = otherIdes.filter((ide) => !processedIdes.has(ide.value)); if (remainingOther.length > 0) { - ideChoices.push(new inquirer.Separator('── Additional Tools ──')); - for (const ide of remainingOther) { - ideChoices.push({ - name: ide.name, - value: ide.value, - checked: false, - }); - } + groupedOptions['Additional Tools'] = remainingOther.map((ide) => ({ + label: ide.name, + value: ide.value, + })); } - let answers; + let selectedIdes = []; let userConfirmedNoTools = false; // Loop until user selects at least one tool OR explicitly confirms no tools while (!userConfirmedNoTools) { - answers = await inquirer.prompt([ - { - type: 'checkbox', - name: 'ides', - message: 'Select tools to configure:', - choices: ideChoices, - pageSize: 30, - }, - ]); + selectedIdes = await prompts.groupMultiselect({ + message: `Select tools to configure ${chalk.dim('(↑/↓ navigate, SPACE select, ENTER confirm)')}:`, + options: groupedOptions, + initialValues: initialValues.length > 0 ? initialValues : undefined, + required: false, + }); // If tools were selected, we're done - if (answers.ides && answers.ides.length > 0) { + if (selectedIdes && selectedIdes.length > 0) { break; } // Warn that no tools were selected - users often miss the spacebar requirement console.log(); console.log(chalk.red.bold('⚠️ WARNING: No tools were selected!')); - console.log(chalk.red(' You must press SPACEBAR to select items, then ENTER to confirm.')); + console.log(chalk.red(' You must press SPACE to select items, then ENTER to confirm.')); console.log(chalk.red(' Simply highlighting an item does NOT select it.')); console.log(); - const { goBack } = await inquirer.prompt([ - { - type: 'confirm', - name: 'goBack', - message: chalk.yellow('Would you like to go back and select at least one tool?'), - default: true, - }, - ]); + const goBack = await prompts.confirm({ + message: chalk.yellow('Would you like to go back and select at least one tool?'), + default: true, + }); if (goBack) { // Re-display a message before looping back @@ -572,8 +538,8 @@ class UI { } return { - ides: answers.ides || [], - skipIde: !answers.ides || answers.ides.length === 0, + ides: selectedIdes || [], + skipIde: !selectedIdes || selectedIdes.length === 0, }; } @@ -582,22 +548,17 @@ class UI { * @returns {Object} Update configuration */ async promptUpdate() { - const answers = await inquirer.prompt([ - { - type: 'confirm', - name: 'backupFirst', - message: 'Create backup before updating?', - default: true, - }, - { - type: 'confirm', - name: 'preserveCustomizations', - message: 'Preserve local customizations?', - default: true, - }, - ]); + const backupFirst = await prompts.confirm({ + message: 'Create backup before updating?', + default: true, + }); - return answers; + const preserveCustomizations = await prompts.confirm({ + message: 'Preserve local customizations?', + default: true, + }); + + return { backupFirst, preserveCustomizations }; } /** @@ -612,20 +573,11 @@ class UI { checked: false, })); - const { selectedModules } = await inquirer.prompt([ - { - type: 'checkbox', - name: 'selectedModules', - message: 'Select modules to add:', - choices, - validate: (answer) => { - if (answer.length === 0) { - return 'You must choose at least one module.'; - } - return true; - }, - }, - ]); + const selectedModules = await prompts.multiselect({ + message: `Select modules to add ${chalk.dim('(↑/↓ navigate, SPACE select, ENTER confirm)')}:`, + choices, + required: true, + }); return selectedModules; } @@ -637,16 +589,10 @@ class UI { * @returns {boolean} User confirmation */ async confirm(message, defaultValue = false) { - const { confirmed } = await inquirer.prompt([ - { - type: 'confirm', - name: 'confirmed', - message, - default: defaultValue, - }, - ]); - - return confirmed; + return await prompts.confirm({ + message, + default: defaultValue, + }); } /** @@ -740,7 +686,7 @@ class UI { * Get module choices for selection * @param {Set} installedModuleIds - Currently installed module IDs * @param {Object} customContentConfig - Custom content configuration - * @returns {Array} Module choices for inquirer + * @returns {Array} Module choices for prompt */ async getModuleChoices(installedModuleIds, customContentConfig = null) { const moduleChoices = []; @@ -797,9 +743,9 @@ class UI { if (allCustomModules.length > 0) { // Add separator for custom content, all custom modules, and official content separator moduleChoices.push( - new inquirer.Separator('── Custom Content ──'), + new choiceUtils.Separator('── Custom Content ──'), ...allCustomModules, - new inquirer.Separator('── Official Content ──'), + new choiceUtils.Separator('── Official Content ──'), ); } @@ -823,42 +769,43 @@ class UI { * @returns {Array} Selected module IDs */ async selectModules(moduleChoices, defaultSelections = []) { - const moduleAnswer = await inquirer.prompt([ - { - type: 'checkbox', - name: 'modules', - message: 'Select modules to install:', - choices: moduleChoices, - default: defaultSelections, - }, - ]); + // Mark choices as checked based on defaultSelections + const choicesWithDefaults = moduleChoices.map((choice) => ({ + ...choice, + checked: defaultSelections.includes(choice.value), + })); - const selected = moduleAnswer.modules || []; + const selected = await prompts.multiselect({ + message: `Select modules to install ${chalk.dim('(↑/↓ navigate, SPACE select, ENTER confirm)')}:`, + choices: choicesWithDefaults, + required: false, + }); - return selected; + return selected || []; } /** * Prompt for directory selection - * @returns {Object} Directory answer from inquirer + * @returns {Object} Directory answer from prompt */ async promptForDirectory() { - return await inquirer.prompt([ - { - type: 'input', - name: 'directory', - message: `Installation directory:`, - default: process.cwd(), - validate: async (input) => this.validateDirectory(input), - filter: (input) => { - // If empty, use the default - if (!input || input.trim() === '') { - return process.cwd(); - } - return this.expandUserPath(input); - }, - }, - ]); + // Use sync validation because @clack/prompts doesn't support async validate + const directory = await prompts.text({ + message: 'Installation directory:', + default: process.cwd(), + placeholder: process.cwd(), + validate: (input) => this.validateDirectorySync(input), + }); + + // Apply filter logic + let filteredDir = directory; + if (!filteredDir || filteredDir.trim() === '') { + filteredDir = process.cwd(); + } else { + filteredDir = this.expandUserPath(filteredDir); + } + + return { directory: filteredDir }; } /** @@ -902,41 +849,89 @@ class UI { const dirExists = await fs.pathExists(directory); if (dirExists) { - const confirmAnswer = await inquirer.prompt([ - { - type: 'confirm', - name: 'proceed', - message: `Install to this directory?`, - default: true, - }, - ]); + const proceed = await prompts.confirm({ + message: 'Install to this directory?', + default: true, + }); - if (!confirmAnswer.proceed) { + if (!proceed) { console.log(chalk.yellow("\nLet's try again with a different path.\n")); } - return confirmAnswer.proceed; + return proceed; } else { // Ask for confirmation to create the directory - const createConfirm = await inquirer.prompt([ - { - type: 'confirm', - name: 'create', - message: `The directory '${directory}' doesn't exist. Would you like to create it?`, - default: false, - }, - ]); + const create = await prompts.confirm({ + message: `The directory '${directory}' doesn't exist. Would you like to create it?`, + default: false, + }); - if (!createConfirm.create) { + if (!create) { console.log(chalk.yellow("\nLet's try again with a different path.\n")); } - return createConfirm.create; + return create; } } /** - * Validate directory path for installation + * Validate directory path for installation (sync version for clack prompts) + * @param {string} input - User input path + * @returns {string|undefined} Error message or undefined if valid + */ + validateDirectorySync(input) { + // Allow empty input to use the default + if (!input || input.trim() === '') { + return; // Empty means use default, undefined = valid for clack + } + + let expandedPath; + try { + expandedPath = this.expandUserPath(input.trim()); + } catch (error) { + return error.message; + } + + // Check if the path exists + const pathExists = fs.pathExistsSync(expandedPath); + + if (!pathExists) { + // Find the first existing parent directory + const existingParent = this.findExistingParentSync(expandedPath); + + if (!existingParent) { + return 'Cannot create directory: no existing parent directory found'; + } + + // Check if the existing parent is writable + try { + fs.accessSync(existingParent, fs.constants.W_OK); + // Path doesn't exist but can be created - will prompt for confirmation later + return; + } catch { + // Provide a detailed error message explaining both issues + return `Directory '${expandedPath}' does not exist and cannot be created: parent directory '${existingParent}' is not writable`; + } + } + + // If it exists, validate it's a directory and writable + const stat = fs.statSync(expandedPath); + if (!stat.isDirectory()) { + return `Path exists but is not a directory: ${expandedPath}`; + } + + // Check write permissions + try { + fs.accessSync(expandedPath, fs.constants.W_OK); + } catch { + return `Directory is not writable: ${expandedPath}`; + } + + return; + } + + /** + * Validate directory path for installation (async version) * @param {string} input - User input path * @returns {string|true} Error message or true if valid */ @@ -992,7 +987,28 @@ class UI { } /** - * Find the first existing parent directory + * Find the first existing parent directory (sync version) + * @param {string} targetPath - The path to check + * @returns {string|null} The first existing parent directory, or null if none found + */ + findExistingParentSync(targetPath) { + let currentPath = path.resolve(targetPath); + + // Walk up the directory tree until we find an existing directory + while (currentPath !== path.dirname(currentPath)) { + // Stop at root + const parent = path.dirname(currentPath); + if (fs.pathExistsSync(parent)) { + return parent; + } + currentPath = parent; + } + + return null; // No existing parent found (shouldn't happen in practice) + } + + /** + * Find the first existing parent directory (async version) * @param {string} targetPath - The path to check * @returns {string|null} The first existing parent directory, or null if none found */ @@ -1054,7 +1070,7 @@ class UI { * @sideeffects None - pure user input collection, no files written * @edgecases Shows warning if user enables TTS but AgentVibes not detected * @calledby promptInstall() during installation flow, after core config, before IDE selection - * @calls checkAgentVibesInstalled(), inquirer.prompt(), chalk.green/yellow/dim() + * @calls checkAgentVibesInstalled(), prompts.select(), chalk.green/yellow/dim() * * AI NOTE: This prompt is strategically positioned in installation flow: * - AFTER core config (user_name, etc) @@ -1096,23 +1112,19 @@ class UI { console.log(chalk.dim(' AgentVibes not detected')); } - const answers = await inquirer.prompt([ - { - type: 'confirm', - name: 'enableTts', - message: 'Enable Agents to Speak Out loud (powered by Agent Vibes? Claude Code only currently)', - default: false, // Default to yes - recommended for best experience - }, - ]); + const enableTts = await prompts.confirm({ + message: 'Enable Agents to Speak Out loud (powered by Agent Vibes? Claude Code only currently)', + default: false, + }); - if (answers.enableTts && !agentVibesInstalled) { + if (enableTts && !agentVibesInstalled) { console.log(chalk.yellow('\n ⚠️ AgentVibes not installed')); console.log(chalk.dim(' Install AgentVibes separately to enable TTS:')); console.log(chalk.dim(' https://github.com/paulpreibisch/AgentVibes\n')); } return { - enabled: answers.enableTts, + enabled: enableTts, alreadyInstalled: agentVibesInstalled, }; } @@ -1230,6 +1242,56 @@ class UI { return existingInstall.ides || []; } + /** + * Validate custom content path synchronously + * @param {string} input - User input path + * @returns {string|undefined} Error message or undefined if valid + */ + validateCustomContentPathSync(input) { + // Allow empty input to cancel + if (!input || input.trim() === '') { + return; // Allow empty to exit + } + + try { + // Expand the path + const expandedPath = this.expandUserPath(input.trim()); + + // Check if path exists + if (!fs.pathExistsSync(expandedPath)) { + return 'Path does not exist'; + } + + // Check if it's a directory + const stat = fs.statSync(expandedPath); + if (!stat.isDirectory()) { + return 'Path must be a directory'; + } + + // Check for module.yaml in the root + const moduleYamlPath = path.join(expandedPath, 'module.yaml'); + if (!fs.pathExistsSync(moduleYamlPath)) { + return 'Directory must contain a module.yaml file in the root'; + } + + // Try to parse the module.yaml to get the module ID + try { + const yaml = require('yaml'); + const content = fs.readFileSync(moduleYamlPath, 'utf8'); + const moduleData = yaml.parse(content); + if (!moduleData.code) { + return 'module.yaml must contain a "code" field for the module ID'; + } + } catch (error) { + return 'Invalid module.yaml file: ' + error.message; + } + + return; // Valid + } catch (error) { + return 'Error validating path: ' + error.message; + } + } + /** * Prompt user for custom content source location * @returns {Object} Custom content configuration @@ -1241,18 +1303,14 @@ class UI { while (true) { // First ask if user wants to add another module or continue if (customContentConfig.sources.length > 0) { - const { action } = await inquirer.prompt([ - { - type: 'list', - name: 'action', - message: 'Would you like to:', - choices: [ - { name: 'Add another custom module', value: 'add' }, - { name: 'Continue with installation', value: 'continue' }, - ], - default: 'continue', - }, - ]); + const action = await prompts.select({ + message: 'Would you like to:', + choices: [ + { name: 'Add another custom module', value: 'add' }, + { name: 'Continue with installation', value: 'continue' }, + ], + default: 'continue', + }); if (action === 'continue') { break; @@ -1263,57 +1321,11 @@ class UI { let isValid = false; while (!isValid) { - const { path: inputPath } = await inquirer.prompt([ - { - type: 'input', - name: 'path', - message: 'Enter the path to your custom content folder (or press Enter to cancel):', - validate: async (input) => { - // Allow empty input to cancel - if (!input || input.trim() === '') { - return true; // Allow empty to exit - } - - try { - // Expand the path - const expandedPath = this.expandUserPath(input.trim()); - - // Check if path exists - if (!(await fs.pathExists(expandedPath))) { - return 'Path does not exist'; - } - - // Check if it's a directory - const stat = await fs.stat(expandedPath); - if (!stat.isDirectory()) { - return 'Path must be a directory'; - } - - // Check for module.yaml in the root - const moduleYamlPath = path.join(expandedPath, 'module.yaml'); - if (!(await fs.pathExists(moduleYamlPath))) { - return 'Directory must contain a module.yaml file in the root'; - } - - // Try to parse the module.yaml to get the module ID - try { - const yaml = require('yaml'); - const content = await fs.readFile(moduleYamlPath, 'utf8'); - const moduleData = yaml.parse(content); - if (!moduleData.code) { - return 'module.yaml must contain a "code" field for the module ID'; - } - } catch (error) { - return 'Invalid module.yaml file: ' + error.message; - } - - return true; - } catch (error) { - return 'Error validating path: ' + error.message; - } - }, - }, - ]); + // Use sync validation because @clack/prompts doesn't support async validate + const inputPath = await prompts.text({ + message: 'Enter the path to your custom content folder (or press Enter to cancel):', + validate: (input) => this.validateCustomContentPathSync(input), + }); // If user pressed Enter without typing anything, exit the loop if (!inputPath || inputPath.trim() === '') { @@ -1345,14 +1357,10 @@ class UI { } // Ask if user wants to add these to the installation - const { shouldInstall } = await inquirer.prompt([ - { - type: 'confirm', - name: 'shouldInstall', - message: `Install ${customContentConfig.sources.length} custom module(s) now?`, - default: true, - }, - ]); + const shouldInstall = await prompts.confirm({ + message: `Install ${customContentConfig.sources.length} custom module(s) now?`, + default: true, + }); if (shouldInstall) { customContentConfig.selected = true; @@ -1431,16 +1439,11 @@ class UI { choices.push({ name: 'Add new custom modules', value: 'add' }, { name: 'Cancel (no custom modules)', value: 'cancel' }); } - const { customAction } = await inquirer.prompt([ - { - type: 'list', - name: 'customAction', - message: - cachedCustomModules.length > 0 ? 'What would you like to do with custom modules?' : 'Would you like to add custom modules?', - choices: choices, - default: cachedCustomModules.length > 0 ? 'keep' : 'add', - }, - ]); + const customAction = await prompts.select({ + message: cachedCustomModules.length > 0 ? 'What would you like to do with custom modules?' : 'Would you like to add custom modules?', + choices: choices, + default: cachedCustomModules.length > 0 ? 'keep' : 'add', + }); switch (customAction) { case 'keep': { @@ -1452,21 +1455,18 @@ class UI { case 'select': { // Let user choose which to keep - const choices = cachedCustomModules.map((m) => ({ + const selectChoices = cachedCustomModules.map((m) => ({ name: `${m.name} ${chalk.gray(`(${m.id})`)}`, value: m.id, + checked: m.checked, })); - const { keepModules } = await inquirer.prompt([ - { - type: 'checkbox', - name: 'keepModules', - message: 'Select custom modules to keep:', - choices: choices, - default: cachedCustomModules.filter((m) => m.checked).map((m) => m.id), - }, - ]); - result.selectedCustomModules = keepModules; + const keepModules = await prompts.multiselect({ + message: `Select custom modules to keep ${chalk.dim('(↑/↓ navigate, SPACE select, ENTER confirm)')}:`, + choices: selectChoices, + required: false, + }); + result.selectedCustomModules = keepModules || []; break; } @@ -1606,26 +1606,20 @@ class UI { console.log(chalk.yellow('─'.repeat(80))); console.log(''); - const { proceed } = await inquirer.prompt([ - { - type: 'list', - name: 'proceed', - message: 'What would you like to do?', - choices: [ - { - name: 'Proceed with update anyway (may have issues)', - value: 'proceed', - short: 'Proceed with update', - }, - { - name: 'Cancel (recommended - do a fresh install instead)', - value: 'cancel', - short: 'Cancel installation', - }, - ], - default: 'cancel', - }, - ]); + const proceed = await prompts.select({ + message: 'What would you like to do?', + choices: [ + { + name: 'Proceed with update anyway (may have issues)', + value: 'proceed', + }, + { + name: 'Cancel (recommended - do a fresh install instead)', + value: 'cancel', + }, + ], + default: 'cancel', + }); if (proceed === 'cancel') { console.log(''); diff --git a/docs/BUNDLE_DISTRIBUTION_SETUP.md b/tools/docs/BUNDLE_DISTRIBUTION_SETUP.md similarity index 100% rename from docs/BUNDLE_DISTRIBUTION_SETUP.md rename to tools/docs/BUNDLE_DISTRIBUTION_SETUP.md diff --git a/tools/docs/index.md b/tools/docs/index.md new file mode 100644 index 00000000..8ac7bc86 --- /dev/null +++ b/tools/docs/index.md @@ -0,0 +1,2 @@ +# Tool and Repo Maintainability Documentation + diff --git a/tools/fix-doc-links.js b/tools/fix-doc-links.js new file mode 100644 index 00000000..dbfcc862 --- /dev/null +++ b/tools/fix-doc-links.js @@ -0,0 +1,288 @@ +/** + * Fix Documentation Links + * + * Converts relative markdown links to repo-relative paths with .md extension. + * This ensures links work both in GitHub and on the Astro/Starlight site + * (the rehype plugin transforms /docs/path/file.md → /path/file/ at build time). + * + * - ./file.md → /docs/current/path/file.md + * - ../other/file.md → /docs/resolved/path/file.md + * - /path/file/ → /docs/path/file.md (or /docs/path/file/index.md if it's a directory) + * + * Usage: + * node tools/fix-doc-links.js # Dry run (shows what would change) + * node tools/fix-doc-links.js --write # Actually write changes + */ + +const fs = require('node:fs'); +const path = require('node:path'); + +const DOCS_ROOT = path.resolve(__dirname, '../docs'); +const DRY_RUN = !process.argv.includes('--write'); + +// Regex to match markdown links: +// - [text](path.md) or [text](path.md#anchor) - existing .md links +// - [text](/path/to/page/) or [text](/path/to/page/#anchor) - site-relative links to convert +const MARKDOWN_LINK_REGEX = /\[([^\]]*)\]\(([^)]+(?:\.md|\/))(?:#[^)]*)?(?:\?[^)]*)?\)/g; +// Simpler approach: match all markdown links and filter in the handler +const ALL_MARKDOWN_LINKS_REGEX = /\[([^\]]*)\]\(([^)]+)\)/g; + +/** + * Get all markdown files in docs directory, excluding _* directories/files + */ +function getMarkdownFiles(dir) { + const files = []; + + function walk(currentDir) { + const entries = fs.readdirSync(currentDir, { withFileTypes: true }); + + for (const entry of entries) { + const fullPath = path.join(currentDir, entry.name); + + // Skip underscore-prefixed entries + if (entry.name.startsWith('_')) { + continue; + } + + if (entry.isDirectory()) { + walk(fullPath); + } else if (entry.isFile() && entry.name.endsWith('.md')) { + files.push(fullPath); + } + } + } + + walk(dir); + return files; +} + +/** + * Convert a markdown link href to repo-relative path with .md extension + * + * @param {string} href - The original href (e.g., "./file.md", "/path/to/page/", "/path/to/page/#anchor") + * @param {string} currentFilePath - Absolute path to the file containing this link + * @returns {string|null} - Repo-relative path (e.g., "/docs/path/to/file.md"), or null if shouldn't be converted + */ +function convertToRepoRelative(href, currentFilePath) { + // Skip external links + if (href.includes('://') || href.startsWith('mailto:') || href.startsWith('tel:')) { + return null; + } + + // Skip anchor-only links + if (href.startsWith('#')) { + return null; + } + + // Extract anchor and query string if present + let anchor = ''; + let query = ''; + let pathPortion = href; + + const hashIndex = href.indexOf('#'); + const queryIndex = href.indexOf('?'); + + if (hashIndex !== -1 || queryIndex !== -1) { + const firstDelimiter = Math.min(hashIndex === -1 ? Infinity : hashIndex, queryIndex === -1 ? Infinity : queryIndex); + pathPortion = href.slice(0, Math.max(0, firstDelimiter)); + + const suffix = href.slice(Math.max(0, firstDelimiter)); + const anchorInSuffix = suffix.indexOf('#'); + + if (suffix.startsWith('?')) { + if (anchorInSuffix === -1) { + query = suffix; + } else { + query = suffix.slice(0, Math.max(0, anchorInSuffix)); + anchor = suffix.slice(Math.max(0, anchorInSuffix)); + } + } else { + anchor = suffix; + } + } + + // Skip non-documentation links (images, external assets, etc.) + const ext = path.extname(pathPortion).toLowerCase(); + if ( + ext && + ext !== '.md' && + !['.md'].includes(ext) && // Has an extension that's not .md - skip unless it's a trailing slash path + !pathPortion.endsWith('/') + ) { + return null; + } + + // Check if original path ends with / (directory reference) BEFORE path.join normalizes it + const isDirectoryPath = pathPortion.endsWith('/'); + + let absolutePath; + + if (pathPortion.startsWith('/docs/')) { + // Already repo-relative with /docs/ prefix + absolutePath = path.join(path.dirname(DOCS_ROOT), pathPortion); + } else if (pathPortion.startsWith('/')) { + // Site-relative (e.g., /tutorials/getting-started/) - resolve from docs root + absolutePath = path.join(DOCS_ROOT, pathPortion); + } else { + // Relative path (./, ../, or bare filename) - resolve from current file's directory + const currentDir = path.dirname(currentFilePath); + absolutePath = path.resolve(currentDir, pathPortion); + } + + // Convert to repo-relative path (with /docs/ prefix) + let repoRelative = '/docs/' + path.relative(DOCS_ROOT, absolutePath); + + // Normalize path separators for Windows + repoRelative = repoRelative.split(path.sep).join('/'); + + // If original path was a directory reference (ended with /), check for index.md or file.md + if (isDirectoryPath) { + const relativeDir = repoRelative.slice(6); // Remove '/docs/' + + // Handle root path case (relativeDir is empty or just '.') + const normalizedDir = relativeDir === '' || relativeDir === '.' ? '' : relativeDir; + const indexPath = path.join(DOCS_ROOT, normalizedDir, 'index.md'); + const filePath = normalizedDir ? path.join(DOCS_ROOT, normalizedDir + '.md') : null; + + if (fs.existsSync(indexPath)) { + // Avoid double slash when repoRelative is '/docs/' (root case) + repoRelative = repoRelative.endsWith('/') ? repoRelative + 'index.md' : repoRelative + '/index.md'; + } else if (filePath && fs.existsSync(filePath)) { + repoRelative = repoRelative + '.md'; + } else { + // Neither exists - default to index.md and let validation catch it + repoRelative = repoRelative.endsWith('/') ? repoRelative + 'index.md' : repoRelative + '/index.md'; + } + } else if (!repoRelative.endsWith('.md')) { + // Path doesn't end with .md - add .md + repoRelative = repoRelative + '.md'; + } + + return repoRelative + query + anchor; +} + +/** + * Process a single markdown file, skipping links inside fenced code blocks + * + * @param {string} filePath - Absolute path to the file + * @returns {Object} - { changed: boolean, original: string, updated: string, changes: Array } + */ +function processFile(filePath) { + const original = fs.readFileSync(filePath, 'utf-8'); + const changes = []; + + // Extract fenced code blocks and replace with placeholders + const codeBlocks = []; + const CODE_PLACEHOLDER = '\u0000CODE_BLOCK_'; + + let contentWithPlaceholders = original.replaceAll(/```[\s\S]*?```/g, (match) => { + const index = codeBlocks.length; + codeBlocks.push(match); + return `${CODE_PLACEHOLDER}${index}\u0000`; + }); + + // Process links only in non-code-block content + contentWithPlaceholders = contentWithPlaceholders.replaceAll(ALL_MARKDOWN_LINKS_REGEX, (match, linkText, href) => { + const newHref = convertToRepoRelative(href, filePath); + + // Skip if conversion returned null (external link, anchor, etc.) + if (newHref === null) { + return match; + } + + // Only record as change if actually different + if (newHref !== href) { + changes.push({ from: href, to: newHref }); + return `[${linkText}](${newHref})`; + } + + return match; + }); + + // Restore code blocks + const updated = contentWithPlaceholders.replaceAll( + new RegExp(`${CODE_PLACEHOLDER}(\\d+)\u0000`, 'g'), + (match, index) => codeBlocks[parseInt(index, 10)], + ); + + return { + changed: changes.length > 0, + original, + updated, + changes, + }; +} + +/** + * Validate that a repo-relative link points to an existing file + */ +function validateLink(repoRelativePath) { + // Strip anchor/query + const checkPath = repoRelativePath.split('#')[0].split('?')[0]; + + // Remove /docs/ prefix to get path relative to DOCS_ROOT + const relativePath = checkPath.startsWith('/docs/') ? checkPath.slice(6) : checkPath.slice(1); + + return fs.existsSync(path.join(DOCS_ROOT, relativePath)); +} + +// Main execution +console.log(`\nScanning docs in: ${DOCS_ROOT}`); +console.log(`Mode: ${DRY_RUN ? 'DRY RUN (use --write to apply changes)' : 'WRITE MODE'}\n`); + +const files = getMarkdownFiles(DOCS_ROOT); +console.log(`Found ${files.length} markdown files (excluding _* paths)\n`); + +let totalChanges = 0; +let filesChanged = 0; +const brokenLinks = []; + +for (const filePath of files) { + const relativePath = path.relative(DOCS_ROOT, filePath); + const result = processFile(filePath); + + if (result.changed) { + filesChanged++; + totalChanges += result.changes.length; + + console.log(`\n${relativePath}`); + for (const change of result.changes) { + const isValid = validateLink(change.to); + const status = isValid ? ' ' : '! '; + + console.log(`${status} ${change.from}`); + console.log(` -> ${change.to}`); + + if (!isValid) { + brokenLinks.push({ + file: relativePath, + link: change.to, + original: change.from, + }); + } + } + + if (!DRY_RUN) { + fs.writeFileSync(filePath, result.updated, 'utf-8'); + } + } +} + +console.log(`\n${'─'.repeat(60)}`); +console.log(`\nSummary:`); +console.log(` Files scanned: ${files.length}`); +console.log(` Files with changes: ${filesChanged}`); +console.log(` Total link updates: ${totalChanges}`); + +if (brokenLinks.length > 0) { + console.log(`\n! Potential broken links (${brokenLinks.length}):`); + for (const bl of brokenLinks) { + console.log(` ${bl.file}: ${bl.link}`); + } +} + +if (DRY_RUN && totalChanges > 0) { + console.log(`\nRun with --write to apply these changes`); +} + +console.log(''); diff --git a/tools/platform-codes.yaml b/tools/platform-codes.yaml index a58e2119..04c4a45f 100644 --- a/tools/platform-codes.yaml +++ b/tools/platform-codes.yaml @@ -56,11 +56,23 @@ platforms: description: "Enhanced Cline fork" rovo: - name: "Rovo Dev" + name: "Rovo" preferred: false category: ide description: "Atlassian's AI coding assistant" + rovo-dev: + name: "Rovo Dev" + preferred: false + category: ide + description: "Atlassian's Rovo development environment" + + kiro-cli: + name: "Kiro CLI" + preferred: false + category: cli + description: "Kiro command-line interface" + github-copilot: name: "GitHub Copilot" preferred: false diff --git a/tools/schema/agent.js b/tools/schema/agent.js index e8e9dc73..ee9be7fb 100644 --- a/tools/schema/agent.js +++ b/tools/schema/agent.js @@ -4,7 +4,7 @@ const { z } = require('zod'); const COMMAND_TARGET_KEYS = ['workflow', 'validate-workflow', 'exec', 'action', 'tmpl', 'data']; const TRIGGER_PATTERN = /^[a-z0-9]+(?:-[a-z0-9]+)*$/; -const COMPOUND_TRIGGER_PATTERN = /^([A-Z]{1,2}) or ([a-z0-9]+(?:-[a-z0-9]+)*) or fuzzy match on ([a-z0-9]+(?:-[a-z0-9]+)*)$/; +const COMPOUND_TRIGGER_PATTERN = /^([A-Z]{1,3}) or fuzzy match on ([a-z0-9]+(?:-[a-z0-9]+)*)$/; /** * Derive the expected shortcut from a kebab-case trigger. @@ -23,9 +23,9 @@ function deriveShortcutFromKebab(kebabTrigger) { /** * Parse and validate a compound trigger string. - * Format: " or or fuzzy match on " + * Format: " or fuzzy match on " * @param {string} triggerValue The trigger string to parse. - * @returns {{ valid: boolean, kebabTrigger?: string, error?: string }} + * @returns {{ valid: boolean, shortcut?: string, kebabTrigger?: string, error?: string }} */ function parseCompoundTrigger(triggerValue) { const match = COMPOUND_TRIGGER_PATTERN.exec(triggerValue); @@ -33,26 +33,9 @@ function parseCompoundTrigger(triggerValue) { return { valid: false, error: 'invalid compound trigger format' }; } - const [, shortcut, kebabTrigger, fuzzyKebab] = match; + const [, shortcut, kebabTrigger] = match; - // Validate both kebab instances are identical - if (kebabTrigger !== fuzzyKebab) { - return { - valid: false, - error: `kebab-case trigger mismatch: "${kebabTrigger}" vs "${fuzzyKebab}"`, - }; - } - - // Validate shortcut matches derived value - const expectedShortcut = deriveShortcutFromKebab(kebabTrigger); - if (shortcut !== expectedShortcut) { - return { - valid: false, - error: `shortcut "${shortcut}" does not match expected "${expectedShortcut}" for "${kebabTrigger}"`, - }; - } - - return { valid: true, kebabTrigger }; + return { valid: true, shortcut, kebabTrigger }; } // Public API --------------------------------------------------------------- @@ -115,6 +98,28 @@ function agentSchema(options = {}) { }); return; } + + // Validate that shortcut matches description brackets + const descriptionMatch = item.description?.match(/^\[([A-Z]{1,3})\]/); + if (!descriptionMatch) { + ctx.addIssue({ + code: 'custom', + path: ['agent', 'menu', index, 'description'], + message: `agent.menu[].description must start with [SHORTCUT] where SHORTCUT matches the trigger shortcut "${result.shortcut}"`, + }); + return; + } + + const descriptionShortcut = descriptionMatch[1]; + if (descriptionShortcut !== result.shortcut) { + ctx.addIssue({ + code: 'custom', + path: ['agent', 'menu', index, 'description'], + message: `agent.menu[].description shortcut "[${descriptionShortcut}]" must match trigger shortcut "${result.shortcut}"`, + }); + return; + } + canonicalTrigger = result.kebabTrigger; } else if (!TRIGGER_PATTERN.test(triggerValue)) { ctx.addIssue({ @@ -213,8 +218,9 @@ function buildAgentSchema(expectedModule) { } /** - * Validate metadata shape and cross-check module expectation against caller input. + * Validate metadata shape. * @param {string|null} expectedModule Trimmed module slug or null when core agent metadata is expected. + * Note: Module field is optional and can be any value - no validation against path. */ function buildMetadataSchema(expectedModule) { const schemaShape = { @@ -223,37 +229,10 @@ function buildMetadataSchema(expectedModule) { title: createNonEmptyString('agent.metadata.title'), icon: createNonEmptyString('agent.metadata.icon'), module: createNonEmptyString('agent.metadata.module').optional(), + hasSidecar: z.boolean(), }; - return ( - z - .object(schemaShape) - .strict() - // Refinement: guard presence and correctness of metadata.module. - .superRefine((value, ctx) => { - const moduleValue = typeof value.module === 'string' ? value.module.trim() : null; - - if (expectedModule && !moduleValue) { - ctx.addIssue({ - code: 'custom', - path: ['module'], - message: 'module-scoped agents must declare agent.metadata.module', - }); - } else if (!expectedModule && moduleValue) { - ctx.addIssue({ - code: 'custom', - path: ['module'], - message: 'core agents must not include agent.metadata.module', - }); - } else if (expectedModule && moduleValue !== expectedModule) { - ctx.addIssue({ - code: 'custom', - path: ['module'], - message: `agent.metadata.module must equal "${expectedModule}"`, - }); - } - }) - ); + return z.object(schemaShape).strict(); } function buildPersonaSchema() { diff --git a/tools/validate-doc-links.js b/tools/validate-doc-links.js new file mode 100644 index 00000000..5b0a018a --- /dev/null +++ b/tools/validate-doc-links.js @@ -0,0 +1,363 @@ +/** + * Documentation Link Validator + * + * Validates site-relative links in markdown files and attempts to fix broken ones. + * + * What it checks: + * - All site-relative links (starting with /) point to existing .md files + * - Anchor links (#section) point to valid headings + * + * What it fixes: + * - Broken links where the target file can be found elsewhere in /docs + * + * Usage: + * node tools/validate-doc-links.js # Dry run (validate and show issues) + * node tools/validate-doc-links.js --write # Fix auto-fixable issues + */ + +const fs = require('node:fs'); +const path = require('node:path'); + +const DOCS_ROOT = path.resolve(__dirname, '../docs'); +const DRY_RUN = !process.argv.includes('--write'); + +// Regex to match markdown links with site-relative paths +const LINK_REGEX = /\[([^\]]*)\]\((\/[^)]+)\)/g; + +// File extensions that are static assets, not markdown docs +const STATIC_ASSET_EXTENSIONS = ['.zip', '.txt', '.pdf', '.png', '.jpg', '.jpeg', '.gif', '.svg', '.webp', '.ico']; + +// Regex to extract headings for anchor validation +const HEADING_PATTERN = /^#{1,6}\s+(.+)$/gm; + +/** + * Get all markdown files in docs directory, excluding _* directories/files + */ +function getMarkdownFiles(dir) { + const files = []; + + function walk(currentDir) { + const entries = fs.readdirSync(currentDir, { withFileTypes: true }); + + for (const entry of entries) { + const fullPath = path.join(currentDir, entry.name); + + if (entry.name.startsWith('_')) { + continue; + } + + if (entry.isDirectory()) { + walk(fullPath); + } else if (entry.isFile() && entry.name.endsWith('.md')) { + files.push(fullPath); + } + } + } + + walk(dir); + return files; +} + +/** + * Strip fenced code blocks from content + */ +function stripCodeBlocks(content) { + return content.replaceAll(/```[\s\S]*?```/g, ''); +} + +/** + * Convert a heading to its anchor slug + */ +function headingToAnchor(heading) { + return heading + .toLowerCase() + .replaceAll(/[\u{1F300}-\u{1F9FF}]/gu, '') // Remove emojis + .replaceAll(/[^\w\s-]/g, '') // Remove special chars + .replaceAll(/\s+/g, '-') // Spaces to hyphens + .replaceAll(/-+/g, '-') // Collapse hyphens + .replaceAll(/^-+|-+$/g, ''); // Trim hyphens +} + +/** + * Extract anchor slugs from a markdown file + */ +function extractAnchors(content) { + const anchors = new Set(); + let match; + + HEADING_PATTERN.lastIndex = 0; + while ((match = HEADING_PATTERN.exec(content)) !== null) { + const headingText = match[1] + .trim() + .replaceAll(/`[^`]+`/g, '') + .replaceAll(/\*\*([^*]+)\*\*/g, '$1') + .replaceAll(/\*([^*]+)\*/g, '$1') + .replaceAll(/\[([^\]]+)\]\([^)]+\)/g, '$1') + .trim(); + anchors.add(headingToAnchor(headingText)); + } + + return anchors; +} + +/** + * Resolve a site-relative link to a file path + * /docs/how-to/installation/install-bmad.md -> docs/how-to/installation/install-bmad.md + * /how-to/installation/install-bmad/ -> docs/how-to/installation/install-bmad.md or .../index.md + */ +function resolveLink(siteRelativePath) { + // Strip anchor and query + let checkPath = siteRelativePath.split('#')[0].split('?')[0]; + + // Strip /docs/ prefix if present (repo-relative links) + if (checkPath.startsWith('/docs/')) { + checkPath = checkPath.slice(5); // Remove '/docs' but keep leading '/' + } + + if (checkPath.endsWith('/')) { + // Could be file.md or directory/index.md + const asFile = path.join(DOCS_ROOT, checkPath.slice(0, -1) + '.md'); + const asIndex = path.join(DOCS_ROOT, checkPath, 'index.md'); + + if (fs.existsSync(asFile)) return asFile; + if (fs.existsSync(asIndex)) return asIndex; + return null; + } + + // Direct path (e.g., /path/file.md) + const direct = path.join(DOCS_ROOT, checkPath); + if (fs.existsSync(direct)) return direct; + + // Try with .md extension + const withMd = direct + '.md'; + if (fs.existsSync(withMd)) return withMd; + + return null; +} + +/** + * Search for a file with directory context + */ +function findFileWithContext(brokenPath) { + // Extract filename and parent directory from the broken path + // e.g., /tutorials/getting-started/foo/ -> parent: getting-started, file: foo.md + const cleanPath = brokenPath.replace(/\/$/, '').replace(/^\//, ''); + const parts = cleanPath.split('/'); + const fileName = parts.at(-1) + '.md'; + const parentDir = parts.length > 1 ? parts.at(-2) : null; + + const allFiles = getMarkdownFiles(DOCS_ROOT); + const matches = []; + + for (const file of allFiles) { + const fileBaseName = path.basename(file); + const fileParentDir = path.basename(path.dirname(file)); + + // Exact filename match with parent directory context + if (fileBaseName === fileName) { + if (parentDir && fileParentDir === parentDir) { + // Strong match: both filename and parent dir match + return [file]; + } + matches.push(file); + } + + // Also check for index.md in a matching directory + if (fileBaseName === 'index.md' && fileParentDir === fileName.replace('.md', '')) { + matches.push(file); + } + } + + return matches; +} + +/** + * Convert absolute file path to site-relative URL + */ +function fileToSiteRelative(filePath) { + let relative = '/' + path.relative(DOCS_ROOT, filePath); + relative = relative.split(path.sep).join('/'); + + if (relative.endsWith('/index.md')) { + return relative.replace(/\/index\.md$/, '/'); + } + return relative.replace(/\.md$/, '/'); +} + +/** + * Process a single file and find issues + */ +function processFile(filePath) { + const content = fs.readFileSync(filePath, 'utf-8'); + const strippedContent = stripCodeBlocks(content); + const issues = []; + + let match; + LINK_REGEX.lastIndex = 0; + + while ((match = LINK_REGEX.exec(strippedContent)) !== null) { + const linkText = match[1]; + const href = match[2]; + + // Extract path and anchor + const hashIndex = href.indexOf('#'); + const linkPath = hashIndex === -1 ? href : href.slice(0, hashIndex); + const anchor = hashIndex === -1 ? null : href.slice(hashIndex + 1); + + // Skip static asset links (zip, txt, images, etc.) + const linkLower = linkPath.toLowerCase(); + if (STATIC_ASSET_EXTENSIONS.some((ext) => linkLower.endsWith(ext))) { + continue; + } + + // Validate the link target exists + const targetFile = resolveLink(linkPath); + + if (!targetFile) { + // Link is broken - try to find the file + const candidates = findFileWithContext(linkPath); + + const issue = { + type: 'broken-link', + linkText, + href, + linkPath, + fullMatch: match[0], + }; + + if (candidates.length === 1) { + issue.status = 'auto-fixable'; + issue.suggestedFix = fileToSiteRelative(candidates[0]) + (anchor ? '#' + anchor : ''); + issue.foundAt = path.relative(DOCS_ROOT, candidates[0]); + } else if (candidates.length > 1) { + issue.status = 'needs-review'; + issue.candidates = candidates.map((c) => path.relative(DOCS_ROOT, c)); + } else { + issue.status = 'manual-check'; + } + + issues.push(issue); + continue; + } + + // Validate anchor if present + if (anchor) { + const targetContent = fs.readFileSync(targetFile, 'utf-8'); + const anchors = extractAnchors(targetContent); + + if (!anchors.has(anchor)) { + issues.push({ + type: 'broken-anchor', + linkText, + href, + anchor, + status: 'manual-check', + message: `Anchor "#${anchor}" not found`, + }); + } + } + } + + return { content, issues }; +} + +/** + * Apply fixes to file content + */ +function applyFixes(content, issues) { + let updated = content; + + for (const issue of issues) { + if (issue.status === 'auto-fixable' && issue.suggestedFix) { + const oldLink = `[${issue.linkText}](${issue.href})`; + const newLink = `[${issue.linkText}](${issue.suggestedFix})`; + updated = updated.replace(oldLink, newLink); + } + } + + return updated; +} + +// Main execution +console.log(`\nValidating docs in: ${DOCS_ROOT}`); +console.log(`Mode: ${DRY_RUN ? 'DRY RUN (use --write to fix)' : 'WRITE MODE'}\n`); + +const files = getMarkdownFiles(DOCS_ROOT); +console.log(`Found ${files.length} markdown files\n`); + +let totalIssues = 0; +let autoFixable = 0; +let needsReview = 0; +let manualCheck = 0; +let filesWithIssues = 0; + +const allIssues = []; + +for (const filePath of files) { + const relativePath = path.relative(DOCS_ROOT, filePath); + const { content, issues } = processFile(filePath); + + if (issues.length > 0) { + filesWithIssues++; + totalIssues += issues.length; + + console.log(`\n${relativePath}`); + + for (const issue of issues) { + if (issue.status === 'auto-fixable') { + autoFixable++; + console.log(` [FIX] ${issue.href}`); + console.log(` -> ${issue.suggestedFix}`); + } else if (issue.status === 'needs-review') { + needsReview++; + console.log(` [REVIEW] ${issue.href}`); + console.log(` Multiple matches found:`); + for (const candidate of issue.candidates) { + console.log(` - ${candidate}`); + } + } else if (issue.type === 'broken-anchor') { + manualCheck++; + console.log(` [MANUAL] ${issue.href}`); + console.log(` ${issue.message}`); + } else { + manualCheck++; + console.log(` [MANUAL] ${issue.href}`); + console.log(` File not found anywhere - may need to remove link`); + } + + allIssues.push({ file: relativePath, ...issue }); + } + + // Apply fixes if not dry run + if (!DRY_RUN) { + const fixableIssues = issues.filter((i) => i.status === 'auto-fixable'); + if (fixableIssues.length > 0) { + const updated = applyFixes(content, fixableIssues); + fs.writeFileSync(filePath, updated, 'utf-8'); + } + } + } +} + +console.log(`\n${'─'.repeat(60)}`); +console.log(`\nSummary:`); +console.log(` Files scanned: ${files.length}`); +console.log(` Files with issues: ${filesWithIssues}`); +console.log(` Total issues: ${totalIssues}`); + +if (totalIssues > 0) { + console.log(`\n Breakdown:`); + console.log(` Auto-fixable: ${autoFixable}`); + console.log(` Needs review: ${needsReview}`); + console.log(` Manual check: ${manualCheck}`); +} + +if (totalIssues === 0) { + console.log(`\n All links valid!`); +} else if (DRY_RUN && autoFixable > 0) { + console.log(`\nRun with --write to auto-fix ${autoFixable} issue(s)`); +} + +console.log(''); + +process.exit(totalIssues > 0 ? 1 : 0); diff --git a/website/README.md b/website/README.md new file mode 100644 index 00000000..0545d295 --- /dev/null +++ b/website/README.md @@ -0,0 +1,76 @@ +# BMAD Method Documentation Site + +This directory contains the Astro + Starlight configuration for the BMAD Method documentation site. + +## Architecture + +The documentation uses a symlink architecture to keep content in `docs/` at the repo root while serving it through Astro: + +``` +bmad2/ +├── docs/ # Content lives here (repo root) +│ ├── index.md +│ ├── tutorials/ +│ ├── how-to/ +│ ├── explanation/ +│ └── reference/ +└── website/ + ├── astro.config.mjs # Astro + Starlight config + ├── src/ + │ ├── content/ + │ │ └── docs -> ../../docs # Symlink to content + │ └── styles/ + │ └── custom.css # Custom styling + └── public/ # Static assets +``` + +## Development + +```bash +# From repo root +npm run docs:dev # Start dev server +npm run docs:build # Build for production +npm run docs:preview # Preview production build +``` + +## Platform Notes + +### Windows Symlink Support + +The `website/src/content/docs` symlink may not work correctly on Windows without Developer Mode enabled or administrator privileges. + +**To enable symlinks on Windows:** + +1. **Enable Developer Mode** (recommended): + - Settings → Update & Security → For developers → Developer Mode: On + - This allows creating symlinks without admin rights + +2. **Or use Git's symlink support**: + ```bash + git config core.symlinks true + ``` + Then re-clone the repository. + +3. **Or create a junction** (alternative): + ```cmd + # Run as Administrator + mklink /J website\src\content\docs ..\..\docs + ``` + +**If symlinks don't work**, you can copy the docs folder instead: +```bash +# Remove the symlink +rm website/src/content/docs + +# Copy the docs folder +cp -r docs website/src/content/docs +``` + +Note: If copying, remember to keep the copy in sync with changes to `docs/`. + +## Build Output + +The build pipeline (`npm run docs:build`) produces: +- Static HTML site in `build/site/` +- LLM-friendly files: `llms.txt`, `llms-full.txt` +- Downloadable ZIP bundles in `downloads/` diff --git a/website/astro.config.mjs b/website/astro.config.mjs new file mode 100644 index 00000000..cc76c528 --- /dev/null +++ b/website/astro.config.mjs @@ -0,0 +1,218 @@ +// @ts-check +import { defineConfig } from 'astro/config'; +import starlight from '@astrojs/starlight'; +import sitemap from '@astrojs/sitemap'; +import rehypeMarkdownLinks from './src/rehype-markdown-links.js'; +import { getSiteUrl } from './src/lib/site-url.js'; + +const siteUrl = getSiteUrl(); +const urlParts = new URL(siteUrl); +// Normalize basePath: ensure trailing slash so links can use `${BASE_URL}path` +const basePath = urlParts.pathname === '/' ? '/' : urlParts.pathname.endsWith('/') ? urlParts.pathname : urlParts.pathname + '/'; + +export default defineConfig({ + site: `${urlParts.origin}${basePath}`, + base: basePath, + outDir: '../build/site', + + // Disable aggressive caching in dev mode + vite: { + optimizeDeps: { + force: true, // Always re-bundle dependencies + }, + server: { + watch: { + usePolling: false, // Set to true if file changes aren't detected + }, + }, + }, + + markdown: { + rehypePlugins: [rehypeMarkdownLinks], + }, + + integrations: [ + sitemap(), + starlight({ + title: 'BMAD Method', + tagline: 'AI-driven agile development with specialized agents and workflows that scale from bug fixes to enterprise platforms.', + + logo: { + src: './public/img/logo.svg', + alt: 'BMAD Logo', + }, + favicon: '/favicon.ico', + + // Social links + social: [ + { icon: 'discord', label: 'Discord', href: 'https://discord.gg/gk8jAdXWmj' }, + { icon: 'github', label: 'GitHub', href: 'https://github.com/bmad-code-org/BMAD-METHOD' }, + { icon: 'youtube', label: 'YouTube', href: 'https://www.youtube.com/@BMadCode' }, + ], + + // Show last updated timestamps + lastUpdated: true, + + // Custom head tags for LLM discovery + head: [ + { + tag: 'meta', + attrs: { + name: 'ai-terms', + content: `AI-optimized documentation: ${siteUrl}/llms-full.txt (plain text, ~100k tokens, complete BMAD reference). Index: ${siteUrl}/llms.txt`, + }, + }, + { + tag: 'meta', + attrs: { + name: 'llms-full', + content: `${siteUrl}/llms-full.txt`, + }, + }, + { + tag: 'meta', + attrs: { + name: 'llms', + content: `${siteUrl}/llms.txt`, + }, + }, + ], + + // Custom CSS + customCss: ['./src/styles/custom.css'], + + // Sidebar configuration (Diataxis structure) + sidebar: [ + { label: 'Welcome', slug: 'index' }, + { + label: 'Tutorials', + collapsed: false, + items: [ + { + label: 'Getting Started', + autogenerate: { directory: 'tutorials/getting-started' }, + }, + { + label: 'Advanced', + autogenerate: { directory: 'tutorials/advanced' }, + }, + ], + }, + { + label: 'How-To Guides', + collapsed: true, + items: [ + { slug: 'how-to/get-answers-about-bmad' }, + { + label: 'Installation', + autogenerate: { directory: 'how-to/installation' }, + }, + { + label: 'Workflows', + autogenerate: { directory: 'how-to/workflows' }, + }, + { + label: 'Customization', + autogenerate: { directory: 'how-to/customization' }, + }, + { + label: 'Brownfield Development', + autogenerate: { directory: 'how-to/brownfield' }, + }, + { + label: 'Troubleshooting', + autogenerate: { directory: 'how-to/troubleshooting' }, + }, + ], + }, + { + label: 'Explanation', + collapsed: true, + items: [ + { + label: 'Core Concepts', + autogenerate: { directory: 'explanation/core-concepts' }, + }, + { + label: 'Architecture', + autogenerate: { directory: 'explanation/architecture' }, + }, + { + label: 'Philosophy', + autogenerate: { directory: 'explanation/philosophy' }, + }, + { + label: 'Features', + autogenerate: { directory: 'explanation/features' }, + }, + { + label: 'Agents', + autogenerate: { directory: 'explanation/agents' }, + }, + { + label: 'BMM', + autogenerate: { directory: 'explanation/bmm' }, + }, + { + label: 'BMad Builder', + autogenerate: { directory: 'explanation/bmad-builder' }, + }, + { + label: 'Game Development', + autogenerate: { directory: 'explanation/game-dev' }, + }, + { + label: 'Creative Intelligence', + autogenerate: { directory: 'explanation/creative-intelligence' }, + }, + { + label: 'Core Module', + autogenerate: { directory: 'explanation/core' }, + }, + { + label: 'FAQ', + autogenerate: { directory: 'explanation/faq' }, + }, + ], + }, + { + label: 'Reference', + collapsed: true, + items: [ + { + label: 'Agents', + autogenerate: { directory: 'reference/agents' }, + }, + { + label: 'Workflows', + autogenerate: { directory: 'reference/workflows' }, + }, + { + label: 'Configuration', + autogenerate: { directory: 'reference/configuration' }, + }, + { + label: 'Glossary', + autogenerate: { directory: 'reference/glossary' }, + }, + ], + }, + ], + + // Credits in footer + credits: false, + + // Pagination + pagination: true, + + // Custom components + components: { + Header: './src/components/Header.astro', + MobileMenuFooter: './src/components/MobileMenuFooter.astro', + }, + + // Table of contents + tableOfContents: { minHeadingLevel: 2, maxHeadingLevel: 3 }, + }), + ], +}); diff --git a/website/css/custom.css b/website/css/custom.css deleted file mode 100644 index 793bfae4..00000000 --- a/website/css/custom.css +++ /dev/null @@ -1,52 +0,0 @@ -/** - * BMAD Documentation Custom Styles - */ - -:root { - --ifm-color-primary: #0d9488; - --ifm-color-primary-dark: #0b847a; - --ifm-color-primary-darker: #0a7d73; - --ifm-color-primary-darkest: #08665f; - --ifm-color-primary-light: #0fa596; - --ifm-color-primary-lighter: #10ac9d; - --ifm-color-primary-lightest: #14c9b8; - --ifm-code-font-size: 95%; - --docusaurus-highlighted-code-line-bg: rgba(0, 0, 0, 0.1); -} - -[data-theme='dark'] { - --ifm-color-primary: #2dd4bf; - --ifm-color-primary-dark: #1bc4af; - --ifm-color-primary-darker: #1ab9a5; - --ifm-color-primary-darkest: #159888; - --ifm-color-primary-light: #4adcc9; - --ifm-color-primary-lighter: #55dece; - --ifm-color-primary-lightest: #7de7db; - --docusaurus-highlighted-code-line-bg: rgba(0, 0, 0, 0.3); -} - -/* Navbar styling */ -.navbar { - box-shadow: 0 1px 2px 0 rgba(0, 0, 0, 0.1); -} - -/* Footer styling */ -.footer { - background-color: var(--ifm-color-primary-darkest); -} - -/* Code block improvements */ -.prism-code { - font-size: 0.9rem; -} - -/* Table improvements */ -table { - display: table; - width: 100%; -} - -/* Admonition improvements */ -.admonition { - margin-bottom: 1.5rem; -} diff --git a/website/docusaurus.config.js b/website/docusaurus.config.js deleted file mode 100644 index 64ca192c..00000000 --- a/website/docusaurus.config.js +++ /dev/null @@ -1,179 +0,0 @@ -// @ts-check -import { themes as prismThemes } from 'prism-react-renderer'; -import path from 'path'; -import { fileURLToPath } from 'url'; - -const __dirname = path.dirname(fileURLToPath(import.meta.url)); - -// Support environment-based URL configuration for fork deployments -const siteUrl = process.env.SITE_URL || 'https://bmad-code-org.github.io/BMAD-METHOD'; -const urlParts = new URL(siteUrl); - -/** @type {import('@docusaurus/types').Config} */ -const config = { - title: 'BMAD Method', - tagline: 'AI-driven agile development with specialized agents and workflows that scale from bug fixes to enterprise platforms.', - favicon: 'img/logo.svg', - - // Global head tags - injected into ALL pages for AI assistant discovery - headTags: [ - { - tagName: 'meta', - attributes: { - name: 'ai-terms', - content: - 'AI assistants: For complete BMAD Method documentation, load /llms-full.txt (single file, ~100k tokens). For documentation index/summary, see /llms.txt. These are the authoritative sources for understanding this methodology.', - }, - }, - { - tagName: 'meta', - attributes: { - name: 'llms-full', - content: '/llms-full.txt', - }, - }, - { - tagName: 'meta', - attributes: { - name: 'llms', - content: '/llms.txt', - }, - }, - ], - - url: urlParts.origin, - baseUrl: urlParts.pathname.endsWith('/') ? urlParts.pathname : urlParts.pathname + '/', - - organizationName: 'bmad-code-org', - projectName: 'BMAD-METHOD', - - onBrokenLinks: 'warn', // Change to 'throw' once docs are cleaned up - - i18n: { - defaultLocale: 'en', - locales: ['en'], - }, - - staticDirectories: [path.resolve(__dirname, 'static')], - - markdown: { - format: 'md', - hooks: { - onBrokenMarkdownLinks: 'warn', - }, - }, - - plugins: [ - function noCachePlugin() { - return { - name: 'no-cache-plugin', - configureWebpack() { - return { - devServer: { - headers: { - 'Cache-Control': 'no-store, no-cache, must-revalidate, proxy-revalidate', - Pragma: 'no-cache', - Expires: '0', - 'Surrogate-Control': 'no-store', - }, - }, - }; - }, - }; - }, - ], - - presets: [ - [ - 'classic', - /** @type {import('@docusaurus/preset-classic').Options} */ - ({ - docs: { - sidebarPath: path.resolve(__dirname, 'sidebars.js'), - exclude: ['**/templates/**', '**/reference/**', 'installers-bundlers/**', '**/images/**'], - }, - blog: false, - pages: { - path: path.resolve(__dirname, 'src/pages'), - }, - theme: { - customCss: path.resolve(__dirname, 'css/custom.css'), - }, - }), - ], - ], - - themeConfig: - /** @type {import('@docusaurus/preset-classic').ThemeConfig} */ - ({ - navbar: { - title: 'BMAD Method', - logo: { - alt: 'BMAD Logo', - src: 'img/logo.svg', - }, - items: [ - { - type: 'docSidebar', - sidebarId: 'mainSidebar', - position: 'left', - label: 'Docs', - }, - { - to: '/downloads', - label: 'Downloads', - position: 'right', - }, - { - href: 'pathname:///llms.txt', - label: 'llms.txt', - position: 'right', - }, - { - href: 'https://github.com/bmad-code-org/BMAD-METHOD', - label: 'GitHub', - position: 'right', - }, - ], - }, - footer: { - style: 'dark', - links: [ - { - title: 'Docs', - items: [ - { label: 'Quick Start', to: '/docs/modules/bmm/quick-start' }, - { label: 'Installation', to: '/docs/getting-started/installation' }, - ], - }, - { - title: 'Community', - items: [{ label: 'Discord', href: 'https://discord.gg/bmad' }], - }, - { - title: 'More', - items: [ - { - label: 'GitHub', - href: 'https://github.com/bmad-code-org/BMAD-METHOD', - }, - { label: 'llms.txt', href: 'pathname:///llms.txt' }, - { label: 'llms-full.txt', href: 'pathname:///llms-full.txt' }, - ], - }, - ], - copyright: `Copyright © ${new Date().getFullYear()} BMAD Code Organization.`, - }, - prism: { - theme: prismThemes.github, - darkTheme: prismThemes.dracula, - }, - colorMode: { - defaultMode: 'light', - disableSwitch: false, - respectPrefersColorScheme: true, - }, - }), -}; - -export default config; diff --git a/website/static/favicon.ico b/website/public/favicon.ico similarity index 100% rename from website/static/favicon.ico rename to website/public/favicon.ico diff --git a/website/static/img/logo.svg b/website/public/img/logo.svg similarity index 100% rename from website/static/img/logo.svg rename to website/public/img/logo.svg diff --git a/website/static/robots.txt b/website/public/robots.txt similarity index 100% rename from website/static/robots.txt rename to website/public/robots.txt diff --git a/website/sidebars.js b/website/sidebars.js deleted file mode 100644 index 3175f711..00000000 --- a/website/sidebars.js +++ /dev/null @@ -1,157 +0,0 @@ -/** @type {import('@docusaurus/plugin-content-docs').SidebarsConfig} */ -const sidebars = { - mainSidebar: [ - 'index', - { - type: 'category', - label: 'Getting Started', - items: [ - 'getting-started/installation', - { - type: 'category', - label: 'IDE Guides', - collapsed: true, - items: [ - 'ide-info/index', - 'ide-info/claude-code', - 'ide-info/cursor', - 'ide-info/windsurf', - 'ide-info/cline', - 'ide-info/github-copilot', - 'ide-info/auggie', - 'ide-info/codex', - 'ide-info/crush', - 'ide-info/gemini', - 'ide-info/iflow', - 'ide-info/kilo', - 'ide-info/opencode', - 'ide-info/qwen', - 'ide-info/roo', - 'ide-info/rovo-dev', - 'ide-info/trae', - ], - }, - 'v4-to-v6-upgrade', - ], - }, - { - type: 'category', - label: 'BMM - Method', - items: [ - 'modules/bmm/index', - 'modules/bmm/quick-start', - 'modules/bmm/scale-adaptive-system', - { - type: 'category', - label: 'Quick Flows', - collapsed: true, - items: ['modules/bmm/bmad-quick-flow', 'modules/bmm/quick-flow-solo-dev', 'modules/bmm/quick-spec-flow'], - }, - { - type: 'category', - label: 'Workflows', - collapsed: true, - items: [ - 'modules/bmm/workflows-planning', - 'modules/bmm/workflows-solutioning', - 'modules/bmm/workflows-analysis', - 'modules/bmm/workflows-implementation', - ], - }, - { - type: 'category', - label: 'Advanced Topics', - collapsed: true, - items: [ - 'modules/bmm/party-mode', - 'modules/bmm/agents-guide', - 'modules/bmm/brownfield-guide', - 'modules/bmm/enterprise-agentic-development', - 'modules/bmm/test-architecture', - ], - }, - { - type: 'category', - label: 'Reference', - collapsed: true, - items: [ - 'modules/bmm/workflow-architecture-reference', - 'modules/bmm/workflow-document-project-reference', - 'modules/bmm/troubleshooting', - 'modules/bmm/faq', - 'modules/bmm/glossary', - ], - }, - ], - }, - { - type: 'category', - label: 'BMB - Builder', - collapsed: true, - items: [ - 'modules/bmb/index', - { - type: 'category', - label: 'Building Agents', - collapsed: true, - items: [ - 'modules/bmb/agents/index', - 'modules/bmb/agents/understanding-agent-types', - 'modules/bmb/agents/simple-agent-architecture', - 'modules/bmb/agents/expert-agent-architecture', - 'modules/bmb/agents/agent-compilation', - 'modules/bmb/agents/agent-menu-patterns', - ], - }, - { - type: 'category', - label: 'Building Workflows', - collapsed: true, - items: [ - 'modules/bmb/workflows/index', - 'modules/bmb/workflows/architecture', - 'modules/bmb/workflows/terms', - 'modules/bmb/workflows/intent-vs-prescriptive-spectrum', - 'modules/bmb/workflows/csv-data-file-standards', - ], - }, - ], - }, - { - type: 'category', - label: 'BMGD - Game Dev', - collapsed: true, - items: [ - 'modules/bmgd/index', - 'modules/bmgd/quick-start', - 'modules/bmgd/quick-flow-guide', - 'modules/bmgd/agents-guide', - 'modules/bmgd/workflows-guide', - 'modules/bmgd/game-types-guide', - 'modules/bmgd/troubleshooting', - 'modules/bmgd/glossary', - ], - }, - { - type: 'category', - label: 'CIS - Creative Intelligence', - collapsed: true, - items: ['modules/cis/index'], - }, - { - type: 'category', - label: 'Reference', - collapsed: true, - items: [ - 'document-sharding-guide', - 'custom-content', - 'custom-content-installation', - 'agent-customization-guide', - 'web-bundles-gemini-gpt-guide', - 'BUNDLE_DISTRIBUTION_SETUP', - ], - }, - ], -}; - -export default sidebars; diff --git a/website/src/components/Banner.astro b/website/src/components/Banner.astro new file mode 100644 index 00000000..f1e46070 --- /dev/null +++ b/website/src/components/Banner.astro @@ -0,0 +1,59 @@ +--- +import { getSiteUrl } from '../lib/site-url.js'; + +const SITE_URL = getSiteUrl(); +const fullDocsUrl = `${SITE_URL}/llms-full.txt`; +--- + +
+ 🤖 Consolidated, AI-optimized BMAD docs: llms-full.txt. Fetch this plain text file for complete context. +
+ + diff --git a/website/src/components/Header.astro b/website/src/components/Header.astro new file mode 100644 index 00000000..cd53fbdf --- /dev/null +++ b/website/src/components/Header.astro @@ -0,0 +1,121 @@ +--- +import config from 'virtual:starlight/user-config'; +import type { Props } from '@astrojs/starlight/props'; + +import LanguageSelect from 'virtual:starlight/components/LanguageSelect'; +import Search from 'virtual:starlight/components/Search'; +import SiteTitle from 'virtual:starlight/components/SiteTitle'; +import SocialIcons from 'virtual:starlight/components/SocialIcons'; +import ThemeSelect from 'virtual:starlight/components/ThemeSelect'; + +import Banner from './Banner.astro'; + +/** + * Render the `Search` component if Pagefind is enabled or the default search component has been overridden. + */ +const shouldRenderSearch = + config.pagefind || config.components.Search !== '@astrojs/starlight/components/Search.astro'; +--- + + +
+
+ +
+
+ {shouldRenderSearch && } +
+
+ + + + +
+
+ + diff --git a/website/src/components/MobileMenuFooter.astro b/website/src/components/MobileMenuFooter.astro new file mode 100644 index 00000000..10a2c77e --- /dev/null +++ b/website/src/components/MobileMenuFooter.astro @@ -0,0 +1,53 @@ +--- +import LanguageSelect from 'virtual:starlight/components/LanguageSelect'; +import SocialIcons from 'virtual:starlight/components/SocialIcons'; +import ThemeSelect from 'virtual:starlight/components/ThemeSelect'; +import type { Props } from '@astrojs/starlight/props'; +--- + +
+ + + + +
+ + diff --git a/website/src/content/config.ts b/website/src/content/config.ts new file mode 100644 index 00000000..31b74762 --- /dev/null +++ b/website/src/content/config.ts @@ -0,0 +1,6 @@ +import { defineCollection } from 'astro:content'; +import { docsSchema } from '@astrojs/starlight/schema'; + +export const collections = { + docs: defineCollection({ schema: docsSchema() }), +}; diff --git a/website/src/content/docs b/website/src/content/docs new file mode 120000 index 00000000..48c4a0c0 --- /dev/null +++ b/website/src/content/docs @@ -0,0 +1 @@ +../../../docs \ No newline at end of file diff --git a/website/src/lib/site-url.js b/website/src/lib/site-url.js new file mode 100644 index 00000000..62df2bf3 --- /dev/null +++ b/website/src/lib/site-url.js @@ -0,0 +1,25 @@ +/** + * Resolve the site's base URL using cascading environment defaults. + * + * Preference order: use SITE_URL if set; otherwise derive a GitHub Pages URL from GITHUB_REPOSITORY; otherwise use the local development URL. + * @returns {string} The resolved site URL (SITE_URL override, or `https://{owner}.github.io/{repo}`, or `http://localhost:3000`). + */ +export function getSiteUrl() { + // Explicit override (works in both local and GitHub Actions) + if (process.env.SITE_URL) { + return process.env.SITE_URL; + } + + // GitHub Actions: compute from repository context + if (process.env.GITHUB_REPOSITORY) { + const parts = process.env.GITHUB_REPOSITORY.split('/'); + if (parts.length !== 2 || !parts[0] || !parts[1]) { + throw new Error(`Invalid GITHUB_REPOSITORY format: "${process.env.GITHUB_REPOSITORY}". Expected "owner/repo".`); + } + const [owner, repo] = parts; + return `https://${owner}.github.io/${repo}`; + } + + // Local development: use dev server + return 'http://localhost:3000'; +} diff --git a/website/src/pages/index.js b/website/src/pages/index.js deleted file mode 100644 index cab2c5d1..00000000 --- a/website/src/pages/index.js +++ /dev/null @@ -1,50 +0,0 @@ -import React from 'react'; -import Layout from '@theme/Layout'; -import Link from '@docusaurus/Link'; -import useBaseUrl from '@docusaurus/useBaseUrl'; - -export default function Home() { - const llmsFullUrl = useBaseUrl('/llms-full.txt'); - - return ( - -
-

BMAD Method

-

- Under Construction -

- - - View Documentation - - - - 🤖 AI Context: llms-full.txt - -
- - ); -} diff --git a/website/src/rehype-markdown-links.js b/website/src/rehype-markdown-links.js new file mode 100644 index 00000000..97d8dec3 --- /dev/null +++ b/website/src/rehype-markdown-links.js @@ -0,0 +1,102 @@ +/** + * Rehype plugin to transform markdown file links (.md) to page routes + * + * Transforms: + * ./path/to/file.md → ./path/to/file/ + * ./path/index.md → ./path/ (index.md becomes directory root) + * ../path/file.md#anchor → ../path/file/#anchor + * ./file.md?query=param → ./file/?query=param + * /docs/absolute/path/file.md → /absolute/path/file/ + * + * For absolute paths starting with /docs/, the /docs prefix is stripped + * since the Astro site serves content from the docs directory as the root. + * + * Affects relative links (./, ../) and absolute paths (/) - external links are unchanged + */ + +import { visit } from 'unist-util-visit'; + +/** + * Convert Markdown file links (.md) into equivalent page route-style links. + * + * The returned transformer walks the HTML tree and rewrites anchor `href` values that are relative paths (./, ../) or absolute paths (/) pointing to `.md` files. It preserves query strings and hash anchors, rewrites `.../index.md` to the directory root path (`.../`), and rewrites other `.md` file paths by removing the `.md` extension and ensuring a trailing slash. External links (http://, https://) and non-.md links are left unchanged. + * + * @returns {function} A HAST tree transformer that mutates `a` element `href` properties as described. + */ +export default function rehypeMarkdownLinks() { + return (tree) => { + visit(tree, 'element', (node) => { + // Only process anchor tags with href + if (node.tagName !== 'a' || !node.properties?.href) { + return; + } + + const href = node.properties.href; + + // Skip if not a string (shouldn't happen, but be safe) + if (typeof href !== 'string') { + return; + } + + // Skip external links (http://, https://, mailto:, etc.) + if (href.includes('://') || href.startsWith('mailto:') || href.startsWith('tel:')) { + return; + } + + // Only transform paths starting with ./, ../, or / (absolute) + if (!href.startsWith('./') && !href.startsWith('../') && !href.startsWith('/')) { + return; + } + + // Extract path portion (before ? and #) to check if it's a .md file + const firstDelimiter = Math.min( + href.indexOf('?') === -1 ? Infinity : href.indexOf('?'), + href.indexOf('#') === -1 ? Infinity : href.indexOf('#'), + ); + const pathPortion = firstDelimiter === Infinity ? href : href.substring(0, firstDelimiter); + + // Don't transform if path doesn't end with .md + if (!pathPortion.endsWith('.md')) { + return; + } + + // Split the URL into parts: path, anchor, and query + let urlPath = pathPortion; + let anchor = ''; + let query = ''; + + // Extract query string and anchor from original href + if (firstDelimiter !== Infinity) { + const suffix = href.substring(firstDelimiter); + const anchorInSuffix = suffix.indexOf('#'); + if (suffix.startsWith('?')) { + if (anchorInSuffix !== -1) { + query = suffix.substring(0, anchorInSuffix); + anchor = suffix.substring(anchorInSuffix); + } else { + query = suffix; + } + } else { + // starts with # + anchor = suffix; + } + } + + // Strip /docs/ prefix from absolute paths (repo-relative → site-relative) + if (urlPath.startsWith('/docs/')) { + urlPath = urlPath.slice(5); // Remove '/docs' prefix, keeping the leading / + } + + // Transform .md to / + // Special case: index.md → directory root (e.g., ./tutorials/index.md → ./tutorials/) + if (urlPath.endsWith('/index.md')) { + urlPath = urlPath.replace(/\/index\.md$/, '/'); + } else { + urlPath = urlPath.replace(/\.md$/, '/'); + } + + // Reconstruct the href + node.properties.href = urlPath + query + anchor; + }); + }; +} diff --git a/website/src/styles/custom.css b/website/src/styles/custom.css new file mode 100644 index 00000000..a232f5ec --- /dev/null +++ b/website/src/styles/custom.css @@ -0,0 +1,483 @@ +/** + * BMAD Method Documentation - Custom Styles for Starlight + * Electric Blue theme optimized for dark mode + * + * CSS Variable Mapping: + * Docusaurus → Starlight + * --ifm-color-primary → --sl-color-accent + * --ifm-background-color → --sl-color-bg + * --ifm-font-color-base → --sl-color-text + */ + +/* ============================================ + COLOR PALETTE - Light Mode + ============================================ */ +:root { + --ai-banner-height: 2.75rem; + --sl-nav-height: 6.25rem; /* Base nav height (~3.5rem) + banner height (2.75rem) */ + + /* Primary accent colors - purple to match Docusaurus */ + --sl-color-accent-low: #e0e0ff; + --sl-color-accent: #8C8CFF; + --sl-color-accent-high: #4141FF; + + /* Text colors */ + --sl-color-white: #1e293b; + --sl-color-gray-1: #334155; + --sl-color-gray-2: #475569; + --sl-color-gray-3: #64748b; + --sl-color-gray-4: #94a3b8; + --sl-color-gray-5: #cbd5e1; + --sl-color-gray-6: #e2e8f0; + --sl-color-black: #f8fafc; + + /* Font settings */ + --sl-font: system-ui, -apple-system, BlinkMacSystemFont, 'Segoe UI', Roboto, 'Helvetica Neue', + Arial, sans-serif; + --sl-text-base: 1rem; + --sl-line-height: 1.7; + + /* Code highlighting */ + --sl-color-bg-inline-code: rgba(140, 140, 255, 0.1); +} + +/* ============================================ + COLOR PALETTE - Dark Mode (Primary Focus) + ============================================ */ +:root[data-theme='dark'] { + /* Primary accent colors - purple to match Docusaurus */ + --sl-color-accent-low: #2a2a5a; + --sl-color-accent: #8C8CFF; + --sl-color-accent-high: #B9B9FF; + + /* Background colors */ + --sl-color-bg: #1b1b1d; + --sl-color-bg-nav: #1b1b1d; + --sl-color-bg-sidebar: #1b1b1d; + --sl-color-hairline-light: rgba(140, 140, 255, 0.1); + --sl-color-hairline: rgba(140, 140, 255, 0.15); + + /* Text colors */ + --sl-color-white: #f8fafc; + --sl-color-gray-1: #e2e8f0; + --sl-color-gray-2: #cbd5e1; + --sl-color-gray-3: #94a3b8; + --sl-color-gray-4: #64748b; + --sl-color-gray-5: #475569; + --sl-color-gray-6: #334155; + --sl-color-black: #1b1b1d; + + /* Code highlighting */ + --sl-color-bg-inline-code: rgba(140, 140, 255, 0.15); +} + +/* ============================================ + TYPOGRAPHY + ============================================ */ +.sl-markdown-content h1 { + margin-bottom: 1.5rem; +} + +.sl-markdown-content h2 { + margin-top: 2.5rem; + margin-bottom: 1rem; +} + +.sl-markdown-content h3 { + margin-top: 2rem; + margin-bottom: 0.75rem; +} + +.sl-markdown-content p { + margin-bottom: 1.25rem; +} + +/* ============================================ + SIDEBAR & NAVIGATION + Clean styling inspired by React Native docs + ============================================ */ + +/* Base transition for all sidebar links */ +.sidebar-content a { + transition: + background-color 0.15s ease, + color 0.15s ease, + border-color 0.15s ease; + border-radius: 4px; +} + +/* Top-level sidebar items (Diataxis categories) */ +.sidebar-content > ul > li > details > summary, +.sidebar-content > ul > li > a { + font-weight: 700; + font-size: 0.9375rem; + padding: 0.5rem 0.75rem; +} + +/* Nested sidebar items */ +.sidebar-content ul ul a { + font-weight: 500; + font-size: 0.875rem; + padding: 0.375rem 0.75rem; + padding-left: 1.5rem; + border-left: 3px solid transparent; +} + +/* Deep nested items */ +.sidebar-content ul ul ul a { + font-weight: 400; + font-size: 0.8125rem; + padding-left: 2.25rem; +} + +/* Active state - thin left accent bar */ +.sidebar-content a[aria-current='page'] { + background-color: rgba(140, 140, 255, 0.08); + color: var(--sl-color-accent); + border-left-color: var(--sl-color-accent); + font-weight: 600; +} + +:root[data-theme='dark'] .sidebar-content a[aria-current='page'] { + background-color: rgba(140, 140, 255, 0.1); + color: var(--sl-color-accent-high); + border-left-color: var(--sl-color-accent); +} + +/* Hover states */ +.sidebar-content a:hover { + background-color: rgba(0, 0, 0, 0.05); +} + +:root[data-theme='dark'] .sidebar-content a:hover { + background-color: rgba(255, 255, 255, 0.05); +} + +/* Section spacing */ +.sidebar-content > ul > li { + margin-top: 0.75rem; +} + +.sidebar-content > ul > li:first-child { + margin-top: 0; +} + +/* Lighter chevrons/carets */ +.sidebar-content summary::marker, +.sidebar-content details > summary::after { + opacity: 0.4; +} + +.sidebar-content summary:hover::marker, +.sidebar-content details > summary:hover::after { + opacity: 0.6; +} + +/* ============================================ + LAYOUT - Fixed width at large viewport + ============================================ */ +.content-panel { + max-width: 1400px; + margin: 0 auto; +} + +/* Main content area */ +main { + min-width: 0; +} + +.sl-markdown-content { + min-width: 0; + overflow-wrap: break-word; + word-wrap: break-word; +} + +/* Hide breadcrumbs if desired */ +/* Uncomment to hide: +nav[aria-label="Breadcrumb"] { + display: none; +} +*/ + +/* ============================================ + NAVBAR + ============================================ */ +header.header { + padding: 0 !important; /* Remove all padding for full-width banner */ + box-shadow: 0 1px 2px rgba(0, 0, 0, 0.1); + height: var(--sl-nav-height) !important; + display: flex; + flex-direction: column; +} + +header.header .header.sl-flex { + padding: 0 1.5rem; + height: calc(var(--sl-nav-height) - var(--ai-banner-height)); + width: 100%; +} + +:root[data-theme='dark'] header.header { + box-shadow: 0 1px 3px rgba(0, 0, 0, 0.3); +} + +.site-title { + font-weight: 700; +} + +/* Logo sizing - constrain to reasonable size */ +.site-title img { + height: 2.5rem; + width: auto; +} + +/* Social links styling */ +.social-icons a { + padding: 0.5rem; + transition: + background-color 0.15s ease, + color 0.15s ease; + border-radius: 6px; +} + +.social-icons a:hover { + background-color: rgba(0, 0, 0, 0.05); +} + +:root[data-theme='dark'] .social-icons a:hover { + background-color: rgba(255, 255, 255, 0.05); +} + +/* ============================================ + CARDS + ============================================ */ +.card { + border-radius: 12px; + border: 2px solid var(--sl-color-gray-5); + background-color: var(--sl-color-bg); + box-shadow: 0 2px 8px rgba(0, 0, 0, 0.08); + transition: + transform 0.2s ease, + box-shadow 0.2s ease, + border-color 0.2s ease; +} + +.card:hover { + transform: translateY(-3px); + border-color: var(--sl-color-accent); + box-shadow: 0 8px 24px rgba(140, 140, 255, 0.15); +} + +:root[data-theme='dark'] .card { + background: linear-gradient(145deg, rgba(30, 41, 59, 0.6), rgba(15, 23, 42, 0.8)); + border-color: rgba(140, 140, 255, 0.2); + box-shadow: 0 2px 8px rgba(0, 0, 0, 0.3); +} + +:root[data-theme='dark'] .card:hover { + border-color: rgba(140, 140, 255, 0.5); + box-shadow: + 0 8px 32px rgba(140, 140, 255, 0.2), + 0 0 0 1px rgba(140, 140, 255, 0.1); +} + +/* Starlight card grid */ +.sl-link-card { + border-radius: 12px; + border: 2px solid var(--sl-color-gray-5); + transition: + transform 0.2s ease, + box-shadow 0.2s ease, + border-color 0.2s ease; +} + +.sl-link-card:hover { + transform: translateY(-3px); + border-color: var(--sl-color-accent); +} + +:root[data-theme='dark'] .sl-link-card { + border-color: rgba(140, 140, 255, 0.2); +} + +:root[data-theme='dark'] .sl-link-card:hover { + border-color: rgba(140, 140, 255, 0.5); +} + +/* ============================================ + BUTTONS + ============================================ */ +.sl-flex a[href], +button { + transition: + background-color 0.2s ease, + transform 0.1s ease; +} + +.sl-flex a[href]:hover, +button:hover { + transform: translateY(-1px); +} + +/* ============================================ + MISC ENHANCEMENTS + ============================================ */ + +/* Smooth scrolling */ +html { + scroll-behavior: smooth; +} + +/* Better link underlines */ +.sl-markdown-content a:not(.sl-link-card) { + text-decoration-thickness: 1px; + text-underline-offset: 2px; +} + +/* Table styling */ +table { + display: table; + width: 100%; +} + +:root[data-theme='dark'] table { + border-color: rgba(140, 140, 255, 0.1); +} + +:root[data-theme='dark'] table th { + background-color: rgba(140, 140, 255, 0.05); +} + +:root[data-theme='dark'] table tr:nth-child(2n) { + background-color: rgba(140, 140, 255, 0.02); +} + +/* Blockquotes */ +blockquote { + border-left-color: var(--sl-color-accent); + background-color: rgba(140, 140, 255, 0.05); + border-radius: 0 8px 8px 0; + padding: 1rem 1.25rem; +} + +/* ============================================ + ADMONITIONS (Starlight Asides) + Rounded, no left border bar + ============================================ */ +.starlight-aside { + margin-bottom: 1.5rem; + padding: 1.25rem 1.5rem; + border-radius: 12px; + border: none; + border-left: 0; + box-shadow: 0 1px 4px rgba(0, 0, 0, 0.08); +} + +/* Tip aside */ +.starlight-aside--tip { + background-color: rgba(16, 185, 129, 0.08); +} + +.starlight-aside--tip .starlight-aside__title { + color: #059669; +} + +:root[data-theme='dark'] .starlight-aside--tip { + background-color: rgba(16, 185, 129, 0.12); +} + +:root[data-theme='dark'] .starlight-aside--tip .starlight-aside__title { + color: #34d399; +} + +/* Note aside */ +.starlight-aside--note { + background-color: rgba(140, 140, 255, 0.08); +} + +.starlight-aside--note .starlight-aside__title { + color: #8C8CFF; +} + +:root[data-theme='dark'] .starlight-aside--note { + background-color: rgba(140, 140, 255, 0.12); +} + +:root[data-theme='dark'] .starlight-aside--note .starlight-aside__title { + color: #8C8CFF; +} + +/* Caution aside */ +.starlight-aside--caution { + background-color: rgba(245, 158, 11, 0.1); +} + +.starlight-aside--caution .starlight-aside__title { + color: #d97706; +} + +:root[data-theme='dark'] .starlight-aside--caution { + background-color: rgba(245, 158, 11, 0.15); +} + +:root[data-theme='dark'] .starlight-aside--caution .starlight-aside__title { + color: #fbbf24; +} + +/* Danger aside */ +.starlight-aside--danger { + background-color: rgba(239, 68, 68, 0.1); +} + +.starlight-aside--danger .starlight-aside__title { + color: #dc2626; +} + +:root[data-theme='dark'] .starlight-aside--danger { + background-color: rgba(239, 68, 68, 0.15); +} + +:root[data-theme='dark'] .starlight-aside--danger .starlight-aside__title { + color: #f87171; +} + +/* Aside icon styling */ +.starlight-aside__icon svg { + width: 1.25rem; + height: 1.25rem; +} + +/* ============================================ + FOOTER - Minimal styling + ============================================ */ +footer { + background-color: var(--sl-color-black); + border-top: 1px solid var(--sl-color-hairline); +} + +:root[data-theme='dark'] footer { + background-color: #020617; +} + +/* ============================================ + RESPONSIVE ADJUSTMENTS + ============================================ */ +@media (max-width: 72rem) { + .content-panel { + max-width: 100%; + } +} + +/* Responsive padding on navbar row only - banner stays full-width */ +@media (min-width: 50rem) { + header.header .header.sl-flex { + padding-left: 2.5rem; + padding-right: 2.5rem; + } +} + +@media (min-width: 72rem) { + header.header .header.sl-flex { + padding-left: 3rem; + padding-right: 3rem; + } +}