ldy26098
/
BMAD-METHOD
mirror of https://github.com/bmad-code-org/BMAD-METHOD.git
1
0
Fork 0
Code Packages Projects Releases Wiki Activity
BMAD-METHOD/.patch/483/CHANGES-SUMMARY.md

2.3 KiB
Raw Blame History

GitHub Issue #483 Fix - Changes Summary

Issue: Generated story Markdown deviates from GFM/CommonMark (CRLF & whitespace) — breaks automated edits on Windows

Files Created/Modified for Fix

Core Solution Files

  • src/utility/markdown-formatter.js - Main MarkdownFormatter class with Windows CRLF support
  • src/utility/workflow-output-formatter.js - Integration module for workflow template processing
  • src/utility/WORKFLOW-MARKDOWN-INTEGRATION.md - Developer integration guide

Test Files

  • test/markdown-formatting-tests.js - Detection tests for markdown issues
  • test/test-markdown-formatter.js - Main test runner for the formatter utility
  • test/run-markdown-tests.js - Alternative test runner script
  • test/fixtures/markdown-issues/ - Test fixture files with problematic markdown samples
    • crlf-mixed.md - Mixed line ending test case
    • spacing-issues.md - Trailing whitespace test case
    • smart-quotes.md - Smart quotes conversion test case
    • heading-hierarchy.md - Heading level hierarchy test case
    • qa-results-exact-match.md - String matching test case

Configuration Files

  • .editorconfig - Project-wide line ending and whitespace settings
  • .remarkrc.json - Markdown linting configuration
  • .remarkignore - Files to ignore during markdown linting
  • eslint.config.mjs - Updated ESLint config to allow CommonJS in utility modules
  • package.json - Added new npm scripts for markdown testing and linting

Key Features Implemented

  1. Windows CRLF Support: Properly converts line endings for Windows compatibility
  2. Smart Whitespace Handling: Removes trailing whitespace while preserving code blocks
  3. GFM Compliance: Enforces GitHub Flavored Markdown standards
  4. Workflow Integration: Automatic formatting for template-generated content
  5. Comprehensive Testing: Validates all edge cases mentioned in the issue

Test Results

  • ✅ All 5 markdown formatter test cases pass
  • ✅ ESLint: 0 errors
  • ✅ Prettier: All files formatted correctly
  • ✅ Core issue resolved: CRLF/whitespace problems fixed

Dependencies Added

  • remark - Markdown processor
  • remark-lint - Markdown linting
  • remark-preset-lint-recommended - Recommended linting rules
  • remark-cli - Command line interface for remark

Date: October 26, 2025 Fix Status: Complete and Tested