gitgo

Streamlined Git command execution engine with fluent chaining interface and comprehensive Git operations support.

---

CHINESE README

中文说明

Main Features

🔗 Fluent Chaining Interface: Method chaining with complex Git workflows and automatic issue propagation ⚡ Comprehensive Git Operations: Complete Git commands coverage including commit, push, fetch, and branch management 🔍 Smart State Detection: Intelligent checking on staged and unstaged changes, clean working trees, and repo status 🎯 Issue Handling: Robust issue propagation with detailed context and debug information 📋 Repo Querying: Advanced repo introspection with branch, commit, and status information

Related Projects

• gogit - Enhanced Git operations toolkit with go-git foundation, providing pure Go implementation without CLI dependencies
• gitgo (this project) - Streamlined Git command execution engine with fluent chaining interface

Installation

go get github.com/go-xlan/gitgo

Usage

Basic Git Operations

package main

import (
	"os"
	"path/filepath"

	"github.com/go-xlan/gitgo"
	"github.com/yyle88/must"
	"github.com/yyle88/rese"
	"github.com/yyle88/zaplog"
)

func main() {
	tempDIR := rese.V1(os.MkdirTemp("", "gitgo-*"))
	defer func() {
		must.Done(os.RemoveAll(tempDIR))
	}()

	zaplog.SUG.Debug("working in:", tempDIR)

	gcm := gitgo.New(tempDIR)
	gcm.Init().Done()
	zaplog.SUG.Info("git repo initialized")

	must.Done(os.WriteFile(filepath.Join(tempDIR, "demo.txt"), []byte("hello"), 0644))
	zaplog.SUG.Info("created demo.txt")

	gcm.Add().Commit("demo commit").Done()
	zaplog.SUG.Info("committed changes")
}

⬆️ Source: Source

Repo State Detection

package main

import (
	"os"
	"path/filepath"

	"github.com/go-xlan/gitgo"
	"github.com/yyle88/must"
	"github.com/yyle88/rese"
	"github.com/yyle88/zaplog"
)

func main() {
	tempDIR := rese.V1(os.MkdirTemp("", "gitgo-*"))
	defer func() {
		must.Done(os.RemoveAll(tempDIR))
	}()

	zaplog.SUG.Debug("working in:", tempDIR)

	gcm := gitgo.New(tempDIR)
	gcm.Init().Done()
	zaplog.SUG.Info("initialized repo")

	must.Done(os.WriteFile(filepath.Join(tempDIR, "file.txt"), []byte("v1"), 0644))
	gcm.Add().Commit("add file").Done()
	zaplog.SUG.Info("committed v1")

	must.Done(os.WriteFile(filepath.Join(tempDIR, "file.txt"), []byte("v2"), 0644))
	zaplog.SUG.Info("modified file to v2")

	hasChanges := rese.V1(gcm.HasUnstagedChanges())
	zaplog.SUG.Info("has unstaged changes:", hasChanges)

	if hasChanges {
		gcm.Add().Commit("update file").Done()
		zaplog.SUG.Info("committed v2 changes")
	}
}

⬆️ Source: Source

Tags and Repo Information

package main

import (
	"os"
	"path/filepath"

	"github.com/go-xlan/gitgo"
	"github.com/yyle88/must"
	"github.com/yyle88/rese"
	"github.com/yyle88/zaplog"
)

func main() {
	tempDIR := rese.V1(os.MkdirTemp("", "gitgo-*"))
	defer func() {
		must.Done(os.RemoveAll(tempDIR))
	}()

	zaplog.SUG.Debug("working in:", tempDIR)

	gcm := gitgo.New(tempDIR)
	gcm.Init().Done()
	zaplog.SUG.Info("repo setup complete")

	must.Done(os.WriteFile(filepath.Join(tempDIR, "app.txt"), []byte("v1"), 0644))
	gcm.Add().Commit("v1").Tag("v1.0.0").Done()
	zaplog.SUG.Info("tagged v1.0.0")

	must.Done(os.WriteFile(filepath.Join(tempDIR, "app.txt"), []byte("v2"), 0644))
	gcm.Add().Commit("v2").Tag("v1.1.0").Done()
	zaplog.SUG.Info("tagged v1.1.0")

	latest, exists, err := gcm.GetLatestTag()
	must.Done(err)
	must.True(exists)
	zaplog.SUG.Info("latest tag:", latest)

	count := rese.V1(gcm.GetCommitCount())
	zaplog.SUG.Info("commit count:", count)
}

