Update the compare/diff function signature step by step.

Author: k1LoW

builtin/compare.go

@@ -1,7 +1,7 @@
 package builtin
 
-func Compare(x, y any, ignorePaths ...string) (bool, error) {
-	d, err := Diff(x, y, ignorePaths...)
+func Compare(x, y any, ignores ...any) (bool, error) {
+	d, err := Diff(x, y, ignores...)
 	if err != nil {
 		return false, err
 	}

builtin/compare_test.go

@@ -90,7 +90,7 @@ func TestCompareWithIgnorePathOrKeys(t *testing.T) {
 	}
 	for i, tt := range tests {
 		t.Run(fmt.Sprintf("Case %d", i), func(t *testing.T) {
-			got, err := Compare(tt.x, tt.y, tt.ignorePathOrKeys...)
+			got, err := Compare(tt.x, tt.y, tt.ignorePathOrKeys)
 			if err != nil {
 				t.Error(err)
 			}

builtin/diff.go

@@ -12,7 +12,25 @@ import (
 	"github.com/itchyny/gojq"
 )
 
-func Diff(x, y any, ignorePaths ...string) (string, error) {
+func Diff(x, y any, ignores ...any) (string, error) {
+	var ignoreSpecifiers []string
+	for _, i := range ignores {
+		switch v := i.(type) {
+		case string:
+			ignoreSpecifiers = append(ignoreSpecifiers, v)
+		case []any:
+			for _, vv := range v {
+				s, ok := vv.(string)
+				if !ok {
+					return "", fmt.Errorf("invalid ignore specifiers: %v", vv)
+				}
+				ignoreSpecifiers = append(ignoreSpecifiers, s)
+			}
+		default:
+			return "", fmt.Errorf("invalid ignore specifiers: %v", i)
+		}
+	}
+
 	impl := diffImpl{}
 
 	// normalize values
@@ -25,7 +43,7 @@ func Diff(x, y any, ignorePaths ...string) (string, error) {
 		return "", err
 	}
 
-	jqIgnorePaths, cmpIgnoreKeys := impl.splitIgnoreSpecifiers(ignorePaths)
+	jqIgnorePaths, cmpIgnoreKeys := impl.splitIgnoreSpecifiers(ignoreSpecifiers)
 
 	var diffOpts []cmp.Option
 	if len(cmpIgnoreKeys) >= 0 {

builtin/diff_test.go

@@ -164,7 +164,7 @@ func TestDiffWithIgnorePathOrKeys(t *testing.T) {
 	}
 	for i, tt := range tests {
 		t.Run(fmt.Sprintf("Case %d", i), func(t *testing.T) {
-			got, err := Diff(tt.x, tt.y, tt.ignorePathOrKeys...)
+			got, err := Diff(tt.x, tt.y, tt.ignorePathOrKeys)
 			if err != nil {
 				t.Error(err)
 			}

eval.go

@@ -262,7 +262,7 @@ func onPrintTraceCallNode(tp exprtrace.TreePrinter, tree treeprint.Tree, callNod
 			}
 		}
 
-		diff, _ := builtin.Diff(a, b, ignoreKeys...) //nostyle:handlerror
+		diff, _ := builtin.Diff(a, b, ignoreKeys) //nostyle:handlerror
 
 		// Normalize NBSP to SPACE
 		diff = strings.Map(func(r rune) rune {

option_test.go

@@ -1044,6 +1044,7 @@ func TestBuiltinFunctionBooks(t *testing.T) {
 		{"testdata/book/builtin_pick.yml", false},
 		{"testdata/book/builtin_omit.yml", false},
 		{"testdata/book/builtin_merge.yml", false},
+		{"testdata/book/builtin_compare.yml", false},
 	}
 	ctx := context.Background()
 	for _, tt := range tests {

testdata/book/builtin_compare.yml

@@ -0,0 +1,16 @@
+desc: For compare() built-in function
+steps:
+  merge:
+    test: |
+      compare(
+        {"a": 1, "b": 3, "c": 5},
+        {"a": 1, "b": 2, "c": 4},
+        "b", "c"
+      )
+  merge2:
+    test: |
+      compare(
+        {"a": 1, "b": 3, "c": 5},
+        {"a": 1, "b": 2, "c": 4},
+        ["b", "c"]
+      )