# rust-lang/rustfmt architecture

> Architecture diagram of the GitHub repository rust-lang/rustfmt, generated by GitDiagram from its file tree, README and a sample of source files (last updated 2026-10-02). It is an AI-made overview: check details against the source.

- Interactive diagram: https://gitdiagram.com/rust-lang/rustfmt
- Repository: https://github.com/rust-lang/rustfmt

## Overview

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: [`src/lib.rs`](https://github.com/rust-lang/rustfmt/blob/main/src/lib.rs) (Formatter library), [`src/visitor.rs`](https://github.com/rust-lang/rustfmt/blob/main/src/visitor.rs) (AST visitor), [`src/config/mod.rs`](https://github.com/rust-lang/rustfmt/blob/main/src/config/mod.rs) (Style configuration), [`src/rewrite.rs`](https://github.com/rust-lang/rustfmt/blob/main/src/rewrite.rs) (Rewrite context)

## Diagram (Mermaid)

```mermaid
flowchart TD

subgraph group_entry["Entry points"]
  node_rustfmt_cli["rustfmt CLI<br/>[main.rs]"]
  node_cargo_fmt["cargo fmt<br/>[main.rs]"]
end

subgraph group_parse["Parsing and source"]
  node_parser["Rust parser<br/>[parser.rs]"]
  node_parse_session["Parse session<br/>[session.rs]"]
  node_macro_parser["Macro parsing<br/>[mod.rs]"]
  node_module_parser["Module discovery<br/>[modules.rs]"]
end

subgraph group_format["Formatting engine"]
  node_formatter["Formatter library<br/>[lib.rs]"]
  node_ast_visitor["AST visitor<br/>[visitor.rs]"]
  node_item_rewrite["Item formatting<br/>[items.rs]"]
  node_expression_rewrite["Expression formatting<br/>[expr.rs]"]
  node_rewrite["Rewrite context<br/>[rewrite.rs]"]
  node_comment_format["Comment formatting<br/>[comment.rs]"]
  node_layout["Layout and width<br/>[shape.rs]"]
end

subgraph group_output["Configuration and output"]
  node_config["Style configuration<br/>[mod.rs]"]
  node_config_options["Config options<br/>[options.rs]"]
  node_file_ranges["File line ranges<br/>[file_lines.rs]"]
  node_emitter["Output emitters<br/>[emitter.rs]"]
  node_diff["Diff generation<br/>[rustfmt_diff.rs]"]
end

node_user(("Developer"))

node_user -->|"runs formatter"| node_rustfmt_cli
node_user -->|"formats project"| node_cargo_fmt
node_rustfmt_cli -->|"formats source"| node_formatter
node_cargo_fmt -->|"formats targets"| node_formatter
node_formatter -->|"loads settings"| node_config
node_config -->|"uses options"| node_config_options
node_config -->|"uses line ranges"| node_file_ranges
node_formatter -->|"parses input"| node_parser
node_parser -->|"uses session"| node_parse_session
node_formatter -->|"visits AST"| node_ast_visitor
node_ast_visitor -.->|"formats items"| node_item_rewrite
node_ast_visitor -.->|"formats expressions"| node_expression_rewrite
node_ast_visitor -.->|"discovers modules"| node_module_parser
node_item_rewrite -.->|"uses rewrite context"| node_rewrite
node_expression_rewrite -.->|"uses rewrite context"| node_rewrite
node_rewrite -->|"uses width rules"| node_layout
node_formatter -->|"formats comments"| node_comment_format
node_formatter -->|"emits output"| node_emitter
node_formatter -->|"builds diffs"| node_diff
node_diff -->|"reads settings"| node_config
node_macro_parser -->|"uses session"| node_parse_session

click node_rustfmt_cli "https://github.com/rust-lang/rustfmt/blob/main/src/bin/main.rs"
click node_cargo_fmt "https://github.com/rust-lang/rustfmt/blob/main/src/cargo-fmt/main.rs"
click node_formatter "https://github.com/rust-lang/rustfmt/blob/main/src/lib.rs"
click node_config "https://github.com/rust-lang/rustfmt/blob/main/src/config/mod.rs"
click node_config_options "https://github.com/rust-lang/rustfmt/blob/main/src/config/options.rs"
click node_file_ranges "https://github.com/rust-lang/rustfmt/blob/main/src/config/file_lines.rs"
click node_parser "https://github.com/rust-lang/rustfmt/blob/main/src/parse/parser.rs"
click node_parse_session "https://github.com/rust-lang/rustfmt/blob/main/src/parse/session.rs"
click node_macro_parser "https://github.com/rust-lang/rustfmt/blob/main/src/parse/macros/mod.rs"
click node_module_parser "https://github.com/rust-lang/rustfmt/blob/main/src/modules.rs"
click node_ast_visitor "https://github.com/rust-lang/rustfmt/blob/main/src/visitor.rs"
click node_item_rewrite "https://github.com/rust-lang/rustfmt/blob/main/src/items.rs"
click node_expression_rewrite "https://github.com/rust-lang/rustfmt/blob/main/src/expr.rs"
click node_rewrite "https://github.com/rust-lang/rustfmt/blob/main/src/rewrite.rs"
click node_comment_format "https://github.com/rust-lang/rustfmt/blob/main/src/comment.rs"
click node_layout "https://github.com/rust-lang/rustfmt/blob/main/src/shape.rs"
click node_emitter "https://github.com/rust-lang/rustfmt/blob/main/src/emitter.rs"
click node_diff "https://github.com/rust-lang/rustfmt/blob/main/src/rustfmt_diff.rs"

classDef toneNeutral fill:#f8fafc,stroke:#334155,stroke-width:1.5px,color:#0f172a
classDef toneBlue fill:#dbeafe,stroke:#2563eb,stroke-width:1.5px,color:#172554
classDef toneAmber fill:#fef3c7,stroke:#d97706,stroke-width:1.5px,color:#78350f
classDef toneMint fill:#dcfce7,stroke:#16a34a,stroke-width:1.5px,color:#14532d
classDef toneRose fill:#ffe4e6,stroke:#e11d48,stroke-width:1.5px,color:#881337
classDef toneIndigo fill:#e0e7ff,stroke:#4f46e5,stroke-width:1.5px,color:#312e81
classDef toneTeal fill:#ccfbf1,stroke:#0f766e,stroke-width:1.5px,color:#134e4a
class node_rustfmt_cli,node_cargo_fmt toneBlue
class node_parser,node_parse_session,node_macro_parser,node_module_parser toneAmber
class node_formatter,node_ast_visitor,node_item_rewrite,node_expression_rewrite,node_rewrite,node_comment_format,node_layout toneMint
class node_config,node_config_options,node_file_ranges,node_emitter,node_diff toneRose
class node_user toneIndigo
```

## Components

### Entry points

- [rustfmt CLI](https://github.com/rust-lang/rustfmt/blob/main/src/bin/main.rs): `src/bin/main.rs`
- [cargo fmt](https://github.com/rust-lang/rustfmt/blob/main/src/cargo-fmt/main.rs): `src/cargo-fmt/main.rs`

### Parsing and source

- [Rust parser](https://github.com/rust-lang/rustfmt/blob/main/src/parse/parser.rs): `src/parse/parser.rs`
- [Parse session](https://github.com/rust-lang/rustfmt/blob/main/src/parse/session.rs): `src/parse/session.rs`
- [Macro parsing](https://github.com/rust-lang/rustfmt/blob/main/src/parse/macros/mod.rs): `src/parse/macros/mod.rs`
- [Module discovery](https://github.com/rust-lang/rustfmt/blob/main/src/modules.rs): `src/modules.rs`

### Formatting engine

- [Formatter library](https://github.com/rust-lang/rustfmt/blob/main/src/lib.rs): `src/lib.rs`
- [AST visitor](https://github.com/rust-lang/rustfmt/blob/main/src/visitor.rs): `src/visitor.rs`
- [Item formatting](https://github.com/rust-lang/rustfmt/blob/main/src/items.rs): `src/items.rs`
- [Expression formatting](https://github.com/rust-lang/rustfmt/blob/main/src/expr.rs): `src/expr.rs`
- [Rewrite context](https://github.com/rust-lang/rustfmt/blob/main/src/rewrite.rs): `src/rewrite.rs`
- [Comment formatting](https://github.com/rust-lang/rustfmt/blob/main/src/comment.rs): `src/comment.rs`
- [Layout and width](https://github.com/rust-lang/rustfmt/blob/main/src/shape.rs): `src/shape.rs`

### Configuration and output

- [Style configuration](https://github.com/rust-lang/rustfmt/blob/main/src/config/mod.rs): `src/config/mod.rs`
- [Config options](https://github.com/rust-lang/rustfmt/blob/main/src/config/options.rs): `src/config/options.rs`
- [File line ranges](https://github.com/rust-lang/rustfmt/blob/main/src/config/file_lines.rs): `src/config/file_lines.rs`
- [Output emitters](https://github.com/rust-lang/rustfmt/blob/main/src/emitter.rs): `src/emitter.rs`
- [Diff generation](https://github.com/rust-lang/rustfmt/blob/main/src/rustfmt_diff.rs): `src/rustfmt_diff.rs`

### Other components

- **Developer**

## Connections

- Developer → rustfmt CLI: runs formatter (evidence: `README.md`)
- Developer → cargo fmt: formats project (evidence: `README.md`)
- rustfmt CLI → Formatter library: formats source (evidence: `README.md`)
- cargo fmt → Formatter library: formats targets (evidence: `README.md`)
- Formatter library → Style configuration: loads settings (evidence: `src/lib.rs`)
- Style configuration → Config options: uses options (evidence: `src/config/mod.rs`)
- Style configuration → File line ranges: uses line ranges (evidence: `src/config/mod.rs`)
- Formatter library → Rust parser: parses input (evidence: `src/lib.rs`)
- Rust parser → Parse session: uses session (evidence: `src/parse/parser.rs`)
- Formatter library → AST visitor: visits AST (evidence: `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 (evidence: `src/rewrite.rs`)
- Formatter library → Comment formatting: formats comments (evidence: `src/lib.rs`)
- Formatter library → Output emitters: emits output (evidence: `src/lib.rs`)
- Formatter library → Diff generation: builds diffs (evidence: `src/lib.rs`)
- Diff generation → Style configuration: reads settings (evidence: `src/rustfmt_diff.rs`)
- Macro parsing → Parse session: uses session (evidence: `src/parse/macros/mod.rs`)
