shithub: furgit

Download patch

ref: 113317d91202f50d24f96a30b2f0df758eb5f2b0
parent: 20d82eb47c63e6cb8a8bf360a79e8ba53948a6d6
author: Runxi Yu <me@runxiyu.org>
date: Tue Nov 25 03:00:00 EST 2025 

refs: Rename ShowRefs -> ListRefs


--- a/refs.go
+++ b/refs.go
@@ -144,8 +144,8 @@
 	Peeled Hash
 }
 
-// ShowRef represents a reference entry as returned by ShowRefs.
-type ShowRef struct {
+// ListRef represents a reference entry as returned by ListRefs.
+type ListRef struct {
 	// Name is the fully qualified ref name (e.g., refs/heads/main).
 	Name string
 	// Ref describes the reference target.
@@ -235,7 +235,7 @@
 	}
 }
 
-// ShowRefs lists refs similarly to git-show-ref.
+// ListRefs lists refs similarly to git-show-ref.
 //
 // The pattern must be empty or begin with "refs/". An empty pattern is
 // treated as "refs/*".
@@ -244,7 +244,7 @@
 // repository root, then packed refs are read while skipping any names
 // that already appeared as loose refs. Packed refs are filtered
 // similarly.
-func (repo *Repository) ShowRefs(pattern string) ([]ShowRef, error) {
+func (repo *Repository) ListRefs(pattern string) ([]ListRef, error) {
 	if pattern == "" {
 		pattern = "refs/*"
 	}
@@ -255,7 +255,7 @@
 		return nil, ErrInvalidRef
 	}
 
-	var out []ShowRef
+	var out []ListRef
 	seen := make(map[string]struct{})
 
 	globPattern := filepath.Join(repo.rootPath, filepath.FromSlash(pattern))
@@ -290,7 +290,7 @@
 		}
 
 		seen[name] = struct{}{}
-		out = append(out, ShowRef{
+		out = append(out, ListRef{
 			Name: name,
 			Ref:  ref,
 		})
@@ -357,7 +357,7 @@
 		if parseErr != nil {
 			return nil, parseErr
 		}
-		out = append(out, ShowRef{
+		out = append(out, ListRef{
 			Name: name,
 			Ref: Ref{
 				Kind: RefKindDetached,
--- a/refs_test.go
+++ b/refs_test.go
@@ -280,7 +280,7 @@
 	}
 }
 
-func TestShowRefsLooseOverridesPacked(t *testing.T) {
+func TestListRefsLooseOverridesPacked(t *testing.T) {
 	repoPath, cleanup := setupTestRepo(t)
 	defer cleanup()
 
@@ -319,9 +319,9 @@
 	hash1, _ := repo.ParseHash(commit1)
 	hash2, _ := repo.ParseHash(commit2)
 
-	refs, err := repo.ShowRefs("refs/heads/*")
+	refs, err := repo.ListRefs("refs/heads/*")
 	if err != nil {
-		t.Fatalf("ShowRefs failed: %v", err)
+		t.Fatalf("ListRefs failed: %v", err)
 	}
 
 	if len(refs) != 2 {
@@ -353,7 +353,7 @@
 	}
 }
 
-func TestShowRefsPatternFiltering(t *testing.T) {
+func TestListRefsPatternFiltering(t *testing.T) {
 	repoPath, cleanup := setupTestRepo(t)
 	defer cleanup()
 
@@ -382,9 +382,9 @@
 
 	hash1, _ := repo.ParseHash(commit1)
 
-	refs, err := repo.ShowRefs("refs/heads/fea*")
+	refs, err := repo.ListRefs("refs/heads/fea*")
 	if err != nil {
-		t.Fatalf("ShowRefs failed: %v", err)
+		t.Fatalf("ListRefs failed: %v", err)
 	}
 	if len(refs) != 1 {
 		t.Fatalf("expected 1 ref, got %d", len(refs))
@@ -397,7 +397,7 @@
 	}
 }
 
-func TestShowRefsPackedPatterns(t *testing.T) {
+func TestListRefsPackedPatterns(t *testing.T) {
 	repoPath, cleanup := setupTestRepo(t)
 	defer cleanup()
 
@@ -458,9 +458,9 @@
 
 	for _, tt := range tests {
 		t.Run(tt.pattern, func(t *testing.T) {
-			refs, err := repo.ShowRefs(tt.pattern)
+			refs, err := repo.ListRefs(tt.pattern)
 			if err != nil {
-				t.Fatalf("ShowRefs(%q) failed: %v", tt.pattern, err)
+				t.Fatalf("ListRefs(%q) failed: %v", tt.pattern, err)
 			}
 
 			got := make(map[string]struct{}, len(refs))
@@ -474,11 +474,11 @@
 			}
 
 			if len(got) != len(want) {
-				t.Fatalf("ShowRefs(%q) returned %d refs, want %d", tt.pattern, len(got), len(want))
+				t.Fatalf("ListRefs(%q) returned %d refs, want %d", tt.pattern, len(got), len(want))
 			}
 			for name := range got {
 				if _, ok := want[name]; !ok {
-					t.Fatalf("ShowRefs(%q) unexpected ref %q", tt.pattern, name)
+					t.Fatalf("ListRefs(%q) unexpected ref %q", tt.pattern, name)
 				}
 			}
 		})
-- 
⑨