bmalph 1.0.0 → 2.2.1

package/bmad/bmm/workflows/document-project/templates/project-scan-report-schema.json

@@ -1,160 +1,160 @@
-{
-  "$schema": "http://json-schema.org/draft-07/schema#",
-  "title": "Project Scan Report Schema",
-  "description": "State tracking file for document-project workflow resumability",
-  "type": "object",
-  "required": ["workflow_version", "timestamps", "mode", "scan_level", "completed_steps", "current_step"],
-  "properties": {
-    "workflow_version": {
-      "type": "string",
-      "description": "Version of document-project workflow",
-      "example": "1.2.0"
-    },
-    "timestamps": {
-      "type": "object",
-      "required": ["started", "last_updated"],
-      "properties": {
-        "started": {
-          "type": "string",
-          "format": "date-time",
-          "description": "ISO 8601 timestamp when workflow started"
-        },
-        "last_updated": {
-          "type": "string",
-          "format": "date-time",
-          "description": "ISO 8601 timestamp of last state update"
-        },
-        "completed": {
-          "type": "string",
-          "format": "date-time",
-          "description": "ISO 8601 timestamp when workflow completed (if finished)"
-        }
-      }
-    },
-    "mode": {
-      "type": "string",
-      "enum": ["initial_scan", "full_rescan", "deep_dive"],
-      "description": "Workflow execution mode"
-    },
-    "scan_level": {
-      "type": "string",
-      "enum": ["quick", "deep", "exhaustive"],
-      "description": "Scan depth level (deep_dive mode always uses exhaustive)"
-    },
-    "project_root": {
-      "type": "string",
-      "description": "Absolute path to project root directory"
-    },
-    "output_folder": {
-      "type": "string",
-      "description": "Absolute path to output folder"
-    },
-    "completed_steps": {
-      "type": "array",
-      "items": {
-        "type": "object",
-        "required": ["step", "status"],
-        "properties": {
-          "step": {
-            "type": "string",
-            "description": "Step identifier (e.g., 'step_1', 'step_2')"
-          },
-          "status": {
-            "type": "string",
-            "enum": ["completed", "partial", "failed"]
-          },
-          "timestamp": {
-            "type": "string",
-            "format": "date-time"
-          },
-          "outputs": {
-            "type": "array",
-            "items": { "type": "string" },
-            "description": "Files written during this step"
-          },
-          "summary": {
-            "type": "string",
-            "description": "1-2 sentence summary of step outcome"
-          }
-        }
-      }
-    },
-    "current_step": {
-      "type": "string",
-      "description": "Current step identifier for resumption"
-    },
-    "findings": {
-      "type": "object",
-      "description": "High-level summaries only (detailed findings purged after writing)",
-      "properties": {
-        "project_classification": {
-          "type": "object",
-          "properties": {
-            "repository_type": { "type": "string" },
-            "parts_count": { "type": "integer" },
-            "primary_language": { "type": "string" },
-            "architecture_type": { "type": "string" }
-          }
-        },
-        "technology_stack": {
-          "type": "array",
-          "items": {
-            "type": "object",
-            "properties": {
-              "part_id": { "type": "string" },
-              "tech_summary": { "type": "string" }
-            }
-          }
-        },
-        "batches_completed": {
-          "type": "array",
-          "description": "For deep/exhaustive scans: subfolders processed",
-          "items": {
-            "type": "object",
-            "properties": {
-              "path": { "type": "string" },
-              "files_scanned": { "type": "integer" },
-              "summary": { "type": "string" }
-            }
-          }
-        }
-      }
-    },
-    "outputs_generated": {
-      "type": "array",
-      "items": { "type": "string" },
-      "description": "List of all output files generated"
-    },
-    "resume_instructions": {
-      "type": "string",
-      "description": "Instructions for resuming from current_step"
-    },
-    "validation_status": {
-      "type": "object",
-      "properties": {
-        "last_validated": {
-          "type": "string",
-          "format": "date-time"
-        },
-        "validation_errors": {
-          "type": "array",
-          "items": { "type": "string" }
-        }
-      }
-    },
-    "deep_dive_targets": {
-      "type": "array",
-      "description": "Track deep-dive areas analyzed (for deep_dive mode)",
-      "items": {
-        "type": "object",
-        "properties": {
-          "target_name": { "type": "string" },
-          "target_path": { "type": "string" },
-          "files_analyzed": { "type": "integer" },
-          "output_file": { "type": "string" },
-          "timestamp": { "type": "string", "format": "date-time" }
-        }
-      }
-    }
-  }
-}
+{
+  "$schema": "http://json-schema.org/draft-07/schema#",
+  "title": "Project Scan Report Schema",
+  "description": "State tracking file for document-project workflow resumability",
+  "type": "object",
+  "required": ["workflow_version", "timestamps", "mode", "scan_level", "completed_steps", "current_step"],
+  "properties": {
+    "workflow_version": {
+      "type": "string",
+      "description": "Version of document-project workflow",
+      "example": "1.2.0"
+    },
+    "timestamps": {
+      "type": "object",
+      "required": ["started", "last_updated"],
+      "properties": {
+        "started": {
+          "type": "string",
+          "format": "date-time",
+          "description": "ISO 8601 timestamp when workflow started"
+        },
+        "last_updated": {
+          "type": "string",
+          "format": "date-time",
+          "description": "ISO 8601 timestamp of last state update"
+        },
+        "completed": {
+          "type": "string",
+          "format": "date-time",
+          "description": "ISO 8601 timestamp when workflow completed (if finished)"
+        }
+      }
+    },
+    "mode": {
+      "type": "string",
+      "enum": ["initial_scan", "full_rescan", "deep_dive"],
+      "description": "Workflow execution mode"
+    },
+    "scan_level": {
+      "type": "string",
+      "enum": ["quick", "deep", "exhaustive"],
+      "description": "Scan depth level (deep_dive mode always uses exhaustive)"
+    },
+    "project_root": {
+      "type": "string",
+      "description": "Absolute path to project root directory"
+    },
+    "project_knowledge": {
+      "type": "string",
+      "description": "Absolute path to project knowledge folder"
+    },
+    "completed_steps": {
+      "type": "array",
+      "items": {
+        "type": "object",
+        "required": ["step", "status"],
+        "properties": {
+          "step": {
+            "type": "string",
+            "description": "Step identifier (e.g., 'step_1', 'step_2')"
+          },
+          "status": {
+            "type": "string",
+            "enum": ["completed", "partial", "failed"]
+          },
+          "timestamp": {
+            "type": "string",
+            "format": "date-time"
+          },
+          "outputs": {
+            "type": "array",
+            "items": { "type": "string" },
+            "description": "Files written during this step"
+          },
+          "summary": {
+            "type": "string",
+            "description": "1-2 sentence summary of step outcome"
+          }
+        }
+      }
+    },
+    "current_step": {
+      "type": "string",
+      "description": "Current step identifier for resumption"
+    },
+    "findings": {
+      "type": "object",
+      "description": "High-level summaries only (detailed findings purged after writing)",
+      "properties": {
+        "project_classification": {
+          "type": "object",
+          "properties": {
+            "repository_type": { "type": "string" },
+            "parts_count": { "type": "integer" },
+            "primary_language": { "type": "string" },
+            "architecture_type": { "type": "string" }
+          }
+        },
+        "technology_stack": {
+          "type": "array",
+          "items": {
+            "type": "object",
+            "properties": {
+              "part_id": { "type": "string" },
+              "tech_summary": { "type": "string" }
+            }
+          }
+        },
+        "batches_completed": {
+          "type": "array",
+          "description": "For deep/exhaustive scans: subfolders processed",
+          "items": {
+            "type": "object",
+            "properties": {
+              "path": { "type": "string" },
+              "files_scanned": { "type": "integer" },
+              "summary": { "type": "string" }
+            }
+          }
+        }
+      }
+    },
+    "outputs_generated": {
+      "type": "array",
+      "items": { "type": "string" },
+      "description": "List of all output files generated"
+    },
+    "resume_instructions": {
+      "type": "string",
+      "description": "Instructions for resuming from current_step"
+    },
+    "validation_status": {
+      "type": "object",
+      "properties": {
+        "last_validated": {
+          "type": "string",
+          "format": "date-time"
+        },
+        "validation_errors": {
+          "type": "array",
+          "items": { "type": "string" }
+        }
+      }
+    },
+    "deep_dive_targets": {
+      "type": "array",
+      "description": "Track deep-dive areas analyzed (for deep_dive mode)",
+      "items": {
+        "type": "object",
+        "properties": {
+          "target_name": { "type": "string" },
+          "target_path": { "type": "string" },
+          "files_analyzed": { "type": "integer" },
+          "output_file": { "type": "string" },
+          "timestamp": { "type": "string", "format": "date-time" }
+        }
+      }
+    }
+  }
+}

