logging

.github/workflows/build.yml

@@ -2,7 +2,7 @@ name: Build
 on: [push]
 
 env:
-  GO_VERSION: "1.21"
+  GO_VERSION: "1.26"
 
 jobs:
 

.golangci.yml

@@ -29,9 +29,6 @@ linters:
       - path: cmd
         linters:
           - forbidigo
-      - path: confile
-        linters:
-          - forbidigo
       - path: fmt
         linters:
           - forbidigo

cmd/root.go

@@ -2,13 +2,14 @@ package cmd
 
 import (
 	"fmt"
+	"io"
 	"os"
 	"sort"
 
+	"github.com/gomicro/forge/confile"
+	"github.com/gomicro/scribe"
 	"github.com/spf13/cobra"
 	"github.com/spf13/viper"
-
-	"github.com/gomicro/forge/confile"
 )
 
 func init() {
@@ -68,6 +69,18 @@ func Execute() {
 }
 
 func rootFunc(cmd *cobra.Command, args []string) error {
+	verbose := viper.GetBool("verbose")
+
+	writer := io.Writer(io.Discard)
+	if verbose {
+		writer = os.Stdout
+	}
+
+	scrb, err := scribe.NewScribe(writer, scribe.DefaultTheme)
+	if err != nil {
+		return fmt.Errorf("setting up output: %w", err)
+	}
+
 	conf, err := confile.ParseFromFile()
 	if err != nil {
 		return err
@@ -81,7 +94,7 @@ func rootFunc(cmd *cobra.Command, args []string) error {
 	}
 
 	for _, s := range args {
-		err := conf.Steps[s].Execute(conf.Steps, conf.Envs, conf.Vars)
+		err := conf.Steps[s].Execute(conf.Steps, conf.Envs, conf.Vars, scrb)
 		if err != nil {
 			return fmt.Errorf("executing step %v: %w", s, err)
 		}

confile/file.go

@@ -4,7 +4,6 @@ import (
 	"errors"
 	"fmt"
 	"io/fs"
-	"io/ioutil"
 	"os"
 	"os/exec"
 	"runtime"
@@ -30,7 +29,7 @@ type File struct {
 // A File with the populated values is returned and any errors encountered while
 // trying to read the file.
 func ParseFromFile() (*File, error) {
-	b, err := ioutil.ReadFile(file)
+	b, err := os.ReadFile(file)
 	if err != nil {
 		return nil, fmt.Errorf("parseFromFile: reading config file: %w", err)
 	}
@@ -93,7 +92,7 @@ func (f *File) Fmt() error {
 		return fmt.Errorf("fmt: marshaling: %w", err)
 	}
 
-	err = ioutil.WriteFile(file, b, 0644)
+	err = os.WriteFile(file, b, 0644)
 	if err != nil {
 		return fmt.Errorf("fmt: writing file: %w", err)
 	}

confile/step.go

@@ -6,6 +6,7 @@ import (
 	"os/exec"
 
 	"github.com/gomicro/forge/vars"
+	"github.com/gomicro/scribe"
 	"github.com/spf13/viper"
 )
 
@@ -25,39 +26,39 @@ type Step struct {
 
 // Execute runs the command that is specified for the step. It returns the output
 // of the command and any errors it encounters.
-func (s *Step) Execute(allSteps map[string]*Step, projectEnvs map[string]string, vars *vars.Vars) error {
+func (s *Step) Execute(allSteps map[string]*Step, projectEnvs map[string]string, vars *vars.Vars, scrb scribe.Scriber) error {
 	skipPre := viper.GetBool("solo") || viper.GetBool("no-pre")
 	skipPost := viper.GetBool("solo") || viper.GetBool("no-post")
 
 	s.projectEnvs = projectEnvs
 	s.vars = vars
 
 	if len(s.Pre) > 0 && !skipPre {
-		err := s.executeSteps(s.Pre, allSteps)
+		err := s.executeSteps(s.Pre, allSteps, scrb)
 		if err != nil {
 			return fmt.Errorf("step: execute pre: %w", err)
 		}
 	}
 
 	if len(s.Steps) > 0 {
-		err := s.executeSteps(s.Steps, allSteps)
+		err := s.executeSteps(s.Steps, allSteps, scrb)
 		if err != nil {
 			return fmt.Errorf("step: execute steps: %w", err)
 		}
 	} else if len(s.Cmds) > 0 {
-		err := s.executeCmds()
+		err := s.executeCmds(scrb)
 		if err != nil {
 			return fmt.Errorf("step: execute cmds: %w", err)
 		}
 	} else {
-		err := s.executeCmd()
+		err := s.executeCmd(scrb)
 		if err != nil {
 			return fmt.Errorf("step: execute cmd: %w", err)
 		}
 	}
 
 	if len(s.Post) > 0 && !skipPost {
-		err := s.executeSteps(s.Post, allSteps)
+		err := s.executeSteps(s.Post, allSteps, scrb)
 		if err != nil {
 			return fmt.Errorf("step: execute post: %w", err)
 		}
@@ -66,16 +67,16 @@ func (s *Step) Execute(allSteps map[string]*Step, projectEnvs map[string]string,
 	return nil
 }
 
-func (s *Step) executeCmd() error {
+func (s *Step) executeCmd(scrb scribe.Scriber) error {
 	cmdString := s.vars.Process(s.Cmd)
-	return executeCmd(cmdString, s.Envs, s.projectEnvs, s.vars)
+	return executeCmd(cmdString, s.Envs, s.projectEnvs, s.vars, scrb)
 }
 
-func (s *Step) executeCmds() error {
+func (s *Step) executeCmds(scrb scribe.Scriber) error {
 	for _, c := range s.Cmds {
 		cmdString := s.vars.Process(c)
 
-		err := executeCmd(cmdString, s.Envs, s.projectEnvs, s.vars)
+		err := executeCmd(cmdString, s.Envs, s.projectEnvs, s.vars, scrb)
 		if err != nil {
 			return fmt.Errorf("cmds: cmd exec: %w", err)
 		}
@@ -84,14 +85,14 @@ func (s *Step) executeCmds() error {
 	return nil
 }
 
-func (s *Step) executeSteps(execList []string, allSteps map[string]*Step) error {
+func (s *Step) executeSteps(execList []string, allSteps map[string]*Step, scrb scribe.Scriber) error {
 	for _, step := range execList {
 		s, ok := allSteps[step]
 		if !ok {
 			return fmt.Errorf("step does not exist: %v", step)
 		}
 
-		err := s.Execute(allSteps, s.projectEnvs, s.vars)
+		err := s.Execute(allSteps, s.projectEnvs, s.vars, scrb)
 		if err != nil {
 			return err
 		}
@@ -100,10 +101,8 @@ func (s *Step) executeSteps(execList []string, allSteps map[string]*Step) error
 	return nil
 }
 
-func executeCmd(cmdString string, stepEnvs, projectEnvs map[string]string, vars *vars.Vars) error {
-	if viper.GetBool("verbose") {
-		fmt.Printf("$ %s\n", cmdString)
-	}
+func executeCmd(cmdString string, stepEnvs, projectEnvs map[string]string, vars *vars.Vars, scrb scribe.Scriber) error {
+	scrb.Print(fmt.Sprintf("$ %s", cmdString))
 
 	cmd := exec.Command("bash", "-c", cmdString)
 

forge.yaml

@@ -8,6 +8,9 @@ steps:
       GOOS: '{{.Os}}'
       VERSION: '{{.ShortSha}}'
     cmd: go build -ldflags "-X 'github.com/gomicro/forge/cmd.Version=$VERSION'" -o {{.Project}} .
+  clean:
+     help: Cleans up the project by removing the binary and other generated content
+     cmd: go clean
   coverage:
     help: Generates the code coverage from all the tests
     cmd: docker run gomicro/gocover

go.mod

@@ -1,12 +1,32 @@
 module github.com/gomicro/forge
 
-go 1.15
+go 1.23.3
 
 require (
+	github.com/gomicro/scribe v0.0.0-20250818044048-c8eae6079552
 	github.com/spf13/cobra v1.2.1
 	github.com/spf13/viper v1.8.1
 	github.com/stretchr/testify v1.11.1
-	golang.org/x/sys v0.0.0-20210630005230-0f9fa26af87c // indirect
-	golang.org/x/text v0.3.6 // indirect
 	gopkg.in/yaml.v3 v3.0.1
 )
+
+require (
+	github.com/davecgh/go-spew v1.1.1 // indirect
+	github.com/fsnotify/fsnotify v1.4.9 // indirect
+	github.com/hashicorp/hcl v1.0.0 // indirect
+	github.com/inconshreveable/mousetrap v1.0.0 // indirect
+	github.com/magiconair/properties v1.8.5 // indirect
+	github.com/mitchellh/mapstructure v1.4.1 // indirect
+	github.com/pelletier/go-toml v1.9.3 // indirect
+	github.com/pmezard/go-difflib v1.0.0 // indirect
+	github.com/spf13/afero v1.6.0 // indirect
+	github.com/spf13/cast v1.3.1 // indirect
+	github.com/spf13/jwalterweatherman v1.1.0 // indirect
+	github.com/spf13/pflag v1.0.5 // indirect
+	github.com/subosito/gotenv v1.2.0 // indirect
+	golang.org/x/sys v0.25.0 // indirect
+	golang.org/x/text v0.3.6 // indirect
+	gopkg.in/check.v1 v1.0.0-20190902080502-41f04d3bba15 // indirect
+	gopkg.in/ini.v1 v1.62.0 // indirect
+	gopkg.in/yaml.v2 v2.4.0 // indirect
+)

go.sum

@@ -39,6 +39,12 @@ cloud.google.com/go/storage v1.10.0/go.mod h1:FLPqc6j+Ki4BU591ie1oL6qBQGu2Bl/tZ9
 dmitri.shuralyov.com/gpu/mtl v0.0.0-20190408044501-666a987793e9/go.mod h1:H6x//7gZCb22OMCxBHrMx7a5I7Hp++hsVxbQ4BYO7hU=
 github.com/BurntSushi/toml v0.3.1/go.mod h1:xHWCNGjB5oqiDr8zfno3MHue2Ht5sIBksp03qcyfWMU=
 github.com/BurntSushi/xgb v0.0.0-20160522181843-27f122750802/go.mod h1:IVnqGOEym/WlBOVXweHU+Q+/VP0lqqI8lqeDx9IjBqo=
+github.com/alecthomas/assert v1.0.0 h1:3XmGh/PSuLzDbK3W2gUbRXwgW5lqPkuqvRgeQ30FI5o=
+github.com/alecthomas/assert v1.0.0/go.mod h1:va/d2JC+M7F6s+80kl/R3G7FUiW6JzUO+hPhLyJ36ZY=
+github.com/alecthomas/colour v0.1.0 h1:nOE9rJm6dsZ66RGWYSFrXw461ZIt9A6+nHgL7FRrDUk=
+github.com/alecthomas/colour v0.1.0/go.mod h1:QO9JBoKquHd+jz9nshCh40fOfO+JzsoXy8qTHF68zU0=
+github.com/alecthomas/repr v0.0.0-20210801044451-80ca428c5142 h1:8Uy0oSf5co/NZXje7U1z8Mpep++QJOldL2hs/sBQf48=
+github.com/alecthomas/repr v0.0.0-20210801044451-80ca428c5142/go.mod h1:2kn6fqh/zIyPLmm3ugklbEi5hg5wS435eygvNfaDQL8=
 github.com/antihax/optional v1.0.0/go.mod h1:uupD/76wgC+ih3iEmQUL+0Ugr19nfwCT1kdvxnR2qWY=
 github.com/armon/circbuf v0.0.0-20150827004946-bbbad097214e/go.mod h1:3U/XgcO3hCbHZ8TKRvWD2dDTCfh9M9ya+I9JpbB7O8o=
 github.com/armon/go-metrics v0.0.0-20180917152333-f0300d1749da/go.mod h1:Q73ZrmVTwzkszR9V5SSuryQ31EELlFMUz1kKyl939pY=
@@ -104,6 +110,10 @@ github.com/golang/protobuf v1.4.3/go.mod h1:oDoupMAO8OvCJWAcko0GGGIgR6R6ocIYbsSw
 github.com/golang/protobuf v1.5.0/go.mod h1:FsONVRAS9T7sI+LIUmWTfcYkHO4aIWwzhcaSAoJOfIk=
 github.com/golang/protobuf v1.5.1/go.mod h1:DopwsBzvsk0Fs44TXzsVbJyPhcCPeIwnvohx4u74HPM=
 github.com/golang/protobuf v1.5.2/go.mod h1:XVQd3VNwM+JqD3oG2Ue2ip4fOMUkwXdXDdiuN0vRsmY=
+github.com/gomicro/penname v0.1.1 h1:a2qxU00YqcnJK4Ll2OYDVQtaAxBZP9rWj8s/C1i8kZg=
+github.com/gomicro/penname v0.1.1/go.mod h1:cDMwvmx4wzDLYzPNR9Z9sEw/ekYfpyiQMEtGMusHfgI=
+github.com/gomicro/scribe v0.0.0-20250818044048-c8eae6079552 h1:IhSzRw/HZn8ZdpbxFHGt+o8mJFODtoqNpuNBWocJq1o=
+github.com/gomicro/scribe v0.0.0-20250818044048-c8eae6079552/go.mod h1:Xe4GOodbsqCXIlsCq1LvIYSGpzqHTNAuF8C8omS/334=
 github.com/google/btree v0.0.0-20180813153112-4030bb1f1f0c/go.mod h1:lNA+9X1NB3Zf8V7Ke586lFgjr2dZNuvo3lPJSGZ5JPQ=
 github.com/google/btree v1.0.0/go.mod h1:lNA+9X1NB3Zf8V7Ke586lFgjr2dZNuvo3lPJSGZ5JPQ=
 github.com/google/go-cmp v0.2.0/go.mod h1:oXzfMopK8JAjlY9xF4vHSVASa0yLyX7SntLO5aqRK0M=
@@ -181,6 +191,8 @@ github.com/magiconair/properties v1.8.5 h1:b6kJs+EmPFMYGkow9GiUyCyOvIwYetYJ3fSaW
 github.com/magiconair/properties v1.8.5/go.mod h1:y3VJvCyxH9uVvJTWEGAELF3aiYNyPKd5NZ3oSwXrF60=
 github.com/mattn/go-colorable v0.0.9/go.mod h1:9vuHe8Xs5qXnSaW/c/ABM9alt+Vo+STaOChaDxuIBZU=
 github.com/mattn/go-isatty v0.0.3/go.mod h1:M+lRXTBqGeGNdLjl/ufCoiOlB5xdOkqRJdNxMWT7Zi4=
+github.com/mattn/go-isatty v0.0.20 h1:xfD0iDuEKnDkl03q4limB+vH+GxLEtL/jb4xVJSWWEY=
+github.com/mattn/go-isatty v0.0.20/go.mod h1:W+V8PltTTMOvKvAeJH7IuucS94S2C6jfK/D7dTCTo3Y=
 github.com/miekg/dns v1.0.14/go.mod h1:W1PPwlIAgtquWBMBEV9nkV9Cazfe8ScdGz/Lj7v3Nrg=
 github.com/mitchellh/cli v1.0.0/go.mod h1:hNIlj7HEI86fIcpObd7a0FcrxTWetlwJDGcceTlRvqc=
 github.com/mitchellh/go-homedir v1.0.0/go.mod h1:SfyaCUpYCn1Vlf4IUYiD9fPX4A5wJrkLzIz1N1q0pr0=
@@ -208,6 +220,8 @@ github.com/rogpeppe/go-internal v1.3.0/go.mod h1:M8bDsm7K2OlrFYOpmOWEs/qY81heoFR
 github.com/russross/blackfriday/v2 v2.0.1/go.mod h1:+Rmxgy9KzJVeS9/2gXHxylqXiyQDYRxCVz55jmeOWTM=
 github.com/ryanuber/columnize v0.0.0-20160712163229-9b3edd62028f/go.mod h1:sm1tb6uqfes/u+d4ooFouqFdy9/2g9QGwK3SQygK0Ts=
 github.com/sean-/seed v0.0.0-20170313163322-e2103e2c3529/go.mod h1:DxrIzT+xaE7yg65j358z/aeFdxmN0P9QXhEzd20vsDc=
+github.com/sergi/go-diff v1.2.0 h1:XU+rvMAioB0UC3q1MFrIQy4Vo5/4VsRDQQXHsEya6xQ=
+github.com/sergi/go-diff v1.2.0/go.mod h1:STckp+ISIX8hZLjrqAeVduY0gWCT9IjLuqbuNXdaHfM=
 github.com/shurcooL/sanitized_anchor_name v1.0.0/go.mod h1:1NzhyTcUVG4SuEtjjoZeVRXNmyL/1OwPU0+IJeTBvfc=
 github.com/smartystreets/assertions v0.0.0-20180927180507-b2de0cb4f26d h1:zE9ykElWQ6/NYmHa3jpm/yHnI4xSofP+UP6SpjHcSeM=
 github.com/smartystreets/assertions v0.0.0-20180927180507-b2de0cb4f26d/go.mod h1:OnSkiWE9lh6wB0YB77sQom3nweQdgAjqCqsofrRNTgc=
@@ -226,18 +240,12 @@ github.com/spf13/pflag v1.0.5/go.mod h1:McXfInJRrz4CZXVZOBLb0bTZqETkiAhM9Iw0y3An
 github.com/spf13/viper v1.8.1 h1:Kq1fyeebqsBfbjZj4EL7gj2IO0mMaiyjYUWcUsl2O44=
 github.com/spf13/viper v1.8.1/go.mod h1:o0Pch8wJ9BVSWGQMbra6iw0oQ5oktSIBaujf1rJH9Ns=
 github.com/stretchr/objx v0.1.0/go.mod h1:HFkY916IF+rwdDfMAkV7OtwuqBVzrE8GR6GFx+wExME=
-github.com/stretchr/objx v0.4.0/go.mod h1:YvHI0jy2hoMjB+UWwv71VJQ9isScKT/TqJzVSSt89Yw=
-github.com/stretchr/objx v0.5.0/go.mod h1:Yh+to48EsGEfYuaHDzXPcE3xhTkx73EhmCGUpEOglKo=
-github.com/stretchr/objx v0.5.2/go.mod h1:FRsXN1f5AsAjCGJKqEizvkpNtU+EGNCLh3NxZ/8L+MA=
 github.com/stretchr/testify v1.2.2/go.mod h1:a8OnRcib4nhh0OaRAV+Yts87kKdq0PP7pXfy6kDkUVs=
 github.com/stretchr/testify v1.3.0/go.mod h1:M5WIy9Dh21IEIfnGCwXGc5bZfKNJtfHm1UVUgZn+9EI=
 github.com/stretchr/testify v1.4.0/go.mod h1:j7eGeouHqKxXV5pUuKE4zz7dFj8WfuZ+81PSLYec5m4=
 github.com/stretchr/testify v1.5.1/go.mod h1:5W2xD1RspED5o8YsWQXVCued0rvSQ+mT+I5cxcmMvtA=
 github.com/stretchr/testify v1.6.1/go.mod h1:6Fq8oRcR53rry900zMqJjRRixrwX3KX962/h/Wwjteg=
 github.com/stretchr/testify v1.7.0/go.mod h1:6Fq8oRcR53rry900zMqJjRRixrwX3KX962/h/Wwjteg=
-github.com/stretchr/testify v1.7.1/go.mod h1:6Fq8oRcR53rry900zMqJjRRixrwX3KX962/h/Wwjteg=
-github.com/stretchr/testify v1.8.0/go.mod h1:yNjHg4UonilssWZ8iaSj1OCr/vHnekPRkoO+kdMU+MU=
-github.com/stretchr/testify v1.8.4/go.mod h1:sz/lmYIOXD/1dqDmKjjqLyZ2RngseejIcXlSw2iwfAo=
 github.com/stretchr/testify v1.11.1 h1:7s2iGBzp5EwR7/aIZr8ao5+dra3wiQyKjjFuvgVKu7U=
 github.com/stretchr/testify v1.11.1/go.mod h1:wZwfW3scLgRK+23gO65QZefKpKQRnfz6sD981Nm4B6U=
 github.com/subosito/gotenv v1.2.0 h1:Slr1R9HxAlEKefgq5jn9U+DnETlIUa6HfgEzj0g5d7s=
@@ -402,8 +410,8 @@ golang.org/x/sys v0.0.0-20210320140829-1e4c9ba3b0c4/go.mod h1:h1NjWce9XRLGQEsW7w
 golang.org/x/sys v0.0.0-20210330210617-4fbd30eecc44/go.mod h1:h1NjWce9XRLGQEsW7wpKNCjG9DtNlClVuFLEZdDNbEs=
 golang.org/x/sys v0.0.0-20210403161142-5e06dd20ab57/go.mod h1:h1NjWce9XRLGQEsW7wpKNCjG9DtNlClVuFLEZdDNbEs=
 golang.org/x/sys v0.0.0-20210510120138-977fb7262007/go.mod h1:oPkhp1MJrh7nUepCBck5+mAzfO9JrbApNNgaTdGDITg=
-golang.org/x/sys v0.0.0-20210630005230-0f9fa26af87c h1:F1jZWGFhYfh0Ci55sIpILtKKK8p3i2/krTr0H1rg74I=
-golang.org/x/sys v0.0.0-20210630005230-0f9fa26af87c/go.mod h1:oPkhp1MJrh7nUepCBck5+mAzfO9JrbApNNgaTdGDITg=
+golang.org/x/sys v0.25.0 h1:r+8e+loiHxRqhXVl6ML1nO3l1+oFoWbnlu2Ehimmi34=
+golang.org/x/sys v0.25.0/go.mod h1:/VUhepiaJMQUp4+oa/7Zr1D23ma6VTLIYjOOTFZPUcA=
 golang.org/x/term v0.0.0-20201126162022-7de9c90e9dd1/go.mod h1:bj7SfCRtBDWHUb9snDiAeCFNEtKQo2Wmx5Cou7ajbmo=
 golang.org/x/text v0.0.0-20170915032832-14c0d48ead0c/go.mod h1:NqM8EUOU14njkJ3fqMW+pc6Ldnwhi/IjpwHt7yyuwOQ=
 golang.org/x/text v0.3.0/go.mod h1:NqM8EUOU14njkJ3fqMW+pc6Ldnwhi/IjpwHt7yyuwOQ=
@@ -575,8 +583,9 @@ google.golang.org/protobuf v1.25.0/go.mod h1:9JNX74DMeImyA3h4bdi1ymwjUzf21/xIlba
 google.golang.org/protobuf v1.26.0-rc.1/go.mod h1:jlhhOSvTdKEhbULTjvd4ARK9grFBp09yW+WbY/TyQbw=
 google.golang.org/protobuf v1.26.0/go.mod h1:9q0QmTI4eRPtz6boOQmLYwt+qCgq0jsYwAQnmE0givc=
 gopkg.in/check.v1 v0.0.0-20161208181325-20d25e280405/go.mod h1:Co6ibVJAznAaIkqp8huTwlJQCZ016jof/cbN4VW5Yz0=
-gopkg.in/check.v1 v1.0.0-20180628173108-788fd7840127 h1:qIbj1fsPNlZgppZ+VLlY7N33q108Sa+fhmuc+sWQYwY=
 gopkg.in/check.v1 v1.0.0-20180628173108-788fd7840127/go.mod h1:Co6ibVJAznAaIkqp8huTwlJQCZ016jof/cbN4VW5Yz0=
+gopkg.in/check.v1 v1.0.0-20190902080502-41f04d3bba15 h1:YR8cESwS4TdDjEe65xsg0ogRM/Nc3DYOhEAlW+xobZo=
+gopkg.in/check.v1 v1.0.0-20190902080502-41f04d3bba15/go.mod h1:Co6ibVJAznAaIkqp8huTwlJQCZ016jof/cbN4VW5Yz0=
 gopkg.in/errgo.v2 v2.1.0/go.mod h1:hNsd1EY+bozCKY1Ytp96fpM3vjJbqLJn88ws8XvfDNI=
 gopkg.in/ini.v1 v1.62.0 h1:duBzk771uxoUuOlyRLkHsygud9+5lrlGjdFBb4mSKDU=
 gopkg.in/ini.v1 v1.62.0/go.mod h1:pNLf8WUiyNEtQjuu5G5vTm06TEv9tsIgeAvK8hOrP4k=