Add pretty debug logging

Author: jclem

cmd/cmd.go

@@ -0,0 +1,12 @@
+package cmd
+
+import (
+	"context"
+	"os"
+)
+
+func Execute() {
+	if err := rootCmd.ExecuteContext(context.Background()); err != nil {
+		os.Exit(1)
+	}
+}

cmd/concurrently.go

@@ -6,7 +6,6 @@ import (
 	"os"
 
 	"github.com/jclem/konk/konk"
-	"github.com/jclem/konk/konk/debugger"
 	"github.com/spf13/cobra"
 )
 
@@ -33,8 +32,11 @@ konk run concurrently -g -n lint -n test
 
 konk run concurrently -bgcL -n "check:*"`,
 	RunE: func(cmd *cobra.Command, args []string) error {
-		dbg := debugger.Get(cmd.Context())
-		dbg.Flags(cmd)
+		ctx := cmd.Context()
+
+		if debug {
+			cmd.DebugFlags()
+		}
 
 		if workingDirectory != "" {
 			if err := os.Chdir(workingDirectory); err != nil {
@@ -53,7 +55,7 @@ konk run concurrently -bgcL -n "check:*"`,
 
 		labels := collectLabels(cmdStrings)
 
-		commands, err := konk.RunConcurrently(cmd.Context(), konk.RunConcurrentlyConfig{
+		commands, err := konk.RunConcurrently(ctx, konk.RunConcurrentlyConfig{
 			Commands:        cmdParts,
 			Labels:          labels,
 			Env:             make([]string, 0),
@@ -64,9 +66,7 @@ konk run concurrently -bgcL -n "check:*"`,
 			NoShell:         noShell,
 		})
 
-		if commands != nil {
-			dbg.Prettyln(commands)
-		}
+		debugCommands(ctx, commands)
 
 		if err != nil {
 			return fmt.Errorf("running commands: %w", err)

cmd/proc.go

@@ -7,7 +7,6 @@ import (
 	"strings"
 
 	"github.com/jclem/konk/konk"
-	"github.com/jclem/konk/konk/debugger"
 	"github.com/spf13/cobra"
 )
 
@@ -21,8 +20,11 @@ var procCommand = cobra.Command{
 	Aliases: []string{"p"},
 	Short:   "Run commands defined in a Procfile (alias: p)",
 	RunE: func(cmd *cobra.Command, _ []string) error {
-		dbg := debugger.Get(cmd.Context())
-		dbg.Flags(cmd)
+		ctx := cmd.Context()
+
+		if debug {
+			cmd.DebugFlags()
+		}
 
 		if workingDirectory != "" {
 			if err := os.Chdir(workingDirectory); err != nil {
@@ -85,7 +87,7 @@ var procCommand = cobra.Command{
 			}
 		}
 
-		commands, err := konk.RunConcurrently(cmd.Context(), konk.RunConcurrentlyConfig{
+		commands, err := konk.RunConcurrently(ctx, konk.RunConcurrentlyConfig{
 			Commands:        commandStrings,
 			Labels:          commandLabels,
 			Env:             envLines,
@@ -96,9 +98,7 @@ var procCommand = cobra.Command{
 			NoShell:         noShell,
 		})
 
-		if commands != nil {
-			dbg.Prettyln(commands)
-		}
+		debugCommands(ctx, commands)
 
 		if err != nil {
 			return fmt.Errorf("running commands: %w", err)

cmd/root.go

@@ -2,9 +2,12 @@ package cmd
 
 import (
 	"context"
+	"log/slog"
 	"os"
+	"strconv"
 
-	"github.com/jclem/konk/konk/debugger"
+	"github.com/golang-cz/devslog"
+	"github.com/jclem/konk/konk"
 	"github.com/spf13/cobra"
 )
 
@@ -26,14 +29,28 @@ var rootCmd = &cobra.Command{
 		// Ensures that usage isn't printed for errors such as non-zero exits.
 		// SEE: https://github.com/spf13/cobra/issues/340#issuecomment-378726225
 		cmd.SilenceUsage = true
+
+		level := slog.LevelInfo
+		if debug {
+			level = slog.LevelDebug
+		}
+
+		slog.SetDefault(slog.New(devslog.NewHandler(os.Stdout, &devslog.Options{ //nolint:exhaustruct // Fields not needed.
+			HandlerOptions: &slog.HandlerOptions{Level: level}, //nolint:exhaustruct // Fields not needed.
+		})))
 	},
 }
 
-func Execute() {
+func init() {
 	rootCmd.PersistentFlags().BoolVarP(&debug, "debug", "D", false, "debug mode")
-	ctx := debugger.WithDebugger(context.Background(), &debug)
+}
 
-	if err := rootCmd.ExecuteContext(ctx); err != nil {
-		os.Exit(1)
+func debugCommands(ctx context.Context, commands []*konk.Command) {
+	if commands != nil {
+		var attrs []any
+		for i, c := range commands {
+			attrs = append(attrs, slog.Any(strconv.Itoa(i), c))
+		}
+		slog.DebugContext(ctx, "commands", attrs...)
 	}
 }

cmd/serially.go

@@ -7,7 +7,6 @@ import (
 	"os"
 
 	"github.com/jclem/konk/konk"
-	"github.com/jclem/konk/konk/debugger"
 	"github.com/mattn/go-shellwords"
 	"github.com/spf13/cobra"
 )
@@ -24,8 +23,11 @@ konk run serially "echo foo" "echo bar"
 
 konk run serially -n build -n deploy`,
 	RunE: func(cmd *cobra.Command, args []string) error {
-		dbg := debugger.Get(cmd.Context())
-		dbg.Flags(cmd)
+		ctx := cmd.Context()
+
+		if debug {
+			cmd.DebugFlags()
+		}
 
 		if workingDirectory != "" {
 			if err := os.Chdir(workingDirectory); err != nil {
@@ -79,7 +81,7 @@ konk run serially -n build -n deploy`,
 			commands[i] = c
 		}
 
-		dbg.Prettyln(commands)
+		debugCommands(ctx, commands)
 
 		for _, c := range commands {
 			ctx, cancel := context.WithCancel(context.Background())

go.mod

@@ -7,6 +7,7 @@ require github.com/spf13/cobra v1.8.1
 require (
 	github.com/cpuguy83/go-md2man/v2 v2.0.4 // indirect
 	github.com/davecgh/go-spew v1.1.1 // indirect
+	github.com/golang-cz/devslog v0.0.11 // indirect
 	github.com/kr/text v0.2.0 // indirect
 	github.com/lucasb-eyer/go-colorful v1.2.0 // indirect
 	github.com/mattn/go-isatty v0.0.14 // indirect

go.sum

@@ -7,6 +7,8 @@ github.com/creack/pty v1.1.9/go.mod h1:oKZEueFk5CKHvIhNR5MUki03XCEU+Q6VDXinZuGJ3
 github.com/davecgh/go-spew v1.1.0/go.mod h1:J7Y8YcW2NihsgmVo/mv3lAwl/skON4iLHjSsI+c5H38=
 github.com/davecgh/go-spew v1.1.1 h1:vj9j/u1bqnvCEfJOwUhtlOARqs3+rkHYY13jYWTU97c=
 github.com/davecgh/go-spew v1.1.1/go.mod h1:J7Y8YcW2NihsgmVo/mv3lAwl/skON4iLHjSsI+c5H38=
+github.com/golang-cz/devslog v0.0.11 h1:v4Yb9o0ZpuZ/D8ZrtVw1f9q5XrjnkxwHF1XmWwO8IHg=
+github.com/golang-cz/devslog v0.0.11/go.mod h1:bSe5bm0A7Nyfqtijf1OMNgVJHlWEuVSXnkuASiE1vV8=
 github.com/inconshreveable/mousetrap v1.0.0 h1:Z8tu5sraLXCXIcARxBp/8cbvlwVa7Z1NHg9XEKhtSvM=
 github.com/inconshreveable/mousetrap v1.0.0/go.mod h1:PxqpIevigyE2G7u3NXJIT2ANytuPF1OarO4DADm73n8=
 github.com/inconshreveable/mousetrap v1.1.0 h1:wN+x4NVGpMsO7ErUn/mUI3vEoE6Jt13X2s0bqwp9tc8=

konk/command.go

@@ -5,6 +5,7 @@ import (
 	"context"
 	"errors"
 	"fmt"
+	"log/slog"
 	"math/rand"
 	"os"
 	"os/exec"
@@ -21,6 +22,15 @@ type Command struct {
 	prefix string
 }
 
+var _ slog.LogValuer = (*Command)(nil)
+
+func (c *Command) LogValue() slog.Value {
+	return slog.GroupValue(
+		slog.String("command", c.cmd.String()),
+		slog.String("prefix", c.prefix),
+	)
+}
+
 type RunCommandConfig struct {
 	AggregateOutput bool
 	StopOnCancel    bool