{"id":20548696,"url":"https://github.com/natescarlet/snapshot","last_synced_at":"2026-02-08T16:02:17.650Z","repository":{"id":37024432,"uuid":"316024630","full_name":"NateScarlet/snapshot","owner":"NateScarlet","description":"Do snapshot test in go","archived":false,"fork":false,"pushed_at":"2024-11-23T13:45:14.000Z","size":68,"stargazers_count":0,"open_issues_count":5,"forks_count":0,"subscribers_count":1,"default_branch":"master","last_synced_at":"2025-11-22T14:58:46.849Z","etag":null,"topics":["snapshot","testing"],"latest_commit_sha":null,"homepage":"","language":"Go","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/NateScarlet.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2020-11-25T18:36:47.000Z","updated_at":"2022-04-24T18:05:10.000Z","dependencies_parsed_at":"2024-06-20T02:51:47.125Z","dependency_job_id":"a3dded83-3c1f-4dd1-aae0-c3d0400bdd4f","html_url":"https://github.com/NateScarlet/snapshot","commit_stats":null,"previous_names":[],"tags_count":10,"template":false,"template_full_name":null,"purl":"pkg:github/NateScarlet/snapshot","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/NateScarlet%2Fsnapshot","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/NateScarlet%2Fsnapshot/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/NateScarlet%2Fsnapshot/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/NateScarlet%2Fsnapshot/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/NateScarlet","download_url":"https://codeload.github.com/NateScarlet/snapshot/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/NateScarlet%2Fsnapshot/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":29236127,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-02-08T14:18:14.570Z","status":"ssl_error","status_checked_at":"2026-02-08T14:18:14.071Z","response_time":57,"last_error":"SSL_read: unexpected eof while reading","robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":false,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["snapshot","testing"],"created_at":"2024-11-16T02:14:19.459Z","updated_at":"2026-02-08T16:02:17.625Z","avatar_url":"https://github.com/NateScarlet.png","language":"Go","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Snapshot\n\n[![godev](https://img.shields.io/static/v1?label=godev\u0026message=reference\u0026color=00add8)](https://pkg.go.dev/github.com/NateScarlet/snapshot/pkg/snapshot)\n[![build status](https://github.com/NateScarlet/snapshot/workflows/Go/badge.svg)](https://github.com/NateScarlet/snapshot/actions)\n\nSnapshot test for golang.\n\nStore snapshot files under `__snapshots__` folder relative to caller file.\n\n- [x] json snapshot for any go object with type info\n- [x] transform value as schema to compare type only\n- [x] clean data by regexp before compare\n\n## Update snapshot\n\nset `SNAPSHOT_UPDATE` env var to `true` to update existed snapshot file.\n\n## Usage\n\n```go\n\nimport (\n    \"time\"\n\n    \"github.com/NateScarlet/snapshot/pkg/snapshot\"\n)\n\ntype Object struct {\n    A string\n    B int\n    C bool\n    D time.Time\n}\n\nfunc TestSomeThing(t *testing.T) {\n    // Match as text\n    snapshot.Match(t, \"text\")\n    // snapshot:\n    // text\n\n    // Match as json\n    snapshot.MatchJSON(t, Object{})\n    // snapshot:\n    // {\n    //   \"$Object\": {\n    //     \"A\": \"\",\n    //     \"B\": 0,\n    //     \"C\": false,\n    //     \"D\": {\n    //       \"$Time\": \"0001-01-01 00:00:00 +0000 UTC\"\n    //     }\n    //   }\n    // }\n\n    // Match schema as json\n    snapshot.MatchJSON(t, Object{}, snapshot.OptionTransform(snapshot.TransformSchema))\n    // snapshot:\n    // {\n    //   \"$Object\": {\n    //     \"A\": \"$string\",\n    //     \"B\": \"$int\",\n    //     \"C\": \"$bool\",\n    //     \"D\": \"$Time\"\n    //   }\n    // }\n\n    // Clean dynamic data to make result deterministic\n    snapshot.MatchJSON(t, \n        Object{\n            A: \"a\",\n            B: 1,\n            C: true,\n            D: time.Now(),\n        }, \n        snapshot.OptionCleanRegex(\n            snapshot.CleanAs(\"*time*\"),\n            `\"D\": {\\s+\"\\$Time\": \"(.+)\"\\s+}`,\n        ),\n    )\n    // snapshot:\n    // {\n    //   \"$Object\": {\n    //     \"A\": \"a\",\n    //     \"B\": 1,\n    //     \"C\": true,\n    //     \"D\": {\n    //       \"$Time\": \"*time*\"\n    //     }\n    //   }\n    // }\n}\n\n```\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fnatescarlet%2Fsnapshot","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fnatescarlet%2Fsnapshot","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fnatescarlet%2Fsnapshot/lists"}