Initial implementation (#1)

Author: spenserblack

.editorconfig

@@ -21,3 +21,6 @@ indent_size = 4
 [*.{yaml,yml}]
 indent_style = space
 indent_size = 2
+
+[Makefile]
+indent_style = tab

.git-blame-ignore-revs

@@ -0,0 +1,2 @@
+# Format
+4b8bab8817edefff3ffa83267de5a2fb9f99cf58

.github/workflows/ci.yml

@@ -14,7 +14,8 @@ jobs:
       - uses: actions/setup-go@v3
         with:
           go-version: '1.20'
-          # cache: true  # NOTE: Requires go.sum
+          cache: true
+      - uses: golangci/golangci-lint-action@v3
       - run: go build -v ./...
       - name: Test and Generate Coverage
         run: go test -v -race -coverprofile=coverage.txt -covermode=atomic ./...

.gitignore

@@ -0,0 +1,3 @@
+# Built assets
+git-lzc
+git-lzc-*

.golangci.yml

@@ -0,0 +1,3 @@
+linters:
+  enable:
+    - gofmt

Makefile

@@ -0,0 +1,2 @@
+git-lzc: cmd/ pkg/ *.go
+	go build ./cmd/git-lzc/

cmd/git-lzc/main.go

@@ -0,0 +1,35 @@
+package main
+
+import (
+	"fmt"
+	"os"
+	"strings"
+
+	lazycommit "github.com/spenserblack/git-lazy-commit"
+)
+
+func main() {
+	repo, err := lazycommit.OpenRepo(".")
+	onError(err)
+
+	noStaged, err := repo.NoStaged()
+	onError(err)
+
+	if noStaged {
+		onError(repo.StageAll())
+	}
+
+	hash, msg, err := repo.Commit()
+	onError(err)
+
+	msgLines := strings.Split(msg, "\n")
+
+	fmt.Printf("[%s] %s\n", hash, msgLines[0])
+}
+
+func onError(err error) {
+	if err != nil {
+		fmt.Fprintf(os.Stderr, "error: %v\n", err)
+		os.Exit(1)
+	}
+}

commit.go

@@ -0,0 +1,93 @@
+package lazycommit
+
+import (
+	"errors"
+	"fmt"
+	"strings"
+
+	"github.com/go-git/go-git/v5"
+	"github.com/go-git/go-git/v5/plumbing"
+
+	"github.com/spenserblack/git-lazy-commit/pkg/fileutils"
+)
+
+// Commit commits all changes in the repository.
+//
+// It returns the commit hash and the commit message.
+func (r *LazyRepo) Commit() (hash plumbing.Hash, msg string, err error) {
+	msg, err = r.CommitMsg()
+	if err != nil {
+		return
+	}
+
+	hash, err = r.wt.Commit(msg, &git.CommitOptions{})
+	return
+}
+
+// CommitMsg builds a commit message using the tracked files in the repository.
+func (r *LazyRepo) CommitMsg() (string, error) {
+	status, err := r.status()
+	if err != nil {
+		return "", err
+	}
+	for filename, fileStatus := range status {
+		if fileStatus.Staging == git.Unmodified || fileStatus.Staging == git.Untracked {
+			delete(status, filename)
+		}
+	}
+
+	if len(status) == 0 {
+		return "", errors.New("no tracked files")
+	}
+	if len(status) == 1 {
+		for filename, fileStatus := range status {
+			return singleFileMsg(filename, fileStatus), nil
+		}
+	}
+	return multiFileMsg(status), nil
+}
+
+func singleFileMsg(filename string, fileStatus *git.FileStatus) string {
+	statusString := ""
+	switch fileStatus.Staging {
+	case git.Added:
+		statusString = "Create"
+	case git.Deleted:
+		statusString = "Delete"
+	case git.Modified:
+		statusString = "Update"
+	case git.Renamed:
+		statusString = "Rename to"
+	case git.Copied:
+		statusString = "Copy to"
+	default:
+		statusString = "Do something to"
+	}
+
+	return fmt.Sprintf("%s %s", statusString, filename)
+}
+
+func multiFileMsg(status git.Status) string {
+	var builder strings.Builder
+
+	filenames := make([]string, 0, len(status))
+	for name := range status {
+		filenames = append(filenames, name)
+	}
+
+	sharedDir := fileutils.SharedDirectory(filenames)
+
+	if sharedDir == "/" {
+		builder.WriteString("Update files\n")
+	} else {
+		builder.WriteString(fmt.Sprintf("Update %s/\n", sharedDir))
+	}
+	builder.WriteRune('\n')
+
+	for filename, fileStatus := range status {
+		msgItem := singleFileMsg(filename, fileStatus)
+		builder.WriteString(fmt.Sprintf("- %s\n", msgItem))
+	}
+
+	return builder.String()
+}

commit_test.go

@@ -0,0 +1,55 @@
+package lazycommit
+
+import (
+	"strings"
+	"testing"
+
+	gitconfig "github.com/go-git/go-git/v5/config"
+)
+
+// Tests that a commit message can't be built when there are no staged changes.
+func TestBuildCommitMessageNoStaged(t *testing.T) {
+	dir := tempRepo(t)
+	repo, err := OpenRepo(dir)
+	if err != nil {
+		t.Fatal(err)
+	}
+	_, err = repo.CommitMsg()
+	if err == nil {
+		t.Fatal("expected error")
+	}
+}
+
+// Tests that commit commits all files in the worktree.
+func TestCommit(t *testing.T) {
+	dir := tempRepo(t)
+	updateConfig(t, dir, func(config *gitconfig.Config) {
+		config.User.Name = "Test User"
+		config.User.Email = "[email protected]"
+	})
+	addFile(t, dir, "test.txt", "test")
+	addFile(t, dir, "test2.txt", "test")
+
+	repo, err := OpenRepo(dir)
+	if err != nil {
+		t.Fatal(err)
+	}
+
+	_, msg, err := repo.Commit()
+	if err != nil {
+		t.Fatal(err)
+	}
+
+	wantHeader := "Update files"
+	wantBodyLines := []string{"- Create test.txt", "- Create test2.txt"}
+
+	if !strings.HasPrefix(msg, wantHeader) {
+		t.Errorf("expected commit message to start with %q, got %q", wantHeader, msg)
+	}
+
+	for _, line := range wantBodyLines {
+		if !strings.Contains(msg, line) {
+			t.Errorf("expected commit message to contain %q, got %q", line, msg)
+		}
+	}
+}

go.mod

@@ -1,3 +1,28 @@
 module github.com/spenserblack/git-lazy-commit
 
 go 1.20
+
+require (
+	github.com/go-git/go-billy/v5 v5.4.0
+	github.com/go-git/go-git/v5 v5.5.2
+)
+
+require (
+	github.com/Microsoft/go-winio v0.5.2 // indirect
+	github.com/ProtonMail/go-crypto v0.0.0-20221026131551-cf6655e29de4 // indirect
+	github.com/acomagu/bufpipe v1.0.3 // indirect
+	github.com/cloudflare/circl v1.1.0 // indirect
+	github.com/emirpasic/gods v1.18.1 // indirect
+	github.com/go-git/gcfg v1.5.0 // indirect
+	github.com/imdario/mergo v0.3.13 // indirect
+	github.com/jbenet/go-context v0.0.0-20150711004518-d14ea06fba99 // indirect
+	github.com/kevinburke/ssh_config v1.2.0 // indirect
+	github.com/pjbgf/sha1cd v0.2.3 // indirect
+	github.com/sergi/go-diff v1.1.0 // indirect
+	github.com/skeema/knownhosts v1.1.0 // indirect
+	github.com/xanzy/ssh-agent v0.3.3 // indirect
+	golang.org/x/crypto v0.3.0 // indirect
+	golang.org/x/net v0.2.0 // indirect
+	golang.org/x/sys v0.3.0 // indirect
+	gopkg.in/warnings.v0 v0.1.2 // indirect
+)