bmad-method 6.0.5-next.8 → 6.1.0

package/test/test-workflow-path-regex.js

@@ -1,88 +0,0 @@
-/**
- * Workflow Path Regex Tests
- *
- * Tests that the source and install workflow path regexes in ModuleManager
- * extract the correct capture groups (module name and workflow sub-path).
- *
- * Usage: node test/test-workflow-path-regex.js
- */
-
-// ANSI colors
-const colors = {
-  reset: '\u001B[0m',
-  green: '\u001B[32m',
-  red: '\u001B[31m',
-  cyan: '\u001B[36m',
-  dim: '\u001B[2m',
-};
-
-let passed = 0;
-let failed = 0;
-
-function assert(condition, testName, errorMessage = '') {
-  if (condition) {
-    console.log(`${colors.green}✓${colors.reset} ${testName}`);
-    passed++;
-  } else {
-    console.log(`${colors.red}✗${colors.reset} ${testName}`);
-    if (errorMessage) {
-      console.log(`  ${colors.dim}${errorMessage}${colors.reset}`);
-    }
-    failed++;
-  }
-}
-
-// ---------------------------------------------------------------------------
-// These regexes are extracted from ModuleManager.vendorWorkflowDependencies()
-// in tools/cli/installers/lib/modules/manager.js
-// ---------------------------------------------------------------------------
-
-// Source regex (line ~1081) — uses non-capturing group for _bmad
-const SOURCE_REGEX = /\{project-root\}\/(?:_bmad)\/([^/]+)\/workflows\/(.+)/;
-
-// Install regex (line ~1091) — uses non-capturing group for _bmad,
-// consistent with source regex
-const INSTALL_REGEX = /\{project-root\}\/(?:_bmad)\/([^/]+)\/workflows\/(.+)/;
-
-// ---------------------------------------------------------------------------
-// Test data
-// ---------------------------------------------------------------------------
-const sourcePath = '{project-root}/_bmad/bmm/workflows/4-implementation/create-story/workflow.md';
-const installPath = '{project-root}/_bmad/bmgd/workflows/4-production/create-story/workflow.md';
-
-console.log(`\n${colors.cyan}Workflow Path Regex Tests${colors.reset}\n`);
-
-// --- Source regex tests (these should pass — source regex is correct) ---
-
-const sourceMatch = sourcePath.match(SOURCE_REGEX);
-
-assert(sourceMatch !== null, 'Source regex matches source path');
-assert(
-  sourceMatch && sourceMatch[1] === 'bmm',
-  'Source regex group [1] is the module name',
-  `Expected "bmm", got "${sourceMatch && sourceMatch[1]}"`,
-);
-assert(
-  sourceMatch && sourceMatch[2] === '4-implementation/create-story/workflow.md',
-  'Source regex group [2] is the workflow sub-path',
-  `Expected "4-implementation/create-story/workflow.md", got "${sourceMatch && sourceMatch[2]}"`,
-);
-
-// --- Install regex tests (group [2] returns module name, not sub-path) ---
-
-const installMatch = installPath.match(INSTALL_REGEX);
-
-assert(installMatch !== null, 'Install regex matches install path');
-
-// This is the critical test: installMatch[2] should be the workflow sub-path,
-// because the code uses it as `installWorkflowSubPath`.
-// With the bug, installMatch[2] is "bmgd" (module name) instead of the sub-path.
-assert(
-  installMatch && installMatch[2] === '4-production/create-story/workflow.md',
-  'Install regex group [2] is the workflow sub-path (used as installWorkflowSubPath)',
-  `Expected "4-production/create-story/workflow.md", got "${installMatch && installMatch[2]}"`,
-);
-
-// --- Summary ---
-console.log(`\n${passed} passed, ${failed} failed\n`);
-process.exit(failed > 0 ? 1 : 0);

package/test/unit-test-schema.js

