npm - bmad-method - Versions diffs - 6.0.0-alpha.3 → 6.0.0-alpha.5 - Mend

bmad-method 6.0.0-alpha.3 → 6.0.0-alpha.5

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (540) hide show

package/bmad/bmb/workflows/create-module/README.md.bak DELETED Viewed

@@ -1,218 +0,0 @@
-# Build Module Workflow
-## Overview
-The Build Module workflow is an interactive scaffolding system that creates complete BMAD modules with agents, workflows, tasks, and installation infrastructure. It serves as the primary tool for building new modules in the BMAD ecosystem, guiding users through the entire module creation process from concept to deployment-ready structure.
-## Key Features
-- **Interactive Module Planning** - Collaborative session to define module concept, scope, and architecture
-- **Intelligent Scaffolding** - Automatic creation of proper directory structures and configuration files
-- **Component Integration** - Seamless integration with create-agent and create-workflow workflows
-- **Installation Infrastructure** - Complete installer setup with configuration templates
-- **Module Brief Integration** - Can use existing module briefs as blueprints for accelerated development
-- **Validation and Documentation** - Built-in validation checks and comprehensive README generation
-## Usage
-### Basic Invocation
-```bash
-workflow create-module
-```
-### With Module Brief Input
-```bash
-# If you have a module brief from the module-brief workflow
-workflow create-module --input module-brief-my-module-2024-09-26.md
-```
-### Configuration
-The workflow loads critical variables from the BMB configuration:
-- **custom_module_location**: Where custom modules are created (default: `bmad/`)
-- **user_name**: Module author information
-- **date**: Automatic timestamp for versioning
-## Workflow Structure
-### Files Included
-```
-create-module/
-├── workflow.yaml           # Configuration and metadata
-├── instructions.md         # Step-by-step execution guide
-├── checklist.md           # Validation criteria
-├── module-structure.md    # Module architecture guide
-├── installer-templates/   # Installation templates
-│   ├── install-config.yaml
-│   └── installer.js
-└── README.md             # This file
-```
-## Workflow Process
-### Phase 1: Concept Definition (Steps 1-2)
-**Module Vision and Identity**
-- Define module concept, purpose, and target audience
-- Establish module code (kebab-case) and friendly name
-- Choose module category (Domain-Specific, Creative, Technical, Business, Personal)
-- Plan component architecture with agent and workflow specifications
-**Module Brief Integration**
-- Automatically detects existing module briefs in output folder
-- Can load and use briefs as pre-populated blueprints
-- Accelerates planning when comprehensive brief exists
-### Phase 2: Architecture Planning (Steps 3-4)
-**Directory Structure Creation**
-- Creates complete module directory hierarchy
-- Sets up agent, workflow, task, template, and data folders
-- Establishes installer directory with proper configuration
-**Module Configuration**
-- Generates main config.yaml with module metadata
-- Configures component counts and references
-- Sets up output and data folder specifications
-### Phase 3: Component Creation (Steps 5-6)
-**Interactive Component Building**
-- Optional creation of first agent using create-agent workflow
-- Optional creation of first workflow using create-workflow workflow
-- Creates placeholders for components to be built later
-**Workflow Integration**
-- Seamlessly invokes sub-workflows for component creation
-- Ensures proper file placement and structure
-- Maintains module consistency across components
-### Phase 4: Installation and Documentation (Steps 7-9)
-**Installer Infrastructure**
-- Creates install-config.yaml for deployment
-- Sets up optional installer.js for complex installation logic
-- Configures post-install messaging and instructions
-**Comprehensive Documentation**
-- Generates detailed README.md with usage examples
-- Creates development roadmap for remaining components
-- Provides quick commands for continued development
-### Phase 5: Validation and Finalization (Step 10)
-**Quality Assurance**
-- Validates directory structure and configuration files
-- Checks component references and path consistency
-- Ensures installer configuration is deployment-ready
-- Provides comprehensive module summary and next steps
-## Output
-### Generated Files
-- **Module Directory**: Complete module structure at `{project-root}/bmad/{module_code}/`
-- **Configuration Files**: config.yaml, install-config.yaml
-- **Documentation**: README.md, TODO.md development roadmap
-- **Component Placeholders**: Structured folders for agents, workflows, and tasks
-### Output Structure
-The workflow creates a complete module ready for development:
-1. **Module Identity** - Name, code, version, and metadata
-2. **Directory Structure** - Proper BMAD module hierarchy
-3. **Configuration System** - Runtime and installation configs
-4. **Component Framework** - Ready-to-use agent and workflow scaffolding
-5. **Installation Infrastructure** - Deployment-ready installer
-6. **Documentation Suite** - README, roadmap, and development guides
-## Requirements
-- **Module Brief** (optional but recommended) - Use module-brief workflow first for best results
-- **BMAD Core Configuration** - Properly configured BMB config.yaml
-- **Build Tools Access** - create-agent and create-workflow workflows must be available
-## Best Practices
-### Before Starting
-1. **Create a Module Brief** - Run module-brief workflow for comprehensive planning
-2. **Review Existing Modules** - Study similar modules in `/bmad/` for patterns and inspiration
-3. **Define Clear Scope** - Have a concrete vision of what the module will accomplish
-### During Execution
-1. **Use Module Briefs** - Load existing briefs when prompted for accelerated development
-2. **Start Simple** - Create one core agent and workflow, then expand iteratively
-3. **Leverage Sub-workflows** - Use create-agent and create-workflow for quality components
-4. **Validate Early** - Review generated structure before proceeding to next phases
-### After Completion
-1. **Follow the Roadmap** - Use generated TODO.md for systematic development
-2. **Test Installation** - Validate installer with `bmad install {module_code}`
-3. **Iterate Components** - Use quick commands to add agents and workflows
-4. **Document Progress** - Update README.md as the module evolves
-## Troubleshooting
-### Common Issues
-**Issue**: Module already exists at target location
-- **Solution**: Choose a different module code or remove existing module
-- **Check**: Verify output folder permissions and available space
-**Issue**: Sub-workflow invocation fails
-- **Solution**: Ensure create-agent and create-workflow workflows are available
-- **Check**: Validate workflow paths in config.yaml
-**Issue**: Installation configuration invalid
-- **Solution**: Review install-config.yaml syntax and paths
-- **Check**: Ensure all referenced paths use {project-root} variables correctly
-## Customization
-To customize this workflow:
-1. **Modify Instructions** - Update instructions.md to adjust scaffolding steps
-2. **Extend Templates** - Add new installer templates in installer-templates/
-3. **Update Validation** - Enhance checklist.md with additional quality checks
-4. **Add Components** - Integrate additional sub-workflows for specialized components
-## Version History
-- **v1.0.0** - Initial release
-  - Interactive module scaffolding
-  - Component integration with create-agent and create-workflow
-  - Complete installation infrastructure
-  - Module brief integration support
-## Support
-For issues or questions:
-- Review the workflow creation guide at `/bmad/bmb/workflows/create-workflow/workflow-creation-guide.md`
-- Study module structure patterns at `module-structure.md`
-- Validate output using `checklist.md`
-- Consult existing modules in `/bmad/` for examples
----
-_Part of the BMad Method v6 - BMB (Builder) Module_

