我用来为 shell 脚本创建出色的用户体验的技术 Techniques I use to create a great user experience for shell scripts

原始链接: https://nochlin.com/blog/6-techniques-i-use-to-create-a-great-user-experience-for-shell-scripts

该文本描述了用户开发的 shell 脚本，用于帮助评估“十亿行挑战”竞赛的过程。 该脚本提供全面的错误处理和输入验证、清晰多彩的输出、详细的进度报告、使用“set -e”和“set +e”的战略错误处理、特定于平台的适应、多次运行的带时间戳的文件输出，并支持用户运行 并分析基准。 作者使用了六种技术来提高脚本的可用性和安全性，包括清晰的错误消息、使用说明、用于更好可见性的 ANSI 颜色、执行前精确的命令打印、选择性错误退出和日志记录时间戳。 该代码可以在“十亿行挑战”存储库中找到。 用户邀请其他人分享他们关于 shell 脚本最佳实践的意见或建议。

The text describes a shell script developed by the user to aid in the evaluation process of a competition known as the "One Billion Row Challenge". The script offers comprehensive error handling and input validation, clear and colorful output, detailed progress reporting, strategic error handling using "set -e" and "set +e", platform-specific adaptations, timestamped file outputs for multiple runs and supports users running and analyzing benchmarks. The author utilized six techniques to improve the usability and safety of the script including clear error messages, usage instructions, ANSI colors for better visibility, precise command printing before execution, selective error exits, and timestamps for logging. The code can be found in the One Billion Row Challenge repository. The user invites others to share their opinions or suggestions regarding shell script best practices.

if [ -z "$1" ] 
  then 
    echo "Usage: evaluate.sh <fork name> (<fork name 2> ...)" 
    echo " for each fork, there must be a 'calculate_average_<fork name>.sh' script and an optional 'prepare_<fork name>.sh'." 
    exit 1 
fi

BOLD_RED='\033[1;31m'
RESET='\033[0m'
echo -e "${BOLD_RED}ERROR${RESET}: ./calculate_average_$fork.sh does not exist." >&2

function print_and_execute() {
  echo "+ $@" >&2 
  "$@" 
}

set -eo pipefail


for fork in "$@"; do
  set +e 

  
  print_and_execute source "./prepare_$fork.sh"

  
  print_and_execute $TIMEOUT ./test.sh $fork

  
done
set -e  

if [ "$(uname -s)" == "Linux" ]; then 
  TIMEOUT="timeout -v $RUN_TIME_LIMIT" 
else 
  if [ -x "$(command -v gtimeout)" ]; then 
    TIMEOUT="gtimeout -v $RUN_TIME_LIMIT"
  else 
    echo -e "${BOLD_YELLOW}WARNING${RESET} gtimeout not available, install with `brew install coreutils` or benchmark runs may take indefinitely long." 
  fi
fi

filetimestamp=$(date +"%Y%m%d%H%M%S")


HYPERFINE_OPTS="--warmup 0 --runs $RUNS --export-json $fork-$filetimestamp-timing.json --output ./$fork-$filetimestamp.out"


echo "Raw results saved to file(s):"
for fork in "$@"; do
  if [ -f "$fork-$filetimestamp-timing.json" ]; then
      cat $fork-$filetimestamp-timing.json >> $fork-$filetimestamp.out
      rm $fork-$filetimestamp-timing.json
  fi

  if [ -f "$fork-$filetimestamp.out" ]; then
    echo "  $fork-$filetimestamp.out"
  fi
done