Skip to main content

scripts-fix-mermaid-diagrams

#!/usr/bin/env python3 """​

title: "Fix Mermaid Diagrams" component_type: script version: "1.0.0" audience: contributor status: stable summary: "CODITECT Mermaid Diagram Fixer ==============================" keywords: ['diagrams', 'fix', 'generation', 'git', 'mermaid'] tokens: ~500 created: 2025-12-22 updated: 2025-12-22 script_name: "fix-mermaid-diagrams.py" language: python executable: true usage: "python3 scripts/fix-mermaid-diagrams.py [options]" python_version: "3.10+" dependencies: [] modifies_files: false network_access: false requires_auth: false​

CODITECT Mermaid Diagram Fixer

STATUS: STUB - Not yet implemented VERSION: 0.1.0 (placeholder) AUTHOR: CODITECT Core Team

DESCRIPTION: Automated fixer for Mermaid diagram syntax issues, ensuring GitHub compatibility. Applies idempotent fixes for common syntax problems that prevent diagrams from rendering correctly.

PURPOSE: - Fix Mermaid syntax errors for GitHub compatibility - Apply idempotent transformations (safe to run multiple times) - Validate diagrams after fixing - Generate fix reports

EXPECTED INPUTS: --paths : Markdown files or directories to process --dry-run : Preview fixes without applying --backup : Create backups before fixing --validate : Validate diagrams after fixing --output : Fix report output

COMMON FIXES: - Entity names with special characters - Unescaped brackets in labels - Missing semicolons - Invalid arrow syntax - Subgraph naming issues - Direction declaration placement

EXPECTED OUTPUTS: - Fixed markdown files - mermaid-fix-report.json with fixes applied

IMPLEMENTATION REQUIREMENTS: 1. Mermaid code block extraction 2. Syntax pattern detection 3. Idempotent fix application 4. Backup management 5. Validation integration 6. Report generation

USAGE EXAMPLES: python scripts/fix-mermaid-diagrams.py --paths docs/ python scripts/fix-mermaid-diagrams.py --dry-run --paths *.md python scripts/fix-mermaid-diagrams.py --backup --validate

SEE ALSO: - commands/fix-mermaid-diagrams.md - skills/mermaid-diagram-fixing/SKILL.md """

import argparse import json import sys

def main(): parser = argparse.ArgumentParser( description='Mermaid Diagram Fixer', epilog='Status: STUB - Implementation required' ) parser.add_argument('--paths', nargs='*', default=['.']) parser.add_argument('--dry-run', action='store_true') parser.add_argument('--backup', action='store_true') parser.add_argument('--validate', action='store_true') parser.add_argument('--output', default='mermaid-fix-report.json')

args = parser.parse_args()

print("CODITECT FIX-MERMAID-DIAGRAMS - STUB")
print(f"Paths: {args.paths}, Dry-run: {args.dry_run}")

stub = {"status": "stub", "fixes_applied": 0, "message": "Not implemented"}
with open(args.output, 'w') as f:
    json.dump(stub, f, indent=2)

return 0

if name == 'main': sys.exit(main())