package/bmad/bmb/workflows/create-module/checklist.md.bak DELETED Viewed

@@ -1,245 +0,0 @@
-# Build Module Validation Checklist
-## Module Identity and Metadata
-### Basic Information
-- [ ] Module code follows kebab-case convention (e.g., "rpg-toolkit")
-- [ ] Module name is descriptive and title-cased
-- [ ] Module purpose is clearly defined (1-2 sentences)
-- [ ] Target audience is identified
-- [ ] Version number follows semantic versioning (e.g., "1.0.0")
-- [ ] Author information is present
-### Naming Consistency
-- [ ] Module code used consistently throughout all files
-- [ ] No naming conflicts with existing modules
-- [ ] All paths use consistent module code references
-## Directory Structure
-### Source Directories (bmad/{module-code}/)
-- [ ] `/agents` directory created (even if empty)
-- [ ] `/workflows` directory created (even if empty)
-- [ ] `/tasks` directory exists (if tasks planned)
-- [ ] `/templates` directory exists (if templates used)
-- [ ] `/data` directory exists (if data files needed)
-- [ ] `config.yaml` present in module root
-- [ ] `README.md` present with documentation
-### Runtime Directories (bmad/{module-code}/)
-- [ ] `/_module-installer` directory created
-- [ ] `/data` directory for user data
-- [ ] `/agents` directory for overrides
-- [ ] `/workflows` directory for instances
-- [ ] Runtime `config.yaml` present
-## Component Planning
-### Agents
-- [ ] At least one agent defined or planned
-- [ ] Agent purposes are distinct and clear
-- [ ] Agent types (Simple/Expert/Module) identified
-- [ ] No significant overlap between agents
-- [ ] Primary agent is identified
-### Workflows
-- [ ] At least one workflow defined or planned
-- [ ] Workflow purposes are clear
-- [ ] Workflow types identified (Document/Action/Interactive)
-- [ ] Primary workflow is identified
-- [ ] Workflow complexity is appropriate
-### Tasks (if applicable)
-- [ ] Tasks have single, clear purposes
-- [ ] Tasks don't duplicate workflow functionality
-- [ ] Task files follow naming conventions
-## Configuration Files
-### Module config.yaml
-- [ ] All required fields present (name, code, version, author)
-- [ ] Component lists accurate (agents, workflows, tasks)
-- [ ] Paths use proper variables ({project-root}, etc.)
-- [ ] Output folders configured
-- [ ] Custom settings documented
-### Install Configuration
-- [ ] `install-config.yaml` exists in `_module-installer`
-- [ ] Installation steps defined
-- [ ] Directory creation steps present
-- [ ] File copy operations specified
-- [ ] Module registration included
-- [ ] Post-install message defined
-## Installation Infrastructure
-### Installer Files
-- [ ] Install configuration validates against schema
-- [ ] All source paths exist or are marked as templates
-- [ ] Destination paths use correct variables
-- [ ] Optional vs required steps clearly marked
-### installer.js (if present)
-- [ ] Main `installModule` function exists
-- [ ] Error handling implemented
-- [ ] Console logging for user feedback
-- [ ] Exports correct function names
-- [ ] Placeholder code replaced with actual logic (or logged as TODO)
-### External Assets (if any)
-- [ ] Asset files exist in assets directory
-- [ ] Copy destinations are valid
-- [ ] Permissions requirements documented
-## Documentation
-### README.md
-- [ ] Module overview section present
-- [ ] Installation instructions included
-- [ ] Component listing with descriptions
-- [ ] Quick start guide provided
-- [ ] Configuration options documented
-- [ ] At least one usage example
-- [ ] Directory structure shown
-- [ ] Author and date information
-### Component Documentation
-- [ ] Each agent has purpose documentation
-- [ ] Each workflow has description
-- [ ] Tasks are documented (if present)
-- [ ] Examples demonstrate typical usage
-### Development Roadmap
-- [ ] TODO.md or roadmap section exists
-- [ ] Planned components listed
-- [ ] Development phases identified
-- [ ] Quick commands for adding components
-## Integration
-### Cross-component References
-- [ ] Agents reference correct workflow paths
-- [ ] Workflows reference correct task paths
-- [ ] All internal paths use module variables
-- [ ] External dependencies declared
-### Module Boundaries
-- [ ] Module scope is well-defined
-- [ ] No feature creep into other domains
-- [ ] Clear separation from other modules
-## Quality Checks
-### Completeness
-- [ ] At least one functional component (not all placeholders)
-- [ ] Core functionality is implementable
-- [ ] Module provides clear value
-### Consistency
-- [ ] Formatting consistent across files
-- [ ] Variable naming follows conventions
-- [ ] Communication style appropriate for domain
-### Scalability
-- [ ] Structure supports future growth
-- [ ] Component organization is logical
-- [ ] No hard-coded limits
-## Testing and Validation
-### Structural Validation
-- [ ] YAML files parse without errors
-- [ ] JSON files (if any) are valid
-- [ ] XML files (if any) are well-formed
-- [ ] No syntax errors in JavaScript files
-### Path Validation
-- [ ] All referenced paths exist or are clearly marked as TODO
-- [ ] Variable substitutions are correct
-- [ ] No absolute paths (unless intentional)
-### Installation Testing
-- [ ] Installation steps can be simulated
-- [ ] No circular dependencies
-- [ ] Uninstall process defined (if complex)
-## Final Checks
-### Ready for Use
-- [ ] Module can be installed without errors
-- [ ] At least one component is functional
-- [ ] User can understand how to get started
-- [ ] Next steps are clear
-### Professional Quality
-- [ ] No placeholder text remains (unless marked TODO)
-- [ ] No obvious typos or grammar issues
-- [ ] Professional tone throughout
-- [ ] Contact/support information provided
-## Issues Found
-### Critical Issues
-<!-- List any issues that MUST be fixed before module can be used -->
-### Warnings
-<!-- List any issues that should be addressed but won't prevent basic usage -->
-### Improvements
-<!-- List any optional enhancements that would improve the module -->
-### Missing Components
-<!-- List any planned components not yet implemented -->
-## Module Complexity Assessment
-### Complexity Rating
-- [ ] Simple (1-2 agents, 2-3 workflows)
-- [ ] Standard (3-5 agents, 5-10 workflows)
-- [ ] Complex (5+ agents, 10+ workflows)
-### Readiness Level
-- [ ] Prototype (Basic structure, mostly placeholders)
-- [ ] Alpha (Core functionality works)
-- [ ] Beta (Most features complete, needs testing)
-- [ ] Release (Full functionality, documented)
-## Sign-off
-**Module Name:** \***\*\*\*\*\***\_\_\***\*\*\*\*\***
-**Module Code:** \***\*\*\*\*\***\_\_\***\*\*\*\*\***
-**Version:** \***\*\*\*\*\***\_\_\***\*\*\*\*\***
-**Validated By:** \***\*\*\*\*\***\_\_\***\*\*\*\*\***
-**Date:** \***\*\*\*\*\***\_\_\***\*\*\*\*\***
-**Status:** ⬜ Pass / ⬜ Pass with Issues / ⬜ Fail

