Revert "Replace all evals with declare"

This reverts commit 315fe0bab7.

.gitignore

@@ -1,3 +1,4 @@
 __pycache__/
 *.pyc
 config.gie
+site/

.readthedocs.yaml

@@ -0,0 +1,8 @@
+version: 2
+build:
+  os: ubuntu-22.04
+  tools:
+    python: "3.12"
+
+mkdocs:
+  configuration: mkdocs.yml

README.md

@@ -18,7 +18,7 @@ A customizable, extensible, themable bash prompt.
 ## One step Installation
 
 ```sh
-curl https://gitlab.com/ceda_ei/wish/raw/master/install.sh | bash
+curl https://gitlab.com/ceda_ei/wish/raw/main/install.sh | bash
 ```
 
 ## Manual Installation
@@ -27,6 +27,12 @@ curl https://gitlab.com/ceda_ei/wish/raw/master/install.sh | bash
 + `git clone https://gitlab.com/ceda_ei/wish.git`
 + `cp wish/config.default.gie wish/config.gie`
 
+
+# Documentation
+
+[Check the wiki for details about customization and
+plugins.](https://wish.readthedocs.io/)
+
 # Customization
 
 Customization of wish is done using a gINIe file (format specific to wish)
@@ -105,7 +111,3 @@ name = hostname
 Which results in the following prompt
 
 ![](https://webionite.com/wish/images/prompt.png)
-
-# Wiki
-
-[Check the wiki for details about customization and plugins.](https://gitlab.com/ceda_ei/wish/wikis/home)

docs/Customization.md

@@ -0,0 +1,3 @@
+# Customization
+
+TODO

docs/Installation.md

@@ -0,0 +1,17 @@
+# Installation
+
+## One step Installation
+
+```sh
+curl https://gitlab.com/ceda_ei/wish/raw/main/install.sh | bash
+```
+
+## Manual Installation
+
++ `cd ~/.config/`
++ `git clone https://gitlab.com/ceda_ei/wish.git`
++ `cp wish/config.default.gie wish/config.gie`
+
+## Customization
+
+Head over to [Customization](Customization.md)

docs/Themes.md

@@ -0,0 +1,3 @@
+# Themes
+
+TODO

docs/development/creating_plugins.md

@@ -0,0 +1,3 @@
+# Creating Plugins
+
+TODO

docs/development/creating_themes.md

@@ -0,0 +1,13 @@
+# Creating Themes
+
+Themes need to define the following variables.
+
++ `WISH_DEFAULT_FG`
++ `WISH_DEFAULT_BG`
+
+Plugins will fallback to these variables if they are not themed.
+
+Themes also need to define variables for plugins. For each plugin named `abc`,
+the theme needs to define `WISH_ABC_BG` and `WISH_ABC_FG`. Themes can
+optionally iterate over `WISH_PLUGINS` array to ensure to theme all elements.
+Check existing [themes](https://gitlab.com/ceda_ei/wish/tree/main/themes).

docs/index.md

@@ -0,0 +1,15 @@
+# Wish
+
+A customizable bash prompt.
+
+## Features
+
+- Extremely configurable: Wish is configured by a single gINIe file
+- Easy to switch themes: Switching themes is as simple as changing a single line.
+- Easy custom themes: Users can override colors for plugins.
+- Responsive: Adapts to terminal width.
+- Easy to create plugins: Plugins are written in bash allowing great flexibility to extend.
+
+## Getting Started
+
+Head over to [Installation](Installation.md)

docs/plugins/battery.md

@@ -0,0 +1,18 @@
+# Battery
+
+Shows the amount of charge in the battery and if it is charging/discharging.
+
+## Add to wish
+
+```ini
+[plugin]
+name = battery
+```
+
+## Config options
+
+| Key         | Meaning                                  | Default |
+|-------------|------------------------------------------|---------|
+| id          | ID of Battery to check.                  | BAT0    |
+| charging    | Symbol while the battery is charging.    | ϟ       |
+| discharging | Symbol while the battery is discharging. | ⏚       |

docs/plugins/bgjobs.md

@@ -0,0 +1,15 @@
+# Background Jobs
+
+Shows the number of background jobs running
+
+## Add to wish
+
+```ini
+[plugin]
+name = bg_jobs
+```
+## Config options
+
+| Key    | Meaning                                     | Default |
+|--------|---------------------------------------------|---------|
+| suffix | Suffix to add to number of background jobs. | &       |

docs/plugins/customtext.md

@@ -0,0 +1,17 @@
+# Custom Text
+
+Display the provided custom text in the prompt.
+
+
+## Add to wish
+
+```ini
+[plugin]
+name = custom_text
+```
+
+## Config options
+
+| Key  | Meaning              | Default |
+|------|----------------------|:-------:|
+| text | Custom text to show. |    -    |

docs/plugins/date.md

@@ -0,0 +1,16 @@
+# Date
+
+Shows the current date and time.
+
+## Add to wish
+
+```ini
+[plugin]
+name = date
+```
+
+## Config options
+
+| Key    | Meaning                                                                         | Default |
+|--------|---------------------------------------------------------------------------------|---------|
+| format | set the date format. Refer to `FORMAT` section of  `man date` for more details. | %F %T   |

docs/plugins/exitcode.md

@@ -0,0 +1,15 @@
+# Exit Code
+
+Shows the exit code of the last command if it is non-zero.
+
+
+## Add to wish
+
+```ini
+[plugin]
+name = exit_code
+```
+
+## Config options
+
+No plugin specific config options are available.

docs/plugins/exitcodesmiley.md

@@ -0,0 +1,19 @@
+# Exit Code Smiley
+
+Shows a happy/sad smiley face based on whether the last command ran successfully or not.
+
+
+## Add to wish
+
+```ini
+[plugin]
+name = exit_code_smiley
+```
+
+## Config options
+
+| Key          | Meaning                                                      | Default |
+|--------------|--------------------------------------------------------------|---------|
+| pass         | Text to show when the last command ran successfully.         | :)      |
+| fail         | Text to show when the last command failed.                   | :(      |
+| hide_on_pass | Whether to hide the output if command executes successfully. | 0       |

docs/plugins/hostname.md

@@ -0,0 +1,14 @@
+# Hostname
+
+Shows the current system's hostname.
+
+## Add to wish
+
+```ini
+[plugin]
+name = hostname
+```
+
+## Config options
+
+No plugin specific config options are available.

docs/plugins/newline.md

@@ -0,0 +1,14 @@
+# Newline
+
+Adds a newline to prompt to push the next plugins into next line.
+
+## Add to wish
+
+```ini
+[plugin]
+name = newline
+```
+
+## Config options
+
+No plugin specific config options are available.

docs/plugins/path.md

@@ -0,0 +1,17 @@
+# Path
+
+Shows the current path and whether it is writeable.
+
+
+## Add to wish
+
+```ini
+[plugin]
+name = path
+```
+
+## Config options
+
+| Key             | Meaning                                      | Default |
+|-----------------|----------------------------------------------|---------|
+| no_write_suffix | Suffix if the current path is not writeable. |        |

docs/plugins/path_powerline.md

@@ -0,0 +1,28 @@
+# Path Powerline
+
+Shows the current path and whether it is writeable.
+
+## Features
+
+- Powerline symbols used as path separators.
+- Long paths are shrunk down to allow for more space for other plugins.
+	- e.g. `/usr/lib/systemd/system/` might get shortened to one of the
+	  following based on config + screen width: `/u/l/s/system`,
+	  `/u/l/systemd/system` or `/u/lib/systemd/system`
+	- This is configurable and disabled by default (check `max_perc` config)
+	- Recommended value for `max_perc` is `50`
+
+
+## Add to wish
+
+```ini
+[plugin]
+name = path
+```
+
+## Config options
+
+| Key             | Meaning                                                      | Default      |
+|-----------------|--------------------------------------------------------------|--------------|
+| no_write_suffix | Suffix if the current path is not writeable.                 |             |
+| max_perc        | Maximum percentage of screen width path should take. (0-100) | 0 (disabled) |

docs/plugins/pythonvenv.md

@@ -0,0 +1,14 @@
+# Python Virtualenv
+
+Shows the currently active virtualenv. If the venv is `.venv`, it shows the parent directory's name.
+
+## Add to wish
+
+```ini
+[plugin]
+name = python_venv
+```
+
+## Config options
+
+No plugin specific config options are available.

docs/plugins/reinit.md

@@ -0,0 +1,18 @@
+# Re-Init
+
+Re-initialize wish from config every time the prompt is redrawn. This plugin is
+primarily intended for playing around with config and should ideally be removed
+after that.
+
+> Note: Add this plugin as the first plugin in `left` prompt.
+
+## Add to wish
+
+```ini
+[plugin]
+name = reinit
+```
+
+## Config options
+
+No plugin specific config options are available.

docs/plugins/space.md

@@ -0,0 +1,14 @@
+# Space
+
+Simple plugin that adds an empty space.
+
+## Add to wish
+
+```ini
+[plugin]
+name = space
+```
+
+## Config options
+
+No plugin specific config options are available.

docs/plugins/tmux.md

@@ -0,0 +1,14 @@
+# Tmux Detached Sessions
+
+Lists the number of tmux sessions that are detached.
+
+### Add to wish
+```ini
+[plugin]
+name = vcs
+```
+## Config options
+
+| Key    | Meaning                                          | Default |
+|--------|--------------------------------------------------|---------|
+| suffix | suffix to add after number of detached sessions. | d       |

docs/plugins/username.md

@@ -0,0 +1,14 @@
+# Username
+
+Shows the current unix username
+
+## Add to wish
+
+```ini
+[plugin]
+name = username
+```
+
+## Config options
+
+No plugin specific config options are available.

docs/plugins/vcs.md

@@ -0,0 +1,24 @@
+# Version Control System (Git)
+
+Provides the state of the git repository in the current directory.
+
+## Features
+
+- Notifies if there are any untracked symbols
+- Name of the current branch
+- Amount of changes (additions/subtractions)
+
+## Add to wish
+
+```ini
+[plugin]
+name = vcs
+```
+
+## Config options
+
+| Key                  | Meaning                                                         | Default |
+|----------------------|-----------------------------------------------------------------|---------|
+| git_symbol           | Symbol to indicate that the current directory is a git repo.    |        |
+| default              | Symbol to display when the current directory is not a git repo. | $       |
+| git_untracked_symbol | Symbol to show if the current git repo has untracked files.     | ●       |

docs/reference/gINIe.md

@@ -0,0 +1,42 @@
+# gINIe file format
+
+
+Customization of wish is done using a gINIe file (format specific to wish)
+which is an extended INI config file. The default location for config file is
+`~/.config/wish/config.gie`. The default config file is automatically copied
+over. The location can be customized using `WISH_CONFIG_FILE` variable.
+Multiple config files can be supplied as an array to `WISH_CONFIG_FILE`.
+
+Comments start with a `#` or `;` and always exist on a line of their own.
+
+Key value pairs are in the form of `key = value`. Keys cannot have whitespaces
+or `=` in them. Values can have any character as part of them. Surrounding
+spaces in values are stripped away. To keep surrounding spaces as a part of
+the value. Although, keys are case-sensitive in gINIe, wish treats them case-
+insensitively.
+
+Block names are enclosed in `[]` (e.g. `[core]`). Block names are case
+sensitive. All key value pairs after a block starts and before the next block
+begins are considered a part of that block. All key value pairs must be in a
+block.
+
+Available Blocks:
+
++ `core`: Core block configures Wish itself. Available keys are:
+    - `auto_newline`: Automatically add a newline if last line of output
+      doesn't end in newline. (0 to disable, 1 to enable)
+    - `theme`: Wish theme.
+    - `powerline`: Enable / Disable powerline. (0 to disable, 1 to enable)
++ `plugin`: Adds a plugin to the section the block is added to. All config for
+  that plugin goes there. Check wiki for details on available keys for
+  plugins. The key "name" defines the plugin to use. Plugin blocks
+  outside a section are ignored.
+
+Section names are enclosed in `||` (e.g. `|left|`). All blocks after a section
+starts and before the next section begins are considered a part of that
+section.  Blocks don't necessarily need to be in a section.
+
+Available sections are `left`, `right` for left prompt and right prompt
+respectively.
+
+

install.sh

@@ -3,12 +3,8 @@
 if hash git; then
 	git clone https://gitlab.com/ceda_ei/Wish.git $HOME/.config/wish
 else
-	curl https://gitlab.com/ceda_ei/wish/-/archive/master/wish-master.tar -o /tmp/wish.tar
-	mkdir $HOME/.config 2> /dev/null
-	cd /tmp/
-	tar xf wish.tar
-	mv wish-master/ wish/
-	mv wish/ $HOME/.config/
+	echo 'Git not found. Please install git.' >&2
+	exit 1
 fi
 cp $HOME/.config/wish/config.default.gie $HOME/.config/wish/config.gie
 

mkdocs.yml

@@ -0,0 +1,37 @@
+site_name: Wish
+repo_url: https://gitlab.com/ceda_ei/wish
+edit_uri: edit/main/docs/
+
+theme: readthedocs
+markdown_extensions:
+  - toc:
+      permalink: true
+
+
+nav:
+  - index.md
+  - Installation.md
+  - Customization.md
+  - Themes.md
+  - plugins:
+    - plugins/battery.md
+    - plugins/bgjobs.md
+    - plugins/customtext.md
+    - plugins/date.md
+    - plugins/exitcode.md
+    - plugins/exitcodesmiley.md
+    - plugins/hostname.md
+    - plugins/newline.md
+    - plugins/path.md
+    - plugins/path_powerline.md
+    - plugins/pythonvenv.md
+    - plugins/reinit.md
+    - plugins/space.md
+    - plugins/tmux.md
+    - plugins/username.md
+    - plugins/vcs.md
+  - development:
+    - development/creating_plugins.md
+    - development/creating_themes.md
+  - reference:
+    - reference/gINIe.md

plugins/reinit.sh

@@ -0,0 +1,15 @@
+function wish_reinit_start() {
+	return 1
+}
+
+function wish_reinit_end() {
+	return 1
+}
+
+function wish_reinit_set_colors() {
+	return
+}
+
+function wish_reinit_main() {
+	wish_init
+}

wish.sh

@@ -23,7 +23,7 @@ function wish_init() {
 	# Source config files
 	for path in "$XDG_CONFIG_HOME" "/usr/share" "$HOME/.config"; do
 		if [[ -f "$path/wish/wish.py" ]]; then
-			source <($path/wish/wish.py "${WISH_CONFIG_FILE[@]}")
+			source <("$path/wish/wish.py" "${WISH_CONFIG_FILE[@]}")
 			break
 		fi
 	done
@@ -50,10 +50,9 @@ function wish_init() {
 	# Source theme
 	WISH_THEME=${WISH_THEME:-plain}
 	while :; do
-		for theme in "$XDG_CONFIG_HOME" "/usr/share" "$HOME/.config"; do
+		if for theme in "$XDG_CONFIG_HOME" "/usr/share" "$HOME/.config"; do
 			source "$theme/wish/themes/$WISH_THEME.sh" &> /dev/null && break
-		done
-		if [[ $? -eq 0 ]]; then
+		done; then
 			break
 		else
 			echo "Theme $WISH_THEME not found. Using theme plain." >&2
@@ -67,7 +66,7 @@ function wish_init() {
 
 	# Call plugins to set colors
 	for plugin in "${WISH_PLUGINS[@]}" "${WISH_RIGHT_PLUGINS[@]}"; do
-		eval wish_${plugin}_set_colors $prev
+		"wish_${plugin}_set_colors" "$prev"
 	done
 }
 
@@ -85,13 +84,13 @@ function color_to_escape_code() {
 	if [[ $color == -1 ]]; then
 		echo "\[\033[0;5;0m\]"
 	else
-		if [[ ${#fg_code} -eq 6 ]]; then
+		if [[ ${#color} -eq 6 ]]; then
 			local r=$(( 16#${color:0:2} ))
 			local g=$(( 16#${color:2:2} ))
 			local b=$(( 16#${color:4:2} ))
 			echo "\[\033[${choice}8;2;$r;$g;${b}m\]"
 		else
-			echo "\[\033[${choice}8;5;${fg_code}m\]"
+			echo "\[\033[${choice}8;5;${color}m\]"
 		fi
 	fi
 }
@@ -103,7 +102,7 @@ function wish_append_left() {
 	local prompt_text="${text@P}"
 	if [[ $text == "\n" ]]; then
 		((WISH_LPLINE++))
-		WISH_LPL=(${WISH_LPL[@]} 0)
+		WISH_LPL=("${WISH_LPL[@]}" 0)
 		WISH_LEFT_PS1="$WISH_LEFT_PS1$colors$text"
 	else
 		if [[ $((${WISH_LPL[$WISH_LPLINE]} + ${#prompt_text})) -lt $COLUMNS ]]; then
@@ -122,7 +121,7 @@ function wish_append_right() {
 	if [[ $text == "\n" ]]; then
 		((WISH_RPLINE++))
 		WISH_RIGHT_PS1=("${WISH_RIGHT_PS1[@]}" "")
-		WISH_RPL=(${WISH_RPL[@]} 0)
+		WISH_RPL=("${WISH_RPL[@]}" 0)
 	elif [[ $((${WISH_LPL[$WISH_RPLINE]} + ${WISH_RPL[$WISH_RPLINE]} + ${#prompt_text})) -lt $COLUMNS ]]; then
 		WISH_RIGHT_PS1[$WISH_RPLINE]="${WISH_RIGHT_PS1[$WISH_RPLINE]}$colors$text"
 		WISH_RPL[$WISH_RPLINE]=$((${WISH_RPL[$WISH_RPLINE]} + ${#prompt_text}))
@@ -142,8 +141,10 @@ function wish_append() {
 	local bg_code=$1
 	local fg_code=$2
 	local text=$3
-	local fg=$(color_to_escape_code 3 $fg_code)
-	local bg=$(color_to_escape_code 4 $bg_code)
+	local fg
+	local bg
+	fg=$(color_to_escape_code 3 "$fg_code")
+	bg=$(color_to_escape_code 4 "$bg_code")
 
 	if [[ $fg_code == -1 ]]; then
 		case $WISH_STATE in
@@ -173,9 +174,9 @@ function wish_append() {
 # line.
 wish_remaining_chars() {
 	if [[ $WISH_STATE -eq 0 ]]; then
-		echo "$(( $COLUMNS - ${WISH_LPL[$WISH_LPLINE]} ))"
+		echo "$(( COLUMNS - ${WISH_LPL[$WISH_LPLINE]} ))"
 	else
-		echo "$(( $COLUMNS - ${WISH_LPL[$WISH_RPLINE]} - ${WISH_RPL[$WISH_RPLINE]} ))"
+		echo "$(( COLUMNS - ${WISH_LPL[$WISH_RPLINE]} - ${WISH_RPL[$WISH_RPLINE]} ))"
 	fi
 }
 
@@ -193,7 +194,10 @@ function wish_main() {
 	local i
 	# Set newline
 	if [[ $WISH_AUTO_NEWLINE != 0 ]]; then
-		echo -ne "\033[6n" ; read -s -d ';'; read -s -d R WISH_CURSOR_POSITION
+		echo -ne "\033[6n"
+		read -rs -d ';'
+		# shellcheck disable=SC2034
+		read -rs -d R WISH_CURSOR_POSITION
 		if [[ $WISH_CURSOR_POSITION != "1" ]]; then
 			PS1="\n"
 		fi
@@ -201,21 +205,21 @@ function wish_main() {
 	# Generate left prompt.
 	WISH_STATE=0  # 0 = left prompt, 1 = right prompt
 	for i in $(seq 0 $((${#WISH_PLUGINS[@]} - 1))); do
-		wish_${WISH_PLUGINS[i]}_main $prev
+		"wish_${WISH_PLUGINS[i]}_main" "$prev"
 		if [[ -v WISH_POWERLINE ]] && [[ $WISH_POWERLINE != 0 ]]; then
-			if wish_${WISH_PLUGINS[$i]}_end $prev; then
+			if "wish_${WISH_PLUGINS[$i]}_end" $prev; then
 				if [[ $i -lt $((${#WISH_PLUGINS[@]} - 1)) ]]; then
-					if wish_${WISH_PLUGINS[$(($i + 1))]}_start $prev; then
+					if "wish_${WISH_PLUGINS[$((i + 1))]}_start" "$prev"; then
 						local plugin=${WISH_PLUGINS[$i]}
-						local next_plugin=${WISH_PLUGINS[$(($i+1))]}
+						local next_plugin=${WISH_PLUGINS[$((i + 1))]}
 						local fg_name="WISH_${plugin^^}_BG"
 						local bg_name="WISH_${next_plugin^^}_BG"
-						wish_append ${!bg_name} ${!fg_name} "${WISH_POWERLINE_LEFT}"
+						wish_append "${!bg_name}" "${!fg_name}" "${WISH_POWERLINE_LEFT}"
 					fi
 				else
 					local plugin=${WISH_PLUGINS[$i]}
 					local fg_name="WISH_${plugin^^}_BG"
-					wish_append -1 ${!fg_name} "${WISH_POWERLINE_LEFT}"
+					wish_append -1 "${!fg_name}" "${WISH_POWERLINE_LEFT}"
 				fi
 			fi
 		fi
@@ -224,26 +228,28 @@ function wish_main() {
 	WISH_STATE=1
 	for i in $(seq 0 $((${#WISH_RIGHT_PLUGINS[@]} - 1))); do
 		if [[ -v WISH_POWERLINE ]] && [[ $WISH_POWERLINE != 0 ]]; then
-			if wish_${WISH_RIGHT_PLUGINS[$i]}_end $prev; then
+			if "wish_${WISH_RIGHT_PLUGINS[$i]}_end" "$prev"; then
 				if [[ $i == 0 ]]; then
 					local plugin=${WISH_RIGHT_PLUGINS[$i]}
 					local fg_name="WISH_${plugin^^}_BG"
-					wish_append -1 ${!fg_name} "${WISH_POWERLINE_RIGHT}"
-				elif wish_${WISH_RIGHT_PLUGINS[$(($i - 1))]}_start $prev; then
+					wish_append -1 "${!fg_name}" "${WISH_POWERLINE_RIGHT}"
+				elif "wish_${WISH_RIGHT_PLUGINS[$((i - 1))]}_start" $prev; then
 					local plugin=${WISH_RIGHT_PLUGINS[$i]}
-					local prev_plugin=${WISH_RIGHT_PLUGINS[$(($i-1))]}
+					local prev_plugin=${WISH_RIGHT_PLUGINS[$((i - 1))]}
 					local fg_name="WISH_${plugin^^}_BG"
 					local bg_name="WISH_${prev_plugin^^}_BG"
-					wish_append ${!bg_name} ${!fg_name} "${WISH_POWERLINE_RIGHT}"
+					wish_append "${!bg_name}" "${!fg_name}" "${WISH_POWERLINE_RIGHT}"
 				fi
 			fi
 		fi
-		wish_${WISH_RIGHT_PLUGINS[$i]}_main $prev
+		"wish_${WISH_RIGHT_PLUGINS[$i]}_main" "$prev"
 	done
 	# Save cursor position, print right prompt, restore cursor position,
 	# print left prompt, reset terminal
+	# shellcheck disable=SC2025
 	PS1=$PS1"\[\e7"
 	PS1="$PS1$(wish_print_right_prompt)"
+	# shellcheck disable=SC2025
 	PS1="$PS1\e8\]$WISH_LEFT_PS1\[\033[0;5;0m\]"
 }