Skip to content

Documentation

For users

Document Contents
Canonical Formatting Rules Normative formatter contract used for implementation, bug fixes, and behavior changes
Formatting Rules All formatting rules, the 7 configuration options, and examples of how each option affects output
Output Showcase Side-by-side comparison of balanced, wide, and narrow wrap styles, and closing-paren placement
Interactive Comparator Pick a Java version and two configs to compare formatted output side-by-side

For contributors

Document Contents
Architecture Package layout, coding conventions, module structure, and test strategy
Contributing Guide Commit conventions, build requirements, and PR checks
Decision Register Canonical log of architectural and product decisions with rationale
Showroom Scenarios How the 24 showroom golden files are structured across Java levels and scenarios
Evaluation Real-world evaluation harness: how to run it, latest results against Guava and Spring
Benchmarks Performance smoke tests and future JMH plans
Changelog Release history

Background

Informal product positioning, ecosystem comparisons, parser-choice rationale, and a research bibliography are archived as TDR-016 in the decision register.