Skip to content

Raw snapshots

A raw target snapshots arbitrary files by content digest — point it at paths, directories, or glob patterns and any added, removed, or changed file becomes a reviewable diff. It is the zero-effort way to put files another tool already produces (Playwright snapshots, build artifacts, generated fixtures) under dungbeetle review.

Configure a target

json
{
  "kind": "raw",
  "name": "playwright-snapshots",
  "paths": ["tests/**/*-snapshots/**"],
  "reportingDir": "playwright/snapshots"
}

Options:

  • paths — files to capture: relative paths, absolute paths, whole directories, or glob patterns (** supported). Resolved against cwd. Directory targets capture everything inside, dotfiles included; glob patterns follow standard glob semantics (dotfiles need a literal leading dot to match).
  • cwd — working directory, resolved relative to the config (default: the config directory).
  • reportingDir — the reporting directory the snapshots file under (default "reporting").

What's captured

Each matching file is recorded as path → { digest, bytes } (sha-256 of the contents), plus the captured directory path. File contents are not stored — the digest record is the snapshot, so captures stay small no matter how big the artifacts are.

How it's compared

The file record is a keyed structure, so the diff names exactly what happened:

  • a new file appears as an added entry,
  • a deleted file as a removed entry,
  • a changed file as its digest changing.

For now the capture records the directory path and per-file digests; linking matching file names with different extensions (e.g. shot.png + shot.json) into one review item is planned as part of the review revamp.

Source-available: CLI under FSL-1.1-ALv2, cloud server under BUSL-1.1. See Licensing.