migrate YAML package to github.com/goccy/go-yaml

itchyny · itchyny · commit 8f8fa7ec8547 · 2025-05-16T21:32:08.000+09:00
diff --git a/cli/cli_test.go b/cli/cli_test.go
@@ -6,8 +6,8 @@ import (
 	"testing"
 	"time"
 
+	"github.com/goccy/go-yaml"
 	"github.com/google/go-cmp/cmp"
-	"gopkg.in/yaml.v3"
 )
 
 func init() {
diff --git a/cli/error.go b/cli/error.go
@@ -9,6 +9,7 @@ import (
 	"strings"
 	"unicode/utf8"
 
+	"github.com/goccy/go-yaml"
 	"github.com/mattn/go-runewidth"
 
 	"github.com/itchyny/gojq"
@@ -121,18 +122,14 @@ type yamlParseError struct {
 }
 
 func (err *yamlParseError) Error() string {
-	var line int
-	msg := strings.TrimPrefix(
-		strings.TrimPrefix(err.err.Error(), "yaml: "),
-		"unmarshal errors:\n  ")
-	if _, e := fmt.Sscanf(msg, "line %d: ", &line); e != nil {
-		return "invalid yaml: " + err.fname
+	var offset int
+	var e *yaml.SyntaxError
+	if errors.As(err.err, &e) {
+		offset = e.Token.Position.Offset
 	}
-	_, msg, _ = strings.Cut(msg, ": ")
-	msg, _, _ = strings.Cut(msg, "\n")
-	linestr := getLineByLine(err.contents, line)
+	linestr, line, column := getLineByOffset(err.contents, offset)
 	return fmt.Sprintf("invalid yaml: %s:%d\n%s  %s",
-		err.fname, line, formatLineInfo(linestr, line, 0), msg)
+		err.fname, line, formatLineInfo(linestr, line, column), e.Message)
 }
 
 func getLineByOffset(str string, offset int) (linestr string, line, column int) {
@@ -166,24 +163,6 @@ func getLineByOffset(str string, offset int) (linestr string, line, column int)
 	return
 }
 
-func getLineByLine(str string, line int) (linestr string) {
-	ss := &stringScanner{str, 0}
-	for {
-		str, _, ok := ss.next()
-		if !ok {
-			break
-		}
-		if line--; line == 0 {
-			linestr = str
-			break
-		}
-	}
-	if len(linestr) > 64 {
-		linestr = trimLastInvalidRune(linestr[:64])
-	}
-	return
-}
-
 func trimLastInvalidRune(s string) string {
 	for i := len(s) - 1; i >= 0 && i > len(s)-utf8.UTFMax; i-- {
 		if b := s[i]; b < utf8.RuneSelf {
diff --git a/cli/error_test.go b/cli/error_test.go
@@ -170,74 +170,3 @@ func TestGetLineByOffset(t *testing.T) {
 		})
 	}
 }
-
-func TestGetLineByLine(t *testing.T) {
-	testCases := []struct {
-		str     string
-		line    int
-		linestr string
-	}{
-		{
-			"", 0,
-			"",
-		},
-		{
-			"abc", -1,
-			"",
-		},
-		{
-			"abc", 0,
-			"",
-		},
-		{
-			"abc", 1,
-			"abc",
-		},
-		{
-			"abc\n", 1,
-			"abc",
-		},
-		{
-			"abc", 2,
-			"",
-		},
-		{
-			"abc\n", 2,
-			"",
-		},
-		{
-			"abc\ndef\nghi", 1,
-			"abc",
-		},
-		{
-			"abc\ndef\nghi", 2,
-			"def",
-		},
-		{
-			"abc\rdef\rghi", 2,
-			"def",
-		},
-		{
-			"abc\r\ndef\r\nghi", 2,
-			"def",
-		},
-		{
-			"abc\ndef\nghi", 3,
-			"ghi",
-		},
-		{
-			"abc\ndef\nghi", 4,
-			"",
-		},
-	}
-	for _, tc := range testCases {
-		t.Run(fmt.Sprintf("%q,%d", tc.str, tc.line), func(t *testing.T) {
-			linestr := getLineByLine(tc.str, tc.line)
-			if linestr != tc.linestr {
-				t.Errorf("getLineByLine(%q, %d):\n"+
-					"     got: %q\n"+
-					"expected: %q", tc.str, tc.line, linestr, tc.linestr)
-			}
-		})
-	}
-}
diff --git a/cli/inputs.go b/cli/inputs.go
@@ -8,7 +8,7 @@ import (
 	"os"
 	"strings"
 
-	"gopkg.in/yaml.v3"
+	"github.com/goccy/go-yaml"
 
 	"github.com/itchyny/gojq"
 )
@@ -287,7 +287,7 @@ func (i *yamlInputIter) Next() (any, bool) {
 		i.err = &yamlParseError{i.fname, i.ir.getContents(nil, nil), err}
 		return i.err, true
 	}
-	return normalizeYAML(v), true
+	return v, true
 }
 
 func (i *yamlInputIter) Close() error {
diff --git a/cli/marshaler.go b/cli/marshaler.go
@@ -5,7 +5,7 @@ import (
 	"io"
 	"strings"
 
-	"gopkg.in/yaml.v3"
+	"github.com/goccy/go-yaml"
 )
 
 type marshaler interface {
@@ -37,12 +37,12 @@ type yamlMarshaler struct {
 }
 
 func (m *yamlMarshaler) marshal(v any, w io.Writer) error {
-	enc := yaml.NewEncoder(w)
+	indent := 2
 	if i := m.indent; i != nil {
-		enc.SetIndent(*i)
-	} else {
-		enc.SetIndent(2)
+		indent = *i
 	}
+	_, isArray := v.([]any) // https://github.com/goccy/go-yaml/issues/291
+	enc := yaml.NewEncoder(w, yaml.Indent(indent), yaml.IndentSequence(!isArray))
 	if err := enc.Encode(v); err != nil {
 		return err
 	}
diff --git a/cli/test.yaml b/cli/test.yaml
@@ -7336,11 +7336,11 @@
     foo: 2021-01-02
     bar: 2021-01-02t10:11:12Z
     baz: "2021-01-02"
-  expected: | # it is impossible to keep the original timestamp strings
+  expected: |
     {
-      "bar": "2021-01-02T10:11:12Z",
+      "bar": "2021-01-02t10:11:12Z",
       "baz": "2021-01-02",
-      "foo": "2021-01-02T00:00:00Z"
+      "foo": "2021-01-02"
     }
 
 - name: yaml input option with slurp option
@@ -7397,7 +7397,7 @@
   error: |
     invalid yaml: <stdin>:2
         2 | 10
-            ^  could not find expected ':'
+            ^  non-map value is specified
 
 - name: yaml input option multiple errors
   args:
@@ -7410,7 +7410,7 @@
   error: |
     invalid yaml: <stdin>:3
         3 | foo: 3
-            ^  mapping key "foo" already defined at line 1
+            ^  mapping key "foo" already defined at [1:1]
 
 - name: yaml file input error
   args:
@@ -7420,7 +7420,7 @@
   error: |
     invalid yaml: testdata/2.yaml:5
         5 |   a: b: c
-            ^  mapping values are not allowed in this context
+                 ^  mapping value is not allowed in this context
 
 - name: yaml file input error in dos format
   args:
@@ -7430,7 +7430,7 @@
   error: |
     invalid yaml: testdata/3.yaml:5
         5 |   a: b: c
-            ^  mapping values are not allowed in this context
+                 ^  mapping value is not allowed in this context
 
 - name: yaml file input error in mac format
   args:
@@ -7440,7 +7440,7 @@
   error: |
     invalid yaml: testdata/4.yaml:5
         5 |   a: b: c
-            ^  mapping values are not allowed in this context
+                 ^  mapping value is not allowed in this context
 
 - name: yaml output option
   args:
diff --git a/cli/yaml.go b/cli/yaml.go
diff --git a/go.mod b/go.mod
@@ -3,11 +3,11 @@ module github.com/itchyny/gojq
 go 1.22
 
 require (
+	github.com/goccy/go-yaml v1.17.1
 	github.com/google/go-cmp v0.5.4
 	github.com/itchyny/timefmt-go v0.1.6
 	github.com/mattn/go-isatty v0.0.20
 	github.com/mattn/go-runewidth v0.0.15
-	gopkg.in/yaml.v3 v3.0.1
 )
 
 require (
diff --git a/go.sum b/go.sum
@@ -1,3 +1,5 @@
+github.com/goccy/go-yaml v1.17.1 h1:LI34wktB2xEE3ONG/2Ar54+/HJVBriAGJ55PHls4YuY=
+github.com/goccy/go-yaml v1.17.1/go.mod h1:XBurs7gK8ATbW4ZPGKgcbrY1Br56PdM69F7LkFRi1kA=
 github.com/google/go-cmp v0.5.4 h1:L8R9j+yAqZuZjsqh/z+F1NCffTKKLShY6zXTItVIZ8M=
 github.com/google/go-cmp v0.5.4/go.mod h1:v8dTdLbMG2kIc/vJvl+f65V22dbkXbowE6jgT/gNBxE=
 github.com/itchyny/timefmt-go v0.1.6 h1:ia3s54iciXDdzWzwaVKXZPbiXzxxnv1SPGFfM/myJ5Q=
@@ -14,7 +16,3 @@ golang.org/x/sys v0.20.0 h1:Od9JTbYCk261bKm4M/mw7AklTlFYIa0bIp9BgSm1S8Y=
 golang.org/x/sys v0.20.0/go.mod h1:/VUhepiaJMQUp4+oa/7Zr1D23ma6VTLIYjOOTFZPUcA=
 golang.org/x/xerrors v0.0.0-20191204190536-9bdfabe68543 h1:E7g+9GITq07hpfrRu66IVDexMakfv52eLZ2CXBWiKr4=
 golang.org/x/xerrors v0.0.0-20191204190536-9bdfabe68543/go.mod h1:I/5z698sn9Ka8TeJc9MKroUUfqBBauWjQqLJ2OPfmY0=
-gopkg.in/check.v1 v0.0.0-20161208181325-20d25e280405 h1:yhCVgyC4o1eVCa2tZl7eS0r+SDo693bJlVdllGtEeKM=
-gopkg.in/check.v1 v0.0.0-20161208181325-20d25e280405/go.mod h1:Co6ibVJAznAaIkqp8huTwlJQCZ016jof/cbN4VW5Yz0=
-gopkg.in/yaml.v3 v3.0.1 h1:fxVm/GzAzEWqLHuvctI91KS9hhNmmWOoWu0XTYJS7CA=
-gopkg.in/yaml.v3 v3.0.1/go.mod h1:K4uyk7z7BCEPqu6E+C64Yfv1cQ7kz7rIZviUmN+EgEM=

Original file line number	Diff line number	Diff line change
`@@ -6,8 +6,8 @@ import (`
`6`	`6`	`"testing"`
`7`	`7`	`"time"`
`8`	`8`
	`9`	`+ "github.com/goccy/go-yaml"`
`9`	`10`	`"github.com/google/go-cmp/cmp"`
`10`		`- "gopkg.in/yaml.v3"`
`11`	`11`	`)`
`12`	`12`
`13`	`13`	`func init() {`
Original file line number	Diff line number	Diff line change
`@@ -8,7 +8,7 @@ import (`
`8`	`8`	`"os"`
`9`	`9`	`"strings"`
`10`	`10`
`11`		`- "gopkg.in/yaml.v3"`
	`11`	`+ "github.com/goccy/go-yaml"`
`12`	`12`
`13`	`13`	`"github.com/itchyny/gojq"`
`14`	`14`	`)`
`@@ -287,7 +287,7 @@ func (i *yamlInputIter) Next() (any, bool) {`
`287`	`287`	`i.err = &yamlParseError{i.fname, i.ir.getContents(nil, nil), err}`
`288`	`288`	`return i.err, true`
`289`	`289`	`}`
`290`		`- return normalizeYAML(v), true`
	`290`	`+ return v, true`
`291`	`291`	`}`
`292`	`292`
`293`	`293`	`func (i *yamlInputIter) Close() error {`
Original file line number	Diff line number	Diff line change
`@@ -5,7 +5,7 @@ import (`
`5`	`5`	`"io"`
`6`	`6`	`"strings"`
`7`	`7`
`8`		`- "gopkg.in/yaml.v3"`
	`8`	`+ "github.com/goccy/go-yaml"`
`9`	`9`	`)`
`10`	`10`
`11`	`11`	`type marshaler interface {`
`@@ -37,12 +37,12 @@ type yamlMarshaler struct {`
`37`	`37`	`}`
`38`	`38`
`39`	`39`	`func (m *yamlMarshaler) marshal(v any, w io.Writer) error {`
`40`		`- enc := yaml.NewEncoder(w)`
	`40`	`+ indent := 2`
`41`	`41`	`if i := m.indent; i != nil {`
`42`		`- enc.SetIndent(*i)`
`43`		`- } else {`
`44`		`- enc.SetIndent(2)`
	`42`	`+ indent = *i`
`45`	`43`	`}`
	`44`	`+ _, isArray := v.([]any) // https://github.com/goccy/go-yaml/issues/291`
	`45`	`+ enc := yaml.NewEncoder(w, yaml.Indent(indent), yaml.IndentSequence(!isArray))`
`46`	`46`	`if err := enc.Encode(v); err != nil {`
`47`	`47`	`return err`
`48`	`48`	`}`