@zeyue0329/xiaoma-cli 1.0.49 → 6.0.0-alpha.13

package/src/modules/xmb/workflows-legacy/module-brief/template.md

@@ -0,0 +1,275 @@
+# 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 XIAOMA Method Module Brief workflow_

package/src/modules/xmb/workflows-legacy/module-brief/workflow.yaml

@@ -0,0 +1,36 @@
+# Module Brief Workflow Configuration
+name: module-brief
+description: "Create a comprehensive Module Brief that serves as the blueprint for building new XIAOMA modules using strategic analysis and creative vision"
+author: "XiaoMa Builder"
+
+# Critical variables
+config_source: "{project-root}/{xiaoma_folder}/xmb/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}/{xiaoma_folder}/"
+module_structure_guide: "{project-root}/{xiaoma_folder}/xmb/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}/{xiaoma_folder}/xmb/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 # XMB workflows run locally in XIAOMA-CLI project

package/src/modules/xmc/README.md

@@ -0,0 +1,128 @@
+# XMC - XiaoMa Method Module
+
+Core orchestration system for AI-driven agile development, providing comprehensive lifecycle management through specialized agents and workflows.
+
+---
+
+## 📚 Complete Documentation
+
+👉 **[XMC Documentation Hub](docs/README.md)** - Start here for complete guides, tutorials, and references
+
+**Quick Links:**
+
+- **[Quick Start Guide](docs/quick-start.md)** - New to XMC? 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 XMC 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:
+
+```
+xmc/
+├── 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:** XiaoMa 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) - 6 workflows
+**Phase 3:** Solutioning (Level 3-4) - 2 workflows
+**Phase 4:** Implementation (iterative) - 10 workflows
+**Testing:** Quality assurance (parallel) - 9 workflows
+
+👉 **[Workflow Guides](docs/README.md#-workflow-guides)** - Detailed documentation for each phase
+
+---
+
+## 🚀 Getting Started
+
+**New Project:**
+
+```bash
+# Install XMC
+npx xiaoma-cli@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
+
+XMC 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 → drafted → ready → 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 XMC, CIS, XMB, 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/xiaoma-code-org/XIAOMA-CLI/issues)** - Report bugs or request features
+- **[YouTube](https://www.youtube.com/@XiaoMaCode)** - Video tutorials and walkthroughs
+
+---
+
+**Ready to build?** → [Start with the Quick Start Guide](docs/quick-start.md)

package/src/modules/xmc/_module-installer/install-config.yaml

@@ -0,0 +1,53 @@
+# XIAOMA™ Method Core Configuration
+
+code: xmc
+name: "XMC: XiaoMa Method Agile-AI Driven-Development"
+default_selected: true # This module will be selected by default for new installations
+
+header: "XiaoMa Method™: Breakthrough Method of Agile-Ai Driven-Dev"
+subheader: "Agent and Workflow Configuration for this module"
+
+# Variables from Core Config inserted:
+## user_name
+## communication_language
+## output_folder
+## xiaoma_folder
+## install_user_docs
+## kb_install
+
+project_name:
+  prompt: "What is the title of your project you will be working on?"
+  default: "{directory_name}"
+  result: "{value}"
+
+user_skill_level:
+  prompt:
+    - "What is your technical experience level?"
+    - "This affects how agents explain concepts to you (NOT document content)."
+    - "Documents are always concise for LLM efficiency."
+  default: "intermediate"
+  result: "{value}"
+  single-select:
+    - value: "beginner"
+      label: "Beginner - New to development, explain concepts clearly"
+    - value: "intermediate"
+      label: "Intermediate - Familiar with development, balance explanation with efficiency"
+    - value: "expert"
+      label: "Expert - Deep technical knowledge, be direct and technical"
+
+sprint_artifacts:
+  default: "docs/sprint-artifacts"
+  result: "{project-root}/{value}"
+
+tea_use_mcp_enhancements:
+  prompt: "Enable Test Architect Playwright MCP capabilities (healing, exploratory, verification)? You have to setup your MCPs yourself; refer to test-architecture.md for hints."
+  default: false
+  result: "{value}"
+
+tea_use_playwright_utils:
+  prompt:
+    - "Are you using playwright-utils (@seontechnologies/playwright-utils) in your project?"
+    - "This adds fixture-based utilities for auth, API requests, network recording, polling, intercept, recurse, logging, file download handling, and burn-in."
+    - "You must install packages yourself, or use test architect's *framework command."
+  default: false
+  result: "{value}"

package/src/modules/xmc/_module-installer/installer.js

@@ -0,0 +1,131 @@
+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'));
+
+/**
+ * XMC Module Installer
+ * Standard module installer function that executes after IDE installations
+ *
+ * @param {Object} options - Installation options
+ * @param {string} options.projectRoot - The root directory of the target project
+ * @param {Object} options.config - Module configuration from install-config.yaml
+ * @param {Array<string>} options.installedIDEs - Array of IDE codes that were installed
+ * @param {Object} options.logger - Logger instance for output
+ * @returns {Promise<boolean>} - Success status
+ */
+async function install(options) {
+  const { projectRoot, config, installedIDEs, logger } = options;
+
+  try {
+    logger.log(chalk.blue('🚀 Installing XMC 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))) {
+        logger.log(chalk.yellow(`Creating output directory: ${outputConfig}`));
+        await fs.ensureDir(outputPath);
+      }
+    }
+
+    // Create dev story location if configured
+    if (config['sprint_artifacts']) {
+      // Strip {project-root}/ prefix if present
+      const storyConfig = config['sprint_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);
+      }
+    }
+
+    // Handle IDE-specific configurations if needed
+    if (installedIDEs && installedIDEs.length > 0) {
+      logger.log(chalk.cyan(`Configuring XMC for IDEs: ${installedIDEs.join(', ')}`));
+
+      // Add any IDE-specific XMC configurations here
+      for (const ide of installedIDEs) {
+        await configureForIDE(ide, projectRoot, config, logger);
+      }
+    }
+
+    logger.log(chalk.green('✓ XMC Module installation complete'));
+    return true;
+  } catch (error) {
+    logger.error(chalk.red(`Error installing XMC module: ${error.message}`));
+    return false;
+  }
+}
+
+/**
+ * Configure XMC module for specific platform/IDE
+ * @private
+ */
+async function configureForIDE(ide, projectRoot, config, logger) {
+  // Validate platform code
+  if (!platformCodes.isValidPlatform(ide)) {
+    logger.warn(chalk.yellow(`  Warning: Unknown platform code '${ide}'. Skipping XMC configuration.`));
+    return;
+  }
+
+  const platformName = platformCodes.getDisplayName(ide);
+
+  // Try to load platform-specific handler
+  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,
+          platformInfo: platformCodes.getPlatform(ide), // Pass platform metadata
+        });
+      }
+    } else {
+      // No platform-specific handler for this IDE
+      logger.log(chalk.dim(`  No XMC-specific configuration for ${platformName}`));
+    }
+  } catch (error) {
+    logger.warn(chalk.yellow(`  Warning: Could not load XMC platform-specific handler for ${platformName}: ${error.message}`));
+  }
+}
+
+module.exports = { install };

package/src/modules/xmc/_module-installer/platform-specifics/claude-code.js

@@ -0,0 +1,35 @@
+const chalk = require('chalk');
+
+/**
+ * XMC Platform-specific installer for Claude Code
+ *
+ * @param {Object} options - Installation options
+ * @param {string} options.projectRoot - The root directory of the target project
+ * @param {Object} options.config - Module configuration from install-config.yaml
+ * @param {Object} options.logger - Logger instance for output
+ * @param {Object} options.platformInfo - Platform metadata from global config
+ * @returns {Promise<boolean>} - Success status
+ */
+async function install(options) {
+  const { logger, platformInfo } = options;
+  // projectRoot and config available for future use
+
+  try {
+    const platformName = platformInfo ? platformInfo.name : 'Claude Code';
+    logger.log(chalk.cyan(`  XMC-${platformName} Specifics installed`));
+
+    // Add Claude Code specific XMC configurations here
+    // For example:
+    // - Custom command configurations
+    // - Agent party configurations
+    // - Workflow integrations
+    // - Template mappings
+
+    return true;
+  } catch (error) {
+    logger.error(chalk.red(`Error installing XMC Claude Code specifics: ${error.message}`));
+    return false;
+  }
+}
+
+module.exports = { install };

package/src/modules/xmc/_module-installer/platform-specifics/windsurf.js

@@ -0,0 +1,32 @@
+const chalk = require('chalk');
+
+/**
+ * XMC Platform-specific installer for Windsurf
+ *
+ * @param {Object} options - Installation options
+ * @param {string} options.projectRoot - The root directory of the target project
+ * @param {Object} options.config - Module configuration from install-config.yaml
+ * @param {Object} options.logger - Logger instance for output
+ * @returns {Promise<boolean>} - Success status
+ */
+async function install(options) {
+  const { logger } = options;
+  // projectRoot and config available for future use
+
+  try {
+    logger.log(chalk.cyan('  XMC-Windsurf Specifics installed'));
+
+    // Add Windsurf specific XMC configurations here
+    // For example:
+    // - Custom cascades
+    // - Workflow adaptations
+    // - Template configurations
+
+    return true;
+  } catch (error) {
+    logger.error(chalk.red(`Error installing XMC Windsurf specifics: ${error.message}`));
+    return false;
+  }
+}
+
+module.exports = { install };