tools: add gogh2moulti.bash.

Author: xavierog

CHANGELOG.md

@@ -11,6 +11,7 @@ Although Moulti's Python packages, modules and functions are obviously available
 ### Added
 
 - Environment variables `MOULTI_ANSI` and `MOULTI_ANSI_THEME_*` provide (almost) full control over ANSI color themes.
+- `tools/gogh2moulti.bash` converts [Gogh themes](https://gogh-co.github.io/Gogh/) into `MOULTI_ANSI_THEME_*` variables.
 
 ### Changed
 

Documentation.md

@@ -398,8 +398,15 @@ The constant scrolling resumes when you hit the `End` key.
    # 8-color theme: specified colors are used as both regular and bright colors:
    MOULTI_ANSI_THEME_halfvga=bg=000000,fg=AAAAAA,ansi=000000:AA0000:00AA00:AA5500:0000AA:AA00AA:00AAAA:AAAAAA
    ```
-   Moulti does not take bg (background) and fg (foreground) into account for the time being.
-   Colors may be prefixed with `#`; hexadecimal digits may be specified as lower or uppercase but there must be exactly 6 digits; theme names are case-sensitive.
+   Manually defining `MOULTI_ANSI_THEME_*` can be painful. So have a look at this helper script that turns [Gogh themes](https://gogh-co.github.io/Gogh/) into such variables:
+   ```shell
+   ./tools/gogh2moulti.bash
+   ```
+   Other details:
+   - Moulti does not take `bg` (background) and `fg` (foreground) into account for the time being.
+   - Colors may be prefixed with `#`.
+   - Hexadecimal digits may be specified as lower or uppercase but there must be exactly 6 digits.
+   - Theme names are case-sensitive: if you define `MOULTI_ANSI_THEME_AlphaBeta`, be sure to mention e.g. `MOULTI_ANSI=dark=AlphaBeta`, not `MOULTI_ANSI=dark=ALPHABETA`.
 - `MOULTI_CUSTOM_CSS`: absolute filepath to a custom TCSS file; see "How to define my own step classes ?"
 - `MOULTI_PASS_CONCURRENCY`: define how many concurrent "moulti pass" commands is acceptable; defaults to 20.
 - `MOULTI_SAVE_PATH`: base path under which export directories are created when saving a Moulti instance; defaults to `.` i.e. the instance's current working directory.

tools/gogh2moulti.bash

@@ -0,0 +1,44 @@
+#!/usr/bin/env bash
+# Convert Gogh themes (YAML) to MOULTI_ANSI_THEME_* environment variables.
+# Launched without any argument: get the Gogh Git repository and convert all its themes.
+# Launched with at least one argument: assume all arguments are filepaths and attempt to convert them.
+
+function extract {
+	grep -o -P "${1}"':.*#[0-9A-Fa-f]{6}' "${2}"
+}
+
+function just_the_color_please {
+	grep -o -P '[0-9A-Fa-f]{6}$'
+}
+
+function gogh_theme_yaml_to_moulti_env_var {
+	local file name bg fg colors
+	file="${1}"
+	name=$(basename "${file}" '.yml' | sed 's/[^A-Za-z0-9_]/_/g')
+	bg=$(extract 'background' "${file}" | just_the_color_please)
+	fg=$(extract 'foreground' "${file}" | just_the_color_please)
+	readarray -t colors < <(extract 'color_(0[1-9]|1[0-6])' "${file}" | sort | just_the_color_please)
+	local IFS=':'
+	printf 'export MOULTI_ANSI_THEME_%s=bg=%s,fg=%s,ansi=%s\n' "${name}" "${bg}" "${fg}" "${colors[*]}"
+}
+
+function gogh_theme_yaml_to_moulti_env_var_loop {
+	for file in "$@"; do
+		gogh_theme_yaml_to_moulti_env_var "${file}"
+	done
+}
+
+function gogh2moulti_main {
+	[ -d gogh ] || git clone https://github.com/Gogh-Co/Gogh.git gogh
+	gogh_theme_yaml_to_moulti_env_var_loop gogh/themes/*.yml
+}
+
+# Sourcing this file? Stop here.
+return 2> /dev/null
+
+set -e
+if [ $# -eq 0 ]; then
+	gogh2moulti_main
+else
+	gogh_theme_yaml_to_moulti_env_var_loop "$@"
+fi