feat: support quick fetch repo status info

Author: inhere

_examples/images/repo-status-info.png

@@ -59,6 +59,12 @@ func (b *BranchInfo) ParseName() *BranchInfo {
 	return b
 }
 
+// branch types
+const (
+	BranchLocal  = "local"
+	BranchRemote = "remote"
+)
+
 // BranchInfos for a git repo
 type BranchInfos struct {
 	parsed bool
@@ -68,9 +74,9 @@ type BranchInfos struct {
 	brLines []string
 
 	current *BranchInfo
-	// local branches. key is branch name
+	// local branches. key is short branch name, eg: dev
 	locales map[string]*BranchInfo
-	// remote branches. key is full branch name
+	// remote branches. key is full branch name, eg: origin/dev
 	remotes map[string]*BranchInfo
 }
 
@@ -160,12 +166,13 @@ const (
 // Search branches by name.
 //
 // Usage:
-// 	Search("fea", BrSearchLocal)
-// 	Search("fea", BrSearchAll)
-// 	// search on remotes
-// 	Search("fea", BrSearchRemote)
+//
+//	Search("fea", BrSearchLocal)
+//	Search("fea", BrSearchAll)
+//	// search on remotes
+//	Search("fea", BrSearchRemote)
 //	// search on remotes and remote name must be equals "origin"
-// 	Search("origin fea", BrSearchRemote)
+//	Search("origin fea", BrSearchRemote)
 func (bs *BranchInfos) Search(name string, flag int) []*BranchInfo {
 	var list []*BranchInfo
 

info_branch.go

@@ -0,0 +1,93 @@
+package gitw
+
+import (
+	"regexp"
+	"strings"
+
+	"github.com/gookit/goutil/strutil"
+)
+
+// StatusPattern string. eg: master...origin/master
+const StatusPattern = `^([\w-]+)...([\w-]+)/(\w[\w/-]+)$`
+
+var statusRegex = regexp.MustCompile(StatusPattern)
+
+// StatusInfo struct
+//
+// by run: git status -bs -u
+type StatusInfo struct {
+	// Branch current branch name.
+	Branch string
+	// UpRemote current upstream remote name.
+	UpRemote string
+	// UpBranch current upstream remote branch name.
+	UpBranch string
+
+	fileNum int
+
+	// Deleted files
+	Deleted []string
+	// Renamed files, contains RM(rename and modify) files
+	Renamed []string
+	// Modified files
+	Modified []string
+	// Unstacked new created files.
+	Unstacked []string
+}
+
+// NewStatusInfo from string.
+func NewStatusInfo(str string) *StatusInfo {
+	si := &StatusInfo{}
+	return si.FromString(str)
+}
+
+// FromString parse and load info
+func (si *StatusInfo) FromString(str string) *StatusInfo {
+	return si.FromLines(strings.Split(str, "\n"))
+}
+
+// FromLines parse and load info
+func (si *StatusInfo) FromLines(lines []string) *StatusInfo {
+	for _, line := range lines {
+		line = strings.Trim(line, " \t")
+		if len(line) == 0 {
+			continue
+		}
+
+		// files
+		mark, value := strutil.MustCut(line, " ")
+		switch mark {
+		case "##":
+			ss := statusRegex.FindStringSubmatch(value)
+			if len(ss) > 1 {
+				si.Branch, si.UpRemote, si.UpBranch = ss[1], ss[2], ss[3]
+			}
+		case "D":
+			si.fileNum++
+			si.Deleted = append(si.Deleted, value)
+		case "R":
+			si.fileNum++
+			si.Renamed = append(si.Renamed, value)
+		case "M":
+			si.fileNum++
+			si.Modified = append(si.Modified, value)
+		case "RM": // rename and modify
+			si.fileNum++
+			si.Renamed = append(si.Renamed, value)
+		case "??":
+			si.fileNum++
+			si.Unstacked = append(si.Unstacked, value)
+		}
+	}
+	return si
+}
+
+// FileNum in git status
+func (si *StatusInfo) FileNum() int {
+	return si.fileNum
+}
+
+// IsCleaned status in workspace
+func (si *StatusInfo) IsCleaned() bool {
+	return si.fileNum == 0
+}

info_status.go

@@ -167,3 +167,21 @@ func TestBranchInfo_parse_verbose(t *testing.T) {
 	assert.True(t, rets[0].IsRemoted())
 	assert.Eq(t, "origin", rets[0].Remote)
 }
+
+func TestStatusInfo_FromLines(t *testing.T) {
+	text := `
+## master...origin/fea/master
+ RM app/Common/GitLocal/GitFlow.php -> app/Common/GitLocal/GitFactory.php
+  M app/Common/GitLocal/GitHub.php
+ ?? app/Common/GitLocal/GitConst.php
+  D tmp/delete-some.file
+`
+	si := gitw.NewStatusInfo(text)
+
+	dump.P(si)
+	assert.Eq(t, "master", si.Branch)
+	assert.Eq(t, "origin", si.UpRemote)
+	assert.Eq(t, "fea/master", si.UpBranch)
+	assert.False(t, si.IsCleaned())
+	assert.Gt(t, si.FileNum(), 2)
+}

info_test.go

@@ -40,6 +40,9 @@ type Repo struct {
 	// config
 	cfg *RepoConfig
 
+	// status info
+	statusInfo *StatusInfo
+
 	// branch infos for the repo
 	branchInfos *BranchInfos
 
@@ -320,6 +323,25 @@ func (r *Repo) LastCommitID() string {
 	return lastCID
 }
 
+// -------------------------------------------------
+// repo status
+// -------------------------------------------------
+
+// StatusInfo get status info of the repo
+func (r *Repo) StatusInfo() *StatusInfo {
+	if r.statusInfo == nil {
+		r.statusInfo = &StatusInfo{}
+		lines, err := r.gw.Status("-bs", "-u").OutputLines()
+		if err != nil {
+			r.setErr(err)
+			return nil
+		}
+
+		r.statusInfo.FromLines(lines)
+	}
+	return r.statusInfo
+}
+
 // -------------------------------------------------
 // repo branch
 // -------------------------------------------------
@@ -431,8 +453,9 @@ func (r *Repo) RandomRemoteInfo(typ ...string) *RemoteInfo {
 // if typ is empty, will return random type info.
 //
 // Usage:
-// 	ri := RemoteInfo("origin")
-// 	ri = RemoteInfo("origin", "push")
+//
+//	ri := RemoteInfo("origin")
+//	ri = RemoteInfo("origin", "push")
 func (r *Repo) RemoteInfo(remote string, typ ...string) *RemoteInfo {
 	riMp := r.RemoteInfos(remote)
 	if len(riMp) == 0 {

repo.go

@@ -19,6 +19,11 @@ func TestMain(m *testing.M) {
 	m.Run()
 }
 
+func TestRepo_StatusInfo(t *testing.T) {
+	si := repo.StatusInfo()
+	dump.P(si)
+}
+
 func TestRepo_RemoteInfos(t *testing.T) {
 	rs := repo.AllRemoteInfos()
 	dump.P(rs)