⬆️ Source: Source

API Reference

Core Methods

• New(path string) *Gcm - Create new Git command engine
• NewGcm(path, execConfig) *Gcm - Create with custom settings

Git Operations

• Status() *Gcm - Show working tree status
• Add() *Gcm - Stage changes
• Commit(message) *Gcm - Create commit with message
• Push() *Gcm - Push to remote repo
• Pull() *Gcm - Fetch and merge from remote repo

Branch Management

• CheckoutNewBranch(name) *Gcm - Create and switch to new branch
• Checkout(name) *Gcm - Switch to existing branch
• GetCurrentBranch() (string, error) - Get the branch name
• ListBranches() ([]string, error) - Get branches as a list

Repo State

• HasStagedChanges() (bool, error) - Check staged changes existence
• HasUnstagedChanges() (bool, error) - Check unstaged changes existence
• HasChanges() (bool, error) - Check changes existence
• GetCommitCount() (int, error) - Get commit count
• GetCommitHash(ref) (string, error) - Get commit hash with reference
• GetRemoteURL(remote) (string, error) - Get remote repo URL
• GetIgnoredFiles() ([]string, error) - Get files ignored in gitignore
• ConfigGet(key) (string, error) - Get Git configuration value

Tag Operations

• GetLatestTag() (string, bool, error) - Get latest tag name with existence check

Issue Handling

• Result() ([]byte, error) - Get output and check issues
• MustDone() *Gcm - Panic when issues happen

📄 License

MIT License - see LICENSE.

---

💬 Contact & Feedback

Contributions are welcome! Report bugs, suggest features, and contribute code:

• 🐛 Mistake reports? Open an issue on GitHub with reproduction steps
• 💡 Fresh ideas? Create an issue to discuss
• 📖 Documentation confusing? Report it so we can improve
• 🚀 Need new features? Share the use cases to help us understand requirements
• ⚡ Performance issue? Help us optimize through reporting slow operations
• 🔧 Configuration problem? Ask questions about complex setups
• 📢 Follow project progress? Watch the repo to get new releases and features
• 🌟 Success stories? Share how this package improved the workflow
• 💬 Feedback? We welcome suggestions and comments

---

🔧 Development

New code contributions, follow this process:

1. Fork: Fork the repo on GitHub (using the webpage UI).
2. Clone: Clone the forked project (git clone https://github.com/yourname/repo-name.git).
3. Navigate: Navigate to the cloned project (cd repo-name)
4. Branch: Create a feature branch (git checkout -b feature/xxx).
5. Code: Implement the changes with comprehensive tests
6. Testing: (Golang project) Ensure tests pass (go test ./...) and follow Go code style conventions
7. Documentation: Update documentation to support client-facing changes
8. Stage: Stage changes (git add .)
9. Commit: Commit changes (git commit -m "Add feature xxx") ensuring backward compatible code
10. Push: Push to the branch (git push origin feature/xxx).
11. PR: Open a merge request on GitHub (on the GitHub webpage) with detailed description.

Please ensure tests pass and include relevant documentation updates.

---

🌟 Support

Welcome to contribute to this project via submitting merge requests and reporting issues.

Project Support:

• ⭐ Give GitHub stars if this project helps you
• 🤝 Share with teammates and (golang) programming friends
• 📝 Write tech blogs about development tools and workflows - we provide content writing support
• 🌟 Join the ecosystem - committed to supporting open source and the (golang) development scene

Have Fun Coding with this package! 🎉🎉🎉

---

GitHub Stars