# google/go-cmp architecture

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

- Interactive diagram: https://gitdiagram.com/google/go-cmp
- Repository: https://github.com/google/go-cmp

## Overview

go-cmp is a Go library for semantic equality and human-readable differences, intended as a safer, more configurable alternative to reflect.DeepEqual. Callers provide two values and optional comparison rules; the library compares recursively, then can render differences. Its documented capabilities include custom comparers, Equal methods, primitive-kind comparison, and options for ignoring unexported fields. The graph separates option construction, comparison, slice-diff support, and report formatting. Evidence is limited to the README and indexed or excerpted source; some internal call details were not sampled.

Main entry points: [`cmp/options.go`](https://github.com/google/go-cmp/blob/master/cmp/options.go) (Option processing), [`cmp/compare.go`](https://github.com/google/go-cmp/blob/master/cmp/compare.go) (Recursive comparison), [`cmp/internal/value`](https://github.com/google/go-cmp/tree/master/cmp/internal/value) (Value helpers), [`cmp/report_slices.go`](https://github.com/google/go-cmp/blob/master/cmp/report_slices.go) (Slice and text diffs)

## Diagram (Mermaid)

```mermaid
flowchart TD

subgraph group_api["Public API"]
  node_compare_api["Equal and Diff<br/>[compare.go]"]
end

subgraph group_compare["Comparison Engine"]
  node_comparison["Recursive comparison<br/>[compare.go]"]
  node_value_helpers["Value helpers"]
  node_function_checks["Function checks<br/>[func.go]"]
  node_slice_diff["Edit-script algorithm<br/>[diff.go]"]
end

subgraph group_options["Comparison Options"]
  node_option_core["Option processing<br/>[options.go]"]
  node_equate["Equivalence rules<br/>[equate.go]"]
  node_ignore["Ignore filters<br/>[ignore.go]"]
  node_sorting["Sort transforms<br/>[sort.go]"]
  node_struct_filters["Struct filters<br/>[struct_filter.go]"]
  node_transforms["Custom transforms<br/>[xform.go]"]
end

subgraph group_reports["Difference Reports"]
  node_path_model["Comparison paths<br/>[path.go]"]
  node_report_values["Value rendering<br/>[report_reflect.go]"]
  node_report_references["Reference rendering"]
  node_slice_reports["Slice and text diffs<br/>[report_slices.go]"]
  node_text_reports["Text formatting<br/>[report_text.go]"]
end

node_caller(("Go caller"))

node_caller -->|"compares values"| node_compare_api
node_compare_api -->|"runs comparison"| node_comparison
node_comparison -->|"processes options"| node_option_core
node_comparison -->|"uses edit scripts"| node_slice_diff
node_comparison -->|"validates functions"| node_function_checks
node_comparison -->|"uses helpers"| node_value_helpers
node_option_core -->|"checks callbacks"| node_function_checks
node_equate -->|"creates options"| node_option_core
node_ignore -->|"creates filters"| node_option_core
node_sorting -->|"creates transforms"| node_option_core
node_struct_filters -->|"creates filters"| node_option_core
node_transforms -->|"creates transforms"| node_option_core
node_compare_api -->|"produces differences"| node_slice_reports
node_path_model -->|"uses helpers"| node_value_helpers
node_report_values -->|"uses helpers"| node_value_helpers
node_report_references -->|"uses helpers"| node_value_helpers
node_slice_reports -->|"computes slice edits"| node_slice_diff
node_text_reports -.->|"formats diff text"| node_slice_reports

click node_compare_api "https://github.com/google/go-cmp/blob/master/cmp/compare.go"
click node_comparison "https://github.com/google/go-cmp/blob/master/cmp/compare.go"
click node_option_core "https://github.com/google/go-cmp/blob/master/cmp/options.go"
click node_equate "https://github.com/google/go-cmp/blob/master/cmp/cmpopts/equate.go"
click node_ignore "https://github.com/google/go-cmp/blob/master/cmp/cmpopts/ignore.go"
click node_sorting "https://github.com/google/go-cmp/blob/master/cmp/cmpopts/sort.go"
click node_struct_filters "https://github.com/google/go-cmp/blob/master/cmp/cmpopts/struct_filter.go"
click node_transforms "https://github.com/google/go-cmp/blob/master/cmp/cmpopts/xform.go"
click node_value_helpers "https://github.com/google/go-cmp/tree/master/cmp/internal/value"
click node_function_checks "https://github.com/google/go-cmp/blob/master/cmp/internal/function/func.go"
click node_slice_diff "https://github.com/google/go-cmp/blob/master/cmp/internal/diff/diff.go"
click node_path_model "https://github.com/google/go-cmp/blob/master/cmp/path.go"
click node_report_values "https://github.com/google/go-cmp/blob/master/cmp/report_reflect.go"
click node_report_references "https://github.com/google/go-cmp/blob/master/cmp/report_references.go"
click node_slice_reports "https://github.com/google/go-cmp/blob/master/cmp/report_slices.go"
click node_text_reports "https://github.com/google/go-cmp/blob/master/cmp/report_text.go"

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_compare_api toneBlue
class node_comparison,node_value_helpers,node_function_checks,node_slice_diff toneAmber
class node_option_core,node_equate,node_ignore,node_sorting,node_struct_filters,node_transforms toneMint
class node_path_model,node_report_values,node_report_references,node_slice_reports,node_text_reports toneRose
class node_caller toneIndigo
```

## Components

### Public API

- [Equal and Diff](https://github.com/google/go-cmp/blob/master/cmp/compare.go): `cmp/compare.go`

### Comparison Engine

- [Recursive comparison](https://github.com/google/go-cmp/blob/master/cmp/compare.go): `cmp/compare.go`
- [Value helpers](https://github.com/google/go-cmp/tree/master/cmp/internal/value): `cmp/internal/value`
- [Function checks](https://github.com/google/go-cmp/blob/master/cmp/internal/function/func.go): `cmp/internal/function/func.go`
- [Edit-script algorithm](https://github.com/google/go-cmp/blob/master/cmp/internal/diff/diff.go): `cmp/internal/diff/diff.go`

### Comparison Options

- [Option processing](https://github.com/google/go-cmp/blob/master/cmp/options.go): `cmp/options.go`
- [Equivalence rules](https://github.com/google/go-cmp/blob/master/cmp/cmpopts/equate.go): `cmp/cmpopts/equate.go`
- [Ignore filters](https://github.com/google/go-cmp/blob/master/cmp/cmpopts/ignore.go): `cmp/cmpopts/ignore.go`
- [Sort transforms](https://github.com/google/go-cmp/blob/master/cmp/cmpopts/sort.go): `cmp/cmpopts/sort.go`
- [Struct filters](https://github.com/google/go-cmp/blob/master/cmp/cmpopts/struct_filter.go): `cmp/cmpopts/struct_filter.go`
- [Custom transforms](https://github.com/google/go-cmp/blob/master/cmp/cmpopts/xform.go): `cmp/cmpopts/xform.go`

### Difference Reports

- [Comparison paths](https://github.com/google/go-cmp/blob/master/cmp/path.go): `cmp/path.go`
- [Value rendering](https://github.com/google/go-cmp/blob/master/cmp/report_reflect.go): `cmp/report_reflect.go`
- [Reference rendering](https://github.com/google/go-cmp/blob/master/cmp/report_references.go): `cmp/report_references.go`
- [Slice and text diffs](https://github.com/google/go-cmp/blob/master/cmp/report_slices.go): `cmp/report_slices.go`
- [Text formatting](https://github.com/google/go-cmp/blob/master/cmp/report_text.go): `cmp/report_text.go`

### Other components

- **Go caller**

## Connections

- Go caller → Equal and Diff: compares values (evidence: `README.md`)
- Equal and Diff → Recursive comparison: runs comparison (evidence: `cmp/compare.go`)
- Recursive comparison → Option processing: processes options (evidence: `cmp/compare.go`)
- Recursive comparison → Edit-script algorithm: uses edit scripts (evidence: `cmp/compare.go`)
- Recursive comparison → Function checks: validates functions (evidence: `cmp/compare.go`)
- Recursive comparison → Value helpers: uses helpers (evidence: `cmp/compare.go`)
- Option processing → Function checks: checks callbacks (evidence: `cmp/options.go`)
- Equivalence rules → Option processing: creates options (evidence: `cmp/cmpopts/equate.go`)
- Ignore filters → Option processing: creates filters (evidence: `cmp/cmpopts/ignore.go`)
- Sort transforms → Option processing: creates transforms (evidence: `cmp/cmpopts/sort.go`)
- Struct filters → Option processing: creates filters (evidence: `cmp/cmpopts/struct_filter.go`)
- Custom transforms → Option processing: creates transforms (evidence: `cmp/cmpopts/xform.go`)
- Equal and Diff → Slice and text diffs: produces differences (evidence: `cmp/compare.go`)
- Comparison paths → Value helpers: uses helpers (evidence: `cmp/path.go`)
- Value rendering → Value helpers: uses helpers (evidence: `cmp/report_reflect.go`)
- Reference rendering → Value helpers: uses helpers (evidence: `cmp/report_references.go`)
- Slice and text diffs → Edit-script algorithm: computes slice edits (evidence: `cmp/report_slices.go`)
- Text formatting → Slice and text diffs: formats diff text
