dartokloning / Synth-Shell

#!/usr/bin/env bash ## ## ## Visit for instructions and more information: ## https://github.com/andresgongora/synth-shell/ ## ## ## ##================================================================================================== ## CODE PARSERS ##================================================================================================== ##------------------------------------------------------------------------------ ## get8bitCode() { CODE=$1 case $CODE in default) echo 9 ;; none) echo 9 ;; black) echo 0 ;; red) echo 1 ;; green) echo 2 ;; yellow) echo 3 ;; blue) echo 4 ;; magenta|purple|pink) echo 5 ;; cyan) echo 6 ;; light-gray) echo 7 ;; dark-gray) echo 60 ;; light-red) echo 61 ;; light-green) echo 62 ;; light-yellow) echo 63 ;; light-blue) echo 64 ;; light-magenta|light-purple) echo 65 ;; light-cyan) echo 66 ;; white) echo 67 ;; *) echo 0 esac } ##------------------------------------------------------------------------------ ## getColorCode() { COLOR=$1 ## Check if color is a 256-color code if [ $COLOR -eq $COLOR ] 2> /dev/null; then if [ $COLOR -gt 0 -a $COLOR -lt 256 ]; then echo "38;5;$COLOR" else echo 0 fi ## Or if color key-workd else BITCODE=$(get8bitCode $COLOR) COLORCODE=$(($BITCODE + 30)) echo $COLORCODE fi } ##------------------------------------------------------------------------------ ## getBackgroundCode() { COLOR=$1 ## Check if color is a 256-color code if [ $COLOR -eq $COLOR ] 2> /dev/null; then if [ $COLOR -gt 0 -a $COLOR -lt 256 ]; then echo "48;5;$COLOR" else echo 0 fi ## Or if color key-workd else BITCODE=$(get8bitCode $COLOR) COLORCODE=$(($BITCODE + 40)) echo $COLORCODE fi } ##------------------------------------------------------------------------------ ## getEffectCode() { EFFECT=$1 NONE=0 case $EFFECT in none) echo $NONE ;; default) echo $NONE ;; bold) echo 1 ;; bright) echo 1 ;; dim) echo 2 ;; underline) echo 4 ;; blink) echo 5 ;; reverse) echo 7 ;; hidden) echo 8 ;; strikeout) echo 9 ;; *) echo $NONE esac } ##------------------------------------------------------------------------------ ## getFormattingSequence() { START='\e[0;' MIDLE=$1 END='m' echo -n "$START$MIDLE$END" } ##================================================================================================== ## AUX ##================================================================================================== applyCodeToText() { local RESET=$(getFormattingSequence $(getEffectCode none)) TEXT=$1 CODE=$2 echo -n "$CODE$TEXT$RESET" } ##================================================================================================== ## MAIN FUNCTIONS ##================================================================================================== ##------------------------------------------------------------------------------ ## getFormatCode() { local RESET=$(getFormattingSequence $(getEffectCode none)) ## NO ARGUMENT PROVIDED if [ "$#" -eq 0 ]; then echo -n "$RESET" ## 1 ARGUMENT -> ASSUME TEXT COLOR elif [ "$#" -eq 1 ]; then TEXT_COLOR=$(getFormattingSequence $(getColorCode $1)) echo -n "$TEXT_COLOR" ## ARGUMENTS PROVIDED else FORMAT="" while [ "$1" != "" ]; do ## PROCESS ARGUMENTS TYPE=$1 ARGUMENT=$2 case $TYPE in -c) CODE=$(getColorCode $ARGUMENT) ;; -b) CODE=$(getBackgroundCode $ARGUMENT) ;; -e) CODE=$(getEffectCode $ARGUMENT) ;; *) CODE="" esac ## ADD CODE SEPARATOR IF NEEDED if [ "$FORMAT" != "" ]; then FORMAT="$FORMAT;" fi ## APPEND CODE FORMAT="$FORMAT$CODE" # Remove arguments from stack shift shift done ## APPLY FORMAT TO TEXT FORMAT_CODE=$(getFormattingSequence $FORMAT) echo -n "${FORMAT_CODE}" fi } ##------------------------------------------------------------------------------ ## formatText() { local RESET=$(getFormattingSequence $(getEffectCode none)) ## NO ARGUMENT PROVIDED if [ "$#" -eq 0 ]; then echo -n "${RESET}" ## ONLY A STRING PROVIDED -> Append reset sequence elif [ "$#" -eq 1 ]; then TEXT=$1 echo -n "${TEXT}${RESET}" ## ARGUMENTS PROVIDED else TEXT=$1 FORMAT_CODE=$(getFormatCode "${@:2}") applyCodeToText "$TEXT" "$FORMAT_CODE" fi } ##------------------------------------------------------------------------------ ## removeColorCodes() { printf "$1" | sed 's/\x1b\[[0-9;]*m//g' } ##============================================================================== ## MAIN FORMAT ##============================================================================== format="USER HOST PWD GIT PYENV TF KUBE DATE CLOCK" separator_char='\uE0B0' # Separation character, '\uE0B0'=triangle separator_padding_left='' # Add char or string to the left of the separator separator_padding_right='' # Add char or string to the right of the separator segment_padding=' ' # Add char or string around segment text enable_vertical_padding=true # Add extra new line over prompt enable_command_on_new_line=true # Add new line between prompt and command ##============================================================================== ## USER ##============================================================================== font_color_user="black" background_user="green" texteffect_user="bold" ##============================================================================== ## HOST ##============================================================================== font_color_host="white" background_host="light-blue" texteffect_host="bold" ##============================================================================== ## PWD (working dir) ##============================================================================== font_color_pwd="dark-gray" background_pwd="white" texteffect_pwd="bold" max_pwd_char="25" ##============================================================================== ## GIT ##============================================================================== font_color_git="light-gray" background_git="dark-gray" texteffect_git="bold" git_symbol_synced='' git_symbol_unpushed=' ▲' git_symbol_unpulled=' ▼' git_symbol_unpushedunpulled=' ◆' git_symbol_dirty=' ◔' git_symbol_dirty_unpushed=' ◔ △' git_symbol_dirty_unpulled=' ◔ ▽' git_symbol_dirty_unpushedunpulled=' ◔ ◇' git_symbol_stash='🗎' git_update_period_minutes=15 # Use -1 to disable automatic updates ##============================================================================== ## PYENV ##============================================================================== font_color_pyenv="white" background_pyenv="blue" texteffect_pyenv="bold" ##============================================================================== ## KUBERNETES ##============================================================================== font_color_kube="white" background_kube="purple" texteffect_kube="bold" ##============================================================================== ## TERRAFORM WORKSPACE ##============================================================================== font_color_tf="purple" background_tf="light-purple" texteffect_tf="bold" ##============================================================================== ## CLOCK ##============================================================================== font_color_clock="white" background_clock="black" texteffect_clock="bold" clock_format="%H:%M:%S" ##============================================================================== ## DATE ##============================================================================== font_color_date="white" background_date="light-purple" texteffect_date="bold" date_format="${hari}, %d ${bulan} %Y" ##============================================================================== ## INPUT (user typed command) ##============================================================================== font_color_input="45" background_input="none" texteffect_input="bold" ##============================================================================== ## EXTERNAL DEPENDENCIES ##============================================================================== [ "$(type -t include)" != 'function' ]&&{ include(){ { [ -z "$_IR" ]&&_IR="$PWD"&&cd "$(dirname "${BASH_SOURCE[0]}")"&&include "$1"&&cd "$_IR"&&unset _IR;}||{ local d="$PWD"&&cd "$(dirname "$PWD/$1")"&&. "$(basename "$1")"&&cd "$d";}||{ echo "Include failed $PWD->$1"&&exit 1;};};} synth_shell_prompt() { ##============================================================================== ## FUNCTIONS ##============================================================================== ##------------------------------------------------------------------------------ ## ## Returns current git branch for current directory, if (and only if) ## the current directory is part of a git repository, and git is installed. ## ## In addition, it adds a symbol to indicate the state of the repository. ## By default, these symbols and their meaning are (set globally): ## ## UPSTREAM NO CHANGE DIRTY ## up to date SSP_GIT_SYNCED SSP_GIT_DIRTY ## ahead SSP_GIT_AHEAD SSP_GIT_DIRTY_AHEAD ## behind SSP_GIT_BEHIND SSP_GIT_DIRTY_BEHIND ## diverged SSP_GIT_DIVERGED SSP_GIT_DIRTY_DIVERGED ## ## Returns an empty string otherwise. ## ## Inspired by twolfson's sexy-bash-prompt: ## https://github.com/twolfson/sexy-bash-prompt ## getGitBranch() { ## Check if git is installed, otherwise skip this function so as to not ## generate any errors. if ! ( which git > /dev/null 2>&1 ); then echo "" return fi ## Check if in a git respository, otherwise skip since there is no info ## to print. local branch=$(git branch 2> /dev/null |\ sed -n '/^[^*]/d;s/*\s*\(.*\)/\1/p') if [[ -z "$branch" ]]; then echo "" return fi ## Fetch branch, required to later determine if the local dir is up to date. ## Because doing so for every terminal prompt can be slow, the script will ## do so only if its globaly enabled (see config) and only periodically in ## the background. if [ "$SSP_GIT_UPDATE_PERIOD_MINUTES" -ge 0 ]; then ## Find .git, i.e., the root of the repository. local d="$PWD" local max_lvls=25 while [ ! -e "./.git" -a $max_lvls -gt 0 ]; do cd .. # Go up 1 level max_lvls=$((max_lvls - 1)) done local dot_git="${PWD}/.git" cd "$d" ## Check if submodule. if [ -f "$dot_git" ]; then local dot_git=$(cat $dot_git | grep 'gitdir' | sed 's/gitdir:\ //g') fi ## Get timestamp. if [ -d "$dot_git" -a -e "${dot_git}/FETCH_HEAD" ]; then local git_last_update=$(stat -c "%Y" "${dot_git}/FETCH_HEAD") fi ## Update if it's time to do so. if [ ! -z $git_last_update ]; then local current_timestamp=$(date +%s) local elapsed_minutes=$(((current_timestamp-git_last_update)/60)) if [ "$elapsed_minutes" -ge "$SSP_GIT_UPDATE_PERIOD_MINUTES" ]; then git fetch --recurse-submodules > /dev/null 2>&1 & fi fi fi ## Get repository status. ## This information contains whether the current branch is ahead, behind or ## diverged (ahead & behind), as well as whether any file has been modified ## locally (is dirty). ## @note The repository must be fetched for this information to be accurate. ## @note The following git flags are used: ## --porcelain: script friendly output. ## -b: show branch tracking info. ## -u no: do not list untracked/dirty files. local is_dirty=false &&\ [[ -n "$(git status --porcelain)" ]] &&\ is_dirty=true local is_ahead=false &&\ [[ "$(git status --porcelain -u no -b)" == *"ahead"* ]] &&\ is_ahead=true local is_behind=false &&\ [[ "$(git status --porcelain -u no -b)" == *"behind"* ]] &&\ is_behind=true ## Determine symbol to show in prompt according to git status. if $is_dirty && $is_ahead && $is_behind; then local symbol=$SSP_GIT_DIRTY_DIVERGED elif $is_dirty && $is_ahead; then local symbol=$SSP_GIT_DIRTY_AHEAD elif $is_dirty && $is_behind; then local symbol=$SSP_GIT_DIRTY_BEHIND elif $is_dirty; then local symbol=$SSP_GIT_DIRTY elif $is_ahead && $is_behind; then local symbol=$SSP_GIT_DIVERGED elif $is_ahead; then local symbol=$SSP_GIT_AHEAD elif $is_behind; then local symbol=$SSP_GIT_BEHIND else local symbol=$SSP_GIT_SYNCED fi ## Get commit tag (if any). [[ -n "$(git tag --points-at HEAD)" ]] &&\ local tag=" $(git tag --points-at HEAD)" || local tag="" ## Get stash count (if any). local git_stash="" local stashed_elements=$(git stash list 2> /dev/null | wc -l) if [ "$stashed_elements" -gt 0 ]; then git_stash=" ${stashed_elements}${SSP_GIT_STASH}" fi ## Return assembled prompt segmet with git info. echo "${branch}$symbol${git_stash}${tag}" } ##------------------------------------------------------------------------------ ## ## getTerraform() { ## Check if terraform is installed, otherwise skip this function. if ! ( which terraform > /dev/null 2>&1 ); then echo "" return fi ## Check if we are in a terraform directory, otherwise skip. if [ ! -d .terraform ]; then echo "" return fi ## Get the terraform workspace local tf="$(terraform workspace show 2> /dev/null | tr -d '\n')" echo "$tf" } ##------------------------------------------------------------------------------ ## ## getPyenv() { ## Conda environment if [ -n "$CONDA_DEFAULT_ENV" ]; then echo "$CONDA_DEFAULT_ENV" ## Python virtual environment elif [ -n "${VIRTUAL_ENV:-}" ]; then local regex='PS1=\"\((.*?)\)\s\$\{PS1' local pyenv=$(cat $VIRTUAL_ENV/bin/activate |\ perl -n -e"/$regex/ && print \$1" 2> /dev/null) if [ -z "${pyenv}" ]; then local pyenv=$(basename ${VIRTUAL_ENV}) fi echo "$pyenv" fi } ##------------------------------------------------------------------------------ ## ## getKube() { type kubectl &>/dev/null && \ type yq &>/dev/null && \ echo -n "$(kubectl config view | yq '.contexts[].context.cluster |select(.contexts[].name == .current-context)' | head -n 1)" } ##------------------------------------------------------------------------------ ## ## Print each word of the propmpt, i.e., a small text acompanied by the ## separator character and formated with colors and background. ## printSegment() { ## GET PARAMETERS local text=$1 local font_color=$2 local background_color=$3 local next_background_color=$4 # needed for the separator, it participates in this and the next text segment local font_effect=$5 ## COMPUTE COLOR FORMAT CODES local no_color="\[$(getFormatCode -e reset)\]" local text_format="\[$(getFormatCode -c $font_color -b $background_color -e $font_effect)\]" local separator_format="\[$(getFormatCode -c $background_color -b $next_background_color)\]" ## GENERATE TEXT printf "${text_format}${segment_padding}${text}${segment_padding}${separator_padding_left}${separator_format}${separator_char}${separator_padding_right}${no_color}" } ##------------------------------------------------------------------------------ ## ## get_colors_for_element() { case $1 in "USER") echo "${SSP_COLORS_USER[@]}" ;; "HOST") echo "${SSP_COLORS_HOST[@]}" ;; "PWD") echo "${SSP_COLORS_PWD[@]}" ;; "GIT") echo "${SSP_COLORS_GIT[@]}" ;; "PYENV") echo "${SSP_COLORS_PYENV[@]}";; "KUBE") echo "${SSP_COLORS_KUBE[@]}";; "TF") echo "${SSP_COLORS_TF[@]}" ;; "CLOCK") echo "${SSP_COLORS_CLOCK[@]}";; "DATE") echo "${SSP_COLORS_DATE[@]}";; "INPUT") echo "${SSP_COLORS_INPUT[@]}";; *) esac } ##------------------------------------------------------------------------------ ## ## combine_elements() { local first=$1 local second=$2 local colors_first=($(get_colors_for_element $first)) local colors_second=($(get_colors_for_element $second)) case $first in "USER") local text="$user" ;; "HOST") local text="$host" ;; "PWD") local text="$path" ;; "GIT") local text="$git_branch" ;; "PYENV") local text="$pyenv" ;; "KUBE") local text="$kube" ;; "TF") local text="$tf" ;; "CLOCK") local text="$clock" ;; "DATE") local text="$date" ;; "INPUT") local text="" ;; *) local text="" ;; esac local text_color=${colors_first[0]} local bg_color=${colors_first[1]} local next_bg_color=${colors_second[1]} local text_effect=${colors_first[2]} printSegment "$text" "$text_color" "$bg_color" "$next_bg_color" "$text_effect" } ##============================================================================== ## HOOK ##============================================================================== prompt_command_hook() { ## GET PARAMETERS ## This might be a bit redundant, but it makes it easier to maintain local elements=(${SSP_ELEMENTS[@]}) local user=$USER local host=$HOSTNAME local path=$PWD local git_branch="$(getGitBranch)" local pyenv="$(getPyenv)" local kube="$(getKube)" local tf="$(getTerraform)" local clock="$(date +"${SSP_CLOCK_FORMAT}")" local date="$(date +"${SSP_DATE_FORMAT}")" ## ADAPT DYNAMICALLY ELEMENTS TO BE SHOWN ## Check if elements such as GIT and the Python environment should be ## shown and adapt the variables as needed. This usually implies removing ## the appropriate field from the "elements" array if the user set them if [ -z "$git_branch" ]; then elements=( ${elements[@]/"GIT"} ) # Remove GIT from elements to be shown fi if [ -z "$pyenv" ]; then elements=( ${elements[@]/"PYENV"} ) # Remove PYENV from elements to be shown fi if [ -z "$tf" ]; then elements=( ${elements[@]/"TF"} ) # Remove TF from elements to be shown fi if [ -z "$kube" ]; then elements=( ${elements[@]/"KUBE"} ) # Remove KUBE from elements to be shown fi ## WINDOW TITLE ## Prevent messed up terminal-window titles, must be set in the PS1 variable case $TERM in xterm*|rxvt*) SSP_PWD="$path" local titlebar="\[\033]0;\${USER}@\${HOSTNAME}: \${SSP_PWD}\007\]" ;; *) local titlebar="" ;; esac ## CONSTRUCT PROMPT ITERATIVELY ## Iterate through all elements to be shown and combine them. Stop once only ## 1 element is left, which should be the "INPUT" element; then apply the ## INPUT formatting. ## Notice that this reuses the PS1 variables over and over again, and appends ## all extra formatting elements to the end of it. PS1="${titlebar}${SSP_VERTICAL_PADDING}${SSP_NEW_LINE_LINK_TOP}" while [ "${#elements[@]}" -gt 1 ]; do local current=${elements[0]} local next=${elements[1]} local elements=("${elements[@]:1}") #remove the 1st element PS1="$PS1$(combine_elements $current $next)" done local input_colors=($(get_colors_for_element ${elements[0]})) local input_color=${input_colors[0]} local input_bg=${input_colors[1]} local input_effect=${input_colors[2]} local input_format="\[$(getFormatCode -c $input_color -b $input_bg -e $input_effect)\]" local command_start_symbol="${input_format}${SSP_BASH_SYMBOL}" ## the prompt is then the prompt we build above, the separation between prompt and command and in ## the case of a new line inbetween, the corresponding link and $ symbol to start the command. PS1="${PS1}${SSP_PROMPT_COMM_SEP}${SSP_NEW_LINE_LINK_BOTTOM}${command_start_symbol} $input_format" ## Once this point is reached, PS1 is formatted and set. The terminal session ## will then use that variable to prompt the user :) } ##============================================================================== ## MAIN ##============================================================================== ## PADDING if $enable_vertical_padding; then local vertical_padding="\n" else local vertical_padding="" fi ## NEW LINE if $enable_command_on_new_line; then local new_line_link_top="╭" local new_line_link_bottom="╰>" local prompt_command_separation="\n" local bash_symbol="\$" else local new_line_link_top="" local new_line_link_top="" local prompt_command_separation="" local bash_symbol="" fi ## CONFIG FOR "prompt_command_hook()" SSP_ELEMENTS=($format "INPUT") # Append INPUT to elements that have to be shown SSP_COLORS_USER=($font_color_user $background_user $texteffect_user) SSP_COLORS_HOST=($font_color_host $background_host $texteffect_host) SSP_COLORS_PWD=($font_color_pwd $background_pwd $texteffect_pwd) SSP_COLORS_GIT=($font_color_git $background_git $texteffect_git) SSP_COLORS_PYENV=($font_color_pyenv $background_pyenv $texteffect_pyenv) SSP_COLORS_KUBE=($font_color_kube $background_kube $texteffect_kube) SSP_COLORS_TF=($font_color_tf $background_tf $texteffect_tf) SSP_COLORS_CLOCK=($font_color_clock $background_clock $texteffect_clock) SSP_COLORS_DATE=($font_color_date $background_date $texteffect_date) SSP_COLORS_INPUT=($font_color_input $background_input $texteffect_input) SSP_VERTICAL_PADDING=$vertical_padding SSP_NEW_LINE_LINK_TOP=$new_line_link_top SSP_NEW_LINE_LINK_BOTTOM=$new_line_link_bottom SSP_PROMPT_COMM_SEP=$prompt_command_separation SSP_BASH_SYMBOL=$bash_symbol SSP_MAX_PWD_CHAR=${max_pwd_char:-25} SSP_GIT_SYNCED=$git_symbol_synced SSP_GIT_AHEAD=$git_symbol_unpushed SSP_GIT_BEHIND=$git_symbol_unpulled SSP_GIT_DIVERGED=$git_symbol_unpushedunpulled SSP_GIT_DIRTY=$git_symbol_dirty SSP_GIT_DIRTY_AHEAD=$git_symbol_dirty_unpushed SSP_GIT_DIRTY_BEHIND=$git_symbol_dirty_unpulled SSP_GIT_DIRTY_DIVERGED=$git_symbol_dirty_unpushedunpulled SSP_GIT_STASH=$git_symbol_stash SSP_GIT_UPDATE_PERIOD_MINUTES=$git_update_period_minutes SSP_CLOCK_FORMAT=${clock_format:-"%H:%M:%S"} SSP_DATE_FORMAT=${date_format:-"%A, %d %B %Y"} ## For terminal line coloring, leaving the rest standard none="$(tput sgr0)" trap 'echo -ne "${none}"' DEBUG ## ADD HOOK TO UPDATE PS1 AFTER EACH COMMAND ## Bash provides an environment variable called PROMPT_COMMAND. ## The contents of this variable are executed as a regular Bash command ## just before Bash displays a prompt. ## We want it to call our own command to truncate PWD and store it in NEW_PWD PROMPT_COMMAND=prompt_command_hook } # synth_shell_prompt() ##------------------------------------------------------------------------------ ## ## CALL SCRIPT FUNCTION ## - CHECK IF SCRIPT IS _NOT_ BEING SOURCED ## - CHECK IF COLOR SUPPORTED ## - Check if compliant with Ecma-48 (ISO/IEC-6429) ## - Call script ## - Unset script ## If not running interactively, don't do anything if [ "${BASH_SOURCE[0]}" == "${0}" ]; then echo -e "Do not run this script, it will do nothing.\nPlease source it instead by running:\n" echo -e "\t. ${BASH_SOURCE[0]}\n" exit elif [ -n "$( echo $- | grep i )" ]; then if command -v tput >/dev/null 2>&1 && tput setaf 1 >&/dev/null; then synth_shell_prompt fi unset synth_shell_prompt unset include fi