bmad-method 4.37.0 → 4.39.1

package/eslint.config.mjs

@@ -0,0 +1,119 @@
+import js from '@eslint/js';
+import eslintConfigPrettier from 'eslint-config-prettier/flat';
+import nodePlugin from 'eslint-plugin-n';
+import unicorn from 'eslint-plugin-unicorn';
+import yml from 'eslint-plugin-yml';
+
+export default [
+  // Global ignores for files/folders that should not be linted
+  {
+    ignores: ['dist/**', 'coverage/**', '**/*.min.js'],
+  },
+
+  // Base JavaScript recommended rules
+  js.configs.recommended,
+
+  // Node.js rules
+  ...nodePlugin.configs['flat/mixed-esm-and-cjs'],
+
+  // Unicorn rules (modern best practices)
+  unicorn.configs.recommended,
+
+  // YAML linting
+  ...yml.configs['flat/recommended'],
+
+  // Place Prettier last to disable conflicting stylistic rules
+  eslintConfigPrettier,
+
+  // Project-specific tweaks
+  {
+    rules: {
+      // Allow console for CLI tools in this repo
+      'no-console': 'off',
+      // Enforce .yaml file extension for consistency
+      'yml/file-extension': [
+        'error',
+        {
+          extension: 'yaml',
+          caseSensitive: true,
+        },
+      ],
+      // Prefer double quotes in YAML wherever quoting is used, but allow the other to avoid escapes
+      'yml/quotes': [
+        'error',
+        {
+          prefer: 'double',
+          avoidEscape: true,
+        },
+      ],
+      // Relax some Unicorn rules that are too opinionated for this codebase
+      'unicorn/prevent-abbreviations': 'off',
+      'unicorn/no-null': 'off',
+    },
+  },
+
+  // CLI/CommonJS scripts under tools/**
+  {
+    files: ['tools/**/*.js'],
+    rules: {
+      // Allow CommonJS patterns for Node CLI scripts
+      'unicorn/prefer-module': 'off',
+      'unicorn/import-style': 'off',
+      'unicorn/no-process-exit': 'off',
+      'n/no-process-exit': 'off',
+      'unicorn/no-await-expression-member': 'off',
+      'unicorn/prefer-top-level-await': 'off',
+      // Avoid failing CI on incidental unused vars in internal scripts
+      'no-unused-vars': 'off',
+      // Reduce style-only churn in internal tools
+      'unicorn/prefer-ternary': 'off',
+      'unicorn/filename-case': 'off',
+      'unicorn/no-array-reduce': 'off',
+      'unicorn/no-array-callback-reference': 'off',
+      'unicorn/consistent-function-scoping': 'off',
+      'n/no-extraneous-require': 'off',
+      'n/no-extraneous-import': 'off',
+      'n/no-unpublished-require': 'off',
+      'n/no-unpublished-import': 'off',
+      // Some scripts intentionally use globals provided at runtime
+      'no-undef': 'off',
+      // Additional relaxed rules for legacy/internal scripts
+      'no-useless-catch': 'off',
+      'unicorn/prefer-number-properties': 'off',
+      'no-unreachable': 'off',
+    },
+  },
+
+  // ESLint config file should not be checked for publish-related Node rules
+  {
+    files: ['eslint.config.mjs'],
+    rules: {
+      'n/no-unpublished-import': 'off',
+    },
+  },
+
+  // YAML workflow templates allow empty mapping values intentionally
+  {
+    files: ['bmad-core/workflows/**/*.yaml'],
+    rules: {
+      'yml/no-empty-mapping-value': 'off',
+    },
+  },
+
+  // GitHub workflow files in this repo may use empty mapping values
+  {
+    files: ['.github/workflows/**/*.yaml'],
+    rules: {
+      'yml/no-empty-mapping-value': 'off',
+    },
+  },
+
+  // Other GitHub YAML files may intentionally use empty values and reserved filenames
+  {
+    files: ['.github/**/*.yaml'],
+    rules: {
+      'yml/no-empty-mapping-value': 'off',
+      'unicorn/filename-case': 'off',
+    },
+  },
+];

