bmad-method 4.43.0 → 4.44.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/CONTRIBUTING.md +2 -9
- package/README.md +0 -80
- package/bmad-core/tasks/validate-next-story.md +1 -1
- package/dist/agents/dev.txt +1 -1
- package/dist/agents/po.txt +1 -1
- package/dist/expansion-packs/bmad-2d-unity-game-dev/agents/game-developer.txt +1 -1
- package/dist/expansion-packs/bmad-2d-unity-game-dev/teams/unity-2d-game-team.txt +1 -1
- package/dist/expansion-packs/bmad-godot-game-dev/agents/bmad-orchestrator.txt +1513 -0
- package/dist/expansion-packs/bmad-godot-game-dev/agents/game-analyst.txt +3190 -0
- package/dist/expansion-packs/bmad-godot-game-dev/agents/game-architect.txt +4499 -0
- package/dist/expansion-packs/bmad-godot-game-dev/agents/game-designer.txt +3925 -0
- package/dist/expansion-packs/bmad-godot-game-dev/agents/game-developer.txt +666 -0
- package/dist/expansion-packs/bmad-godot-game-dev/agents/game-pm.txt +2381 -0
- package/dist/expansion-packs/bmad-godot-game-dev/agents/game-po.txt +1612 -0
- package/dist/expansion-packs/bmad-godot-game-dev/agents/game-qa.txt +1745 -0
- package/dist/expansion-packs/bmad-godot-game-dev/agents/game-sm.txt +1208 -0
- package/dist/expansion-packs/bmad-godot-game-dev/agents/game-ux-expert.txt +958 -0
- package/dist/expansion-packs/bmad-godot-game-dev/teams/godot-game-team.txt +27721 -0
- package/dist/teams/team-all.txt +1 -1
- package/dist/teams/team-fullstack.txt +1 -1
- package/dist/teams/team-ide-minimal.txt +1 -1
- package/dist/teams/team-no-ui.txt +1 -1
- package/docs/GUIDING-PRINCIPLES.md +3 -3
- package/docs/flattener.md +91 -0
- package/docs/versions.md +1 -1
- package/docs/working-in-the-brownfield.md +15 -6
- package/expansion-packs/bmad-godot-game-dev/README.md +244 -0
- package/expansion-packs/bmad-godot-game-dev/agent-teams/godot-game-team.yaml +18 -0
- package/expansion-packs/bmad-godot-game-dev/agents/bmad-orchestrator.md +147 -0
- package/expansion-packs/bmad-godot-game-dev/agents/game-analyst.md +84 -0
- package/expansion-packs/bmad-godot-game-dev/agents/game-architect.md +146 -0
- package/expansion-packs/bmad-godot-game-dev/agents/game-designer.md +78 -0
- package/expansion-packs/bmad-godot-game-dev/agents/game-developer.md +124 -0
- package/expansion-packs/bmad-godot-game-dev/agents/game-pm.md +82 -0
- package/expansion-packs/bmad-godot-game-dev/agents/game-po.md +115 -0
- package/expansion-packs/bmad-godot-game-dev/agents/game-qa.md +160 -0
- package/expansion-packs/bmad-godot-game-dev/agents/game-sm.md +66 -0
- package/expansion-packs/bmad-godot-game-dev/agents/game-ux-expert.md +75 -0
- package/expansion-packs/bmad-godot-game-dev/checklists/game-architect-checklist.md +377 -0
- package/expansion-packs/bmad-godot-game-dev/checklists/game-change-checklist.md +250 -0
- package/expansion-packs/bmad-godot-game-dev/checklists/game-design-checklist.md +225 -0
- package/expansion-packs/bmad-godot-game-dev/checklists/game-po-checklist.md +448 -0
- package/expansion-packs/bmad-godot-game-dev/checklists/game-story-dod-checklist.md +202 -0
- package/expansion-packs/bmad-godot-game-dev/config.yaml +30 -0
- package/expansion-packs/bmad-godot-game-dev/data/bmad-kb.md +811 -0
- package/expansion-packs/bmad-godot-game-dev/data/brainstorming-techniques.md +36 -0
- package/expansion-packs/bmad-godot-game-dev/data/development-guidelines.md +893 -0
- package/expansion-packs/bmad-godot-game-dev/data/elicitation-methods.md +156 -0
- package/expansion-packs/bmad-godot-game-dev/data/technical-preferences.md +3 -0
- package/expansion-packs/bmad-godot-game-dev/tasks/advanced-elicitation.md +110 -0
- package/expansion-packs/bmad-godot-game-dev/tasks/apply-qa-fixes.md +224 -0
- package/expansion-packs/bmad-godot-game-dev/tasks/brownfield-create-epic.md +162 -0
- package/expansion-packs/bmad-godot-game-dev/tasks/brownfield-create-story.md +149 -0
- package/expansion-packs/bmad-godot-game-dev/tasks/correct-course-game.md +159 -0
- package/expansion-packs/bmad-godot-game-dev/tasks/create-deep-research-prompt.md +278 -0
- package/expansion-packs/bmad-godot-game-dev/tasks/create-doc.md +103 -0
- package/expansion-packs/bmad-godot-game-dev/tasks/create-game-story.md +202 -0
- package/expansion-packs/bmad-godot-game-dev/tasks/document-project.md +343 -0
- package/expansion-packs/bmad-godot-game-dev/tasks/execute-checklist.md +88 -0
- package/expansion-packs/bmad-godot-game-dev/tasks/facilitate-brainstorming-session.md +136 -0
- package/expansion-packs/bmad-godot-game-dev/tasks/game-brownfield-create-epic.md +160 -0
- package/expansion-packs/bmad-godot-game-dev/tasks/game-brownfield-create-story.md +147 -0
- package/expansion-packs/bmad-godot-game-dev/tasks/game-design-brainstorming.md +290 -0
- package/expansion-packs/bmad-godot-game-dev/tasks/game-risk-profile.md +368 -0
- package/expansion-packs/bmad-godot-game-dev/tasks/game-test-design.md +219 -0
- package/expansion-packs/bmad-godot-game-dev/tasks/generate-ai-frontend-prompt.md +51 -0
- package/expansion-packs/bmad-godot-game-dev/tasks/kb-mode-interaction.md +77 -0
- package/expansion-packs/bmad-godot-game-dev/tasks/review-game-story.md +364 -0
- package/expansion-packs/bmad-godot-game-dev/tasks/shard-doc.md +187 -0
- package/expansion-packs/bmad-godot-game-dev/tasks/validate-game-story.md +208 -0
- package/expansion-packs/bmad-godot-game-dev/templates/brainstorming-output-tmpl.yaml +156 -0
- package/expansion-packs/bmad-godot-game-dev/templates/brownfield-prd-tmpl.yaml +281 -0
- package/expansion-packs/bmad-godot-game-dev/templates/competitor-analysis-tmpl.yaml +306 -0
- package/expansion-packs/bmad-godot-game-dev/templates/game-architecture-tmpl.yaml +1111 -0
- package/expansion-packs/bmad-godot-game-dev/templates/game-brief-tmpl.yaml +356 -0
- package/expansion-packs/bmad-godot-game-dev/templates/game-design-doc-tmpl.yaml +724 -0
- package/expansion-packs/bmad-godot-game-dev/templates/game-prd-tmpl.yaml +209 -0
- package/expansion-packs/bmad-godot-game-dev/templates/game-qa-gate-tmpl.yaml +186 -0
- package/expansion-packs/bmad-godot-game-dev/templates/game-story-tmpl.yaml +406 -0
- package/expansion-packs/bmad-godot-game-dev/templates/game-ui-spec-tmpl.yaml +601 -0
- package/expansion-packs/bmad-godot-game-dev/templates/level-design-doc-tmpl.yaml +620 -0
- package/expansion-packs/bmad-godot-game-dev/templates/market-research-tmpl.yaml +418 -0
- package/expansion-packs/bmad-godot-game-dev/utils/bmad-doc-template.md +327 -0
- package/expansion-packs/bmad-godot-game-dev/utils/workflow-management.md +71 -0
- package/expansion-packs/bmad-godot-game-dev/workflows/game-dev-greenfield.yaml +245 -0
- package/expansion-packs/bmad-godot-game-dev/workflows/game-prototype.yaml +213 -0
- package/package.json +1 -1
- package/release_notes.md +11 -2
- package/tools/flattener/ignoreRules.js +2 -0
- package/tools/installer/bin/bmad.js +2 -1
- package/tools/installer/config/install.config.yaml +16 -7
- package/tools/installer/lib/ide-setup.js +192 -80
- package/tools/installer/package.json +1 -1
- package/tools/upgraders/v3-to-v4-upgrader.js +1 -0
- package/test.md +0 -1
- /package/{implement-fork-friendly-ci.sh → tools/implement-fork-friendly-ci.sh} +0 -0
package/CONTRIBUTING.md
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
# Contributing to this project
|
|
2
2
|
|
|
3
|
-
Thank you for
|
|
3
|
+
Thank you for contributing to this project! This document outlines the process for contributing and some guidelines to follow.
|
|
4
4
|
|
|
5
5
|
🆕 **New to GitHub or pull requests?** Check out our [beginner-friendly Pull Request Guide](docs/how-to-contribute-with-pull-requests.md) first!
|
|
6
6
|
|
|
@@ -8,10 +8,7 @@ Thank you for considering contributing to this project! This document outlines t
|
|
|
8
8
|
|
|
9
9
|
Also note, we use the discussions feature in GitHub to have a community to discuss potential ideas, uses, additions and enhancements.
|
|
10
10
|
|
|
11
|
-
💬 **Discord Community**: Join our [Discord server](https://discord.gg/gk8jAdXWmj) for real-time discussions
|
|
12
|
-
|
|
13
|
-
- **#general-dev** - Technical discussions, feature ideas, and development questions
|
|
14
|
-
- **#bugs-issues** - Bug reports and issue discussions
|
|
11
|
+
💬 **Discord Community**: Join our [Discord server](https://discord.gg/gk8jAdXWmj) for real-time discussions or search past discussions or ideas.
|
|
15
12
|
|
|
16
13
|
## Code of Conduct
|
|
17
14
|
|
|
@@ -191,10 +188,6 @@ Fixes #[issue number] (if applicable)
|
|
|
191
188
|
|
|
192
189
|
[2-3 bullets listing HOW you implemented it]
|
|
193
190
|
|
|
194
|
-
-
|
|
195
|
-
-
|
|
196
|
-
-
|
|
197
|
-
|
|
198
191
|
## Testing
|
|
199
192
|
|
|
200
193
|
[1-2 sentences on how you tested this]
|
package/README.md
CHANGED
|
@@ -112,86 +112,6 @@ npm run install:bmad # build and install all to a destination folder
|
|
|
112
112
|
|
|
113
113
|
BMAD™'s natural language framework works in ANY domain. Expansion packs provide specialized AI agents for creative writing, business strategy, health & wellness, education, and more. Also expansion packs can expand the core BMAD-METHOD™ with specific functionality that is not generic for all cases. [See the Expansion Packs Guide](docs/expansion-packs.md) and learn to create your own!
|
|
114
114
|
|
|
115
|
-
## Codebase Flattener Tool
|
|
116
|
-
|
|
117
|
-
The BMAD-METHOD™ includes a powerful codebase flattener tool designed to prepare your project files for AI model consumption. This tool aggregates your entire codebase into a single XML file, making it easy to share your project context with AI assistants for analysis, debugging, or development assistance.
|
|
118
|
-
|
|
119
|
-
### Features
|
|
120
|
-
|
|
121
|
-
- **AI-Optimized Output**: Generates clean XML format specifically designed for AI model consumption
|
|
122
|
-
- **Smart Filtering**: Automatically respects `.gitignore` patterns to exclude unnecessary files
|
|
123
|
-
- **Binary File Detection**: Intelligently identifies and excludes binary files, focusing on source code
|
|
124
|
-
- **Progress Tracking**: Real-time progress indicators and comprehensive completion statistics
|
|
125
|
-
- **Flexible Output**: Customizable output file location and naming
|
|
126
|
-
|
|
127
|
-
### Usage
|
|
128
|
-
|
|
129
|
-
```bash
|
|
130
|
-
# Basic usage - creates flattened-codebase.xml in current directory
|
|
131
|
-
npx bmad-method flatten
|
|
132
|
-
|
|
133
|
-
# Specify custom input directory
|
|
134
|
-
npx bmad-method flatten --input /path/to/source/directory
|
|
135
|
-
npx bmad-method flatten -i /path/to/source/directory
|
|
136
|
-
|
|
137
|
-
# Specify custom output file
|
|
138
|
-
npx bmad-method flatten --output my-project.xml
|
|
139
|
-
npx bmad-method flatten -o /path/to/output/codebase.xml
|
|
140
|
-
|
|
141
|
-
# Combine input and output options
|
|
142
|
-
npx bmad-method flatten --input /path/to/source --output /path/to/output/codebase.xml
|
|
143
|
-
```
|
|
144
|
-
|
|
145
|
-
### Example Output
|
|
146
|
-
|
|
147
|
-
The tool will display progress and provide a comprehensive summary:
|
|
148
|
-
|
|
149
|
-
```text
|
|
150
|
-
📊 Completion Summary:
|
|
151
|
-
✅ Successfully processed 156 files into flattened-codebase.xml
|
|
152
|
-
📁 Output file: /path/to/your/project/flattened-codebase.xml
|
|
153
|
-
📏 Total source size: 2.3 MB
|
|
154
|
-
📄 Generated XML size: 2.1 MB
|
|
155
|
-
📝 Total lines of code: 15,847
|
|
156
|
-
🔢 Estimated tokens: 542,891
|
|
157
|
-
📊 File breakdown: 142 text, 14 binary, 0 errors
|
|
158
|
-
```
|
|
159
|
-
|
|
160
|
-
The generated XML file contains your project's text-based source files in a structured format that AI models can easily parse and understand, making it perfect for code reviews, architecture discussions, or getting AI assistance with your BMAD-METHOD™ projects.
|
|
161
|
-
|
|
162
|
-
#### Advanced Usage & Options
|
|
163
|
-
|
|
164
|
-
- CLI options
|
|
165
|
-
- `-i, --input <path>`: Directory to flatten. Default: current working directory or auto-detected project root when run interactively.
|
|
166
|
-
- `-o, --output <path>`: Output file path. Default: `flattened-codebase.xml` in the chosen directory.
|
|
167
|
-
- Interactive mode
|
|
168
|
-
- If you do not pass `--input` and `--output` and the terminal is interactive (TTY), the tool will attempt to detect your project root (by looking for markers like `.git`, `package.json`, etc.) and prompt you to confirm or override the paths.
|
|
169
|
-
- In non-interactive contexts (e.g., CI), it will prefer the detected root silently; otherwise it falls back to the current directory and default filename.
|
|
170
|
-
- File discovery and ignoring
|
|
171
|
-
- Uses `git ls-files` when inside a git repository for speed and correctness; otherwise falls back to a glob-based scan.
|
|
172
|
-
- Applies your `.gitignore` plus a curated set of default ignore patterns (e.g., `node_modules`, build outputs, caches, logs, IDE folders, lockfiles, large media/binaries, `.env*`, and previously generated XML outputs).
|
|
173
|
-
- Binary handling
|
|
174
|
-
- Binary files are detected and excluded from the XML content. They are counted in the final summary but not embedded in the output.
|
|
175
|
-
- XML format and safety
|
|
176
|
-
- UTF-8 encoded file with root element `<files>`.
|
|
177
|
-
- Each text file is emitted as a `<file path="relative/path">` element whose content is wrapped in `<![CDATA[ ... ]]>`.
|
|
178
|
-
- The tool safely handles occurrences of `]]>` inside content by splitting the CDATA to preserve correctness.
|
|
179
|
-
- File contents are preserved as-is and indented for readability inside the XML.
|
|
180
|
-
- Performance
|
|
181
|
-
- Concurrency is selected automatically based on your CPU and workload size. No configuration required.
|
|
182
|
-
- Running inside a git repo improves discovery performance.
|
|
183
|
-
|
|
184
|
-
#### Minimal XML example
|
|
185
|
-
|
|
186
|
-
```xml
|
|
187
|
-
<?xml version="1.0" encoding="UTF-8"?>
|
|
188
|
-
<files>
|
|
189
|
-
<file path="src/index.js"><![CDATA[
|
|
190
|
-
// your source content
|
|
191
|
-
]]></file>
|
|
192
|
-
</files>
|
|
193
|
-
```
|
|
194
|
-
|
|
195
115
|
## Documentation & Resources
|
|
196
116
|
|
|
197
117
|
### Essential Guides
|
|
@@ -21,7 +21,7 @@ To comprehensively validate a story draft before implementation begins, ensuring
|
|
|
21
21
|
|
|
22
22
|
### 1. Template Completeness Validation
|
|
23
23
|
|
|
24
|
-
- Load
|
|
24
|
+
- Load `.bmad-core/templates/story-tmpl.yaml` and extract all section headings from the template
|
|
25
25
|
- **Missing sections check**: Compare story sections against template sections to verify all required sections are present
|
|
26
26
|
- **Placeholder validation**: Ensure no template placeholders remain unfilled (e.g., `{{EpicNum}}`, `{{role}}`, `_TBD_`)
|
|
27
27
|
- **Agent section verification**: Confirm all sections from template exist for future agent use
|
package/dist/agents/dev.txt
CHANGED
|
@@ -361,7 +361,7 @@ To comprehensively validate a story draft before implementation begins, ensuring
|
|
|
361
361
|
|
|
362
362
|
### 1. Template Completeness Validation
|
|
363
363
|
|
|
364
|
-
- Load
|
|
364
|
+
- Load `.bmad-core/templates/story-tmpl.yaml` and extract all section headings from the template
|
|
365
365
|
- **Missing sections check**: Compare story sections against template sections to verify all required sections are present
|
|
366
366
|
- **Placeholder validation**: Ensure no template placeholders remain unfilled (e.g., `{{EpicNum}}`, `{{role}}`, `_TBD_`)
|
|
367
367
|
- **Agent section verification**: Confirm all sections from template exist for future agent use
|
package/dist/agents/po.txt
CHANGED
|
@@ -478,7 +478,7 @@ To comprehensively validate a story draft before implementation begins, ensuring
|
|
|
478
478
|
|
|
479
479
|
### 1. Template Completeness Validation
|
|
480
480
|
|
|
481
|
-
- Load
|
|
481
|
+
- Load `.bmad-core/templates/story-tmpl.yaml` and extract all section headings from the template
|
|
482
482
|
- **Missing sections check**: Compare story sections against template sections to verify all required sections are present
|
|
483
483
|
- **Placeholder validation**: Ensure no template placeholders remain unfilled (e.g., `{{EpicNum}}`, `{{role}}`, `_TBD_`)
|
|
484
484
|
- **Agent section verification**: Confirm all sections from template exist for future agent use
|
|
@@ -211,7 +211,7 @@ To comprehensively validate a story draft before implementation begins, ensuring
|
|
|
211
211
|
|
|
212
212
|
### 1. Template Completeness Validation
|
|
213
213
|
|
|
214
|
-
- Load
|
|
214
|
+
- Load `.bmad-core/templates/story-tmpl.yaml` and extract all section headings from the template
|
|
215
215
|
- **Missing sections check**: Compare story sections against template sections to verify all required sections are present
|
|
216
216
|
- **Placeholder validation**: Ensure no template placeholders remain unfilled (e.g., `{{EpicNum}}`, `{{role}}`, `_TBD_`)
|
|
217
217
|
- **Agent section verification**: Confirm all sections from template exist for future agent use
|
|
@@ -7931,7 +7931,7 @@ To comprehensively validate a story draft before implementation begins, ensuring
|
|
|
7931
7931
|
|
|
7932
7932
|
### 1. Template Completeness Validation
|
|
7933
7933
|
|
|
7934
|
-
- Load
|
|
7934
|
+
- Load `.bmad-core/templates/story-tmpl.yaml` and extract all section headings from the template
|
|
7935
7935
|
- **Missing sections check**: Compare story sections against template sections to verify all required sections are present
|
|
7936
7936
|
- **Placeholder validation**: Ensure no template placeholders remain unfilled (e.g., `{{EpicNum}}`, `{{role}}`, `_TBD_`)
|
|
7937
7937
|
- **Agent section verification**: Confirm all sections from template exist for future agent use
|