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/830/ARCHIVED-FILES.md

161 lines
6.6 KiB
Markdown
Raw Blame History

# PR-830 Archived Files
This directory contains all code files added or modified as part of PR-830 work, preserving the original directory structure.
## Archive Date
October 29, 2025
## Purpose
Maintain a complete snapshot of all changes for PR-830: CommonMark-compliant Markdown formatting rules.
## Directory Structure
```text
.patch/830/
├── .github/
│ └── workflows/
│ └── markdown-conformance.yml # NEW: CI workflow for markdown checks
├── docs/
│ ├── bmad-brownfield-guide.md # MODIFIED: Added fence languages
│ ├── conversion-report-shard-doc-2025-10-26.md # MODIFIED: Added fence languages
│ ├── v4-to-v6-upgrade.md # MODIFIED: Added fence languages
│ ├── ide-info/
│ │ ├── auggie.md # MODIFIED: Added fence languages, blank lines
│ │ ├── claude-code.md # MODIFIED: Added fence languages, blank lines
│ │ ├── cline.md # MODIFIED: Added fence languages, blank lines
│ │ ├── codex.md # MODIFIED: Added fence languages
│ │ ├── crush.md # MODIFIED: Added fence languages
│ │ ├── cursor.md # MODIFIED: Added fence languages, blank lines
│ │ ├── gemini.md # MODIFIED: Added fence languages
│ │ ├── iflow.md # MODIFIED: Added fence languages
│ │ ├── opencode.md # MODIFIED: Added fence languages
│ │ ├── qwen.md # MODIFIED: Added fence languages
│ │ └── trae.md # MODIFIED: Added fence languages
│ └── installers-bundlers/
│ ├── ide-injections.md # MODIFIED: Added fence languages
│ ├── installers-modules-platforms-reference.md # MODIFIED: Added fence languages, spacing
│ └── web-bundler-usage.md # MODIFIED: Added fence languages
├── tools/
│ └── markdown/
│ ├── check-md-conformance.js # NEW: Conformance checker
│ ├── fix-fence-languages.js # NEW: Automated fence language fixer
│ └── README.md # NEW: Documentation for markdown tools
├── package.json # MODIFIED: Added check:md:* and lint:md scripts
├── .markdownlint.json # NEW: Markdownlint configuration
├── markdownlint-rules/
│ └── table-blank-lines.js # NEW: Custom markdownlint rule
├── markdownlint-README.md # NEW: How to use markdownlint config
├── fix-approach.md # NEW: Comprehensive fix methodology
├── integration-plan.md # NEW: CI/tooling integration plan
├── markdownlint-comparison.md # NEW: Comparison of tools
├── plan.md # NEW: Implementation plan
├── todo.md # NEW: Task tracking
├── PR-830-Summary.md # NEW: PR summary from GitHub
├── PR-830-conversation.md # NEW: PR conversation from GitHub
└── test-logs/ # Directory with test outputs
├── docs-baseline.txt
├── bmad-baseline.txt
├── src-baseline.txt
├── brownfield-dry-run.txt
├── conversion-dry-run.txt
└── docs-after-fixes.txt
```
## Summary of Changes
### New Files Created (8)
1. `.github/workflows/markdown-conformance.yml` - GitHub Actions CI workflow
2. `tools/markdown/check-md-conformance.js` - Conformance checker script
3. `tools/markdown/fix-fence-languages.js` - Automated fixer with dry-run mode
4. `tools/markdown/README.md` - Tool documentation
5. `.patch/830/.markdownlint.json` - Markdownlint configuration
6. `.patch/830/markdownlint-rules/table-blank-lines.js` - Custom rule
7. `.patch/830/markdownlint-README.md` - Usage instructions
8. `.patch/830/fix-approach.md` - Complete methodology documentation
### Modified Files (19)
#### Configuration
- `package.json` - Added 5 markdown check/lint scripts
#### Documentation (18 files)
- Fixed **28 code fences** lacking language identifiers
- Fixed **1 spacing violation** (blank line before fence)
- All docs now conform to PR-830 rules (0 violations)
**Files:**
- docs/bmad-brownfield-guide.md (8 fences)
- docs/conversion-report-shard-doc-2025-10-26.md (2 fences)
- docs/v4-to-v6-upgrade.md (4 fences)
- docs/ide-info/*.md (11 files, varied fixes)
- docs/installers-bundlers/*.md (3 files, 8 fences + spacing)
## Test Results
### Before Fixes
- **docs/**: 219 violations in 21 files
- **bmad/**: 1094 violations in 59 files
- **src/**: 4729 violations in 239 files
### After Fixes
- **docs/**: 0 violations (PASS) ✅
- **bmad/**: Not yet remediated (future work)
- **src/**: Not yet remediated (future work)
## Tools Created
### 1. check-md-conformance.js
- Zero dependencies
- Detects: fence languages, blank lines, bullet markers
- CI-friendly exit codes
- Fast execution
### 2. fix-fence-languages.js
- Dry-run capability
- Content-based language detection
- Supports: yaml, json, bash, javascript, xml, markdown, text
- Detailed fix preview
### 3. GitHub Actions Workflow
- Runs on PR to main/v6-alpha
- Required check: `check:md:all`
- Optional: markdownlint
- Prevents regressions
## NPM Scripts Added
```json
{
"check:md:all": "node tools/markdown/check-md-conformance.js docs bmad src",
"check:md:docs": "node tools/markdown/check-md-conformance.js docs",
"check:md:bmad": "node tools/markdown/check-md-conformance.js bmad",
"check:md:src": "node tools/markdown/check-md-conformance.js src",
"lint:md": "markdownlint --config .patch/830/.markdownlint.json --rules .patch/830/markdownlint-rules/table-blank-lines.js docs bmad src"
}
```
## Integration Status
- ✅ Custom conformance checker operational
- ✅ Automated fixer with dry-run validated
- ✅ Markdownlint configured with custom rules
- ✅ NPM scripts integrated
- ✅ GitHub Actions CI workflow deployed
- ✅ All docs/ violations resolved
- ⏳ bmad/ remediation pending
- ⏳ src/ remediation pending
## References
- **PR #830**: https://github.com/bmad-code-org/BMAD-METHOD/pull/830
- **Related Work**: `.patch/483` (markdown formatting, CRLF issues)
- **Branch**: patch-830
- **Test Evidence**: `.patch/830/test-logs/*`
- **Documentation**: `.patch/830/fix-approach.md`
---
**Archive Complete:** October 29, 2025
**Status:** Ready for PR submission
**Next Steps:** Apply to bmad/ and src/ directories
View Git Blame Copy Permalink