bmad-method 6.0.0-alpha.12 → 6.0.0-alpha.14

package/src/modules/bmb/workflows/create-module/templates/installer.template.js

@@ -0,0 +1,47 @@
+/**
+ * {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 install-config.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 };

package/src/modules/bmb/workflows/create-module/templates/module-plan.template.md

@@ -0,0 +1,5 @@
+---
+stepsCompleted: []
+---
+
+# Module Plan {module name}

package/src/modules/bmb/workflows/create-module/templates/workflow-plan-template.md

@@ -0,0 +1,23 @@
+# 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

package/src/modules/bmb/workflows/create-module/validation.md

@@ -0,0 +1,126 @@
+# 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
+
+### Required Files in \_module-installer/
+
+- [ ] install-config.yaml - Installation configuration
+- [ ] installer.js - Custom logic (if needed)
+
+## Configuration Validation
+
+### install-config.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

package/src/modules/bmb/workflows/create-module/workflow.md

@@ -0,0 +1,55 @@
+---
+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_folder}/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_folder}/bmb/config.yaml and resolve:
+
+- `project_name`, `output_folder`, `user_name`, `communication_language`, `document_output_language`, `custom_module_location`
+
+### 2. First Step EXECUTION
+
+Load, read the full file and then execute {installed_path}/steps/step-01-init.md to begin the workflow.

package/src/modules/bmb/workflows/create-workflow/steps/step-01-init.md

@@ -0,0 +1,157 @@
+---
+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_folder}/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: '{custom_stand_alone_location}/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 `{custom_stand_alone_location}/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_folder}/custom/src/workflows`)
+- For other modules: Check their install-config.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.

package/src/modules/bmb/workflows/create-workflow/steps/step-02-gather.md

@@ -0,0 +1,211 @@
+---
+name: 'step-02-gather'
+description: 'Gather comprehensive requirements for the workflow being created'
+
+# Path Definitions
+workflow_path: '{project-root}/{bmad_folder}/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: '{custom_stand_alone_location}/workflows/{new_workflow_name}'
+workflowPlanFile: '{targetWorkflowPath}/workflow-plan-{new_workflow_name}.md'
+
+# Task References
+advancedElicitationTask: '{project-root}/{bmad_folder}/core/tasks/advanced-elicitation.xml'
+partyModeWorkflow: '{project-root}/{bmad_folder}/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_folder}/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_folder}/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.