ma-agents 2.19.2 → 2.20.1

package/lib/bmad-cache/cis/tools/build-docs.mjs

@@ -0,0 +1,448 @@
+/**
+ * Creative Intelligence Suite 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-module-creative-intelligence-suite';
+
+// 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',
+  'archived',
+  // Note: Files/dirs starting with _ (like _STYLE_GUIDE.md, _archive/) are excluded in shouldExcludeFromLlm()
+];
+
+// =============================================================================
+// Main Entry Point
+/**
+ * Orchestrates the full Creative Intelligence Suite 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() {
+  console.log();
+  printBanner('Creative Intelligence Suite Documentation Build Pipeline');
+  console.log();
+  console.log(`Project root: ${PROJECT_ROOT}`);
+  console.log(`Build directory: ${BUILD_DIR}`);
+  console.log();
+
+  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 = [
+    '# Creative Intelligence Suite Documentation',
+    '',
+    '> Innovation, brainstorming, and problem-solving agents for the BMad Method.',
+    '',
+    `Documentation: ${siteUrl}`,
+    `Repository: ${REPO_URL}`,
+    `Full docs: ${siteUrl}/llms-full.txt`,
+    '',
+    '## Quick Start',
+    '',
+    `- **[Quick Start](${siteUrl}/tutorials/quick-start)** - Get started with CIS`,
+    `- **[Installation](${siteUrl}/reference/installation)** - Installation guide`,
+    '',
+    '## Core Concepts',
+    '',
+    `- **[What is CIS?](${siteUrl}/explanation/what-is-cis)** - Understanding the suite`,
+    `- **[Brainstorming](${siteUrl}/how-to/brainstorm)** - Brainstorming workflows`,
+    `- **[Problem Solving](${siteUrl}/how-to/solve-problems)** - Problem-solving agents`,
+    '',
+    '---',
+    '',
+    '## 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 = [
+    '# Creative Intelligence Suite 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;
+  return 6;
+}
+
+/**
+ * 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 });
+}
+
+/**
+ * Recursively copies all files and subdirectories from one directory to another, creating the destination if needed.
+ *
+ * @param {string} src - Path to the source directory to copy from.
+ * @param {string} dest - Path to the destination directory to copy to.
+ * @param {string[]} [exclude=[]] - List of file or directory names (not paths) to skip while copying.
+ * @returns {boolean} `true` if the source existed and copying proceeded, `false` if the source did not exist.
+ */
+function copyDirectory(src, dest, exclude = []) {
+  if (!fs.existsSync(src)) return false;
+  fs.mkdirSync(dest, { recursive: true });
+
+  for (const entry of fs.readdirSync(src, { withFileTypes: true })) {
+    if (exclude.includes(entry.name)) continue;
+
+    const srcPath = path.join(src, entry.name);
+    const destPath = path.join(dest, entry.name);
+
+    if (entry.isDirectory()) {
+      copyDirectory(srcPath, destPath, exclude);
+    } else {
+      fs.copyFileSync(srcPath, destPath);
+    }
+  }
+  return 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) + '╝');
+}

package/lib/bmad-cache/cis/website/astro.config.mjs

