use golang.org/x/term for terminal detection by thaJeztah · Pull Request #1484 · sirupsen/logrus

thaJeztah · 2026-02-24T11:37:31Z

Using a low version of this dependency, as the IsTerminal function was not modified in newer versions;

golang/term@v0.2.0...v0.40.0

thaJeztah · 2026-02-24T11:55:38Z

 require (
 	github.com/davecgh/go-spew v1.1.1 // indirect
 	github.com/pmezard/go-difflib v1.0.0 // indirect
+	golang.org/x/sys v0.13.0 // indirect


Keeping the version used before, but technically this could be v0.2.0

Copilot

Pull request overview

This PR consolidates platform-specific terminal detection code by replacing custom implementations with the standard golang.org/x/term package. The change simplifies maintenance by removing 10 platform-specific files and replacing them with a single, cross-platform implementation in text_formatter.go.

Changes:

Replaced platform-specific terminal detection functions with golang.org/x/term.IsTerminal
Removed 10 platform-specific terminal detection files (Windows, Unix, BSD, Solaris, App Engine, etc.)
Updated dependencies: added golang.org/x/term v0.2.0 and moved golang.org/x/sys to indirect dependency

Reviewed changes

Copilot reviewed 12 out of 13 changed files in this pull request and generated 2 comments.

Show a summary per file

File	Description
text_formatter.go	Replaced `checkIfTerminal()` call with inline type switch using `term.IsTerminal()`
terminal_check_windows.go	Deleted - Windows-specific terminal detection and VT processing
terminal_check_unix.go	Deleted - Unix-specific terminal detection using ioctl
terminal_check_bsd.go	Deleted - BSD-specific terminal detection
terminal_check_solaris.go	Deleted - Solaris-specific terminal detection
terminal_check_appengine.go	Deleted - App Engine-specific behavior (always returned true)
terminal_check_notappengine.go	Deleted - Non-App Engine wrapper function
terminal_check_no_terminal.go	Deleted - Fallback for js/nacl/plan9
terminal_check_js.go	Deleted - JavaScript-specific fallback
terminal_check_wasi.go	Deleted - WASI-specific fallback
terminal_check_wasip1.go	Deleted - WASIP1-specific fallback
go.mod	Added golang.org/x/term v0.2.0, moved golang.org/x/sys to indirect
go.sum	Added checksums for golang.org/x/term v0.2.0 and updated golang.org/x/sys

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

Copilot · 2026-02-24T12:24:43Z

+		switch v := entry.Logger.Out.(type) {
+		case *os.File:
+			f.isTerminal = term.IsTerminal(int(v.Fd())) // #nosec G115 -- Ignore "integer overflow conversion"; Fd() is OS-provided, not user-controlled
+		default:
+			f.isTerminal = false
+		}


The removal of terminal_check_appengine.go changes the behavior for App Engine environments. Previously, checkIfTerminal would return true in App Engine environments. With the new implementation, it will return false (since App Engine's output is typically not an os.File). This could be a breaking change for users who relied on the old behavior. Consider documenting this change or verifying that returning false is the intended behavior for App Engine.

Ah, right, hm... wonder if appengine is still a thing, and if it still needs the special build-tag; I see it was added in

Split terminal check to add build tags to support App Engine. #635

Copilot

Pull request overview

Copilot reviewed 12 out of 13 changed files in this pull request and generated 2 comments.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

Copilot · 2026-02-24T13:06:28Z

+
+	"golang.org/x/term"
+)
+
+func checkIfTerminal(w io.Writer) bool {
+	if f, ok := w.(*os.File); ok {
+		return term.IsTerminal(int(f.Fd())) // #nosec G115 -- Fd() is OS-provided, not user-controlled; overflow not attacker-influenced


On Windows the previous implementation enabled ENABLE_VIRTUAL_TERMINAL_PROCESSING via SetConsoleMode when w was *os.File. Switching to term.IsTerminal drops that side effect, which can regress ANSI color output when users set ForceColors without wrapping output via go-colorable. Consider reintroducing a Windows-specific path that enables VT processing (or explicitly document that Windows users must use go-colorable / enable VT themselves).

Suggested change

"golang.org/x/term"

)

func checkIfTerminal(w io.Writer) bool {

if f, ok := w.(*os.File); ok {

return term.IsTerminal(int(f.Fd())) // #nosec G115 -- Fd() is OS-provided, not user-controlled; overflow not attacker-influenced

"runtime"

"syscall"

"unsafe"

"golang.org/x/term"

)

var (

kernel32 = syscall.NewLazyDLL("kernel32.dll")

getConsoleMode = kernel32.NewProc("GetConsoleMode")

setConsoleMode = kernel32.NewProc("SetConsoleMode")

)

func enableVirtualTerminalProcessing(f *os.File) {

if runtime.GOOS != "windows" {

return

}

const ENABLE_VIRTUAL_TERMINAL_PROCESSING = 0x0004

handle := uintptr(f.Fd()) // #nosec G115 -- Fd() is OS-provided, not user-controlled; overflow not attacker-influenced

var mode uint32

r1, _, _ := getConsoleMode.Call(handle, uintptr(unsafe.Pointer(&mode)))

if r1 == 0 {

return

}

if mode&ENABLE_VIRTUAL_TERMINAL_PROCESSING != 0 {

return

}

_, _, _ = setConsoleMode.Call(handle, uintptr(mode|ENABLE_VIRTUAL_TERMINAL_PROCESSING))

}

func checkIfTerminal(w io.Writer) bool {

if f, ok := w.(*os.File); ok {

isTerminal := term.IsTerminal(int(f.Fd())) // #nosec G115 -- Fd() is OS-provided, not user-controlled; overflow not attacker-influenced

if isTerminal {

enableVirtualTerminalProcessing(f)

}

return isTerminal

Using a low version of this dependency, as the `IsTerminal` function was not modified in newer versions; golang/term@v0.2.0...v0.40.0 Signed-off-by: Sebastiaan van Stijn <github@gone.nl>

Signed-off-by: Sebastiaan van Stijn <github@gone.nl>

thaJeztah mentioned this pull request Feb 24, 2026

fix: solaris build tags, go.mod go version, go mod tidy, go fix #1483

Merged

thaJeztah commented Feb 24, 2026

View reviewed changes

thaJeztah requested a review from Copilot February 24, 2026 12:18

Copilot started reviewing on behalf of thaJeztah February 24, 2026 12:19 View session

Copilot AI reviewed Feb 24, 2026

View reviewed changes

thaJeztah force-pushed the use_x_term branch 2 times, most recently from d1cbc2e to 87d959b Compare February 24, 2026 13:01

thaJeztah requested a review from Copilot February 24, 2026 13:01

Copilot started reviewing on behalf of thaJeztah February 24, 2026 13:01 View session

Copilot AI reviewed Feb 24, 2026

View reviewed changes

thaJeztah force-pushed the use_x_term branch 4 times, most recently from c5f4554 to e013d10 Compare February 27, 2026 10:34

thaJeztah marked this pull request as draft February 27, 2026 10:34

thaJeztah force-pushed the use_x_term branch 4 times, most recently from 6900582 to a0bdca4 Compare February 27, 2026 12:04

use golang.org/x/term for terminal detection

433a2d4

Using a low version of this dependency, as the `IsTerminal` function was not modified in newer versions; golang/term@v0.2.0...v0.40.0 Signed-off-by: Sebastiaan van Stijn <github@gone.nl>

thaJeztah force-pushed the use_x_term branch from a0bdca4 to 3c4873d Compare July 6, 2026 14:34

WIP

d05026d

Signed-off-by: Sebastiaan van Stijn <github@gone.nl>

thaJeztah force-pushed the use_x_term branch from 3c4873d to d05026d Compare July 6, 2026 14:35

Navigation Menu

use golang.org/x/term for terminal detection - #1484

use golang.org/x/term for terminal detection#1484
thaJeztah wants to merge 2 commits into
sirupsen:masterfrom
thaJeztah:use_x_term

thaJeztah commented Feb 24, 2026

Uh oh!

thaJeztah Feb 24, 2026

Uh oh!

Copilot AI left a comment

Uh oh!

Uh oh!

Copilot AI Feb 24, 2026

Uh oh!

thaJeztah Feb 24, 2026

Uh oh!

Copilot AI left a comment

Uh oh!

Copilot AI Feb 24, 2026

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

-	"golang.org/x/term"
-)
-func checkIfTerminal(w io.Writer) bool {
-	if f, ok := w.(*os.File); ok {
-		return term.IsTerminal(int(f.Fd())) // #nosec G115 -- Fd() is OS-provided, not user-controlled; overflow not attacker-influenced
+	"runtime"
+	"syscall"
+	"unsafe"
+	"golang.org/x/term"
+)
+var (
+	kernel32       = syscall.NewLazyDLL("kernel32.dll")
+	getConsoleMode = kernel32.NewProc("GetConsoleMode")
+	setConsoleMode = kernel32.NewProc("SetConsoleMode")
+)
+func enableVirtualTerminalProcessing(f *os.File) {
+	if runtime.GOOS != "windows" {
+		return
+	}
+	const ENABLE_VIRTUAL_TERMINAL_PROCESSING = 0x0004
+	handle := uintptr(f.Fd()) // #nosec G115 -- Fd() is OS-provided, not user-controlled; overflow not attacker-influenced
+	var mode uint32
+	r1, _, _ := getConsoleMode.Call(handle, uintptr(unsafe.Pointer(&mode)))
+	if r1 == 0 {
+		return
+	}
+	if mode&ENABLE_VIRTUAL_TERMINAL_PROCESSING != 0 {
+		return
+	}
+	_, _, _ = setConsoleMode.Call(handle, uintptr(mode|ENABLE_VIRTUAL_TERMINAL_PROCESSING))
+}
+func checkIfTerminal(w io.Writer) bool {
+	if f, ok := w.(*os.File); ok {
+		isTerminal := term.IsTerminal(int(f.Fd())) // #nosec G115 -- Fd() is OS-provided, not user-controlled; overflow not attacker-influenced
+		if isTerminal {
+			enableVirtualTerminalProcessing(f)
+		}
+		return isTerminal

Conversation

thaJeztah commented Feb 24, 2026

Uh oh!

thaJeztah Feb 24, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Reviewed changes

Uh oh!

Uh oh!

Copilot AI Feb 24, 2026

Choose a reason for hiding this comment

Uh oh!

thaJeztah Feb 24, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Uh oh!

Copilot AI Feb 24, 2026

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants