mirror of
https://github.com/kuhyx/signal-bot.git
synced 2026-11-11 21:54:03 +01:00
Krzysztof kuhy Rudnicki
144f5de28c
Thirteen commands, and the only list of them was a README table nobody in a Signal group can read — which had itself gone stale two releases earlier, still advertising four commands after nine more had shipped. 0.1.1 gave each command an output that says what the command is; that only helps once you already know to type it. !pomoc (also !pomocy, !help, !komendy, !commands) prints all fourteen, grouped, one Polish line each. The interesting part is that it cannot go stale. CommandRegistry.register now takes the description as a REQUIRED argument, so a command that does not explain itself does not compile; and render_help prints any command that help_command.GROUPS forgot to file, under no heading, rather than dropping it. Two independent ways to fail closed, because the README proved that a hand-maintained second list is a list that drifts. Command also gained `primary`, the first raw alias. The trigger set could not supply it: those are folded skeletons in an unordered frozenset, so all that survives of "!papież" there is "!papiez", and the styled Unicode aliases come out as zalgo. aliases.json already lists the canonical Polish spelling first. The full trigger table moves to DOCS-commands.md. It did not fit in README — that file was already sitting exactly on the shared 250-line cap, and the gate caught the overflow on the first commit attempt. Exercised in testbot at the unbumped version before this bump: the live dispatcher ran it and posted the list, journal clean. pytest 708 green at 100% branch coverage, e2e green including a new scenario that asserts !pomoc mentions a command registered by a different module. Co-Authored-By: Claude Opus 5 (1M context) <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_017w1HZ3cZ7neL3rFdQ6VMBA
52 lines
2.4 KiB
Markdown
52 lines
2.4 KiB
Markdown
# Commands
|
|
|
|
The copy that matters is not this file: `!pomoc` prints the same list **in the
|
|
group**, in Polish, one line of description per command. That version is built
|
|
from the command registry at run time and cannot drift, because
|
|
`CommandRegistry.register` takes the description as a required argument and
|
|
`help_command.render_help` prints any command its `GROUPS` table forgot to
|
|
file anyway, under no heading.
|
|
|
|
This file is the trigger reference — every spelling that resolves, which
|
|
`!pomoc` deliberately does not print.
|
|
|
|
| Command | Aliases |
|
|
|---|---|
|
|
| cat | `!kot` `!koty` `!kots` `!cat` `!cats` `!meow` `!miau` + styled variants |
|
|
| dog | `!pies` `!psy` `!dog` `!dogs` `!woof` `!szczek` + styled variants |
|
|
| gecko | `!gekon` `!gekony` `!geko` `!gecko` `!geckon` `!geckos` |
|
|
| pope | `!papież` `!papiez` `!papieze` `!papieża` `!papa` `!pope` `!popes` `!pontifex` + styled variants |
|
|
| stats_today | `!staty` `!statystyki` `!stats` `!dziś` `!dzis` |
|
|
| stats_yesterday | `!wczoraj` `!yesterday` |
|
|
| stats_week | `!tydzień` `!tydzien` `!week` |
|
|
| stats_month | `!miesiąc` `!miesiac` `!month` |
|
|
| stats_year | `!rok` `!year` |
|
|
| stats_records | `!rekordy` `!rekord` `!records` |
|
|
| stats_crown | `!korona` `!crown` |
|
|
| stats_weekdays | `!dni` `!days` |
|
|
| stats_me | `!ja` `!moje` `!mnie` |
|
|
| help | `!pomoc` `!pomocy` `!help` `!komendy` `!commands` |
|
|
|
|
Aliases live in `signal_bot/aliases.json`, not in source, because they are
|
|
data: adding one should never mean touching Python.
|
|
|
|
## Why `!pomoc` shows the first alias and not a trigger
|
|
|
|
`Command.triggers` is a `frozenset` of **folded skeletons** — `folding.py`
|
|
runs NFKC, strips diacritics and maps Cyrillic/Greek/small-caps/leet
|
|
lookalikes onto ASCII, so that `!gecko` typed on a Russian keyboard still
|
|
resolves. Everything that makes those triggers robust also makes them
|
|
unprintable: the set has no order, `!papież` survives only as `!papiez`, and
|
|
the styled variants come out as zalgo.
|
|
|
|
So `Command.primary` holds the first *raw* trigger instead, which
|
|
`aliases.json` lists as the canonical Polish spelling for every command.
|
|
|
|
Two consequences worth remembering, both from `folding.py`:
|
|
|
|
- A command name can never contain a digit — `fold` maps `0134578` onto
|
|
letters, so `!7dni` would resolve as `!tdni`.
|
|
- The styled Unicode aliases in the table above are redundant now; folding
|
|
covers them. They are kept because removing an alias can only take
|
|
something away.
|