Merge pull request #611 from DannyBen/update/colors-tty

Update colors library to support auto-colors based on TTY

Author: DannyBen

examples/colors/src/lib/colors.sh

@@ -10,10 +10,21 @@
 ## Color output will be disabled if `NO_COLOR` environment variable is set
 ## in compliance with https://no-color.org/
 ##
+## In case you wish to enable auto detection for color output based on the
+## terminal being interactive (TTY), call `enable_auto_colors` in your 
+## `src/initialize.sh` (Run `bashly add hooks` to add this file).
+##
+enable_auto_colors() {
+  ## If NO_COLOR has not been set and stdout is not a TTY, disable colors
+  if [[ -z ${NO_COLOR+x} && ! -t 1 ]]; then
+    NO_COLOR=1
+  fi
+}
+
 print_in_color() {
   local color="$1"
   shift
-  if [[ -z ${NO_COLOR+x} ]]; then
+  if [[ "${NO_COLOR:-}" == "" ]]; then
     printf "$color%b\e[0m\n" "$*"
   else
     printf "%b\n" "$*"

examples/dependencies-alt/src/lib/colors.sh

@@ -10,10 +10,21 @@
 ## Color output will be disabled if `NO_COLOR` environment variable is set
 ## in compliance with https://no-color.org/
 ##
+## In case you wish to enable auto detection for color output based on the
+## terminal being interactive (TTY), call `enable_auto_colors` in your 
+## `src/initialize.sh` (Run `bashly add hooks` to add this file).
+##
+enable_auto_colors() {
+  ## If NO_COLOR has not been set and stdout is not a TTY, disable colors
+  if [[ -z ${NO_COLOR+x} && ! -t 1 ]]; then
+    NO_COLOR=1
+  fi
+}
+
 print_in_color() {
   local color="$1"
   shift
-  if [[ -z ${NO_COLOR+x} ]]; then
+  if [[ "${NO_COLOR:-}" == "" ]]; then
     printf "$color%b\e[0m\n" "$*"
   else
     printf "%b\n" "$*"

examples/dependencies/src/lib/colors.sh

@@ -10,10 +10,21 @@
 ## Color output will be disabled if `NO_COLOR` environment variable is set
 ## in compliance with https://no-color.org/
 ##
+## In case you wish to enable auto detection for color output based on the
+## terminal being interactive (TTY), call `enable_auto_colors` in your 
+## `src/initialize.sh` (Run `bashly add hooks` to add this file).
+##
+enable_auto_colors() {
+  ## If NO_COLOR has not been set and stdout is not a TTY, disable colors
+  if [[ -z ${NO_COLOR+x} && ! -t 1 ]]; then
+    NO_COLOR=1
+  fi
+}
+
 print_in_color() {
   local color="$1"
   shift
-  if [[ -z ${NO_COLOR+x} ]]; then
+  if [[ "${NO_COLOR:-}" == "" ]]; then
     printf "$color%b\e[0m\n" "$*"
   else
     printf "%b\n" "$*"

examples/render-mandoc/docs/download.1

@@ -1,6 +1,6 @@
 .\" Automatically generated by Pandoc 3.2
 .\"
-.TH "download" "1" "December 2024" "Version 0.1.0" "Sample application"
+.TH "download" "1" "January 2025" "Version 0.1.0" "Sample application"
 .SH NAME
 \f[B]download\f[R] \- Sample application
 .SH SYNOPSIS

examples/render-mandoc/docs/download.md

@@ -1,6 +1,6 @@
 % download(1) Version 0.1.0 | Sample application
 % Lana Lang
-% December 2024
+% January 2025
 
 NAME
 ==================================================

lib/bashly/libraries/colors/colors.sh

@@ -10,6 +10,17 @@
 ## Color output will be disabled if `NO_COLOR` environment variable is set
 ## in compliance with https://no-color.org/
 ##
+## In case you wish to enable auto detection for color output based on the
+## terminal being interactive (TTY), call `enable_auto_colors` in your 
+## `src/initialize.sh` (Run `bashly add hooks` to add this file).
+##
+enable_auto_colors() {
+  ## If NO_COLOR has not been set and stdout is not a TTY, disable colors
+  if [[ -z ${NO_COLOR+x} && ! -t 1 ]]; then
+    NO_COLOR=1
+  fi
+}
+
 print_in_color() {
   local color="$1"
   shift

lib/bashly/libraries/libraries.yml

@@ -3,6 +3,14 @@ colors:
   files:
     - source: "colors/colors.sh"
       target: "%{user_lib_dir}/colors.%{user_ext}"
+  post_install_message: |
+    The colors library supports the g`NO_COLOR` standard out of the box.
+
+    In case you wish to also enable automatic output of colors based on the
+    terminal being interactive (TTY), call g`enable_auto_colors` in your 
+    g`src/initialize.sh`. You may run the following command to add this file:
+
+      m`$ bashly add hooks`
 
 completions: 
   help: Generate a bash completions function.

spec/approvals/cli/add/colors

@@ -1 +1,10 @@
 created spec/tmp/src/lib/colors.sh
+
+The colors library supports the NO_COLOR standard out of the box.
+
+In case you wish to also enable automatic output of colors based on the
+terminal being interactive (TTY), call enable_auto_colors in your 
+src/initialize.sh. You may run the following command to add this file:
+
+  $ bashly add hooks
+

spec/approvals/examples/colors

@@ -1,5 +1,14 @@
 + bashly add colors --force
 created src/lib/colors.sh
+
+The colors library supports the NO_COLOR standard out of the box.
+
+In case you wish to also enable automatic output of colors based on the
+terminal being interactive (TTY), call enable_auto_colors in your 
+src/initialize.sh. You may run the following command to add this file:
+
+  $ bashly add hooks
+
 + bashly generate
 creating user files in src
 skipped src/root_command.sh (exists)

spec/approvals/examples/dependencies

@@ -1,5 +1,14 @@
 + bashly add colors
 created src/lib/colors.sh
+
+The colors library supports the NO_COLOR standard out of the box.
+
+In case you wish to also enable automatic output of colors based on the
+terminal being interactive (TTY), call enable_auto_colors in your 
+src/initialize.sh. You may run the following command to add this file:
+
+  $ bashly add hooks
+
 + bashly generate
 creating user files in src
 created src/download_command.sh