go-task/internal/output/group.go

package output

import (
	"bytes"
	"io"

	"github.com/go-task/task/v3/internal/templater"
)

type Group struct {
	Begin, End string
	ErrorOnly  bool
}

func (g Group) WrapWriter(stdOut, _ io.Writer, _ string, cache *templater.Cache) (io.Writer, io.Writer, CloseFunc) {
	gw := &groupWriter{writer: stdOut}
	if g.Begin != "" {
		gw.begin = templater.Replace(g.Begin, cache) + "\n"
	}
	if g.End != "" {
		gw.end = templater.Replace(g.End, cache) + "\n"
	}
	return gw, gw, func(err error) error {
		if g.ErrorOnly && err == nil {
			return nil
		}

		return gw.close()
	}
}

type groupWriter struct {
	writer     io.Writer
	buff       bytes.Buffer
	begin, end string
}

func (gw *groupWriter) Write(p []byte) (int, error) {
	return gw.buff.Write(p)
}

func (gw *groupWriter) close() error {
	if gw.buff.Len() == 0 {
		// don't print begin/end messages if there's no buffered entries
		return nil
	}
	if len(gw.begin) > 0 {
		// Rewrite the gw.buff with the beginning text.
		s := gw.buff.String()
		gw.buff.Reset()
		gw.buff.WriteString(gw.begin)
		gw.buff.WriteString(s)
	}
	gw.buff.WriteString(gw.end)
	// Return the entire gw.buff to ensure the group is written atomically to stdout.
	_, err := io.Copy(gw.writer, &gw.buff)
	return err
}