File: terminal.go

package info (click to toggle)
golang-github-juju-ansiterm 1.0.0-1
  • links: PTS, VCS
  • area: main
  • in suites: bookworm, forky, sid, trixie
  • size: 176 kB
  • sloc: makefile: 9
file content (44 lines) | stat: -rw-r--r-- 1,181 bytes parent folder | download
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
// Copyright 2016 Canonical Ltd.
// Licensed under the LGPLv3, see LICENCE file for details.

package ansiterm

import (
	"io"
	"os"

	"github.com/mattn/go-colorable"
	"github.com/mattn/go-isatty"
)

// colorEnabledWriter returns a writer that can handle the ansi color codes
// and true if the writer passed in is a terminal capable of color. If the
// TERM environment variable is set to "dumb", the terminal is not considered
// color capable.
func colorEnabledWriter(w io.Writer) (io.Writer, bool) {
	f, ok := w.(*os.File)
	if !ok {
		return w, false
	}

	// NO_COLOR is a relatively new standard for preventing color enabled
	// writers rather than using the TERM env.
	//
	// "...should check for the presence of a NO_COLOR environment variable
	//  that, when present (regardless of its value), prevents the addition of
	//  ANSI color."
	// See: https://no-color.org/
	if _, ok := os.LookupEnv("NO_COLOR"); ok {
		return w, false
	}

	// Check the TERM environment variable specifically
	// to check for "dumb" terminals.
	if os.Getenv("TERM") == "dumb" {
		return w, false
	}
	if !isatty.IsTerminal(f.Fd()) {
		return w, false
	}
	return colorable.NewColorable(f), true
}