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

package/src/modules/bmb/workflows-legacy/create-module/checklist.md

@@ -1,235 +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_folder}/{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)
-- [ ] `/_module-installer/install-config.yaml` present (defines configuration questions)
-- [ ] `README.md` present with documentation
-
-### Installed Module Structure (generated in target after installation)
-
-- [ ] `/agents` directory for compiled agents
-- [ ] `/workflows` directory for workflow instances
-- [ ] `/data` directory for user data
-- [ ] `config.yaml` generated from install-config.yaml during installation
-
-## 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
-
-### Installation Configuration (install-config.yaml)
-
-- [ ] `install-config.yaml` exists in `_module-installer`
-- [ ] Module metadata present (code, name, version)
-- [ ] Configuration questions defined for user input
-- [ ] Default values provided for all questions
-- [ ] Prompt text is clear and helpful
-- [ ] Result templates use proper variable substitution
-- [ ] Paths use proper variables ({project-root}, {value}, etc.)
-
-### Generated Config (config.yaml in target)
-
-- [ ] Generated during installation from install-config.yaml
-- [ ] Contains all user-provided configuration values
-- [ ] Module metadata included
-- [ ] No config.yaml should exist in source module
-
-## 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)

package/src/modules/bmb/workflows-legacy/create-module/installer-templates/install-config.yaml

@@ -1,92 +0,0 @@
-# {{MODULE_NAME}} Module Configuration
-# This file defines installation questions and module configuration values
-
-code: "{{MODULE_CODE}}"
-name: "{{MODULE_NAME}}"
-default_selected: "{{DEFAULT_SELECTED}}" # true if this should be selected by default
-
-# Welcome message shown during installation
-prompt:
-  - "{{WELCOME_MESSAGE_LINE_1}}"
-  - "{{WELCOME_MESSAGE_LINE_2}}"
-# Core config values are automatically inherited:
-## 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)
-#
-# Field structure:
-#   field_name:
-#     prompt: "Question to ask user" (optional - omit for static values)
-#     default: "default_value" (optional)
-#     result: "{value}" or "static-value"
-#     single-select: [...] (optional - for dropdown)
-#     multi-select: [...] (optional - for checkboxes)
-#
-# Special placeholders in result:
-#   {value} - replaced with user's answer
-#   {project-root} - replaced with project root path
-#   {directory_name} - replaced with project directory name
-#   {module_code} - replaced with this module's code
-# ============================================================================
-
-# EXAMPLE: Interactive text input
-# example_project_name:
-#   prompt: "What is your project name?"
-#   default: "{directory_name}"
-#   result: "{value}"
-
-# EXAMPLE: Interactive single-select dropdown
-# example_skill_level:
-#   prompt: "What is your experience level?"
-#   default: "intermediate"
-#   result: "{value}"
-#   single-select:
-#     - value: "beginner"
-#       label: "Beginner - New to this domain"
-#     - value: "intermediate"
-#       label: "Intermediate - Familiar with basics"
-#     - value: "expert"
-#       label: "Expert - Deep knowledge"
-
-# EXAMPLE: Interactive multi-select checkboxes
-# example_features:
-#   prompt:
-#     - "Which features do you want to enable?"
-#     - "(Select all that apply)"
-#   result: "{value}"
-#   multi-select:
-#     - "Feature A"
-#     - "Feature B"
-#     - "Feature C"
-
-# EXAMPLE: Interactive path input
-# example_output_path:
-#   prompt: "Where should outputs be saved?"
-#   default: "output/{{MODULE_CODE}}"
-#   result: "{project-root}/{value}"
-
-# EXAMPLE: Static value (no user prompt)
-# example_static_setting:
-#   result: "hardcoded-value"
-
-# EXAMPLE: Static path
-# module_data_path:
-#   result: "{project-root}/{bmad_folder}/{{MODULE_CODE}}/data"
-
-# ============================================================================
-# YOUR MODULE CONFIGURATION FIELDS
-# ============================================================================
-# Replace examples above with your module's actual configuration needs.
-# Delete this comment block and the examples when implementing.
-# ============================================================================
-
-# TODO: INSERT {MODULE_CONFIG_FIELDS} HERE

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

@@ -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,
-};