chore(console): support IsTerminal (#19)

gin-contrib · Jan 23, 2022 · 0b1bbbb · 0b1bbbb
1 parent 8448be2
commit 0b1bbbb
Show file tree

Hide file tree

Showing 3 changed files with 14 additions and 3 deletions.
diff --git a/go.mod b/go.mod
@@ -4,6 +4,7 @@ go 1.13
 
 require (
 	github.com/gin-gonic/gin v1.7.2
+	github.com/mattn/go-isatty v0.0.12
 	github.com/rs/zerolog v1.23.0
 	github.com/stretchr/testify v1.7.0
 )
diff --git a/logger.go b/logger.go
@@ -3,15 +3,25 @@ package logger
 import (
 	"io"
 	"net/http"
+	"os"
 	"regexp"
 	"time"
 
 	"github.com/gin-gonic/gin"
+	"github.com/mattn/go-isatty"
 	"github.com/rs/zerolog"
 )
 
 func defaultLogger(c *gin.Context, out io.Writer, latency time.Duration) zerolog.Logger {
-	logger := zerolog.New(out).With().
+	isTerm := isatty.IsTerminal(os.Stdout.Fd())
+	logger := zerolog.New(out).
+		Output(
+			zerolog.ConsoleWriter{
+				Out:     out,
+				NoColor: !isTerm,
+			},
+		).
+		With().
 		Timestamp().
 		Int("status", c.Writer.Status()).
 		Str("method", c.Request.Method).

diff --git a/logger_test.go b/logger_test.go
@@ -56,14 +56,14 @@ func TestLogger(t *testing.T) {
 	assert.Contains(t, buffer.String(), "400")
 	assert.Contains(t, buffer.String(), "POST")
 	assert.Contains(t, buffer.String(), "/example")
-	assert.Contains(t, buffer.String(), "warn")
+	assert.Contains(t, buffer.String(), "WRN")
 
 	buffer.Reset()
 	performRequest(r, "PUT", "/example?a=100")
 	assert.Contains(t, buffer.String(), "502")
 	assert.Contains(t, buffer.String(), "PUT")
 	assert.Contains(t, buffer.String(), "/example")
-	assert.Contains(t, buffer.String(), "error")
+	assert.Contains(t, buffer.String(), "ERR")
 }
 
 func TestLoggerWithLogger(t *testing.T) {