package/bmad/bmm/workflows/document-project/templates/source-tree-template.md

@@ -1,135 +1,135 @@
-# {{project_name}} - Source Tree Analysis
-
-**Date:** {{date}}
-
-## Overview
-
-{{source_tree_overview}}
-
-{{#if is_multi_part}}
-
-## Multi-Part Structure
-
-This project is organized into {{parts_count}} distinct parts:
-
-{{#each project_parts}}
-
-- **{{part_name}}** (`{{root_path}}`): {{purpose}}
-  {{/each}}
-  {{/if}}
-
-## Complete Directory Structure
-
-```
-{{complete_source_tree}}
-```
-
-## Critical Directories
-
-{{#each critical_folders}}
-
-### `{{folder_path}}`
-
-{{description}}
-
-**Purpose:** {{purpose}}
-**Contains:** {{contents_summary}}
-{{#if entry_points}}**Entry Points:** {{entry_points}}{{/if}}
-{{#if integration_note}}**Integration:** {{integration_note}}{{/if}}
-
-{{/each}}
-
-{{#if is_multi_part}}
-
-## Part-Specific Trees
-
-{{#each project_parts}}
-
-### {{part_name}} Structure
-
-```
-{{source_tree}}
-```
-
-**Key Directories:**
-{{#each critical_directories}}
-
-- **`{{path}}`**: {{description}}
-  {{/each}}
-
-{{/each}}
-
-## Integration Points
-
-{{#each integration_points}}
-
-### {{from_part}} → {{to_part}}
-
-- **Location:** `{{integration_path}}`
-- **Type:** {{integration_type}}
-- **Details:** {{details}}
-  {{/each}}
-
-{{/if}}
-
-## Entry Points
-
-{{#if is_single_part}}
-
-- **Main Entry:** `{{main_entry_point}}`
-  {{#if additional_entry_points}}
-- **Additional:**
-  {{#each additional_entry_points}}
-  - `{{path}}`: {{description}}
-    {{/each}}
-    {{/if}}
-    {{else}}
-    {{#each project_parts}}
-
-### {{part_name}}
-
-- **Entry Point:** `{{entry_point}}`
-- **Bootstrap:** {{bootstrap_description}}
-  {{/each}}
-  {{/if}}
-
-## File Organization Patterns
-
-{{file_organization_patterns}}
-
-## Key File Types
-
-{{#each file_type_patterns}}
-
-### {{file_type}}
-
-- **Pattern:** `{{pattern}}`
-- **Purpose:** {{purpose}}
-- **Examples:** {{examples}}
-  {{/each}}
-
-## Asset Locations
-
-{{#if has_assets}}
-{{#each asset_locations}}
-
-- **{{asset_type}}**: `{{location}}` ({{file_count}} files, {{total_size}})
-  {{/each}}
-  {{else}}
-  No significant assets detected.
-  {{/if}}
-
-## Configuration Files
-
-{{#each config_files}}
-
-- **`{{path}}`**: {{description}}
-  {{/each}}
-
-## Notes for Development
-
-{{development_notes}}
-
----
-
-_Generated using BMAD Method `document-project` workflow_
+# {{project_name}} - Source Tree Analysis
+
+**Date:** {{date}}
+
+## Overview
+
+{{source_tree_overview}}
+
+{{#if is_multi_part}}
+
+## Multi-Part Structure
+
+This project is organized into {{parts_count}} distinct parts:
+
+{{#each project_parts}}
+
+- **{{part_name}}** (`{{root_path}}`): {{purpose}}
+  {{/each}}
+  {{/if}}
+
+## Complete Directory Structure
+
+```
+{{complete_source_tree}}
+```
+
+## Critical Directories
+
+{{#each critical_folders}}
+
+### `{{folder_path}}`
+
+{{description}}
+
+**Purpose:** {{purpose}}
+**Contains:** {{contents_summary}}
+{{#if entry_points}}**Entry Points:** {{entry_points}}{{/if}}
+{{#if integration_note}}**Integration:** {{integration_note}}{{/if}}
+
+{{/each}}
+
+{{#if is_multi_part}}
+
+## Part-Specific Trees
+
+{{#each project_parts}}
+
+### {{part_name}} Structure
+
+```
+{{source_tree}}
+```
+
+**Key Directories:**
+{{#each critical_directories}}
+
+- **`{{path}}`**: {{description}}
+  {{/each}}
+
+{{/each}}
+
+## Integration Points
+
+{{#each integration_points}}
+
+### {{from_part}} → {{to_part}}
+
+- **Location:** `{{integration_path}}`
+- **Type:** {{integration_type}}
+- **Details:** {{details}}
+  {{/each}}
+
+{{/if}}
+
+## Entry Points
+
+{{#if is_single_part}}
+
+- **Main Entry:** `{{main_entry_point}}`
+  {{#if additional_entry_points}}
+- **Additional:**
+  {{#each additional_entry_points}}
+  - `{{path}}`: {{description}}
+    {{/each}}
+    {{/if}}
+    {{else}}
+    {{#each project_parts}}
+
+### {{part_name}}
+
+- **Entry Point:** `{{entry_point}}`
+- **Bootstrap:** {{bootstrap_description}}
+  {{/each}}
+  {{/if}}
+
+## File Organization Patterns
+
+{{file_organization_patterns}}
+
+## Key File Types
+
+{{#each file_type_patterns}}
+
+### {{file_type}}
+
+- **Pattern:** `{{pattern}}`
+- **Purpose:** {{purpose}}
+- **Examples:** {{examples}}
+  {{/each}}
+
+## Asset Locations
+
+{{#if has_assets}}
+{{#each asset_locations}}
+
+- **{{asset_type}}**: `{{location}}` ({{file_count}} files, {{total_size}})
+  {{/each}}
+  {{else}}
+  No significant assets detected.
+  {{/if}}
+
+## Configuration Files
+
+{{#each config_files}}
+
+- **`{{path}}`**: {{description}}
+  {{/each}}
+
+## Notes for Development
+
+{{development_notes}}
+
+---
+
+_Generated using BMAD Method `document-project` workflow_

package/bmad/bmm/workflows/document-project/workflow.yaml

@@ -1,30 +1,22 @@
-# Document Project Workflow Configuration
-name: "document-project"
-version: "1.2.0"
-description: "Analyzes and documents brownfield projects by scanning codebase, architecture, and patterns to create comprehensive reference documentation for AI-assisted development"
-author: "BMad"
-
-# Critical variables
-config_source: "{project-root}/_bmad/bmm/config.yaml"
-output_folder: "{config_source}:project_knowledge"
-user_name: "{config_source}:user_name"
-communication_language: "{config_source}:communication_language"
-document_output_language: "{config_source}:document_output_language"
-user_skill_level: "{config_source}:user_skill_level"
-date: system-generated
-
-# Module path and component files
-installed_path: "{project-root}/_bmad/bmm/workflows/document-project"
-instructions: "{installed_path}/instructions.md"
-validation: "{installed_path}/checklist.md"
-
-# Required data files - CRITICAL for project type detection and documentation requirements
-documentation_requirements_csv: "{installed_path}/documentation-requirements.csv"
-
-# Output configuration - Multiple files generated in output folder
-# Primary output: {output_folder}/project-documentation/
-# Additional files generated by sub-workflows based on project structure
-
-standalone: true
-
-web_bundle: false
+# Document Project Workflow Configuration
+name: "document-project"
+version: "1.2.0"
+description: "Analyzes and documents brownfield projects by scanning codebase, architecture, and patterns to create comprehensive reference documentation for AI-assisted development"
+author: "BMad"
+
+# Critical variables
+config_source: "{project-root}/_bmad/bmm/config.yaml"
+project_knowledge: "{config_source}:project_knowledge"
+user_name: "{config_source}:user_name"
+communication_language: "{config_source}:communication_language"
+document_output_language: "{config_source}:document_output_language"
+user_skill_level: "{config_source}:user_skill_level"
+date: system-generated
+
+# Module path and component files
+installed_path: "{project-root}/_bmad/bmm/workflows/document-project"
+instructions: "{installed_path}/instructions.md"
+validation: "{installed_path}/checklist.md"
+
+# Required data files - CRITICAL for project type detection and documentation requirements
+documentation_requirements_csv: "{installed_path}/documentation-requirements.csv"