(feat) Use bat to display coloured documentation of environment variables during setup

CHANGELOG.md

@@ -14,6 +14,7 @@
 - Added some eslint rules to validate react components code style
 - Fixed all react components code according to eslint rules
 - Renamed proof-of-identity to supporting-documents in react components and in end-user strings
+- Use bat to display coloured documentation of environment variables during setup
 - Fix a bug: when email was mapped from SSO provided as empty string -> unable to merge account
 - Fix a bug: when an empty data was retured by the SSO, unable to edit it
 - Fix a bug: user can change his group in the profile completion page, even if mapped from the SSO

doc/environment.md

@@ -58,9 +58,9 @@ You can generate such a random key by running `rails secret`.
 
 Configure the Rails' Action Mailer delivery method.
 See http://guides.rubyonrails.org/action_mailer_basics.html#action-mailer-configuration for more details.
-<a name="SMTP_ADDRESS"></a><a name="SMTP_PORT"></a><a name="SMTP_USER_NAME"></a><a name="SMTP_PASSWORD"></a><a name="SMTP_AUTHENTICATION"></a><a name="SMTP_ENABLE_STARTTLS_AUTO"></a><a name="SMTP_OPENSSL_VERIFY_MODE"></a><a name="SMTP_TLS"></a>
+<a name="SMTP_ADDRESS"></a><a name="SMTP_PORT"></a><a name="SMTP_USER_NAME"></a><a name="SMTP_PASSWORD"></a><a name="SMTP_AUTHENTICATION"></a><a name="SMTP_ENABLE_STARTTLS_AUTO"></a><a name="SMTP_OPENSSL_VERIFY_MODE"></a>
 
-    SMTP_ADDRESS, SMTP_PORT, SMTP_USER_NAME, SMTP_PASSWORD, SMTP_AUTHENTICATION, SMTP_ENABLE_STARTTLS_AUTO, SMTP_OPENSSL_VERIFY_MODE & SMTP_TLS
+    SMTP_ADDRESS, SMTP_PORT, SMTP_USER_NAME, SMTP_PASSWORD, SMTP_AUTHENTICATION, SMTP_ENABLE_STARTTLS_AUTO & SMTP_OPENSSL_VERIFY_MODE
 
 When DELIVERY_METHOD is set to **smtp**, configure the SMTP server parameters.
 See https://guides.rubyonrails.org/action_mailer_basics.html#action-mailer-configuration for more details.

setup/setup.sh

@@ -15,11 +15,11 @@ welcome_message()
   printf "\n                 Welcome to Fab-manager's setup assistant\n\n\n"
   echo "Thank you for installing Fab-manager."
   printf "This script will guide you through the installation process of Fab-manager\n\n"
-  echo -e "Please report any \e[1mfeedback or improvement request\e[21m on https://feedback.fab-manager.com/"
-  echo -e "For \e[1mbug reports\e[21m, please open a new issue on https://github.com/sleede/fab-manager/issues"
-  echo -e "You can call for \e[1mcommunity assistance\e[21m on https://forum.fab-manager.com/"
+  echo -e "Please report any \e[1mfeedback or improvement request\e[0m on https://feedback.fab-manager.com/"
+  echo -e "For \e[1mbug reports\e[0m, please open a new issue on https://github.com/sleede/fab-manager/issues"
+  echo -e "You can call for \e[1mcommunity assistance\e[0m on https://forum.fab-manager.com/"
   printf "\nYou can interrupt this installation at any time by pressing Ctrl+C\n"
-  printf "If you do not feel confortable with this installation, you can \e[4msubscribe to our hosting offers\e[24m:\nhttps://www.fab-manager.com/saas-offer\n\n"
+  printf "If you do not feel confortable with this installation, you can \e[4msubscribe to our hosting offers\e[0m:\nhttps://www.fab-manager.com/saas-offer\n\n"
   read -rp "Continue? (Y/n) " confirm </dev/tty
   if [[ "$confirm" = "n" ]]; then exit 1; fi
 }
@@ -236,6 +236,10 @@ yq() {
   docker run --rm -i -v "${FABMANAGER_PATH}:/workdir" --user "$UID" mikefarah/yq:4 "$@"
 }
 
+bat() {
+  docker run --rm -i -v "${PWD}:/workdir"  --user "$UID" sleede/bat:latest "$@"
+}
+
 prepare_nginx()
 {
   if [ "$NGINX" != "n" ]; then
@@ -365,12 +369,9 @@ configure_env_file()
     local var_doc current
     var_doc=$(get_md_anchor "$doc" "$variable")
     current=$(grep "$variable=" "$FABMANAGER_PATH/config/env")
-    printf "\n\n\n==== \e[4m%s\e[24m ====\n" "$variable"
-    printf "**** \e[1mDocumentation:\e[21m ****\n"
-    echo "$var_doc"
-    printf "=======================\n- \e[1mCurrent value: %s\e[21m\n- New value? (leave empty to keep the current value)\n" "$current"
+    echo "$var_doc" | bat --file-name "$variable" --language md --color=always
+    printf "- \e[1mCurrent value: %s\e[21m\n- New value? (leave empty to keep the current value)\n" "$current"
     read -rep "  > " value </dev/tty
-    echo "======================="
     if [ "$value" != "" ]; then
       esc_val=$(printf '%s\n' "$value" | sed -e 's/\//\\\//g')
       esc_curr=$(printf '%s\n' "$current" | sed -e 's/\//\\\//g')
@@ -383,7 +384,7 @@ configure_env_file()
 
   # if DEFAULT_PROTOCOL was set to http, ALLOW_INSECURE_HTTP is probably required
   if grep "^DEFAULT_PROTOCOL=http$" "$FABMANAGER_PATH/config/env" 1>/dev/null; then
-    get_md_anchor "$doc" "ALLOW_INSECURE_HTTP"
+    get_md_anchor "$doc" "ALLOW_INSECURE_HTTP" | bat --file-name "ALLOW_INSECURE_HTTP" --language md --color=always
     printf "You have set \e[1mDEFAULT_PROTOCOL\e[21m to \e[1mhttp\e[21m.\n"
     read -rp "Do you want to allow insecure HTTP? (Y/n) " confirm </dev/tty
     if [ "$confirm" != "n" ]; then