管道中的 Bash 测试导致奇怪的行为

Question

我正在尝试为 bash 编写一个带有各种样式选项的彩色输出库，允许使用重定向进行着色和样式设置。

例如

echo "Red" | red输出红色文字

和

echo "Bold" | bold 输出粗体文本

和

echo "Yellow bold" | yellow | bold 输出粗体黄色文本

目前我写的代码如下：

#shellcheck shell=bash

# set debug
# set -o xtrace

# number of colors supported
__colors=$(tput colors 2> /dev/null)
# colors
__black="$(tput setaf 0)"
__red="$(tput setaf 1)"
__green="$(tput setaf 2)"
__yellow="$(tput setaf 3)"
__blue="$(tput setaf 4)"
__magenta="$(tput setaf 5)"
__cyan="$(tput setaf 6)"
__white="$(tput setaf 7)"
# style
__default="$(tput sgr0)"
__bold="$(tput bold)"
__underline="$(tput smul)"


function has_colors() {
  COLOR=${COLOR:-auto}
  if [[ $COLOR = 'never' ]]; then
    return 1
  elif [[ $COLOR = 'always' ]]; then
    return 0
  else
    # check if stoud is terminal and terminal supports colors
    [[ -t 1 ]] && \
    [[ -n $__colors ]] && \
    [[ $__colors -ge 8 ]]
  fi
}

function __style() {
  read -r input
  if has_colors; then
    echo -e "$1" "$input" "$__default"
  else
    echo -e "$input"
  fi
}

function black() {
  __style "$__black"
}

function red() {
  __style "$__red"
}

function green() {
  __style "$__green"
}

function yellow() {
  __style "$__yellow"
}

function blue() {
  __style "$__blue"
}

function magenta() {
  __style "$__magenta"
}

function cyan() {
  __style "$__cyan"
}

function white() {
  __style "$__white"
}

function bold() {
  __style "$__bold"
}

function underline() {
  __style "$__underline"
}

设置 COLOR=always 始终使用转义码输出。另一方面 COLOR=auto 执行一些检查以确保当前标准输出是终端并且终端支持颜色。

问题是使用多个样式选项似乎不起作用。它总是应用最后一个样式选项。例如：

echo "Yellow bold" | yellow | bold 输出粗体文本，但不是黄色。

另一方面：

echo "Bold yellow" | bold | yellow 输出黄色文本，但不是粗体。

有趣的是；设置 COLOR=always 似乎工作得很好。所以看起来我执行的测试是否 stdout 是终端 [[ -t 1 ]] 导致了这种情况。我不确定是否是因为该测试存在某种延迟。但是当我删除[[ -t 1 ]] 位时，它可以工作。

知道如何实现这一目标吗？不是 Bash 专家，也不是 shell 如何解决这个问题的专家。这里很混乱。

Answer 1

清醒地看待这个问题，我发现了我的方法中的问题。

[[ -t 1 ]] 测试 stdout 是否为终端，当我通过管道传递两个函数时，如 echo "Hello" | yellow | bold ，[[ -t 1 ]] 在通过函数 yellow 表示输出不是终端时为 false。

这是因为函数（黄色）的输出通过管道传输到第二个函数（粗体）。这就是为什么它不输出黄色的转义码而只输出输入的原因。

因此，如果我继续通过管道连接到另一个函数，例如 echo "Hello" | yellow | bold | underline，它只会在输出下划线。

这似乎是一种很好且简单的颜色输出方法，但现在我必须改变我的方法，除非有办法知道当前正在运行的函数是否正在通过管道传输但未重定向？

编辑

This post 表明有一种方法可以检测命令是被重定向还是被管道传输。

最后，这种方法似乎不太可行，因为如果我在管道时不禁用颜色，它将在管道到另一个不是另一个输出样式函数的命令时输出颜色代码；这可能是一个边缘情况，但解决方案仍然不是 %100 故障证明

编辑解决方案：

改变了方法。而不是像下面这样使用下一个格式选项作为第一个格式的参数一个接一个地管道格式

echo "Hello" | yellow bold underline

最终代码如下：

#shellcheck shell=bash

# set debug
# set -xv

# number of colors supported
__colors=$(tput colors 2> /dev/null)

# foreground colors
__black="$(tput setaf 0)"
__red="$(tput setaf 1)"
__green="$(tput setaf 2)"
__yellow="$(tput setaf 3)"
__blue="$(tput setaf 4)"
__magenta="$(tput setaf 5)"
__cyan="$(tput setaf 6)"
__white="$(tput setaf 7)"

# background colors
__bg_black="$(tput setab 0)"
__bg_red="$(tput setab 1)"
__bg_green="$(tput setab 2)"
__bg_yellow="$(tput setab 3)"
__bg_blue="$(tput setab 4)"
__bg_magenta="$(tput setab 5)"
__bg_cyan="$(tput setab 6)"
__bg_white="$(tput setab 7)"

# style
__reset="$(tput sgr0)"
__bold="$(tput bold)"
__underline="$(tput smul)"

function has_colors() {
  COLOR=${COLOR:-auto}
  if [[ $COLOR = 'never' ]]; then
    return 1
  elif [[ $COLOR = 'always' ]]; then
    return 0
  else
    [[ -t 1 ]] && [[ -n $__colors ]] && [[ $__colors -ge 8 ]]
  fi
}

function __format() {
  local format="$1"
  local next="${2:-}" # next formatting function e.g. underline
  if has_colors; then
    echo -en "$format"
    if [[ -n $next ]]; then
      shift 2
      tee | "$next" "$@"
    else
      tee
      echo -en "$__reset"
    fi
  else
    tee #print output
  fi
}

function black() { __format "$__black" "$@"; }
function red() { __format "$__red" "$@"; }
function green() { __format "$__green" "$@";}
function yellow() { __format "$__yellow" "$@"; }
function blue() { __format "$__blue" "$@"; }
function magenta() { __format "$__magenta" "$@";}
function cyan() { __format "$__cyan"  "$@";}
function white() { __format "$__white"  "$@";}

function bg_black() { __format "$__bg_black" "$@"; }
function bg_red() { __format "$__bg_red" "$@"; }
function bg_green() { __format "$__bg_green" "$@";}
function bg_yellow() { __format "$__bg_yellow" "$@"; }
function bg_blue() { __format "$__bg_blue" "$@"; }
function bg_magenta() { __format "$__bg_magenta" "$@";}
function bg_cyan() { __format "$__bg_cyan"  "$@";}
function bg_white() { __format "$__bg_white"  "$@";}

function bold() { __format "$__bold"  "$@";}
function underline() { __format "$__underline" "$@"; }