Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Check deprecate configuration variables #119

Open
wants to merge 3 commits into
base: master
Choose a base branch
from
Open

Check deprecate configuration variables #119

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
62ffcec
Check deprecate configuration variables
akinomyoga Jan 21, 2022
91f0edf
Work around the "division by 0" error without any segments
akinomyoga Jan 23, 2022
61d7f1f
Fix a typo in error message (configure::get_feature_file)
akinomyoga Jan 23, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 3 additions & 0 deletions sbp.bash
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -64,6 +64,7 @@ _sbp_set_prompt() {
fi
printf '\e]2;%s\007' "$title"

((_sbp_set_prompt_count++))
PS1=$(bash "${SBP_PATH}/src/main.bash" "$command_status" "$command_duration")
[[ -n "$SBP_DEBUG" ]] && debug::tick_timer "Done"

Expand All @@ -78,4 +79,6 @@ _sbp_pre_exec() {
# shellcheck disable=SC2034
PS0="\$(_sbp_pre_exec)"

export _sbp_set_prompt_count=0

[[ "$PROMPT_COMMAND" =~ _sbp_set_prompt ]] || PROMPT_COMMAND="_sbp_set_prompt;$PROMPT_COMMAND"
148 changes: 147 additions & 1 deletion src/configure.bash
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -37,7 +37,7 @@ configure::get_feature_file() {
else
debug::log "Could not find $local_file"
debug::log "Could not find $global_file"
debug::log "Make sure at least on of them exists"
debug::log "Make sure at least one of them exists"
fi

}
Expand Down Expand Up @@ -78,6 +78,148 @@ configure::set_layout() {
fi
}

configure::deprecate::_is_warning_enabled() {
# shellcheck disable=SC2154 # _sbp_set_prompt_count is supposed to be
# exported by the parent shell.
((_sbp_set_prompt_count <= 1))
}

configure::deprecate::_warn_proc() {
local old_config_name=$1 new_config_name=${2-} message=${3-}
local sgr0=$'\e[m' sgr_old=$'\e[1;31m' sgr_new=$'\e[1;34m'
if [[ ! $message && $new_config_name ]]; then
message="Please use '$sgr_new$new_config_name$sgr0'."
fi
printf '\e[35m%s\e[36m:\e[32m%s\e[36m:\e[m %s\n' "${BASH_SOURCE[1]}" "${BASH_LINENO[0]}" "'$sgr_old$old_config_name$sgr0' is deprecated.${message:+ $message}" >/dev/tty
}

configure::deprecate::_add_scalar() {
local old_config_name=$1 new_config_name=$2
local fallback_variable=${new_config_name:-_sbp_configure_deprecate__$old_config_name}
if configure::deprecate::_is_warning_enabled; then
# shellcheck disable=SC1087
declare -gn "$old_config_name=$fallback_variable[\$(configure::deprecate::_warn_proc '$old_config_name' '$new_config_name')]"
else
declare -gn "$old_config_name=$fallback_variable"
fi
_sbp_configure_deprecated_configs+=()
}

configure::deprecate::_add_array() {
local old_config_name=$1 new_config_name=$2 default_elements=$3
_sbp_configure_deprecated_arrays+=("$old_config_name:$new_config_name:$default_elements")
}

configure::deprecate::reset() {
local old_config_name
for old_config_name in "${_sbp_configure_deprecated_configs[@]}"; do
unset -n "$old_config_name"
done
unset -v _sbp_configure_deprecated_configs

local entry new_config_name default_elements
for entry in "${_sbp_configure_deprecated_arrays[@]}"; do
old_config_name=${entry%%:*} entry=${entry#*:}
new_config_name=${entry%%:*} entry=${entry#*:}
default_elements=$entry
if ! declare -p "$new_config_name" &>/dev/null; then
if declare -p "$old_config_name" &>/dev/null; then
if configure::deprecate::_is_warning_enabled; then
local sgr0=$'\e[m' sgr_file=$'\e[35m' sgr_sep=$'\e[36m' sgr_old=$'\e[1;31m' sgr_new=$'\e[1;34m'
printf '%s\n' "$sgr_file$config_file$sgr_sep:$sgr0 Array '$sgr_old$old_config_name$sgr0' is deprecated. Please assign to '$sgr_new$new_config_name$sgr0'." >/dev/tty
fi
eval -- "$new_config_name=(\"\${$old_config_name[@]}\")"
else
eval -- "$new_config_name=($default_elements)"
fi
fi
done
}

configure::deprecate::setup() {
# List of deprecated configuration variables

# commit 3c9b999f24445441fa828627c6b269e8c322704b
configure::deprecate::_add_scalar color00 color0
configure::deprecate::_add_scalar color01 color1
configure::deprecate::_add_scalar color02 color2
configure::deprecate::_add_scalar color03 color3
configure::deprecate::_add_scalar color04 color4
configure::deprecate::_add_scalar color05 color5
configure::deprecate::_add_scalar color06 color6
configure::deprecate::_add_scalar color07 color7
configure::deprecate::_add_scalar color08 color8
configure::deprecate::_add_scalar color09 color9
configure::deprecate::_add_scalar color0A color10
configure::deprecate::_add_scalar color0B color11
configure::deprecate::_add_scalar color0C color12
configure::deprecate::_add_scalar color0D color13
configure::deprecate::_add_scalar color0E color14
configure::deprecate::_add_scalar color0F color15

configure::deprecate::_add_array settings_hooks SBP_HOOKS "'alert'"
configure::deprecate::_add_array settings_segments_left SBP_SEGMENTS_LEFT "'host' 'path' 'python_env' 'k8s' 'git' 'nix'"
configure::deprecate::_add_array settings_segments_right RBP_SEGMENTS_RIGHT "'command' 'timestamp'"

configure::deprecate::_add_scalar settings_theme_color SBP_THEME_COLOR
configure::deprecate::_add_scalar settings_theme_layout SBP_THEME_LAYOUT
configure::deprecate::_add_scalar settings_timestamp_format SEGMENTS_TIMESTAMP_FORMAT
configure::deprecate::_add_scalar settings_openshift_default_user SEGMENTS_K8S_DEFAULT_USER
configure::deprecate::_add_scalar settings_openshift_hide_cluster SEGMENTS_K8S_HIDE_CLUSTER
configure::deprecate::_add_scalar settings_rescuetime_refresh_rate SEGMENTS_RESCUETIME_REFRESH_RATE
configure::deprecate::_add_scalar settings_git_icon SEGMENTS_GIT_ICON 'This will be set up by layout.'
configure::deprecate::_add_scalar settings_git_incoming_icon SEGMENTS_GIT_INCOMING_ICON 'This will be set up by layout.'
configure::deprecate::_add_scalar settings_git_outgoing_icon SEGMENTS_GIT_OUTGOING_ICON 'This will be set up by layout.'
configure::deprecate::_add_scalar settings_path_splitter_disable SEGMENTS_PATH_SPLITTER_DISABLE 'This will be set up by layout.'
configure::deprecate::_add_scalar settings_prompt_ready_icon SEGMENTS_PROMPT_READY_ICON 'This will be set up by layout.'

configure::deprecate::_add_scalar settings_command_color_primary SEGMENTS_COMMAND_COLOR_PRIMARY
configure::deprecate::_add_scalar settings_command_color_secondary SEGMENTS_COMMAND_COLOR_SECONDARY
configure::deprecate::_add_scalar settings_command_color_primary_error SEGMENTS_COMMAND_COLOR_PRIMARY_HIGHLIGHT
configure::deprecate::_add_scalar settings_command_color_secondary_error SEGMENTS_COMMAND_COLOR_SECONDARY_HIGHLIGHT
configure::deprecate::_add_scalar settings_git_color_primary SEGMENTS_GIT_COLOR_PRIMARY
configure::deprecate::_add_scalar settings_git_color_secondary SEGMENTS_GIT_COLOR_SECONDARY
configure::deprecate::_add_scalar settings_host_color_primary SEGMENTS_HOST_COLOR_PRIMARY
configure::deprecate::_add_scalar settings_host_color_secondary SEGMENTS_HOST_COLOR_SECONDARY
configure::deprecate::_add_scalar settings_host_root_color_primary SEGMENTS_HOST_COLOR_PRIMARY_HIGHLIGHT
configure::deprecate::_add_scalar settings_host_root_color_secondary SEGMENTS_HOST_COLOR_SECONDARY_HIGHLIGHT
configure::deprecate::_add_scalar settings_path_color_primary SEGMENTS_PATH_COLOR_PRIMARY
configure::deprecate::_add_scalar settings_path_color_secondary SEGMENTS_PATH_COLOR_SECONDARY
configure::deprecate::_add_scalar settings_path_splitter_color SEGMENTS_PATH_COLOR_SPLITTER
configure::deprecate::_add_scalar settings_path_readonly_color_secondary SEGMENTS_PATH_RO_COLOR_SECONDARY
configure::deprecate::_add_scalar settings_path_readonly_color_primary SEGMENTS_PATH_RO_COLOR_PRIMARY
configure::deprecate::_add_scalar settings_prompt_ready_color_primary SEGMENTS_PROMPT_READY_COLOR_PRIMARY
configure::deprecate::_add_scalar settings_prompt_ready_color_secondary SEGMENTS_PROMPT_READY_COLOR_SECONDARY
configure::deprecate::_add_scalar settings_python_virtual_env_color_primary SEGMENTS_PYTHON_ENV_COLOR_PRIMARY
configure::deprecate::_add_scalar settings_python_virtual_env_color_secondary SEGMENTS_PYTHON_ENV_COLOR_SECONDARY
configure::deprecate::_add_scalar settings_return_code_color_primary SEGMENTS_RETURN_CODE_COLOR_PRIMARY
configure::deprecate::_add_scalar settings_return_code_color_secondary SEGMENTS_RETURN_CODE_COLOR_SECONDARY
configure::deprecate::_add_scalar settings_timestamp_color_primary SEGMENTS_TIMESTAMP_COLOR_PRIMARY
configure::deprecate::_add_scalar settings_timestamp_color_secondary SEGMENTS_TIMESTAMP_COLOR_SECONDARY
configure::deprecate::_add_scalar settings_aws_color_primary SEGMENTS_AWS_COLOR_PRIMARY
configure::deprecate::_add_scalar settings_aws_color_secondary SEGMENTS_AWS_COLOR_SECONDARY
configure::deprecate::_add_scalar settings_openshift_color_primary SEGMENTS_K8S_COLOR_PRIMARY
configure::deprecate::_add_scalar settings_openshift_color_secondary SEGMENTS_K8S_COLOR_SECONDARY
configure::deprecate::_add_scalar settings_rescuetime_color_primary SEGMENTS_RESCUETIME_COLOR_PRIMARY
configure::deprecate::_add_scalar settings_rescuetime_color_secondary SEGMENTS_RESCUETIME_COLOR_SECONDARY
configure::deprecate::_add_scalar settings_rescuetime_splitter_color SEGMENTS_RESCUETIME_SPLITTER_COLOR
configure::deprecate::_add_scalar settings_prompt_ready_vi_mode ''
configure::deprecate::_add_scalar settings_prompt_ready_newline ''
configure::deprecate::_add_scalar settings_prompt_ready_vi_insert_color ''
configure::deprecate::_add_scalar settings_prompt_ready_vi_command_color ''

# commit 3e2eba8f62098fb07be071445482494c4b36c03f
configure::deprecate::_add_scalar SEGMENTS_PATH_SPLITTER_COLOR SEGMENTS_PATH_COLOR_SPLITTER

# commit b3b3c0ba039036ef7eeccddfa3e9fda26eda1642
configure::deprecate::_add_scalar SEGMENTS_PATH_READONLY_COLOR_SECONDARY SEGMENTS_PATH_RO_COLOR_SECONDARY
configure::deprecate::_add_scalar SEGMENTS_PATH_READONLY_COLOR_PRIMARY SEGMENTS_PATH_RO_COLOR_PRIMARY

# commit f5d0b29e2647ce644ea01be469da10a3cbb4939d
configure::deprecate::_add_scalar SETTINGS_WTTR_LOCATION SEGMENTS_WTTR_LOCATION
configure::deprecate::_add_scalar SETTINGS_WTTR_FORMAT SEGMENTS_WTTR_FORMAT
}

configure::load_config() {
[[ -d "$SBP_CACHE" ]] || mkdir -p "$SBP_CACHE"

Expand All @@ -93,6 +235,8 @@ configure::load_config() {
cp "$colors_template" "$colors_file"
fi

configure::deprecate::setup

# shellcheck source=/dev/null
source "$config_file"
source "$default_config"
Expand All @@ -101,4 +245,6 @@ configure::load_config() {
# shellcheck source=/dev/null
source "$colors_file"
source "$default_colors"

configure::deprecate::reset
}
2 changes: 1 addition & 1 deletion src/main.bash
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,7 @@ main::main() {
left_segment_count=${#SBP_SEGMENTS_LEFT[@]}
right_segment_count=${#SBP_SEGMENTS_RIGHT[@]}
total_segment_count=$(( left_segment_count + right_segment_count ))
SEGMENTS_MAX_LENGTH=$(( COLUMNS / total_segment_count ))
SEGMENTS_MAX_LENGTH=$(( COLUMNS / (total_segment_count ? total_segment_count : 1) ))

for group in "${segment_groups[@]}"; do
# Bash doesn't support array -> array, so we use pointers instead :(
Expand Down