Merge branch 'main' into main

Author: fatih

.github/workflows/go.yml

@@ -39,7 +39,7 @@ jobs:
       run: "go vet ./..."
 
     - name: Staticcheck
-      uses: dominikh/staticcheck-action@v1.3.1
+      uses: dominikh/staticcheck-action@v1.4.1
       with:
         version: "2025.1.1"
         install-go: false

color.go

@@ -19,15 +19,15 @@ var (
 	// set (regardless of its value). This is a global option and affects all
 	// colors. For more control over each color block use the methods
 	// DisableColor() individually.
-	NoColor = noColorIsSet() || os.Getenv("TERM") == "dumb" ||
-		(!isatty.IsTerminal(os.Stdout.Fd()) && !isatty.IsCygwinTerminal(os.Stdout.Fd()))
+	NoColor = noColorIsSet() || os.Getenv("TERM") == "dumb" || !stdoutIsTerminal()
 
 	// Output defines the standard output of the print functions. By default,
-	// os.Stdout is used.
-	Output = colorable.NewColorableStdout()
+	// stdOut() is used.
+	Output = stdOut()
 
-	// Error defines a color supporting writer for os.Stderr.
-	Error = colorable.NewColorableStderr()
+	// Error defines the standard error of the print functions. By default,
+	// stdErr() is used.
+	Error = stdErr()
 
 	// colorsCache is used to reduce the count of created Color objects and
 	// allows to reuse already created objects with required Attribute.
@@ -40,6 +40,33 @@ func noColorIsSet() bool {
 	return os.Getenv("NO_COLOR") != ""
 }
 
+// stdoutIsTerminal returns true if os.Stdout is a terminal.
+// Returns false if os.Stdout is nil (e.g., when running as a Windows service).
+func stdoutIsTerminal() bool {
+	if os.Stdout == nil {
+		return false
+	}
+	return isatty.IsTerminal(os.Stdout.Fd()) || isatty.IsCygwinTerminal(os.Stdout.Fd())
+}
+
+// stdOut returns a writer for color output.
+// Returns io.Discard if os.Stdout is nil (e.g., when running as a Windows service).
+func stdOut() io.Writer {
+	if os.Stdout == nil {
+		return io.Discard
+	}
+	return colorable.NewColorableStdout()
+}
+
+// stdErr returns a writer for color error output.
+// Returns io.Discard if os.Stderr is nil (e.g., when running as a Windows service).
+func stdErr() io.Writer {
+	if os.Stderr == nil {
+		return io.Discard
+	}
+	return colorable.NewColorableStderr()
+}
+
 // Color defines a custom color object which is defined by SGR parameters.
 type Color struct {
 	params  []Attribute
@@ -220,22 +247,30 @@ func (c *Color) unset() {
 // a low-level function, and users should use the higher-level functions, such
 // as color.Fprint, color.Print, etc.
 func (c *Color) SetWriter(w io.Writer) *Color {
+	_, _ = c.setWriter(w)
+	return c
+}
+
+func (c *Color) setWriter(w io.Writer) (int, error) {
 	if c.isNoColorSet() {
-		return c
+		return 0, nil
 	}
 
-	fmt.Fprint(w, c.format())
-	return c
+	return fmt.Fprint(w, c.format())
 }
 
 // UnsetWriter resets all escape attributes and clears the output with the give
 // io.Writer. Usually should be called after SetWriter().
 func (c *Color) UnsetWriter(w io.Writer) {
+	_, _ = c.unsetWriter(w)
+}
+
+func (c *Color) unsetWriter(w io.Writer) (int, error) {
 	if c.isNoColorSet() {
-		return
+		return 0, nil
 	}
 
-	fmt.Fprintf(w, "%s[%dm", escape, Reset)
+	return fmt.Fprintf(w, "%s[%dm", escape, Reset)
 }
 
 // Add is used to chain SGR parameters. Use as many as parameters to combine
@@ -251,10 +286,20 @@ func (c *Color) Add(value ...Attribute) *Color {
 // On Windows, users should wrap w with colorable.NewColorable() if w is of
 // type *os.File.
 func (c *Color) Fprint(w io.Writer, a ...interface{}) (n int, err error) {
-	c.SetWriter(w)
-	defer c.UnsetWriter(w)
+	n, err = c.setWriter(w)
+	if err != nil {
+		return n, err
+	}
 
-	return fmt.Fprint(w, a...)
+	nn, err := fmt.Fprint(w, a...)
+	n += nn
+	if err != nil {
+		return
+	}
+
+	nn, err = c.unsetWriter(w)
+	n += nn
+	return n, err
 }
 
 // Print formats using the default formats for its operands and writes to
@@ -274,10 +319,20 @@ func (c *Color) Print(a ...interface{}) (n int, err error) {
 // On Windows, users should wrap w with colorable.NewColorable() if w is of
 // type *os.File.
 func (c *Color) Fprintf(w io.Writer, format string, a ...interface{}) (n int, err error) {
-	c.SetWriter(w)
-	defer c.UnsetWriter(w)
+	n, err = c.setWriter(w)
+	if err != nil {
+		return n, err
+	}
+
+	nn, err := fmt.Fprintf(w, format, a...)
+	n += nn
+	if err != nil {
+		return
+	}
 
-	return fmt.Fprintf(w, format, a...)
+	nn, err = c.unsetWriter(w)
+	n += nn
+	return n, err
 }
 
 // Printf formats according to a format specifier and writes to standard output.

color_test.go

@@ -5,6 +5,7 @@ import (
 	"fmt"
 	"io"
 	"os"
+	"strings"
 	"testing"
 
 	"github.com/mattn/go-colorable"
@@ -249,6 +250,42 @@ func Test_noColorIsSet(t *testing.T) {
 	}
 }
 
+func TestStdoutIsTerminal_NilStdout(t *testing.T) {
+	stdout := os.Stdout
+	os.Stdout = nil
+	t.Cleanup(func() {
+		os.Stdout = stdout
+	})
+
+	if stdoutIsTerminal() {
+		t.Fatal("stdoutIsTerminal() = true, want false")
+	}
+}
+
+func TestStdOut_NilStdout(t *testing.T) {
+	stdout := os.Stdout
+	os.Stdout = nil
+	t.Cleanup(func() {
+		os.Stdout = stdout
+	})
+
+	if got := stdOut(); got != io.Discard {
+		t.Fatalf("stdOut() = %v, want %v", got, io.Discard)
+	}
+}
+
+func TestStdErr_NilStderr(t *testing.T) {
+	stderr := os.Stderr
+	os.Stderr = nil
+	t.Cleanup(func() {
+		os.Stderr = stderr
+	})
+
+	if got := stdErr(); got != io.Discard {
+		t.Fatalf("stdErr() = %v, want %v", got, io.Discard)
+	}
+}
+
 func TestColorVisual(t *testing.T) {
 	// First Visual Test
 	Output = colorable.NewColorableStdout()
@@ -460,6 +497,64 @@ func TestColor_Sprintln_Newline(t *testing.T) {
 	}
 }
 
+func TestColor_Fprint(t *testing.T) {
+	rb := new(strings.Builder)
+	c := New(FgRed)
+
+	n, err := c.Fprint(rb, "foo", "bar")
+	if err != nil {
+		t.Errorf("Fprint error: %v", err)
+	}
+	got := rb.String()
+	want := "\x1b[31mfoobar\x1b[0m"
+
+	if want != got {
+		t.Errorf("Fprint error\n\nwant: %q\n got: %q", want, got)
+	}
+	if n != len(got) {
+		t.Errorf("Fprint byte count does not match actual bytes written\n\nwant: %d\n got: %d", len(got), n)
+	}
+}
+
+func TestColor_Fprintln(t *testing.T) {
+	rb := new(strings.Builder)
+	c := New(FgRed)
+
+	n, err := c.Fprintln(rb, "foo", "bar")
+	if err != nil {
+		t.Errorf("Fprint error: %v", err)
+	}
+	got := rb.String()
+	want := "\x1b[31mfoo bar\x1b[0m\n"
+
+	if want != got {
+		t.Errorf("Fprintln error\n\nwant: %q\n got: %q", want, got)
+	}
+	if n != len(got) {
+		t.Errorf("Fprintln byte count does not match actual bytes written\n\nwant: %d\n got: %d", len(got), n)
+	}
+}
+
+func TestColor_Fprintf(t *testing.T) {
+	rb := new(strings.Builder)
+	c := New(FgRed)
+
+	n, err := c.Fprintf(rb, "%-7s %-7s %5d\n", "hello", "world", 123)
+	if err != nil {
+		t.Errorf("Fprint error: %v", err)
+	}
+
+	want := "\x1b[31mhello   world     123\n\x1b[0m"
+
+	got := rb.String()
+	if want != got {
+		t.Errorf("Fprintf error\n\nwant: %q\n got: %q", want, got)
+	}
+	if n != len(got) {
+		t.Errorf("Fprintf byte count does not match actual bytes written\n\nwant: %d\n got: %d", len(got), n)
+	}
+}
+
 func TestColor_Fprintln_Newline(t *testing.T) {
 	rb := new(bytes.Buffer)
 	c := New(FgRed)

color_windows.go

@@ -9,6 +9,9 @@ import (
 func init() {
 	// Opt-in for ansi color support for current process.
 	// https://learn.microsoft.com/en-us/windows/console/console-virtual-terminal-sequences#output-sequences
+	if os.Stdout == nil {
+		return
+	}
 	var outMode uint32
 	out := windows.Handle(os.Stdout.Fd())
 	if err := windows.GetConsoleMode(out, &outMode); err != nil {

go.mod

@@ -1,9 +1,9 @@
 module github.com/fatih/color
 
-go 1.24.1
+go 1.25.0
 
 require (
 	github.com/mattn/go-colorable v0.1.14
 	github.com/mattn/go-isatty v0.0.20
-	golang.org/x/sys v0.31.0
+	golang.org/x/sys v0.42.0
 )

go.sum

@@ -3,5 +3,5 @@ github.com/mattn/go-colorable v0.1.14/go.mod h1:6LmQG8QLFO4G5z1gPvYEzlUgJ2wF+stg
 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=
 golang.org/x/sys v0.6.0/go.mod h1:oPkhp1MJrh7nUepCBck5+mAzfO9JrbApNNgaTdGDITg=
-golang.org/x/sys v0.31.0 h1:ioabZlmFYtWhL+TRYpcnNlLwhyxaM9kWTDEmfnprqik=
-golang.org/x/sys v0.31.0/go.mod h1:BJP2sWEmIv4KK5OTEluFJCKSidICx8ciO85XgH3Ak8k=
+golang.org/x/sys v0.42.0 h1:omrd2nAlyT5ESRdCLYdm3+fMfNFE/+Rf4bDIQImRJeo=
+golang.org/x/sys v0.42.0/go.mod h1:4GL1E5IUh+htKOUEOaiffhrAeqysfVGipDYzABqnCmw=