How clj-commons/pretty works
Main Components
a. Core Formatting Modules:
• Exception Formatting Module
• Binary Data Formatting Module
• Table Formatting Module
• Pretty REPL Module
b. Supporting Components:
• Specs/Validation Layer
• Implementation Details
• Test Framework
┌─ API Layer ─────────────────────────────────┐
• Public Interface (clj-commons.*) │
• Core Formatting Modules ──────────────────┤
• ┌─────────┐ ┌──────────┐ ┌────────────┐ │
• ANSI │ │Exception │ │ Binary │ │
• Support │ │Formatting│ │ Formatting │ │
• ┘ └──────────┘ └────────────┘ │
• ┌─────────┐ ┌──────────┐ │
• Table │ │ Pretty │ │
• Formatter│ │ REPL │ │
• ┘ └──────────┘ │
• Support Layer ───────────────────────────┤
• ┌─────────┐ ┌──────────┐ │
• Specs │ │ Core │ │
• Impl │ │
• ┘ └──────────┘ │
• ┘
Key Relationships to Highlight
• How the public API interfaces with each formatting module
• Dependency on the specs layer for validation
• Relationship between the implementation and the public interfaces
Implementation Details
• Related functionality (e.g., format/*, pretty/*)
• How the specs (specs.clj) relate to their respective modules
• Test coverage for each component