package/bmad/bmb/workflows/create-module/installer-templates/installer.js.bak DELETED Viewed

@@ -1,231 +0,0 @@
-/* eslint-disable unicorn/prefer-module, unicorn/prefer-node-protocol */
-/**
- * {{MODULE_NAME}} Module Installer
- * Custom installation logic for complex module setup
- *
- * This is a template - replace {{VARIABLES}} with actual values
- */
-// const fs = require('fs'); // Uncomment when implementing file operations
-const path = require('path');
-/**
- * Main installation function
- * Called by BMAD installer when processing the module
- */
-async function installModule(config) {
-  console.log('🚀 Installing {{MODULE_NAME}} module...');
-  console.log(`   Version: ${config.version}`);
-  console.log(`   Module Code: ${config.module_code}`);
-  try {
-    // Step 1: Validate environment
-    await validateEnvironment(config);
-    // Step 2: Setup custom configurations
-    await setupConfigurations(config);
-    // Step 3: Initialize module-specific features
-    await initializeFeatures(config);
-    // Step 4: Run post-install tasks
-    await runPostInstallTasks(config);
-    console.log('✅ {{MODULE_NAME}} module installed successfully!');
-    return {
-      success: true,
-      message: 'Module installed and configured',
-    };
-  } catch (error) {
-    console.error('❌ Installation failed:', error.message);
-    return {
-      success: false,
-      error: error.message,
-    };
-  }
-}
-/**
- * Validate that the environment meets module requirements
- */
-async function validateEnvironment(config) {
-  console.log('   Validating environment...');
-  // TODO: Add environment checks
-  // Examples:
-  // - Check for required tools/binaries
-  // - Verify permissions
-  // - Check network connectivity
-  // - Validate API keys
-  // Placeholder validation
-  if (!config.project_root) {
-    throw new Error('Project root not defined');
-  }
-  console.log('   ✓ Environment validated');
-}
-/**
- * Setup module-specific configurations
- */
-async function setupConfigurations(config) {
-  console.log('   Setting up configurations...');
-  // TODO: Add configuration setup
-  // Examples:
-  // - Create config files
-  // - Setup environment variables
-  // - Configure external services
-  // - Initialize settings
-  // Placeholder configuration
-  const configPath = path.join(config.project_root, 'bmad', config.module_code, 'config.json');
-  // Example of module config that would be created
-  // const moduleConfig = {
-  //   installed: new Date().toISOString(),
-  //   settings: {
-  //     // Add default settings
-  //   }
-  // };
-  // Note: This is a placeholder - actual implementation would write the file
-  console.log(`   ✓ Would create config at: ${configPath}`);
-  console.log('   ✓ Configurations complete');
-}
-/**
- * Initialize module-specific features
- */
-async function initializeFeatures(config) {
-  console.log('   Initializing features...');
-  // TODO: Add feature initialization
-  // Examples:
-  // - Create database schemas
-  // - Setup cron jobs
-  // - Initialize caches
-  // - Register webhooks
-  // - Setup file watchers
-  // Module-specific initialization based on type
-  switch (config.module_category) {
-    case 'data': {
-      await initializeDataFeatures(config);
-      break;
-    }
-    case 'automation': {
-      await initializeAutomationFeatures(config);
-      break;
-    }
-    case 'integration': {
-      await initializeIntegrationFeatures(config);
-      break;
-    }
-    default: {
-      console.log('   - Using standard initialization');
-    }
-  }
-  console.log('   ✓ Features initialized');
-}
-/**
- * Initialize data-related features
- */
-async function initializeDataFeatures(/* config */) {
-  console.log('   - Setting up data storage...');
-  // TODO: Setup databases, data folders, etc.
-}
-/**
- * Initialize automation features
- */
-async function initializeAutomationFeatures(/* config */) {
-  console.log('   - Setting up automation hooks...');
-  // TODO: Setup triggers, watchers, schedulers
-}
-/**
- * Initialize integration features
- */
-async function initializeIntegrationFeatures(/* config */) {
-  console.log('   - Setting up integrations...');
-  // TODO: Configure APIs, webhooks, external services
-}
-/**
- * Run post-installation tasks
- */
-async function runPostInstallTasks(/* config */) {
-  console.log('   Running post-install tasks...');
-  // TODO: Add post-install tasks
-  // Examples:
-  // - Generate sample data
-  // - Run initial workflows
-  // - Send notifications
-  // - Update registries
-  console.log('   ✓ Post-install tasks complete');
-}
-/**
- * Initialize database for the module (optional)
- */
-async function initDatabase(/* config */) {
-  console.log('   Initializing database...');
-  // TODO: Add database initialization
-  // This function can be called from install-config.yaml
-  console.log('   ✓ Database initialized');
-}
-/**
- * Generate sample data for the module (optional)
- */
-async function generateSamples(config) {
-  console.log('   Generating sample data...');
-  // TODO: Create sample files, data, configurations
-  // This helps users understand how to use the module
-  const samplesPath = path.join(config.project_root, 'examples', config.module_code);
-  console.log(`   - Would create samples at: ${samplesPath}`);
-  console.log('   ✓ Samples generated');
-}
-/**
- * Uninstall the module (cleanup)
- */
-async function uninstallModule(/* config */) {
-  console.log('🗑️  Uninstalling {{MODULE_NAME}} module...');
-  try {
-    // TODO: Add cleanup logic
-    // - Remove configurations
-    // - Clean up databases
-    // - Unregister services
-    // - Backup user data
-    console.log('✅ Module uninstalled successfully');
-    return { success: true };
-  } catch (error) {
-    console.error('❌ Uninstall failed:', error.message);
-    return {
-      success: false,
-      error: error.message,
-    };
-  }
-}
-// Export functions for BMAD installer
-module.exports = {
-  installModule,
-  initDatabase,
-  generateSamples,
-  uninstallModule,
-};