package/expansion-packs/bmad-2d-phaser-game-dev/agents/game-developer.md

@@ -60,10 +60,10 @@ commands:
 task-execution:
   flow: Read story → Implement game feature → Write tests → Pass tests → Update [x] → Next task
   updates-ONLY:
-    - "Checkboxes: [ ] not started | [-] in progress | [x] complete"
-    - "Debug Log: | Task | File | Change | Reverted? |"
-    - "Completion Notes: Deviations only, <50 words"
-    - "Change Log: Requirement changes only"
+    - 'Checkboxes: [ ] not started | [-] in progress | [x] complete'
+    - 'Debug Log: | Task | File | Change | Reverted? |'
+    - 'Completion Notes: Deviations only, <50 words'
+    - 'Change Log: Requirement changes only'
   blocking: Unapproved deps | Ambiguous after story check | 3 failures | Missing game config
   done: Game feature works + Tests pass + 60 FPS + No lint errors + Follows Phaser 3 best practices
 dependencies:

package/expansion-packs/bmad-2d-phaser-game-dev/agents/game-sm.md

@@ -27,7 +27,7 @@ activation-instructions:
   - When listing tasks/templates or presenting options during conversations, always show as numbered options list, allowing the user to type a number to select or execute
   - STAY IN CHARACTER!
   - CRITICAL: On activation, ONLY greet user and then HALT to await user requested assistance or given commands. ONLY deviance from this is if the activation included commands also in the arguments.
-  - "CRITICAL RULE: You are ONLY allowed to create/modify story files - NEVER implement! If asked to implement, tell user they MUST switch to Game Developer Agent"
+  - 'CRITICAL RULE: You are ONLY allowed to create/modify story files - NEVER implement! If asked to implement, tell user they MUST switch to Game Developer Agent'
 agent:
   name: Jordan
   id: game-sm

package/expansion-packs/bmad-2d-phaser-game-dev/config.yaml

@@ -1,5 +1,5 @@
 name: bmad-2d-phaser-game-dev
-version: 1.12.0
+version: 1.13.0
 short-title: Phaser 3 2D Game Dev Pack
 description: >-
   2D Game Development expansion pack for BMad Method - Phaser 3 & TypeScript

package/expansion-packs/bmad-2d-phaser-game-dev/data/development-guidelines.md

