@codebend3r/che 1.0.0 → 1.1.0

package/README.md

@@ -11,8 +11,33 @@ your shell, and browsable through one menu.**
 ![Dependencies: stdlib only](https://img.shields.io/badge/dependencies-stdlib%20only-brightgreen)
 ![Shells: zsh, bash, fish](https://img.shields.io/badge/shells-zsh%20%7C%20bash%20%7C%20fish-8A2BE2)
 
-<img src="menu.png" alt="The che menu: commands grouped by category on the left, details for the selected command on the right" width="850">
+</div>
+
+<!-- che:banner -->
+```text
+**#*-
+#*-.         .::---:::.
+=       .:+#%@@@@@@@@@%#*+-.
+      .-*%@@@@@@@@@*==----+*-
+     .=-====*%@@@@+:..:===--+:
+     . .-:.  .=%@%+=-+:...=+==
+      .=:-.:=:.+#***+***+++**+.    ██████╗██╗  ██╗███████╗
+      -.:++**+-#@%##%%####%##*-   ██╔════╝██║  ██║██╔════╝
+     .=+**#%#-:-+=--+%%@@####+.   ██║     ███████║█████╗
+     .+*#%@@*...=+::+##%%#***-.   ██║     ██╔══██║██╔══╝
+      -*##%@*=:-#*=-:--==##*+:.   ╚██████╗██║  ██║███████╗
+      .=+#+-::--::-:.:.: :++=:.    ╚═════╝╚═╝  ╚═╝╚══════╝
+       :++...::::---==++:---...
+        :..=**+++-=*#%@%=:::..
+         .:-*%@@@@@@@%#*. :::
+:  .      .  -+**#*=-.
+++-.                       .::
++*+=:                    .-===.
+```
+<!-- /che:banner -->
 
+<div align="center">
+<img src="menu.png" alt="The che menu: commands grouped by category on the left, details for the selected command on the right" width="850">
 </div>
 
 The scripts are Python, standard library only. The names you type
@@ -290,6 +315,7 @@ where you copy one machine's rc file to another.
 
 ```
 bin/
+  art.py              the wordmark and the face beside it, for every screen
   che.py              the dispatcher and the interactive menu
   commands.py         the command manifest: the source of truth for everything
   install.py          installer, first-run wizard, doctor, self-update

package/bin/art.py

@@ -0,0 +1,121 @@
+"""The che wordmark and the face it shares a name with, as text.
+
+``LOGO`` is the block-letter wordmark that ``che install``, ``che doctor`` and
+the first-run screen print. ``FACE`` is Che Guevara, rendered from a photograph
+to 32 columns by 18 rows so the two fit side by side in an 80-column terminal.
+Dense characters are the bright parts of the photo, which reads correctly on a
+dark background.
+
+``banner()`` lays the face beside whatever a screen wants next to it, normally
+the wordmark with a subtitle underneath, centred vertically on the face. Lines
+may carry colour escapes; widths are measured with ``tui.display_width`` so the
+escapes do not push the right-hand column about.
+"""
+
+from __future__ import annotations
+
+from collections.abc import Sequence
+
+import tui
+
+LOGO = r"""
+   ██████╗██╗  ██╗███████╗
+  ██╔════╝██║  ██║██╔════╝
+  ██║     ███████║█████╗
+  ██║     ██╔══██║██╔══╝
+  ╚██████╗██║  ██║███████╗
+   ╚═════╝╚═╝  ╚═╝╚══════╝
+"""
+
+FACE = """
+**#*-
+#*-.         .::---:::.
+=       .:+#%@@@@@@@@@%#*+-.
+      .-*%@@@@@@@@@*==----+*-
+     .=-====*%@@@@+:..:===--+:
+     . .-:.  .=%@%+=-+:...=+==
+      .=:-.:=:.+#***+***+++**+.
+      -.:++**+-#@%##%%####%##*-
+     .=+**#%#-:-+=--+%%@@####+.
+     .+*#%@@*...=+::+##%%#***-.
+      -*##%@*=:-#*=-:--==##*+:.
+      .=+#+-::--::-:.:.: :++=:.
+       :++...::::---==++:---...
+        :..=**+++-=*#%@%=:::..
+         .:-*%@@@@@@@%#*. :::
+:  .      .  -+**#*=-.
+++-.                       .::
++*+=:                    .-===.
+"""
+
+# What the face gets on its left, so it lines up with the two-space indent the
+# wordmark and every subtitle carry.
+INDENT = "  "
+# Columns between the face and the block beside it. The wordmark lines start
+# with two spaces of their own, so the visible gap is wider than this.
+GAP = 1
+
+
+def logo_lines() -> list[str]:
+    return LOGO.strip("\n").splitlines()
+
+
+def face_lines() -> list[str]:
+    return FACE.strip("\n").splitlines()
+
+
+HEIGHT = len(face_lines())
+WIDTH = len(INDENT) + max(len(line) for line in face_lines())
+
+
+def wordmark(colors: tui.Palette | None = None) -> list[str]:
+    """The block letters, coloured the way every screen prints them."""
+    colors = colors or tui.palette()
+    return [f"{colors.bright_magenta}{line}{colors.reset}" for line in logo_lines()]
+
+
+def face(colors: tui.Palette | None = None) -> list[str]:
+    """The face, indented to line up with the wordmark and in the same colour."""
+    colors = colors or tui.palette()
+    return [f"{colors.bright_magenta}{INDENT}{line}{colors.reset}" for line in face_lines()]
+
+
+def compose(left: Sequence[str], right: Sequence[str], *, gap: int = GAP) -> list[str]:
+    """Lay ``right`` beside ``left``, the shorter block centred on the taller."""
+    left = list(left)
+    right = list(right)
+    left_width = max((tui.display_width(line) for line in left), default=0)
+    height = max(len(left), len(right))
+    left_top = (height - len(left)) // 2
+    right_top = (height - len(right)) // 2
+
+    rows = []
+    for index in range(height):
+        a = left[index - left_top] if 0 <= index - left_top < len(left) else ""
+        b = right[index - right_top] if 0 <= index - right_top < len(right) else ""
+        if b:
+            a += " " * (left_width + gap - tui.display_width(a))
+        rows.append((a + b).rstrip())
+    return rows
+
+
+def fits(right: Sequence[str], columns: int) -> bool:
+    """Whether the face and ``right`` sit side by side in ``columns``."""
+    right_width = max((tui.display_width(line) for line in right), default=0)
+    return WIDTH + GAP + right_width <= columns
+
+
+def banner(
+    right: Sequence[str], *, columns: int | None = None, colors: tui.Palette | None = None
+) -> list[str]:
+    """The face with ``right`` beside it, or ``right`` alone when it would not fit.
+
+    ``right`` is normally the wordmark plus whatever a screen wants under it (a
+    subtitle, the command count). It comes back untouched, indent and all, on a
+    terminal too narrow for both, so every caller keeps working at 40 columns.
+    """
+    if columns is None:
+        columns = tui.size()[0]
+    if not fits(right, columns):
+        return list(right)
+    return compose(face(colors), right)

package/bin/che.py

@@ -30,6 +30,7 @@ from pathlib import Path
 
 sys.path.insert(0, str(Path(__file__).resolve().parent))
 
+import art
 import install as installer
 import shellgen
 import tui
@@ -427,33 +428,52 @@ def handle_key(state: Menu, key: str) -> str:
     return ""
 
 
+# The face heads the menu only while the list under it keeps at least this
+# many rows. Below that the one-line header takes over, as it always did.
+MIN_LIST_ROWS = 8
+
+
+def banner_fits(screen: tui.Screen, right: list[str]) -> bool:
+    """Whether the face and wordmark can head the menu and still leave a list."""
+    spare = screen.rows - (art.HEIGHT + 1) - 4
+    return spare >= MIN_LIST_ROWS and art.fits(right, screen.columns)
+
+
 def draw(screen: tui.Screen, state: Menu) -> None:
     colors = tui.palette()
     width = screen.columns
 
     total = len(all_commands())
     shown = len(state.matches())
-    title = f"{colors.bright_magenta}{colors.bold}che{colors.reset}"
     counter = f"{shown}/{total}" if state.query else str(total)
-    header = (
-        f"  {title} {colors.grey}v{VERSION}{colors.reset}  "
-        f"{colors.grey}{counter} commands{colors.reset}"
-    )
-    screen.line()
-    screen.line(header)
-
     if state.searching or state.query:
         caret = f"{colors.cyan}▏{colors.reset}" if state.searching else " "
-        screen.line(f"  {colors.grey}search{colors.reset} {caret}{state.query}")
+        prompt = f"  {colors.grey}search{colors.reset} {caret}{state.query}"
+    else:
+        prompt = f"  {colors.grey}type to search   ↑↓ move   ⏎ run   ? keys{colors.reset}"
+
+    right = art.wordmark(colors)
+    right += ["", f"  {colors.grey}v{VERSION}  {counter} commands{colors.reset}", prompt]
+    if banner_fits(screen, right) and not state.show_help:
+        # The face beside the wordmark, with the version, the count and the
+        # search line tucked under the letters.
+        screen.lines(art.banner(right, columns=width, colors=colors))
     else:
-        screen.line(f"  {colors.grey}type to search   ↑↓ move   ⏎ run   ? keys{colors.reset}")
+        title = f"{colors.bright_magenta}{colors.bold}che{colors.reset}"
+        screen.line()
+        screen.line(
+            f"  {title} {colors.grey}v{VERSION}{colors.reset}  "
+            f"{colors.grey}{counter} commands{colors.reset}"
+        )
+        screen.line(prompt)
     screen.line(f"  {colors.grey}{'─' * max(0, width - 4)}{colors.reset}")
+    header_rows = screen.used
 
     if state.show_help:
         draw_help(screen)
         return
 
-    body_rows = max(3, screen.rows - 8)
+    body_rows = max(3, screen.rows - header_rows - 4)
     rows = state.rows()
     if not rows:
         screen.line()

package/bin/install.py

@@ -39,6 +39,7 @@ from pathlib import Path
 # `parent`, where the scripts under bin/<category>/ use `parent.parent`.
 sys.path.insert(0, str(Path(__file__).resolve().parent))
 
+import art
 import shellgen
 from commands import PACKAGE_NAME, REPO, VERSION, all_commands, required_binaries
 from tui import choose, confirm, is_interactive, palette
@@ -818,22 +819,15 @@ def _with_fish_path_line(block: str) -> str:
 # The first-run wizard
 # ---------------------------------------------------------------------------
 
-LOGO = r"""
-   ██████╗██╗  ██╗███████╗
-  ██╔════╝██║  ██║██╔════╝
-  ██║     ███████║█████╗
-  ██║     ██╔══██║██╔══╝
-  ╚██████╗██║  ██║███████╗
-   ╚═════╝╚═╝  ╚═╝╚══════╝
-"""
-
 
 def print_logo(subtitle: str = "") -> None:
+    """The face beside the wordmark, with ``subtitle`` under the letters."""
     colors = palette()
-    for line in LOGO.strip("\n").splitlines():
-        print(f"{colors.bright_magenta}{line}{colors.reset}")
+    right = art.wordmark(colors)
     if subtitle:
-        print(f"  {colors.grey}{subtitle}{colors.reset}")
+        right.append(f"  {colors.grey}{subtitle}{colors.reset}")
+    for line in art.banner(right, colors=colors):
+        print(line)
     print()
 
 

package/bin/shellgen.py

@@ -20,6 +20,7 @@ from __future__ import annotations
 import shlex
 from pathlib import Path
 
+import art
 from commands import (
     BUILTINS,
     CATEGORIES,
@@ -751,8 +752,15 @@ def _tools_table() -> str:
     return "\n".join(rows)
 
 
+def _banner_island() -> str:
+    """The face beside the wordmark, exactly as ``che`` prints them."""
+    rows = art.compose(art.face_lines(), art.logo_lines())
+    return "```text\n" + "\n".join(rows) + "\n```"
+
+
 def readme_islands() -> dict[str, str]:
     return {
+        "banner": _banner_island(),
         "commands": _commands_table(),
         "builtins": _builtins_table(),
         "keys": _keys_table(),

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@codebend3r/che",
-  "version": "1.0.0",
+  "version": "1.1.0",
   "description": "Helper scripts shared across machines, called by name from your shell and browsable through one menu",
   "keywords": [
     "cli",

package/shell/che.bash

@@ -1,4 +1,4 @@
-# che 1.0.0 - generated file, do not edit.
+# che 1.1.0 - generated file, do not edit.
 #
 # Generated from bin/commands.py by `che install`.
 # To change a wrapper, edit that manifest and run `che install` again.

package/shell/che.fish

@@ -1,4 +1,4 @@
-# che 1.0.0 - generated file, do not edit.
+# che 1.1.0 - generated file, do not edit.
 #
 # Generated from bin/commands.py by `che install`.
 # To change a wrapper, edit that manifest and run `che install` again.

package/shell/che.zsh

@@ -1,4 +1,4 @@
-# che 1.0.0 - generated file, do not edit.
+# che 1.1.0 - generated file, do not edit.
 #
 # Generated from bin/commands.py by `che install`.
 # To change a wrapper, edit that manifest and run `che install` again.

package/shell/completions/_che

@@ -1,5 +1,5 @@
 #compdef che
-# che 1.0.0 - generated file, do not edit.
+# che 1.1.0 - generated file, do not edit.
 #
 # Generated from bin/commands.py by `che install`.
 # To change a wrapper, edit that manifest and run `che install` again.

package/shell/completions/che.bash

@@ -1,4 +1,4 @@
-# che 1.0.0 - generated file, do not edit.
+# che 1.1.0 - generated file, do not edit.
 #
 # Generated from bin/commands.py by `che install`.
 # To change a wrapper, edit that manifest and run `che install` again.

package/shell/completions/che.fish

@@ -1,4 +1,4 @@
-# che 1.0.0 - generated file, do not edit.
+# che 1.1.0 - generated file, do not edit.
 #
 # Generated from bin/commands.py by `che install`.
 # To change a wrapper, edit that manifest and run `che install` again.