How rust-lang/rustfmt works
rustfmt is a Rust source formatter. The main workflow accepts files or stdin, loads formatting configuration, parses Rust into compiler AST structures, rewrites code to fit configured style, then emits formatted output or diffs for check mode. The README also documents cargo fmt as a project/workspace entry point and configurable style editions. Internal links are limited to relationships named in the source index or README; several implementation stages are represented at subsystem level because their source was not sampled.
Main entry points: lib.rs Formatter library · visitor.rs AST visitor · mod.rs Style configuration · rewrite.rs Rewrite context
Components 19
Entry points
- rustfmt CLI
src/bin/main.rs - cargo fmt
src/cargo-fmt/main.rs
Parsing and source
- Rust parser
src/parse/parser.rs - Parse session
src/parse/session.rs - Macro parsing
src/parse/macros/mod.rs - Module discovery
src/modules.rs
Formatting engine
- Formatter library
src/lib.rs - AST visitor
src/visitor.rs - Item formatting
src/items.rs - Expression formatting
src/expr.rs - Rewrite context
src/rewrite.rs - Comment formatting
src/comment.rs - Layout and width
src/shape.rs
Configuration and output
- Style configuration
src/config/mod.rs - Config options
src/config/options.rs - File line ranges
src/config/file_lines.rs - Output emitters
src/emitter.rs - Diff generation
src/rustfmt_diff.rs
Other components
- Developer
Connections 21
- Developer → rustfmt CLI: runs formatter
README.md - Developer → cargo fmt: formats project
README.md - rustfmt CLI → Formatter library: formats source
README.md - cargo fmt → Formatter library: formats targets
README.md - Formatter library → Style configuration: loads settings
src/lib.rs - Style configuration → Config options: uses options
src/config/mod.rs - Style configuration → File line ranges: uses line ranges
src/config/mod.rs - Formatter library → Rust parser: parses input
src/lib.rs - Rust parser → Parse session: uses session
src/parse/parser.rs - Formatter library → AST visitor: visits AST
src/lib.rs - AST visitor → Item formatting: formats items
- AST visitor → Expression formatting: formats expressions
- AST visitor → Module discovery: discovers modules
- Item formatting → Rewrite context: uses rewrite context
- Expression formatting → Rewrite context: uses rewrite context
- Rewrite context → Layout and width: uses width rules
src/rewrite.rs - Formatter library → Comment formatting: formats comments
src/lib.rs - Formatter library → Output emitters: emits output
src/lib.rs - Formatter library → Diff generation: builds diffs
src/lib.rs - Diff generation → Style configuration: reads settings
src/rustfmt_diff.rs - Macro parsing → Parse session: uses session
src/parse/macros/mod.rs