use json as wire format for snapshot for better cross platform support

.github/workflows/test.yml

@@ -7,7 +7,11 @@ env:
 
 jobs:
   test:
-    runs-on: ubuntu-latest
+    runs-on: ${{ matrix.os }}
+
+    strategy:
+      matrix:
+        os: [macos-latest, windows-latest, ubuntu-latest]
 
     steps:
       - uses: actions/setup-go@v4
@@ -17,9 +21,14 @@ jobs:
       - uses: actions/checkout@v3
 
       - name: lint
+        if: matrix.os == 'ubuntu-latest'
         run: go run github.com/ysmood/golangci-lint@latest
 
       - name: test
         env:
           TERM: xterm-256color
-        run: go test -race -coverprofile=coverage.out ./... && go run ./cmd/check-cov
+        run: go test -coverprofile="coverage.out" ./...
+
+      - name: coverage
+        if: matrix.os == 'ubuntu-latest'
+        run: go run ./cmd/check-cov

snapshots.go

@@ -6,11 +6,8 @@ import (
 	"path/filepath"
 	"regexp"
 	"strings"
-
-	"github.com/ysmood/gop"
 )
 
-const snapshotGopExt = ".gop"
 const snapshotJSONExt = ".json"
 
 type snapshot struct {
@@ -23,14 +20,9 @@ func (g G) snapshotsDir() string {
 }
 
 func (g G) loadSnapshots() {
-	paths, err := filepath.Glob(filepath.Join(g.snapshotsDir(), "*"+snapshotGopExt))
-	g.E(err)
-
-	jsonPaths, err := filepath.Glob(filepath.Join(g.snapshotsDir(), "*"+snapshotJSONExt))
+	paths, err := filepath.Glob(filepath.Join(g.snapshotsDir(), "*"+snapshotJSONExt))
 	g.E(err)
 
-	paths = append(paths, jsonPaths...)
-
 	for _, path := range paths {
 		g.snapshots.Store(path, snapshot{g.Read(path).String(), false})
 	}
@@ -56,39 +48,15 @@ func (g G) loadSnapshots() {
 // To update the snapshot, just change the name of the snapshot or remove the corresponding snapshot file.
 // It will auto-remove the unused snapshot files after the test.
 // The snapshot files should be version controlled.
-// The format of the snapshot file is the output of [gop.Plain].
-func (g G) Snapshot(name string, x interface{}) {
-	g.Helper()
-	g.snapshot(name, x, false)
-}
-
-// SnapshotJSON is similar to [G.Snapshot], but it will convert x to JSON string before comparing.
 // The format of the snapshot file is json.
-func (g G) SnapshotJSON(name string, x interface{}) {
-	g.Helper()
-	g.snapshot(name, x, true)
-}
-
-func (g G) snapshot(name string, x interface{}, jsonType bool) {
+func (g G) Snapshot(name string, x interface{}) {
 	g.Helper()
 
-	var ext string
-	if jsonType {
-		ext = snapshotJSONExt
-	} else {
-		ext = snapshotGopExt
-	}
-
-	path := filepath.Join(g.snapshotsDir(), escapeFileName(name)+ext)
+	path := filepath.Join(g.snapshotsDir(), escapeFileName(name)+snapshotJSONExt)
 
-	var xs string
-	if jsonType {
-		b, err := json.MarshalIndent(x, "", "  ")
-		g.E(err)
-		xs = string(b)
-	} else {
-		xs = gop.Plain(x)
-	}
+	b, err := json.MarshalIndent(x, "", "  ")
+	g.E(err)
+	xs := string(b)
 
 	if data, ok := g.snapshots.Load(path); ok {
 		s := data.(snapshot)

snapshots_test.go

@@ -19,7 +19,6 @@ func TestSnapshots(t *testing.T) {
 	g.Snapshot("a", "ok")
 	g.Snapshot("b", 1)
 	g.Snapshot("c", C{10})
-	g.SnapshotJSON("d", C{20})
 
 	g.Run("sub", func(g got.G) {
 		g.Snapshot("d", "ok")
@@ -31,7 +30,7 @@ func TestSnapshots(t *testing.T) {
 	gm.Snapshot("a", "no")
 	m.check(`"no" ⦗not ==⦘ "ok"`)
 
-	gm.Snapshot("a", "no\nno")
+	gm.Snapshot("a", map[int]int{1: 2})
 	g.Has(m.msg, "diff chunk")
 	m.reset()
 
@@ -41,7 +40,7 @@ func TestSnapshots(t *testing.T) {
 }
 
 func TestSnapshotsCreate(t *testing.T) {
-	path := filepath.FromSlash(".got/snapshots/TestSnapshotsCreate/a.gop")
+	path := filepath.FromSlash(".got/snapshots/TestSnapshotsCreate/a.json")
 	err := os.RemoveAll(path)
 	if err != nil {
 		panic(err)
@@ -57,7 +56,7 @@ func TestSnapshotsCreate(t *testing.T) {
 }
 
 func TestSnapshotsNotUsed(t *testing.T) {
-	path := filepath.FromSlash(".got/snapshots/TestSnapshotsNotUsed/a.gop")
+	path := filepath.FromSlash(".got/snapshots/TestSnapshotsNotUsed/a.json")
 
 	g := got.T(t)
 	g.WriteFile(path, []byte(`1`))
@@ -70,7 +69,7 @@ func TestSnapshotsNotUsed(t *testing.T) {
 }
 
 func TestSnapshotsNotUsedWhenFailure(t *testing.T) {
-	path := filepath.FromSlash(".got/snapshots/TestSnapshotsNotUsedWhenFailure/a.gop")
+	path := filepath.FromSlash(".got/snapshots/TestSnapshotsNotUsedWhenFailure/a.json")
 
 	g := got.T(t)
 	g.WriteFile(path, []byte(`1`))