@@ -1,133 +0,0 @@
-/**
- * Unit Tests for Agent Schema Edge Cases
- *
- * Tests internal functions to achieve 100% branch coverage
- */
-
-const { validateAgentFile } = require('../tools/schema/agent.js');
-
-console.log('Running edge case unit tests...\n');
-
-let passed = 0;
-let failed = 0;
-
-// Test 1: Path with malformed module structure (no slash after module name)
-// This tests line 213: slashIndex === -1
-console.log('Test 1: Malformed module path (no slash after module name)');
-try {
-  const result = validateAgentFile('src/bmm', {
-    agent: {
-      metadata: {
-        id: 'test',
-        name: 'Test',
-        title: 'Test',
-        icon: '🧪',
-      },
-      persona: {
-        role: 'Test',
-        identity: 'Test',
-        communication_style: 'Test',
-        principles: ['Test'],
-      },
-      menu: [{ trigger: 'help', description: 'Help', action: 'help' }],
-    },
-  });
-
-  if (result.success) {
-    console.log('✗ Should have failed - missing module field');
-    failed++;
-  } else {
-    console.log('✓ Correctly handled malformed path (treated as core agent)');
-    passed++;
-  }
-} catch (error) {
-  console.log('✗ Unexpected error:', error.message);
-  failed++;
-}
-console.log('');
-
-// Test 2: Module option with empty string
-// This tests line 222: trimmed.length > 0
-console.log('Test 2: Module agent with empty string in module field');
-try {
-  const result = validateAgentFile('src/bmm/agents/test.agent.yaml', {
-    agent: {
-      metadata: {
-        id: 'test',
-        name: 'Test',
-        title: 'Test',
-        icon: '🧪',
-        module: '   ', // Empty after trimming
-      },
-      persona: {
-        role: 'Test',
-        identity: 'Test',
-        communication_style: 'Test',
-        principles: ['Test'],
-      },
-      menu: [{ trigger: 'help', description: 'Help', action: 'help' }],
-    },
-  });
-
-  if (result.success) {
-    console.log('✗ Should have failed - empty module string');
-    failed++;
-  } else {
-    console.log('✓ Correctly rejected empty module string');
-    passed++;
-  }
-} catch (error) {
-  console.log('✗ Unexpected error:', error.message);
-  failed++;
-}
-console.log('');
-
-// Test 3: Core agent path (src/core/agents/...) - tests the !filePath.startsWith(marker) branch
-console.log('Test 3: Core agent path returns null for module');
-try {
-  const result = validateAgentFile('src/core/agents/test.agent.yaml', {
-    agent: {
-      metadata: {
-        id: 'test',
-        name: 'Test',
-        title: 'Test',
-        icon: '🧪',
-        // No module field - correct for core agent
-      },
-      persona: {
-        role: 'Test',
-        identity: 'Test',
-        communication_style: 'Test',
-        principles: ['Test'],
-      },
-      menu: [{ trigger: 'help', description: 'Help', action: 'help' }],
-    },
-  });
-
-  if (result.success) {
-    console.log('✓ Core agent validated correctly (no module required)');
-    passed++;
-  } else {
-    console.log('✗ Core agent should pass without module field');
-    failed++;
-  }
-} catch (error) {
-  console.log('✗ Unexpected error:', error.message);
-  failed++;
-}
-console.log('');
-
-// Summary
-console.log('═══════════════════════════════════════');
-console.log('Edge Case Unit Test Results:');
-console.log(`  Passed: ${passed}`);
-console.log(`  Failed: ${failed}`);
-console.log('═══════════════════════════════════════\n');
-
-if (failed === 0) {
-  console.log('✨ All edge case tests passed!\n');
-  process.exit(0);
-} else {
-  console.log('❌ Some edge case tests failed\n');
-  process.exit(1);
-}

package/tools/build-docs.mjs

