Add the monkeyd module, which crawls a novel and sends the rendered PDF back as a Telegram document. Crawling and rendering come from the monkeyd-crawler submodule, resolved through a go.mod replace directive. The command is admin-only and restricted to monkeydd.com: one run makes hundreds of outbound requests over minutes, and the extractor only understands that site. Exports run one at a time and on a detached goroutine, because handlers are dispatched synchronously and an inline crawl would block every other command. The runtime image gains DejaVuSans; font discovery probes system paths and the distroless base ships none, so PDF rendering would otherwise fail in production. CI checks out submodules and the builder copies the submodule go.mod before go mod download, which needs it to resolve the build list.
3.5 KiB
AGENTS.md
Project Context
miti99bot is a Go Telegram bot with pluggable modules under
internal/modules. Runtime storage is MongoDB when MONGO_URL is set and
in-memory storage in tests. Read README.md before implementation work.
third_party/monkeyd-crawler is a git submodule resolved through a go.mod
replace directive, not a versioned dependency. Go commands fail until it is
checked out (git submodule update --init --recursive). Changes to the crawler
belong in its own repository and must be pushed before the submodule pointer is
advanced here, or fresh clones cannot resolve the pinned commit.
Development Rules
- Keep changes scoped to the requested module or shared contract.
- Follow existing module patterns before adding abstractions.
- Use
rgfor code search. - Use
gofmton changed Go files. - Run focused tests for touched packages, then
go test ./...andgo vet ./...for command, storage, migration, or shared behavior changes. - Before committing code changes, run the CI lint gate locally with
golangci-lint runwhen the binary is available. - Do not commit secrets, tokens, dotenv files, private keys, or production data.
Command Changes
Telegram command names are user-facing contracts. When adding, renaming, or deleting commands, update all related surfaces:
- module command registration in
internal/modules/<module>/ - command parameter metadata used by Telegram and
/help - handler usage text and user-facing error text
- tests for registration, handlers, and command menu behavior
- README/docs when behavior changes are user-visible
Follow docs/command-parameter-conventions.md for all command parameter
metadata and usage text. Keep metadata, usage errors, examples, and tests exact.
Telegram's native menu and /help show command syntax plus the summary without
example invocations.
Stats Compatibility
The stats module persists command usage in the stats collection. Command
name changes must preserve stats history.
- When renaming a command, add a one-time startup migration that moves stats
from the old command name to the new command name. Cover anonymous command
totals and per-user command rows. Guard the migration with the shared
systemcollection so it is idempotent. - When deleting a command, do not delete its stats rows. Keep them as legacy
records and mark them with
deleted: truein the stats document. - Stats queries must filter legacy deleted rows from visible results. Apply the filter consistently to top commands, top users, commands by user, users by command, and username lookup paths for both MongoDB and in-memory stores.
- If adding a deleted marker or migration fields, update indexes if query performance needs it and add tests for both startup migration and stats views.
- Legacy stats records are retained until the project owner decides to remove them.
Startup Migrations
Startup migrations should be safe to run every boot:
- create MongoDB indexes idempotently
- use
internal/systemstaterecords in the sharedsystemcollection for one-time migrations - write tests for migration idempotency and legacy data handling
- after production data is verified migrated and the owner approves cleanup,
remove completed one-time migration runtime code and migration-only tests;
keep historical
systemmarker records and legacy data unless the owner explicitly asks to delete them
Git
Use conventional commit messages without AI attribution. Keep commits focused; split unrelated code, test, docs, and config changes when useful.