snapfix.yaml.example

# snapfix.yaml — project-level configuration
# Place this file in your project root.
# All values are optional; shown here with their defaults.

snapfix:
  # Directory where fixture files are written.
  # Relative paths are resolved from the project root.
  output_dir: tests/fixtures

  # Maximum serialization depth. Objects deeper than this emit a
  # __snapfix_maxdepth__ sentinel instead of crashing.
  max_depth: 10

  # Maximum serialized payload size in bytes. Payloads larger than this
  # emit a __snapfix_truncated__ sentinel and the fixture is not written.
  max_size_bytes: 500000

  # Set to false to disable all capture globally (e.g. in production).
  # Can also be set via SNAPFIX_ENABLED=false environment variable.
  enabled: true

  # NEW in v0.3.3: Number of historical snapshot versions to retain in a FIFO ring buffer.
  # Each time you re-capture a fixture, the previous version is saved as a numbered backup
  # (.1.json, .2.json, etc.). Older versions are automatically deleted when this limit is exceeded.
  # Enables temporal diffing via `snapfix diff <name> --version N`.
  # Can also be set via SNAPFIX_HISTORY=2 environment variable.
  snapshot_history: 2