mirror of https://github.com/bmad-code-org/BMAD-METHOD.git synced 2026-08-28 19:20:41 +08:00

Files

T

Alex Verkhovsky 513f440a23 refactor(installer): restructure installer with clean separation of concerns (#2129 )

* refactor(installer): restructure installer with clean separation of concerns

Move tools/cli/ to tools/installer/ with major structural cleanup:

- InstallPaths async factory for path resolution and directory creation
- Config value object (frozen) replaces mutable config bag
- ExistingInstall value object replaces stateful Detector class
- OfficialModules + CustomModules + ExternalModuleManager replace monolithic ModuleManager
- install() is prompt-free; all user interaction in ui.js
- Update state returned explicitly instead of mutating customConfig
- Delete dead code: dependency-resolver, _base-ide, IdeConfigManager,
  platform-codes helpers, npx wrapper, xml-utils
- Flatten directory structure: custom/handler → custom-handler,
  tools/cli/ → tools/installer/, lib/ directories removed
- Update all path references in package.json, tests, CI, and docs

* fix(installer): guard ExistingInstall.version and surface module.yaml errors

Guard ExistingInstall.version access with .installed check in
uninstall.js, ui.js, and installer.js to prevent throwing on
empty/partial _bmad dirs. Surface invalid module.yaml parse errors
as warnings instead of silently returning empty results.

2026-03-27 06:50:07 -06:00

2.0 KiB

Raw Blame History

Prompt: Generate External Modules Reference Page

Goal

Create a reference documentation page at docs/reference/modules.md that lists all official external BMad modules with descriptions and links.

Source of Truth

Read tools/installer/external-official-modules.yaml — this is the authoritative registry of official external modules. Use the module names, codes, npm package names, and repository URLs from this file.

Research Step

For each module in the registry, visit its GitHub repository (url in the YAML record) and read its README to get:

A 1-2 sentence description of what the module does
The key agents and workflows it provides (if listed)
Any notable features or use cases

Output Format

Create docs/reference/modules.md following the project's Reference Catalog structure (see docs/_STYLE_GUIDE.md):

1. Title + Hook
2. Items (## for each module)
   - Brief description (one sentence)
   - **Key Info:** as flat list (code, npm package, GitHub link)
3. Installation note

Style

use @docs/_STYLE_GUIDE.md

Frontmatter

---
title: Official Modules
---

Content Requirements

Start with a brief intro explaining that BMad extends through official modules selected during installation
For each module include:
- ## header with module name
- 1-2 sentence description (sourced from GitHub README, not just the registry's short description)
- Key info list: module code, npm package (linked), GitHub repo (linked)
- Brief bullet list of what it provides (agents, workflows, key features) — keep to 3-5 bullets
Include a :::tip admonition about how to install modules (via npx bmad-method installer)
Mention that community modules and a marketplace are coming
Do NOT include built-in modules (core, bmm) — this page is specifically for external/add-on modules

Existing Pages for Reference

Look at these files to match the tone and style of existing reference docs:

docs/reference/agents.md
docs/reference/commands.md
docs/reference/testing.md

2.0 KiB Raw Blame History