@@ -1,464 +0,0 @@
-/**
- * BMAD Documentation Build Pipeline
- *
- * Consolidates docs from multiple sources, generates LLM-friendly files,
- * and builds the Astro+Starlight site.
- *
- * Build outputs:
- *   build/artifacts/     - With llms.txt, llms-full.txt
- *   build/site/          - Final Astro output (deployable)
- */
-
-import { execSync } from 'node:child_process';
-import fs from 'node:fs';
-import path from 'node:path';
-import { fileURLToPath } from 'node:url';
-import { getSiteUrl } from '../website/src/lib/site-url.mjs';
-
-// =============================================================================
-// Configuration
-// =============================================================================
-
-const PROJECT_ROOT = path.dirname(path.dirname(fileURLToPath(import.meta.url)));
-const BUILD_DIR = path.join(PROJECT_ROOT, 'build');
-
-const REPO_URL = 'https://github.com/bmad-code-org/BMAD-METHOD';
-
-// DO NOT CHANGE THESE VALUES!
-// llms-full.txt is consumed by AI agents as context. Most LLMs have ~200k token limits.
-// 600k chars ≈ 150k tokens (safe margin). Exceeding this breaks AI agent functionality.
-const LLM_MAX_CHARS = 600_000;
-const LLM_WARN_CHARS = 500_000;
-
-const LLM_EXCLUDE_PATTERNS = [
-  'changelog',
-  'ide-info/',
-  'v4-to-v6-upgrade',
-  'faq',
-  'reference/glossary/',
-  'explanation/game-dev/',
-  'bmgd/',
-  // Note: Files/dirs starting with _ (like _STYLE_GUIDE.md, _archive/) are excluded in shouldExcludeFromLlm()
-];
-
-// =============================================================================
-// 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() {
-  if (process.platform === 'win32') {
-    console.error('Error: The docs build pipeline does not support Windows.');
-    console.error('Please build on Linux, macOS, or WSL.');
-    process.exit(1);
-  }
-
-  console.log();
-  printBanner('BMAD Documentation Build Pipeline');
-  console.log();
-  console.log(`Project root: ${PROJECT_ROOT}`);
-  console.log(`Build directory: ${BUILD_DIR}`);
-  console.log();
-
-  // Check for broken internal links before building
-  checkDocLinks();
-
-  cleanBuildDirectory();
-
-  const docsDir = path.join(PROJECT_ROOT, 'docs');
-  const artifactsDir = await generateArtifacts(docsDir);
-  const siteDir = buildAstroSite();
-
-  printBuildSummary(docsDir, artifactsDir, siteDir);
-}
-
-main().catch((error) => {
-  console.error(error);
-  process.exit(1);
-});
-
-// =============================================================================
-// Pipeline Stages
-/**
- * Generate LLM files for the documentation pipeline.
- *
- * Creates the build/artifacts directory and writes `llms.txt` and `llms-full.txt` (sourced from the provided docs directory).
- *
- * @param {string} docsDir - Path to the source docs directory containing Markdown files.
- * @returns {string} Path to the created artifacts directory.
- */
-
-async function generateArtifacts(docsDir) {
-  printHeader('Generating LLM files');
-
-  const outputDir = path.join(BUILD_DIR, 'artifacts');
-  fs.mkdirSync(outputDir, { recursive: true });
-
-  // Generate LLM files reading from docs/, output to artifacts/
-  generateLlmsTxt(outputDir);
-  generateLlmsFullTxt(docsDir, outputDir);
-
-  console.log();
-  console.log(`  \u001B[32m✓\u001B[0m Artifact generation complete`);
-
-  return outputDir;
-}
-
-/**
- * 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 artifactsDir = path.join(BUILD_DIR, 'artifacts');
-
-  // Build Astro site (outputs to build/site via astro.config.mjs)
-  runAstroBuild();
-  copyArtifactsToSite(artifactsDir, siteDir);
-
-  console.log();
-  console.log(`  \u001B[32m✓\u001B[0m Astro build complete`);
-
-  return siteDir;
-}
-
-// =============================================================================
-// 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...');
-
-  const siteUrl = getSiteUrl();
-  const content = [
-    '# BMAD Method Documentation',
-    '',
-    '> AI-driven agile development with specialized agents and workflows that scale from bug fixes to enterprise platforms.',
-    '',
-    `Documentation: ${siteUrl}`,
-    `Repository: ${REPO_URL}`,
-    `Full docs: ${siteUrl}/llms-full.txt`,
-    '',
-    '## Quick Start',
-    '',
-    `- **[Getting Started](${siteUrl}/tutorials/getting-started/)** - Tutorial: install and learn how BMad works`,
-    `- **[Installation](${siteUrl}/how-to/install-bmad/)** - How to install BMad Method`,
-    '',
-    '## Core Concepts',
-    '',
-    `- **[Quick Flow](${siteUrl}/explanation/quick-flow/)** - Fast development workflow`,
-    `- **[Quick Dev New Preview](${siteUrl}/explanation/quick-dev-new-preview/)** - Unified quick workflow with planning, implementation, and review in one run`,
-    `- **[Party Mode](${siteUrl}/explanation/party-mode/)** - Multi-agent collaboration`,
-    `- **[Workflow Map](${siteUrl}/reference/workflow-map/)** - Visual overview of phases and workflows`,
-    '',
-    '## Modules',
-    '',
-    `- **[Official Modules](${siteUrl}/reference/modules/)** - BMM, BMB, BMGD, and more`,
-    '',
-    '---',
-    '',
-    '## Quick Links',
-    '',
-    `- [Full Documentation (llms-full.txt)](${siteUrl}/llms-full.txt) - Complete docs for AI context`,
-    '',
-  ].join('\n');
-
-  const outputPath = path.join(outputDir, 'llms.txt');
-  fs.writeFileSync(outputPath, content, 'utf-8');
-  console.log(`    Generated llms.txt (${content.length.toLocaleString()} chars)`);
-}
-
-/**
- * Builds a consolidated llms-full.txt containing all Markdown files under docsDir wrapped in <document path="..."> 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 = getAllMarkdownFiles(docsDir).sort(compareLlmDocs);
-
-  const output = [
-    '# BMAD Method Documentation (Full)',
-    '',
-    '> Complete documentation for AI consumption',
-    `> Generated: ${date}`,
-    `> Repository: ${REPO_URL}`,
-    '',
-  ];
-
-  let fileCount = 0;
-  let skippedCount = 0;
-
-  for (const mdPath of files) {
-    if (shouldExcludeFromLlm(mdPath)) {
-      skippedCount++;
-      continue;
-    }
-
-    const fullPath = path.join(docsDir, mdPath);
-    try {
-      const content = readMarkdownContent(fullPath);
-      output.push(`<document path="${mdPath}">`, content, '</document>', '');
-      fileCount++;
-    } catch (error) {
-      console.error(`    Warning: Could not read ${mdPath}: ${error.message}`);
-    }
-  }
-
-  const result = output.join('\n');
-  validateLlmSize(result);
-
-  const outputPath = path.join(outputDir, 'llms-full.txt');
-  fs.writeFileSync(outputPath, result, 'utf-8');
-
-  const tokenEstimate = Math.floor(result.length / 4).toLocaleString();
-  console.log(
-    `    Processed ${fileCount} files (skipped ${skippedCount}), ${result.length.toLocaleString()} chars (~${tokenEstimate} tokens)`,
-  );
-}
-
-function compareLlmDocs(a, b) {
-  const aKey = getLlmSortKey(a);
-  const bKey = getLlmSortKey(b);
-
-  if (aKey !== bKey) return aKey - bKey;
-  return a.localeCompare(b);
-}
-
-function getLlmSortKey(filePath) {
-  if (filePath === 'index.md') return 0;
-  if (filePath.startsWith(`tutorials${path.sep}`) || filePath.startsWith('tutorials/')) return 2;
-  if (filePath.startsWith(`how-to${path.sep}`) || filePath.startsWith('how-to/')) return 3;
-  if (filePath.startsWith(`explanation${path.sep}`) || filePath.startsWith('explanation/')) return 4;
-  if (filePath.startsWith(`reference${path.sep}`) || filePath.startsWith('reference/')) return 5;
-  if (filePath.startsWith(`bmgd${path.sep}`) || filePath.startsWith('bmgd/')) return 6;
-  return 7;
-}
-
-/**
- * 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 = [];
-
-  for (const entry of fs.readdirSync(dir, { withFileTypes: true })) {
-    const fullPath = path.join(dir, entry.name);
-
-    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;
-}
-
-/**
- * Determine whether a file path matches any configured LLM exclusion pattern.
- * Also excludes any files or directories starting with underscore.
- * @param {string} filePath - The file path to test.
- * @returns {boolean} `true` if excluded, `false` otherwise.
- */
-function shouldExcludeFromLlm(filePath) {
-  // Exclude if ANY path component starts with underscore
-  // (e.g., _STYLE_GUIDE.md, _archive/file.md, dir/_STYLE_GUIDE.md)
-  const pathParts = filePath.split(path.sep);
-  if (pathParts.some((part) => part.startsWith('_'))) return true;
-
-  // Check configured patterns
-  return LLM_EXCLUDE_PATTERNS.some((pattern) => filePath.includes(pattern));
-}
-
-function readMarkdownContent(filePath) {
-  let content = fs.readFileSync(filePath, 'utf-8');
-
-  if (content.startsWith('---')) {
-    const end = content.indexOf('---', 3);
-    if (end !== -1) {
-      content = content.slice(end + 3).trim();
-    }
-  }
-
-  return content;
-}
-
-function validateLlmSize(content) {
-  const charCount = content.length;
-
-  if (charCount > LLM_MAX_CHARS) {
-    console.error(`    ERROR: Exceeds ${LLM_MAX_CHARS.toLocaleString()} char limit`);
-    process.exit(1);
-  } else if (charCount > LLM_WARN_CHARS) {
-    console.warn(`    \u001B[33mWARNING: Approaching ${LLM_WARN_CHARS.toLocaleString()} char limit\u001B[0m`);
-  }
-}
-
-// =============================================================================
-// 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,
-    },
-  });
-}
-
-/**
- * Copy generated artifact files into the built site directory.
- *
- * Copies llms.txt and llms-full.txt from the artifacts directory into the site directory.
- *
- * @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...');
-
-  fs.copyFileSync(path.join(artifactsDir, 'llms.txt'), path.join(siteDir, 'llms.txt'));
-  fs.copyFileSync(path.join(artifactsDir, 'llms-full.txt'), path.join(siteDir, 'llms-full.txt'));
-}
-
-// =============================================================================
-// 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).
- * @param {string} siteDir - Path to the final built site directory whose contents will be listed.
- */
-
-function printBuildSummary(docsDir, artifactsDir, siteDir) {
-  console.log();
-  printBanner('Build Complete!');
-  console.log();
-  console.log('Build artifacts:');
-  console.log(`  Source docs:     ${docsDir}`);
-  console.log(`  Generated files: ${artifactsDir}`);
-  console.log(`  Final site:      ${siteDir}`);
-  console.log();
-  console.log(`Deployable output: ${siteDir}/`);
-  console.log();
-
-  listDirectoryContents(siteDir);
-}
-
-function listDirectoryContents(dir) {
-  const entries = fs.readdirSync(dir).slice(0, 15);
-
-  for (const entry of entries) {
-    const fullPath = path.join(dir, entry);
-    const stat = fs.statSync(fullPath);
-
-    if (stat.isFile()) {
-      const sizeStr = formatFileSize(stat.size);
-      console.log(`  ${entry.padEnd(40)} ${sizeStr.padStart(8)}`);
-    } else {
-      console.log(`  ${entry}/`);
-    }
-  }
-}
-
-/**
- * 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`;
-  } else if (bytes > 1024) {
-    return `${Math.floor(bytes / 1024)}K`;
-  }
-  return `${bytes}B`;
-}
-
-// =============================================================================
-// 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...');
-
-  if (fs.existsSync(BUILD_DIR)) {
-    fs.rmSync(BUILD_DIR, { recursive: true });
-  }
-  fs.mkdirSync(BUILD_DIR, { recursive: true });
-}
-
-// =============================================================================
-// Console Output Formatting
-// =============================================================================
-
-function printHeader(title) {
-  console.log();
-  console.log('┌' + '─'.repeat(62) + '┐');
-  console.log(`│ ${title.padEnd(60)} │`);
-  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/validate-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);
-  }
-}