@@ -73,7 +73,7 @@ interface GameState {
 interface GameSettings {
   musicVolume: number;
   sfxVolume: number;
-  difficulty: "easy" | "normal" | "hard";
+  difficulty: 'easy' | 'normal' | 'hard';
   controls: ControlScheme;
 }
 ```
@@ -114,12 +114,12 @@ class GameScene extends Phaser.Scene {
   private inputManager!: InputManager;
 
   constructor() {
-    super({ key: "GameScene" });
+    super({ key: 'GameScene' });
   }
 
   preload(): void {
     // Load only scene-specific assets
-    this.load.image("player", "assets/player.png");
+    this.load.image('player', 'assets/player.png');
   }
 
   create(data: SceneData): void {
@@ -144,7 +144,7 @@ class GameScene extends Phaser.Scene {
     this.inputManager.destroy();
 
     // Remove event listeners
-    this.events.off("*");
+    this.events.off('*');
   }
 }
 ```
@@ -153,13 +153,13 @@ class GameScene extends Phaser.Scene {
 
 ```typescript
 // Proper scene transitions with data
-this.scene.start("NextScene", {
+this.scene.start('NextScene', {
   playerScore: this.playerScore,
   currentLevel: this.currentLevel + 1,
 });
 
 // Scene overlays for UI
-this.scene.launch("PauseMenuScene");
+this.scene.launch('PauseMenuScene');
 this.scene.pause();
 ```
 
@@ -203,7 +203,7 @@ class Player extends GameEntity {
   private health!: HealthComponent;
 
   constructor(scene: Phaser.Scene, x: number, y: number) {
-    super(scene, x, y, "player");
+    super(scene, x, y, 'player');
 
     this.movement = this.addComponent(new MovementComponent(this));
     this.health = this.addComponent(new HealthComponent(this, 100));
@@ -223,7 +223,7 @@ class GameManager {
 
   constructor(scene: Phaser.Scene) {
     if (GameManager.instance) {
-      throw new Error("GameManager already exists!");
+      throw new Error('GameManager already exists!');
     }
 
     this.scene = scene;
@@ -233,7 +233,7 @@ class GameManager {
 
   static getInstance(): GameManager {
     if (!GameManager.instance) {
-      throw new Error("GameManager not initialized!");
+      throw new Error('GameManager not initialized!');
     }
     return GameManager.instance;
   }
@@ -280,7 +280,7 @@ class BulletPool {
     }
 
     // Pool exhausted - create new bullet
-    console.warn("Bullet pool exhausted, creating new bullet");
+    console.warn('Bullet pool exhausted, creating new bullet');
     return new Bullet(this.scene, 0, 0);
   }
 
@@ -380,14 +380,12 @@ class InputManager {
   }
 
   private setupKeyboard(): void {
-    this.keys = this.scene.input.keyboard.addKeys(
-      "W,A,S,D,SPACE,ESC,UP,DOWN,LEFT,RIGHT",
-    );
+    this.keys = this.scene.input.keyboard.addKeys('W,A,S,D,SPACE,ESC,UP,DOWN,LEFT,RIGHT');
   }
 
   private setupTouch(): void {
-    this.scene.input.on("pointerdown", this.handlePointerDown, this);
-    this.scene.input.on("pointerup", this.handlePointerUp, this);
+    this.scene.input.on('pointerdown', this.handlePointerDown, this);
+    this.scene.input.on('pointerup', this.handlePointerUp, this);
   }
 
   update(): void {
@@ -414,9 +412,9 @@ class InputManager {
 class AssetManager {
   loadAssets(): Promise<void> {
     return new Promise((resolve, reject) => {
-      this.scene.load.on("filecomplete", this.handleFileComplete, this);
-      this.scene.load.on("loaderror", this.handleLoadError, this);
-      this.scene.load.on("complete", () => resolve());
+      this.scene.load.on('filecomplete', this.handleFileComplete, this);
+      this.scene.load.on('loaderror', this.handleLoadError, this);
+      this.scene.load.on('complete', () => resolve());
 
       this.scene.load.start();
     });
@@ -432,8 +430,8 @@ class AssetManager {
   private loadFallbackAsset(key: string): void {
     // Load placeholder or default assets
     switch (key) {
-      case "player":
-        this.scene.load.image("player", "assets/defaults/default-player.png");
+      case 'player':
+        this.scene.load.image('player', 'assets/defaults/default-player.png');
         break;
       default:
         console.warn(`No fallback for asset: ${key}`);
@@ -460,11 +458,11 @@ class GameSystem {
 
   private attemptRecovery(context: string): void {
     switch (context) {
-      case "update":
+      case 'update':
         // Reset system state
         this.reset();
         break;
-      case "render":
+      case 'render':
         // Disable visual effects
         this.disableEffects();
         break;
@@ -484,7 +482,7 @@ class GameSystem {
 
 ```typescript
 // Example test for game mechanics
-describe("HealthComponent", () => {
+describe('HealthComponent', () => {
   let healthComponent: HealthComponent;
 
   beforeEach(() => {
@@ -492,18 +490,18 @@ describe("HealthComponent", () => {
     healthComponent = new HealthComponent(mockEntity, 100);
   });
 
-  test("should initialize with correct health", () => {
+  test('should initialize with correct health', () => {
     expect(healthComponent.currentHealth).toBe(100);
     expect(healthComponent.maxHealth).toBe(100);
   });
 
-  test("should handle damage correctly", () => {
+  test('should handle damage correctly', () => {
     healthComponent.takeDamage(25);
     expect(healthComponent.currentHealth).toBe(75);
     expect(healthComponent.isAlive()).toBe(true);
   });
 
-  test("should handle death correctly", () => {
+  test('should handle death correctly', () => {
     healthComponent.takeDamage(150);
     expect(healthComponent.currentHealth).toBe(0);
     expect(healthComponent.isAlive()).toBe(false);
@@ -516,7 +514,7 @@ describe("HealthComponent", () => {
 **Scene Testing:**
 
 ```typescript
-describe("GameScene Integration", () => {
+describe('GameScene Integration', () => {
   let scene: GameScene;
   let mockGame: Phaser.Game;
 
@@ -526,7 +524,7 @@ describe("GameScene Integration", () => {
     scene = new GameScene();
   });
 
-  test("should initialize all systems", () => {
+  test('should initialize all systems', () => {
     scene.create({});
 
     expect(scene.gameManager).toBeDefined();

package/expansion-packs/bmad-2d-phaser-game-dev/templates/game-architecture-tmpl.yaml

@@ -14,7 +14,7 @@ sections:
   - id: initial-setup
     instruction: |
       This template creates a comprehensive game architecture document specifically for Phaser 3 + TypeScript projects. This should provide the technical foundation for all game development stories and epics.
-      
+
       If available, review any provided documents: Game Design Document (GDD), Technical Preferences. This architecture should support all game mechanics defined in the GDD.
 
   - id: introduction
@@ -22,7 +22,7 @@ sections:
     instruction: Establish the document's purpose and scope for game development
     content: |
       This document outlines the complete technical architecture for {{game_title}}, a 2D game built with Phaser 3 and TypeScript. It serves as the technical foundation for AI-driven game development, ensuring consistency and scalability across all game systems.
-      
+
       This architecture is designed to support the gameplay mechanics defined in the Game Design Document while maintaining 60 FPS performance and cross-platform compatibility.
     sections:
       - id: change-log
@@ -41,7 +41,7 @@ sections:
         title: Architecture Summary
         instruction: |
           Provide a comprehensive overview covering:
-          
+
           - Game engine choice and configuration
           - Project structure and organization
           - Key systems and their interactions
@@ -129,23 +129,23 @@ sections:
         title: Scene Management System
         template: |
           **Purpose:** Handle game flow and scene transitions
-          
+
           **Key Components:**
-          
+
           - Scene loading and unloading
           - Data passing between scenes
           - Transition effects
           - Memory management
-          
+
           **Implementation Requirements:**
-          
+
           - Preload scene for asset loading
           - Menu system with navigation
           - Gameplay scenes with state management
           - Pause/resume functionality
-          
+
           **Files to Create:**
-          
+
           - `src/scenes/BootScene.ts`
           - `src/scenes/PreloadScene.ts`
           - `src/scenes/MenuScene.ts`
@@ -155,23 +155,23 @@ sections:
         title: Game State Management
         template: |
           **Purpose:** Track player progress and game status
-          
+
           **State Categories:**
-          
+
           - Player progress (levels, unlocks)
           - Game settings (audio, controls)
           - Session data (current level, score)
           - Persistent data (achievements, statistics)
-          
+
           **Implementation Requirements:**
-          
+
           - Save/load system with localStorage
           - State validation and error recovery
           - Cross-session data persistence
           - Settings management
-          
+
           **Files to Create:**
-          
+
           - `src/systems/GameState.ts`
           - `src/systems/SaveManager.ts`
           - `src/types/GameData.ts`
@@ -179,23 +179,23 @@ sections:
         title: Asset Management System
         template: |
           **Purpose:** Efficient loading and management of game assets
-          
+
           **Asset Categories:**
-          
+
           - Sprite sheets and animations
           - Audio files and music
           - Level data and configurations
           - UI assets and fonts
-          
+
           **Implementation Requirements:**
-          
+
           - Progressive loading strategy
           - Asset caching and optimization
           - Error handling for failed loads
           - Memory management for large assets
-          
+
           **Files to Create:**
-          
+
           - `src/systems/AssetManager.ts`
           - `src/config/AssetConfig.ts`
           - `src/utils/AssetLoader.ts`
@@ -203,23 +203,23 @@ sections:
         title: Input Management System
         template: |
           **Purpose:** Handle all player input across platforms
-          
+
           **Input Types:**
-          
+
           - Keyboard controls
           - Mouse/pointer interaction
           - Touch gestures (mobile)
           - Gamepad support (optional)
-          
+
           **Implementation Requirements:**
-          
+
           - Input mapping and configuration
           - Touch-friendly mobile controls
           - Input buffering for responsive gameplay
           - Customizable control schemes
-          
+
           **Files to Create:**
-          
+
           - `src/systems/InputManager.ts`
           - `src/utils/TouchControls.ts`
           - `src/types/InputTypes.ts`
@@ -232,19 +232,19 @@ sections:
             title: "{{mechanic_name}} System"
             template: |
               **Purpose:** {{system_purpose}}
-              
+
               **Core Functionality:**
-              
+
               - {{feature_1}}
               - {{feature_2}}
               - {{feature_3}}
-              
+
               **Dependencies:** {{required_systems}}
-              
+
               **Performance Considerations:** {{optimization_notes}}
-              
+
               **Files to Create:**
-              
+
               - `src/systems/{{system_name}}.ts`
               - `src/gameObjects/{{related_object}}.ts`
               - `src/types/{{system_types}}.ts`
@@ -252,65 +252,65 @@ sections:
         title: Physics & Collision System
         template: |
           **Physics Engine:** {{physics_choice}} (Arcade Physics/Matter.js)
-          
+
           **Collision Categories:**
-          
+
           - Player collision
           - Enemy interactions
           - Environmental objects
           - Collectibles and items
-          
+
           **Implementation Requirements:**
-          
+
           - Optimized collision detection
           - Physics body management
           - Collision callbacks and events
           - Performance monitoring
-          
+
           **Files to Create:**
-          
+
           - `src/systems/PhysicsManager.ts`
           - `src/utils/CollisionGroups.ts`
       - id: audio-system
         title: Audio System
         template: |
           **Audio Requirements:**
-          
+
           - Background music with looping
           - Sound effects for actions
           - Audio settings and volume control
           - Mobile audio optimization
-          
+
           **Implementation Features:**
-          
+
           - Audio sprite management
           - Dynamic music system
           - Spatial audio (if applicable)
           - Audio pooling for performance
-          
+
           **Files to Create:**
-          
+
           - `src/systems/AudioManager.ts`
           - `src/config/AudioConfig.ts`
       - id: ui-system
         title: UI System
         template: |
           **UI Components:**
-          
+
           - HUD elements (score, health, etc.)
           - Menu navigation
           - Modal dialogs
           - Settings screens
-          
+
           **Implementation Requirements:**
-          
+
           - Responsive layout system
           - Touch-friendly interface
           - Keyboard navigation support
           - Animation and transitions
-          
+
           **Files to Create:**
-          
+
           - `src/systems/UIManager.ts`
           - `src/gameObjects/UI/`
           - `src/types/UITypes.ts`
@@ -610,4 +610,4 @@ sections:
           - 90%+ test coverage on game logic
           - Zero TypeScript errors in strict mode
           - Consistent adherence to coding standards
-          - Comprehensive documentation coverage
+          - Comprehensive documentation coverage