@@ -0,0 +1,134 @@
+// @ts-check
+import { defineConfig } from 'astro/config';
+import starlight from '@astrojs/starlight';
+import sitemap from '@astrojs/sitemap';
+import rehypeMarkdownLinks from './src/rehype-markdown-links.js';
+import rehypeBasePaths from './src/rehype-base-paths.js';
+import { getSiteUrl } from './src/lib/site-url.mjs';
+
+const siteUrl = getSiteUrl();
+const urlParts = new URL(siteUrl);
+// Normalize basePath: ensure trailing slash so links can use `${BASE_URL}path`
+const basePath = urlParts.pathname === '/' ? '/' : urlParts.pathname.endsWith('/') ? urlParts.pathname : urlParts.pathname + '/';
+
+export default defineConfig({
+  site: `${urlParts.origin}${basePath}`,
+  base: basePath,
+  outDir: '../build/site',
+
+  // Disable aggressive caching in dev mode
+  vite: {
+    optimizeDeps: {
+      force: true, // Always re-bundle dependencies
+    },
+    server: {
+      watch: {
+        usePolling: false, // Set to true if file changes aren't detected
+      },
+    },
+  },
+
+  markdown: {
+    rehypePlugins: [
+      [rehypeMarkdownLinks, { base: basePath }],
+      [rehypeBasePaths, { base: basePath }],
+    ],
+  },
+
+  integrations: [
+    sitemap(),
+    starlight({
+      title: 'Creative Intelligence Suite',
+      tagline: 'Innovation, brainstorming, and problem-solving agents for the BMad Method.',
+
+      logo: {
+        light: './public/img/bmad-light.png',
+        dark: './public/img/bmad-dark.png',
+        alt: 'Creative Intelligence Suite',
+        replacesTitle: true,
+      },
+      favicon: '/favicon.ico',
+
+      // Social links
+      social: [
+        { icon: 'discord', label: 'Discord', href: 'https://discord.gg/gk8jAdXWmj' },
+        { icon: 'github', label: 'GitHub', href: 'https://github.com/bmad-code-org/bmad-module-creative-intelligence-suite' },
+        { icon: 'youtube', label: 'YouTube', href: 'https://www.youtube.com/@BMadCode' },
+      ],
+
+      // Show last updated timestamps
+      lastUpdated: true,
+
+      // Custom head tags for LLM discovery
+      head: [
+        {
+          tag: 'meta',
+          attrs: {
+            name: 'ai-terms',
+            content: `AI-optimized documentation: ${siteUrl}/llms-full.txt (plain text). Index: ${siteUrl}/llms.txt`,
+          },
+        },
+        {
+          tag: 'meta',
+          attrs: {
+            name: 'llms-full',
+            content: `${siteUrl}/llms-full.txt`,
+          },
+        },
+        {
+          tag: 'meta',
+          attrs: {
+            name: 'llms',
+            content: `${siteUrl}/llms.txt`,
+          },
+        },
+      ],
+
+      // Custom CSS
+      customCss: ['./src/styles/custom.css'],
+
+      // Sidebar configuration (Diataxis structure)
+      sidebar: [
+        { label: 'Welcome', slug: 'index' },
+        {
+          label: 'Tutorials',
+          collapsed: false,
+          autogenerate: { directory: 'tutorials' },
+        },
+        {
+          label: 'How-To Guides',
+          collapsed: true,
+          autogenerate: { directory: 'how-to' },
+        },
+        {
+          label: 'Explanation',
+          collapsed: true,
+          autogenerate: { directory: 'explanation' },
+        },
+        {
+          label: 'Reference',
+          collapsed: true,
+          autogenerate: { directory: 'reference' },
+        },
+      ],
+
+      // Credits in footer
+      credits: false,
+
+      // Pagination
+      pagination: false,
+
+      // Use our docs/404.md instead of Starlight's built-in 404
+      disable404Route: true,
+
+      // Custom components
+      components: {
+        Header: './src/components/Header.astro',
+        MobileMenuFooter: './src/components/MobileMenuFooter.astro',
+      },
+
+      // Table of contents
+      tableOfContents: { minHeadingLevel: 2, maxHeadingLevel: 3 },
+    }),
+  ],
+});

package/lib/bmad-cache/cis/website/src/components/Banner.astro

@@ -0,0 +1,56 @@
+---
+import { getSiteUrl } from '../lib/site-url.mjs';
+
+const llmsFullUrl = `${getSiteUrl()}/llms-full.txt`;
+---
+
+<div class="ai-banner">
+  <span>🤖 AI-optimized docs: <a href={llmsFullUrl}>llms-full.txt</a></span>
+</div>
+
+<style>
+  .ai-banner {
+    width: 100vw;
+    margin-left: calc(-50vw + 50%);
+    height: var(--ai-banner-height, 2.75rem);
+    background: #334155;
+    color: rgb(148, 163, 184);
+    padding: 0.5rem 1rem;
+    font-size: 0.875rem;
+    border-bottom: 1px solid rgba(140, 140, 255, 0.15);
+    display: flex;
+    align-items: center;
+    justify-content: center;
+    box-sizing: border-box;
+    font-family: system-ui, sans-serif;
+  }
+
+  .ai-banner span {
+    white-space: nowrap;
+    overflow: hidden;
+    text-overflow: ellipsis;
+    max-width: 100%;
+  }
+  .ai-banner a {
+    color: #8C8CFF;
+    text-decoration: none;
+    font-weight: 600;
+  }
+  .ai-banner a:hover {
+    text-decoration: underline;
+  }
+
+  @media (min-width: 50rem) {
+    .ai-banner {
+      padding-left: 2.5rem;
+      padding-right: 2.5rem;
+    }
+  }
+
+  @media (min-width: 72rem) {
+    .ai-banner {
+      padding-left: 3rem;
+      padding-right: 3rem;
+    }
+  }
+</style>