The review pass found the CLI breaking its own written rules. A node broadcasts its own name, so every name the CLI prints is remote data — and Rich read `[...]` in it as a style tag. A node called `[bold]Loud` printed as `Loud`, silently no longer the string that identifies it; a node called `[/]Bob` raised MarkupError and took the command down. The log handler then failed the same way while reporting it, replacing the diagnostic with a traceback about the diagnostic. No log line and no scripted line is ever marked up, so all three consoles now say so. `right=` never right-aligned anything. Rich's `Text.wrap` returns early on `overflow="ignore"`, above the justify step, so asking for one threw the other away — every numeric lane in the CLI was left-aligned while CLAUDE.md, script.py's own docstring and the manual all said otherwise. "crop" refuses to elide just as firmly and still aligns. `config show` printed an empty string as `""` and `config set` read those two characters literally, so feeding a dump back in replaced every empty setting with a pair of quote marks — and the next dump looked identical, so nothing ever said so. It also masked an *unreported* PIN behind six bullets, telling the reader the radio was PIN-locked when it was not: `conceal` already declined to mask the menu's absence token and had simply never been shown the CLI's. `meshterm about` drew the `---` above its colophon as a rule sized to the console, which on a 16384-cell console is one 48KB line in a 4KB page. A rule is a frame; the scripted copy drops it with the QR. The contract fixture set only `--db`, which moves the history and nothing else — so the suite read whatever was in the developer's own ~/.meshterm. That is how `[/]Bob`, planted by hand on one machine, could crash the suite there and pass everywhere else. $MESHTERM_HOME moves the whole directory. Co-Authored-By: Claude Opus 5 (1M context) <noreply@anthropic.com>
157 lines
5.3 KiB
Python
157 lines
5.3 KiB
Python
"""The About MeshTerm tools: the four written pages in the menu's last section.
|
|
|
|
*About MeshTerm*, *About the author*, *Join Discord*, *Support MeshTerm* — in that
|
|
order, which is the order a stranger asks the questions in: what is this, who made it,
|
|
where is everyone, how do I help. They share the *This app* section with Preferences,
|
|
which leads it: the section is the app's own scope, and the one row that *changes*
|
|
MeshTerm sits above the four that describe it.
|
|
Each is a page rather than a feature: it reads nothing, transmits nothing, and needs no
|
|
device, so it opens straight to its screen (see :mod:`meshterm.ui.about`) instead of
|
|
prompting for anything first.
|
|
|
|
Each also keeps a CLI face — ``meshterm about``, ``meshterm about-author``,
|
|
``meshterm discord``, ``meshterm support`` — printing the same page to the terminal, so
|
|
the answers are reachable from a shell without launching the full-screen session.
|
|
|
|
The pages themselves are written in markdown under ``meshterm/assets/pages`` (see
|
|
:mod:`meshterm.ui.about`); nothing here knows what any of them say.
|
|
"""
|
|
|
|
from __future__ import annotations
|
|
|
|
from typing import TYPE_CHECKING, Any
|
|
|
|
from ..context import AppContext
|
|
from .base import Tool, ToolResult, register
|
|
|
|
if TYPE_CHECKING:
|
|
from ..ui.markdown import MarkdownDoc
|
|
|
|
|
|
class _AboutTool(Tool):
|
|
"""Shared behaviour for the four About pages: open the screen, or print the page.
|
|
|
|
The pages differ only in their title, icon, and content, so everything else — the
|
|
menu-only screen open, the printing CLI face, the run row — lives here once. A
|
|
subclass supplies :meth:`page`, and nothing more.
|
|
"""
|
|
|
|
category = "This app"
|
|
|
|
@staticmethod
|
|
def page() -> MarkdownDoc:
|
|
"""Build this page's content.
|
|
|
|
Overridden by each page. Subclasses import their builder *inside* the override
|
|
rather than at module scope: the registry imports every tool module at startup
|
|
(see :func:`~meshterm.tools.load_all_tools`), and a page's content is only ever
|
|
wanted once someone actually opens it.
|
|
"""
|
|
raise NotImplementedError
|
|
|
|
async def prompt_params(self, ctx: AppContext) -> dict[str, Any] | None:
|
|
"""Open the page; returning ``None`` completes the invocation with no run row.
|
|
|
|
The page transmits nothing and stores nothing, so — like the Trophy case and the
|
|
mesh walk — it lives here rather than in :meth:`run`, and logs no run of its own.
|
|
|
|
Args:
|
|
ctx: Shared application context.
|
|
|
|
Returns:
|
|
Always ``None``.
|
|
"""
|
|
from ..ui.about import open_about_page
|
|
|
|
await open_about_page(ctx, self.title, self.page())
|
|
return None
|
|
|
|
async def run(self, ctx: AppContext, params: dict[str, Any]) -> ToolResult:
|
|
"""Print the page — only reachable from the CLI (the menu opens the screen).
|
|
|
|
Without its scannable codes: a QR is a second rendering of a link the page already
|
|
prints, drawn for a phone pointed at a screen, and redirected into a file it is a
|
|
block of block characters around nothing new.
|
|
|
|
Args:
|
|
ctx: Shared application context.
|
|
params: Unused beyond the injected ``_run_id``.
|
|
|
|
Returns:
|
|
A :class:`ToolResult` naming the page that was shown.
|
|
"""
|
|
ctx.ui.show(self.page().for_script())
|
|
return ToolResult(summary={"page": self.name})
|
|
|
|
|
|
@register
|
|
class AboutMeshTermTool(_AboutTool):
|
|
"""What MeshTerm is, where it came from, and the terms it ships under."""
|
|
|
|
name = "about"
|
|
title = "About MeshTerm"
|
|
icon = "📖"
|
|
help = "What this is, and the terms it ships under"
|
|
order = 10 # the question a stranger asks first
|
|
|
|
@staticmethod
|
|
def page() -> MarkdownDoc:
|
|
"""The *About MeshTerm* page."""
|
|
from ..ui.about import about_meshterm
|
|
|
|
return about_meshterm()
|
|
|
|
|
|
@register
|
|
class AboutAuthorTool(_AboutTool):
|
|
"""The person behind MeshTerm, on the mesh and off it."""
|
|
|
|
name = "about-author"
|
|
title = "About the author"
|
|
icon = "👤"
|
|
help = "The person behind MeshTerm, on and off the mesh"
|
|
order = 20 # who made the thing you just read about
|
|
|
|
@staticmethod
|
|
def page() -> MarkdownDoc:
|
|
"""The *About the author* page."""
|
|
from ..ui.about import about_author
|
|
|
|
return about_author()
|
|
|
|
|
|
@register
|
|
class JoinDiscordTool(_AboutTool):
|
|
"""The community server: one invite link, and a QR of it for a phone to read."""
|
|
|
|
name = "discord"
|
|
title = "Join Discord"
|
|
icon = "🔗"
|
|
help = "The invite link to the MeshTerm community server"
|
|
order = 25 # where everyone else is, once you know what this is and who made it
|
|
|
|
@staticmethod
|
|
def page() -> MarkdownDoc:
|
|
"""The *Join Discord* page."""
|
|
from ..ui.about import join_discord
|
|
|
|
return join_discord()
|
|
|
|
|
|
@register
|
|
class SupportProjectTool(_AboutTool):
|
|
"""What keeps MeshTerm going, and the ways — paid and unpaid — to help it along."""
|
|
|
|
name = "support"
|
|
title = "Support MeshTerm"
|
|
icon = "💰"
|
|
help = "What keeps MeshTerm going, and how to help"
|
|
order = 30 # the ask, and only once the pages before it have earned it
|
|
|
|
@staticmethod
|
|
def page() -> MarkdownDoc:
|
|
"""The *Support MeshTerm* page."""
|
|
from ..ui.about import support_project
|
|
|
|
return support_project()
|