Show candidate command-line invocation on dry run

Author: ammario

cmd/aicommit/main.go

@@ -6,8 +6,10 @@ import (
 	"io"
 	"os"
 	"os/exec"
+	"path/filepath"
 	"strings"
 
+	"al.essio.dev/pkg/shellescape"
 	"github.com/coder/aicommit"
 	"github.com/coder/pretty"
 	"github.com/coder/serpent"
@@ -30,7 +32,7 @@ func debugf(format string, args ...any) {
 	}
 	// Gray
 	c := pretty.FgColor(colorProfile.Color("#808080"))
-	pretty.Fprintf(os.Stderr, c, format, args...)
+	pretty.Fprintf(os.Stderr, c, "debug: "+format+"\n", args...)
 }
 
 func getLastCommitHash() (string, error) {
@@ -51,6 +53,16 @@ func resolveRef(ref string) (string, error) {
 	return strings.TrimSpace(string(output)), nil
 }
 
+func formatShellCommand(cmd *exec.Cmd) string {
+	buf := &strings.Builder{}
+	buf.WriteString(filepath.Base(cmd.Path))
+	for _, arg := range cmd.Args[1:] {
+		buf.WriteString(" ")
+		buf.WriteString(shellescape.Quote(arg))
+	}
+	return buf.String()
+}
+
 func run(inv *serpent.Invocation, opts runOptions) error {
 	workdir, err := os.Getwd()
 	if err != nil {
@@ -84,7 +96,7 @@ func run(inv *serpent.Invocation, opts runOptions) error {
 	ctx := inv.Context()
 	if debugMode {
 		for _, msg := range msgs {
-			debugf("%s: (%v tokens)\n %s\n\n", msg.Role, aicommit.CountTokens(msg), aicommit.Ellipse(msg.Content, 100))
+			debugf("%s: (%v tokens)\n %s\n\n", msg.Role, aicommit.CountTokens(msg), msg.Content)
 		}
 		debugf("prompt includes %d commits\n", len(msgs)/2)
 	}
@@ -118,15 +130,23 @@ func run(inv *serpent.Invocation, opts runOptions) error {
 		}
 		// Usage is only sent in the last message.
 		if resp.Usage != nil {
-			debugf("total tokens: %d", resp.Usage.TotalTokens)
+			debugf("\ntotal tokens: %d", resp.Usage.TotalTokens)
 			break
 		}
 		c := resp.Choices[0].Delta.Content
 		msg.WriteString(c)
 		pretty.Fprintf(inv.Stdout, color, "%s", c)
 	}
+	inv.Stdout.Write([]byte("\n"))
+
+	cmd := exec.Command("git", "commit", "-m", msg.String())
+	if opts.amend {
+		cmd.Args = append(cmd.Args, "--amend")
+	}
 
 	if opts.dryRun {
+		fmt.Fprintf(inv.Stdout, "Run the following command to commit:\n")
+		inv.Stdout.Write([]byte("" + formatShellCommand(cmd) + "\n"))
 		return nil
 	}
 	if opts.ref != "" {
@@ -137,10 +157,6 @@ func run(inv *serpent.Invocation, opts runOptions) error {
 	inv.Stdout.Write([]byte("\n"))
 
 	inv.Stdout.Write([]byte("\n"))
-	cmd := exec.Command("git", "commit", "-m", msg.String())
-	if opts.amend {
-		cmd.Args = append(cmd.Args, "--amend")
-	}
 
 	cmd.Stderr = os.Stderr
 	cmd.Stdout = os.Stdout

go.mod

@@ -34,6 +34,7 @@ require (
 )
 
 require (
+	al.essio.dev/pkg/shellescape v1.5.0
 	cdr.dev/slog v1.6.2-0.20240126064726-20367d4aede6 // indirect
 	github.com/aymanbagabas/go-osc52/v2 v2.0.1 // indirect
 	github.com/go-git/go-git/v5 v5.12.0

go.sum

@@ -1,3 +1,5 @@
+al.essio.dev/pkg/shellescape v1.5.0 h1:7oTvSsQ5kg9WksA9O58y9wjYnY4jP0CL82/Q8WLUGKk=
+al.essio.dev/pkg/shellescape v1.5.0/go.mod h1:6sIqp7X2P6mThCQ7twERpZTuigpr6KbZWtls1U8I890=
 cdr.dev/slog v1.6.2-0.20240126064726-20367d4aede6 h1:KHblWIE/KHOwQ6lEbMZt6YpcGve2FEZ1sDtrW1Am5UI=
 cdr.dev/slog v1.6.2-0.20240126064726-20367d4aede6/go.mod h1:NaoTA7KwopCrnaSb0JXTC0PTp/O/Y83Lndnq0OEV3ZQ=
 cloud.google.com/go/compute v1.23.0 h1:tP41Zoavr8ptEqaW6j+LQOnyBBhO7OkOMAGrgLopTwY=
@@ -63,6 +65,8 @@ github.com/golang/protobuf v1.5.3 h1:KhyjKVUg7Usr/dYsdSqoFveMYd5ko72D+zANwlG1mmg
 github.com/golang/protobuf v1.5.3/go.mod h1:XVQd3VNwM+JqD3oG2Ue2ip4fOMUkwXdXDdiuN0vRsmY=
 github.com/google/go-cmp v0.6.0 h1:ofyhxvXcZhMsU5ulbFiLKl/XBFqE1GSq7atu8tAmTRI=
 github.com/google/go-cmp v0.6.0/go.mod h1:17dUlkBOakJ0+DkrSSNjCkIjxS6bF9zb3elmeNGIjoY=
+github.com/google/shlex v0.0.0-20191202100458-e7afc7fbc510 h1:El6M4kTTCOh6aBiKaUGG7oYTSPP8MxqL4YI3kZKwcP4=
+github.com/google/shlex v0.0.0-20191202100458-e7afc7fbc510/go.mod h1:pupxD2MaaD3pAXIBCelhxNneeOaAeabZDe5s4K6zSpQ=
 github.com/hashicorp/errwrap v1.0.0/go.mod h1:YH+1FKiLXxHSkmPseP+kNlulaMuP3n2brvKWEqk/Jc4=
 github.com/hashicorp/errwrap v1.1.0 h1:OxrOeh75EUXMY8TBjag2fzXGZ40LB6IKw45YeGUDY2I=
 github.com/hashicorp/errwrap v1.1.0/go.mod h1:YH+1FKiLXxHSkmPseP+kNlulaMuP3n2brvKWEqk/Jc4=

prompt.go

@@ -73,7 +73,9 @@ func BuildPrompt(log io.Writer, dir string,
 			Content: "You are a helpful assistant that generates commit messages for git diffs." +
 				"Generate nothing but the commit message. Do not include any other text." +
 				"Commit messages should have a maximum column width of 100 characters." +
-				"Extended descriptions go on a new line. Follow the style of the existing commit messages.",
+				"Extended descriptions go on a new line. Follow the style of the existing commit messages." +
+				"Each message is an individual diff for and individual commit. Do not describe changes from previous commits" +
+				"in the new commit message.",
 		},
 	}